Add Instructions
", "fullInstruction":"Add additional instructions.
"}`. For details and an example, see [Create a Named Entity Recognition Labeling Job (API) ](https://docs.aws.amazon.com/sagemaker/latest/dg/sms-named-entity-recg.html#sms-creating-ner-api). For all other [built-in task types](https://docs.aws.amazon.com/sagemaker/latest/dg/sms-task-types.html) and [custom tasks](https://docs.aws.amazon.com/sagemaker/latest/dg/sms-custom-templates.html), 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 [https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateLabelingJob.html#sagemaker-CreateLabelingJob-request-LabelAttributeName](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateLabelingJob.html#sagemaker-CreateLabelingJob-request-LabelAttributeName) of the labeling job you want to adjust or verify annotations of. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `(https|s3)://([^/]+)/?(.*)` Required: No ** [LabelingJobAlgorithmsConfig](#API_CreateLabelingJob_RequestSyntax) ** Configures the information required to perform automated data labeling. Type: [LabelingJobAlgorithmsConfig](API_LabelingJobAlgorithmsConfig.md) object Required: No ** [LabelingJobName](#API_CreateLabelingJob_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [OutputConfig](#API_CreateLabelingJob_RequestSyntax) ** 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. Type: [LabelingJobOutputConfig](API_LabelingJobOutputConfig.md) object Required: Yes ** [RoleArn](#API_CreateLabelingJob_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` Required: Yes ** [StoppingConditions](#API_CreateLabelingJob_RequestSyntax) ** 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. Type: [LabelingJobStoppingConditions](API_LabelingJobStoppingConditions.md) object Required: No ** [Tags](#API_CreateLabelingJob_RequestSyntax) ** An array of key/value pairs. For more information, see [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what) in the * AWS Billing and Cost Management User Guide*. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No ## Response Syntax ``` { "LabelingJobArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [LabelingJobArn](#API_CreateLabelingJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the labeling job. You use this ARN to identify the labeling job. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:labeling-job/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/CreateLabelingJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/CreateLabelingJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/CreateLabelingJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/CreateLabelingJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/CreateLabelingJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/CreateLabelingJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/CreateLabelingJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/CreateLabelingJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/CreateLabelingJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/CreateLabelingJob) # CreateMlflowApp Creates an MLflow Tracking Server using a general purpose Amazon S3 bucket as the artifact store. ## Request Syntax ``` { "AccountDefaultStatus": "string", "ArtifactStoreUri": "string", "DefaultDomainIdList": [ "string" ], "ModelRegistrationMode": "string", "Name": "string", "RoleArn": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "WeeklyMaintenanceWindowStart": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AccountDefaultStatus](#API_CreateMlflowApp_RequestSyntax) ** Indicates whether this MLflow app is the default for the entire account. Type: String Valid Values: `ENABLED | DISABLED` Required: No ** [ArtifactStoreUri](#API_CreateMlflowApp_RequestSyntax) ** The S3 URI for a general purpose bucket to use as the MLflow App artifact store. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `(https|s3)://([^/]+)/?(.*)` Required: Yes ** [DefaultDomainIdList](#API_CreateMlflowApp_RequestSyntax) ** List of SageMaker domain IDs for which this MLflow App is used as the default. Type: Array of strings Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `d-(-*[a-z0-9]){1,61}` Required: No ** [ModelRegistrationMode](#API_CreateMlflowApp_RequestSyntax) ** Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to `AutoModelRegistrationEnabled`. To disable automatic model registration, set this value to `AutoModelRegistrationDisabled`. If not specified, `AutomaticModelRegistration` defaults to `AutoModelRegistrationDisabled`. Type: String Valid Values: `AutoModelRegistrationEnabled | AutoModelRegistrationDisabled` Required: No ** [Name](#API_CreateMlflowApp_RequestSyntax) ** A string identifying the MLflow app name. This string is not part of the tracking server ARN. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}` Required: Yes ** [RoleArn](#API_CreateMlflowApp_RequestSyntax) ** The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow App uses to access the artifact store in Amazon S3. The role should have the `AmazonS3FullAccess` permission. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` Required: Yes ** [Tags](#API_CreateMlflowApp_RequestSyntax) ** Tags consisting of key-value pairs used to manage metadata for the MLflow App. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No ** [WeeklyMaintenanceWindowStart](#API_CreateMlflowApp_RequestSyntax) ** The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. For example: TUE:03:30. Type: String Length Constraints: Minimum length of 0. Maximum length of 9. Pattern: `(Mon|Tue|Wed|Thu|Fri|Sat|Sun):([01]\d|2[0-3]):([0-5]\d)` Required: No ## Response Syntax ``` { "Arn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Arn](#API_CreateMlflowApp_ResponseSyntax) ** The ARN of the MLflow App. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:mlflow-app/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/CreateMlflowApp) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/CreateMlflowApp) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/CreateMlflowApp) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/CreateMlflowApp) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/CreateMlflowApp) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/CreateMlflowApp) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/CreateMlflowApp) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/CreateMlflowApp) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/CreateMlflowApp) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/CreateMlflowApp) # CreateMlflowTrackingServer Creates an MLflow Tracking Server using a general purpose Amazon S3 bucket as the artifact store. For more information, see [Create an MLflow Tracking Server](https://docs.aws.amazon.com/sagemaker/latest/dg/mlflow-create-tracking-server.html). ## Request Syntax ``` { "ArtifactStoreUri": "string", "AutomaticModelRegistration": boolean, "MlflowVersion": "string", "RoleArn": "string", "S3BucketOwnerAccountId": "string", "S3BucketOwnerVerification": boolean, "Tags": [ { "Key": "string", "Value": "string" } ], "TrackingServerName": "string", "TrackingServerSize": "string", "WeeklyMaintenanceWindowStart": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ArtifactStoreUri](#API_CreateMlflowTrackingServer_RequestSyntax) ** The S3 URI for a general purpose bucket to use as the MLflow Tracking Server artifact store. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `(https|s3)://([^/]+)/?(.*)` Required: Yes ** [AutomaticModelRegistration](#API_CreateMlflowTrackingServer_RequestSyntax) ** Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to `True`. To disable automatic model registration, set this value to `False`. If not specified, `AutomaticModelRegistration` defaults to `False`. Type: Boolean Required: No ** [MlflowVersion](#API_CreateMlflowTrackingServer_RequestSyntax) ** The version of MLflow that the tracking server uses. To see which MLflow versions are available to use, see [How it works](https://docs.aws.amazon.com/sagemaker/latest/dg/mlflow.html#mlflow-create-tracking-server-how-it-works). Type: String Length Constraints: Minimum length of 0. Maximum length of 16. Pattern: `[0-9]*.[0-9]*.[0-9]*` Required: No ** [RoleArn](#API_CreateMlflowTrackingServer_RequestSyntax) ** The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow Tracking Server uses to access the artifact store in Amazon S3. The role should have `AmazonS3FullAccess` permissions. For more information on IAM permissions for tracking server creation, see [Set up IAM permissions for MLflow](https://docs.aws.amazon.com/sagemaker/latest/dg/mlflow-create-tracking-server-iam.html). Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` Required: Yes ** [S3BucketOwnerAccountId](#API_CreateMlflowTrackingServer_RequestSyntax) ** Expected AWS account ID that owns the Amazon S3 bucket for artifact storage. Defaults to caller's account ID if not provided. Type: String Length Constraints: Fixed length of 12. Pattern: `\d+` Required: No ** [S3BucketOwnerVerification](#API_CreateMlflowTrackingServer_RequestSyntax) ** Enable Amazon S3 Ownership checks when interacting with Amazon S3 buckets from a SageMaker Managed MLflow Tracking Server. Defaults to `True` if not provided. Type: Boolean Required: No ** [Tags](#API_CreateMlflowTrackingServer_RequestSyntax) ** Tags consisting of key-value pairs used to manage metadata for the tracking server. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No ** [TrackingServerName](#API_CreateMlflowTrackingServer_RequestSyntax) ** A unique string identifying the tracking server name. This string is part of the tracking server ARN. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}` Required: Yes ** [TrackingServerSize](#API_CreateMlflowTrackingServer_RequestSyntax) ** The size of the tracking server you want to create. You can choose between `"Small"`, `"Medium"`, and `"Large"`. The default MLflow Tracking Server configuration size is `"Small"`. You can choose a size depending on the projected use of the tracking server such as the volume of data logged, number of users, and frequency of use. We recommend using a small tracking server for teams of up to 25 users, a medium tracking server for teams of up to 50 users, and a large tracking server for teams of up to 100 users. Type: String Valid Values: `Small | Medium | Large` Required: No ** [WeeklyMaintenanceWindowStart](#API_CreateMlflowTrackingServer_RequestSyntax) ** The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. For example: TUE:03:30. Type: String Length Constraints: Minimum length of 0. Maximum length of 9. Pattern: `(Mon|Tue|Wed|Thu|Fri|Sat|Sun):([01]\d|2[0-3]):([0-5]\d)` Required: No ## Response Syntax ``` { "TrackingServerArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [TrackingServerArn](#API_CreateMlflowTrackingServer_ResponseSyntax) ** The ARN of the tracking server. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:mlflow-tracking-server/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/CreateMlflowTrackingServer) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/CreateMlflowTrackingServer) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/CreateMlflowTrackingServer) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/CreateMlflowTrackingServer) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/CreateMlflowTrackingServer) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/CreateMlflowTrackingServer) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/CreateMlflowTrackingServer) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/CreateMlflowTrackingServer) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/CreateMlflowTrackingServer) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/CreateMlflowTrackingServer) # CreateModel Creates a model in SageMaker. In the request, you name the model and describe a primary container. For the primary container, you specify the Docker image that contains inference code, artifacts (from prior training), and a custom environment map that the inference code uses when you deploy the model for predictions. Use this API to create a model if you want to use SageMaker hosting services or run a batch transform job. To host your model, you create an endpoint configuration with the `CreateEndpointConfig` API, and then create an endpoint with the `CreateEndpoint` API. SageMaker then deploys all of the containers that you defined for the model in the hosting environment. To run a batch transform using your model, you start a job with the `CreateTransformJob` API. SageMaker uses your model and your dataset to get inferences which are then saved to a specified S3 location. In the request, you also provide an IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute hosting instances or for batch transform jobs. In addition, you also use the IAM role to manage permissions the inference code needs. For example, if the inference code access any other AWS resources, you grant necessary permissions via this role. ## Request Syntax ``` { "Containers": [ { "AdditionalModelDataSources": [ { "ChannelName": "string", "S3DataSource": { "CompressionType": "string", "ETag": "string", "HubAccessConfig": { "HubContentArn": "string" }, "ManifestEtag": "string", "ManifestS3Uri": "string", "ModelAccessConfig": { "AcceptEula": boolean }, "S3DataType": "string", "S3Uri": "string" } } ], "ContainerHostname": "string", "Environment": { "string" : "string" }, "Image": "string", "ImageConfig": { "RepositoryAccessMode": "string", "RepositoryAuthConfig": { "RepositoryCredentialsProviderArn": "string" } }, "InferenceSpecificationName": "string", "Mode": "string", "ModelDataSource": { "S3DataSource": { "CompressionType": "string", "ETag": "string", "HubAccessConfig": { "HubContentArn": "string" }, "ManifestEtag": "string", "ManifestS3Uri": "string", "ModelAccessConfig": { "AcceptEula": boolean }, "S3DataType": "string", "S3Uri": "string" } }, "ModelDataUrl": "string", "ModelPackageName": "string", "MultiModelConfig": { "ModelCacheSetting": "string" } } ], "EnableNetworkIsolation": boolean, "ExecutionRoleArn": "string", "InferenceExecutionConfig": { "Mode": "string" }, "ModelName": "string", "PrimaryContainer": { "AdditionalModelDataSources": [ { "ChannelName": "string", "S3DataSource": { "CompressionType": "string", "ETag": "string", "HubAccessConfig": { "HubContentArn": "string" }, "ManifestEtag": "string", "ManifestS3Uri": "string", "ModelAccessConfig": { "AcceptEula": boolean }, "S3DataType": "string", "S3Uri": "string" } } ], "ContainerHostname": "string", "Environment": { "string" : "string" }, "Image": "string", "ImageConfig": { "RepositoryAccessMode": "string", "RepositoryAuthConfig": { "RepositoryCredentialsProviderArn": "string" } }, "InferenceSpecificationName": "string", "Mode": "string", "ModelDataSource": { "S3DataSource": { "CompressionType": "string", "ETag": "string", "HubAccessConfig": { "HubContentArn": "string" }, "ManifestEtag": "string", "ManifestS3Uri": "string", "ModelAccessConfig": { "AcceptEula": boolean }, "S3DataType": "string", "S3Uri": "string" } }, "ModelDataUrl": "string", "ModelPackageName": "string", "MultiModelConfig": { "ModelCacheSetting": "string" } }, "Tags": [ { "Key": "string", "Value": "string" } ], "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Containers](#API_CreateModel_RequestSyntax) ** Specifies the containers in the inference pipeline. Type: Array of [ContainerDefinition](API_ContainerDefinition.md) objects Array Members: Minimum number of 0 items. Maximum number of 15 items. Required: No ** [EnableNetworkIsolation](#API_CreateModel_RequestSyntax) ** Isolates the model container. No inbound or outbound network calls can be made to or from the model container. Type: Boolean Required: No ** [ExecutionRoleArn](#API_CreateModel_RequestSyntax) ** The Amazon Resource Name (ARN) of the IAM role that 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 [SageMaker Roles](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html). To be able to pass this role to SageMaker, the caller of this API must have the `iam:PassRole` permission. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` Required: No ** [InferenceExecutionConfig](#API_CreateModel_RequestSyntax) ** Specifies details of how containers in a multi-container endpoint are called. Type: [InferenceExecutionConfig](API_InferenceExecutionConfig.md) object Required: No ** [ModelName](#API_CreateModel_RequestSyntax) ** The name of the new model. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9]([\-a-zA-Z0-9]*[a-zA-Z0-9])?` Required: Yes ** [PrimaryContainer](#API_CreateModel_RequestSyntax) ** 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. Type: [ContainerDefinition](API_ContainerDefinition.md) object Required: No ** [Tags](#API_CreateModel_RequestSyntax) ** 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](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No ** [VpcConfig](#API_CreateModel_RequestSyntax) ** A [VpcConfig](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html) 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](https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html) and [Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud](https://docs.aws.amazon.com/sagemaker/latest/dg/batch-vpc.html). Type: [VpcConfig](API_VpcConfig.md) object Required: No ## Response Syntax ``` { "ModelArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ModelArn](#API_CreateModel_ResponseSyntax) ** The ARN of the model created in SageMaker. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:model/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/CreateModel) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/CreateModel) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/CreateModel) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/CreateModel) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/CreateModel) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/CreateModel) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/CreateModel) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/CreateModel) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/CreateModel) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/CreateModel) # CreateModelBiasJobDefinition Creates the definition for a model bias job. ## Request Syntax ``` { "JobDefinitionName": "string", "JobResources": { "ClusterConfig": { "InstanceCount": number, "InstanceType": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number } }, "ModelBiasAppSpecification": { "ConfigUri": "string", "Environment": { "string" : "string" }, "ImageUri": "string" }, "ModelBiasBaselineConfig": { "BaseliningJobName": "string", "ConstraintsResource": { "S3Uri": "string" } }, "ModelBiasJobInput": { "BatchTransformInput": { "DataCapturedDestinationS3Uri": "string", "DatasetFormat": { "Csv": { "Header": boolean }, "Json": { "Line": boolean }, "Parquet": { } }, "EndTimeOffset": "string", "ExcludeFeaturesAttribute": "string", "FeaturesAttribute": "string", "InferenceAttribute": "string", "LocalPath": "string", "ProbabilityAttribute": "string", "ProbabilityThresholdAttribute": number, "S3DataDistributionType": "string", "S3InputMode": "string", "StartTimeOffset": "string" }, "EndpointInput": { "EndpointName": "string", "EndTimeOffset": "string", "ExcludeFeaturesAttribute": "string", "FeaturesAttribute": "string", "InferenceAttribute": "string", "LocalPath": "string", "ProbabilityAttribute": "string", "ProbabilityThresholdAttribute": number, "S3DataDistributionType": "string", "S3InputMode": "string", "StartTimeOffset": "string" }, "GroundTruthS3Input": { "S3Uri": "string" } }, "ModelBiasJobOutputConfig": { "KmsKeyId": "string", "MonitoringOutputs": [ { "S3Output": { "LocalPath": "string", "S3UploadMode": "string", "S3Uri": "string" } } ] }, "NetworkConfig": { "EnableInterContainerTrafficEncryption": boolean, "EnableNetworkIsolation": boolean, "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } }, "RoleArn": "string", "StoppingCondition": { "MaxRuntimeInSeconds": number }, "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [JobDefinitionName](#API_CreateModelBiasJobDefinition_RequestSyntax) ** The name of the bias job definition. The name must be unique within an AWS Region in the AWS account. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [JobResources](#API_CreateModelBiasJobDefinition_RequestSyntax) ** Identifies the resources to deploy for a monitoring job. Type: [MonitoringResources](API_MonitoringResources.md) object Required: Yes ** [ModelBiasAppSpecification](#API_CreateModelBiasJobDefinition_RequestSyntax) ** Configures the model bias job to run a specified Docker container image. Type: [ModelBiasAppSpecification](API_ModelBiasAppSpecification.md) object Required: Yes ** [ModelBiasBaselineConfig](#API_CreateModelBiasJobDefinition_RequestSyntax) ** The baseline configuration for a model bias job. Type: [ModelBiasBaselineConfig](API_ModelBiasBaselineConfig.md) object Required: No ** [ModelBiasJobInput](#API_CreateModelBiasJobDefinition_RequestSyntax) ** Inputs for the model bias job. Type: [ModelBiasJobInput](API_ModelBiasJobInput.md) object Required: Yes ** [ModelBiasJobOutputConfig](#API_CreateModelBiasJobDefinition_RequestSyntax) ** The output configuration for monitoring jobs. Type: [MonitoringOutputConfig](API_MonitoringOutputConfig.md) object Required: Yes ** [NetworkConfig](#API_CreateModelBiasJobDefinition_RequestSyntax) ** Networking options for a model bias job. Type: [MonitoringNetworkConfig](API_MonitoringNetworkConfig.md) object Required: No ** [RoleArn](#API_CreateModelBiasJobDefinition_RequestSyntax) ** The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` Required: Yes ** [StoppingCondition](#API_CreateModelBiasJobDefinition_RequestSyntax) ** A time limit for how long the monitoring job is allowed to run before stopping. Type: [MonitoringStoppingCondition](API_MonitoringStoppingCondition.md) object Required: No ** [Tags](#API_CreateModelBiasJobDefinition_RequestSyntax) ** (Optional) An array of key-value pairs. For more information, see [ Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL) in the * AWS Billing and Cost Management User Guide*. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No ## Response Syntax ``` { "JobDefinitionArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [JobDefinitionArn](#API_CreateModelBiasJobDefinition_ResponseSyntax) ** The Amazon Resource Name (ARN) of the model bias job. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/CreateModelBiasJobDefinition) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/CreateModelBiasJobDefinition) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/CreateModelBiasJobDefinition) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/CreateModelBiasJobDefinition) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/CreateModelBiasJobDefinition) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/CreateModelBiasJobDefinition) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/CreateModelBiasJobDefinition) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/CreateModelBiasJobDefinition) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/CreateModelBiasJobDefinition) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/CreateModelBiasJobDefinition) # CreateModelCard Creates an Amazon SageMaker Model Card. For information about how to use model cards, see [Amazon SageMaker Model Card](https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html). ## Request Syntax ``` { "Content": "string", "ModelCardName": "string", "ModelCardStatus": "string", "SecurityConfig": { "KmsKeyId": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Content](#API_CreateModelCard_RequestSyntax) ** The content of the model card. Content must be in [model card JSON schema](https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema) and provided as a string. Type: String Length Constraints: Minimum length of 0. Maximum length of 100000. Pattern: `.*` Required: Yes ** [ModelCardName](#API_CreateModelCard_RequestSyntax) ** The unique name of the model card. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [ModelCardStatus](#API_CreateModelCard_RequestSyntax) ** The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval. + `Draft`: The model card is a work in progress. + `PendingReview`: The model card is pending review. + `Approved`: The model card is approved. + `Archived`: The model card is archived. No more updates should be made to the model card, but it can still be exported. Type: String Valid Values: `Draft | PendingReview | Approved | Archived` Required: Yes ** [SecurityConfig](#API_CreateModelCard_RequestSyntax) ** An optional Key Management Service key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with highly sensitive data. Type: [ModelCardSecurityConfig](API_ModelCardSecurityConfig.md) object Required: No ** [Tags](#API_CreateModelCard_RequestSyntax) ** Key-value pairs used to manage metadata for model cards. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No ## Response Syntax ``` { "ModelCardArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ModelCardArn](#API_CreateModelCard_ResponseSyntax) ** The Amazon Resource Name (ARN) of the successfully created model card. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/CreateModelCard) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/CreateModelCard) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/CreateModelCard) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/CreateModelCard) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/CreateModelCard) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/CreateModelCard) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/CreateModelCard) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/CreateModelCard) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/CreateModelCard) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/CreateModelCard) # CreateModelCardExportJob Creates an Amazon SageMaker Model Card export job. ## Request Syntax ``` { "ModelCardExportJobName": "string", "ModelCardName": "string", "ModelCardVersion": number, "OutputConfig": { "S3OutputPath": "string" } } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ModelCardExportJobName](#API_CreateModelCardExportJob_RequestSyntax) ** The name of the model card export job. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [ModelCardName](#API_CreateModelCardExportJob_RequestSyntax) ** The name or Amazon Resource Name (ARN) of the model card to export. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:model-card/.*)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})` Required: Yes ** [ModelCardVersion](#API_CreateModelCardExportJob_RequestSyntax) ** The version of the model card to export. If a version is not provided, then the latest version of the model card is exported. Type: Integer Required: No ** [OutputConfig](#API_CreateModelCardExportJob_RequestSyntax) ** The model card output configuration that specifies the Amazon S3 path for exporting. Type: [ModelCardExportOutputConfig](API_ModelCardExportOutputConfig.md) object Required: Yes ## Response Syntax ``` { "ModelCardExportJobArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ModelCardExportJobArn](#API_CreateModelCardExportJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the model card export job. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}/export-job/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/CreateModelCardExportJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/CreateModelCardExportJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/CreateModelCardExportJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/CreateModelCardExportJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/CreateModelCardExportJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/CreateModelCardExportJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/CreateModelCardExportJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/CreateModelCardExportJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/CreateModelCardExportJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/CreateModelCardExportJob) # CreateModelExplainabilityJobDefinition Creates the definition for a model explainability job. ## Request Syntax ``` { "JobDefinitionName": "string", "JobResources": { "ClusterConfig": { "InstanceCount": number, "InstanceType": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number } }, "ModelExplainabilityAppSpecification": { "ConfigUri": "string", "Environment": { "string" : "string" }, "ImageUri": "string" }, "ModelExplainabilityBaselineConfig": { "BaseliningJobName": "string", "ConstraintsResource": { "S3Uri": "string" } }, "ModelExplainabilityJobInput": { "BatchTransformInput": { "DataCapturedDestinationS3Uri": "string", "DatasetFormat": { "Csv": { "Header": boolean }, "Json": { "Line": boolean }, "Parquet": { } }, "EndTimeOffset": "string", "ExcludeFeaturesAttribute": "string", "FeaturesAttribute": "string", "InferenceAttribute": "string", "LocalPath": "string", "ProbabilityAttribute": "string", "ProbabilityThresholdAttribute": number, "S3DataDistributionType": "string", "S3InputMode": "string", "StartTimeOffset": "string" }, "EndpointInput": { "EndpointName": "string", "EndTimeOffset": "string", "ExcludeFeaturesAttribute": "string", "FeaturesAttribute": "string", "InferenceAttribute": "string", "LocalPath": "string", "ProbabilityAttribute": "string", "ProbabilityThresholdAttribute": number, "S3DataDistributionType": "string", "S3InputMode": "string", "StartTimeOffset": "string" } }, "ModelExplainabilityJobOutputConfig": { "KmsKeyId": "string", "MonitoringOutputs": [ { "S3Output": { "LocalPath": "string", "S3UploadMode": "string", "S3Uri": "string" } } ] }, "NetworkConfig": { "EnableInterContainerTrafficEncryption": boolean, "EnableNetworkIsolation": boolean, "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } }, "RoleArn": "string", "StoppingCondition": { "MaxRuntimeInSeconds": number }, "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [JobDefinitionName](#API_CreateModelExplainabilityJobDefinition_RequestSyntax) ** The name of the model explainability job definition. The name must be unique within an AWS Region in the AWS account. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [JobResources](#API_CreateModelExplainabilityJobDefinition_RequestSyntax) ** Identifies the resources to deploy for a monitoring job. Type: [MonitoringResources](API_MonitoringResources.md) object Required: Yes ** [ModelExplainabilityAppSpecification](#API_CreateModelExplainabilityJobDefinition_RequestSyntax) ** Configures the model explainability job to run a specified Docker container image. Type: [ModelExplainabilityAppSpecification](API_ModelExplainabilityAppSpecification.md) object Required: Yes ** [ModelExplainabilityBaselineConfig](#API_CreateModelExplainabilityJobDefinition_RequestSyntax) ** The baseline configuration for a model explainability job. Type: [ModelExplainabilityBaselineConfig](API_ModelExplainabilityBaselineConfig.md) object Required: No ** [ModelExplainabilityJobInput](#API_CreateModelExplainabilityJobDefinition_RequestSyntax) ** Inputs for the model explainability job. Type: [ModelExplainabilityJobInput](API_ModelExplainabilityJobInput.md) object Required: Yes ** [ModelExplainabilityJobOutputConfig](#API_CreateModelExplainabilityJobDefinition_RequestSyntax) ** The output configuration for monitoring jobs. Type: [MonitoringOutputConfig](API_MonitoringOutputConfig.md) object Required: Yes ** [NetworkConfig](#API_CreateModelExplainabilityJobDefinition_RequestSyntax) ** Networking options for a model explainability job. Type: [MonitoringNetworkConfig](API_MonitoringNetworkConfig.md) object Required: No ** [RoleArn](#API_CreateModelExplainabilityJobDefinition_RequestSyntax) ** The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` Required: Yes ** [StoppingCondition](#API_CreateModelExplainabilityJobDefinition_RequestSyntax) ** A time limit for how long the monitoring job is allowed to run before stopping. Type: [MonitoringStoppingCondition](API_MonitoringStoppingCondition.md) object Required: No ** [Tags](#API_CreateModelExplainabilityJobDefinition_RequestSyntax) ** (Optional) An array of key-value pairs. For more information, see [ Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL) in the * AWS Billing and Cost Management User Guide*. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No ## Response Syntax ``` { "JobDefinitionArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [JobDefinitionArn](#API_CreateModelExplainabilityJobDefinition_ResponseSyntax) ** The Amazon Resource Name (ARN) of the model explainability job. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/CreateModelExplainabilityJobDefinition) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/CreateModelExplainabilityJobDefinition) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/CreateModelExplainabilityJobDefinition) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/CreateModelExplainabilityJobDefinition) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/CreateModelExplainabilityJobDefinition) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/CreateModelExplainabilityJobDefinition) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/CreateModelExplainabilityJobDefinition) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/CreateModelExplainabilityJobDefinition) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/CreateModelExplainabilityJobDefinition) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/CreateModelExplainabilityJobDefinition) # CreateModelPackage Creates a model package that you can use to create 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 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`. **Note** 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. ## Request Syntax ``` { "AdditionalInferenceSpecifications": [ { "Containers": [ { "AdditionalS3DataSource": { "CompressionType": "string", "ETag": "string", "S3DataType": "string", "S3Uri": "string" }, "BaseModel": { "HubContentName": "string", "HubContentVersion": "string", "RecipeName": "string" }, "ContainerHostname": "string", "Environment": { "string" : "string" }, "Framework": "string", "FrameworkVersion": "string", "Image": "string", "ImageDigest": "string", "IsCheckpoint": boolean, "ModelDataETag": "string", "ModelDataSource": { "S3DataSource": { "CompressionType": "string", "ETag": "string", "HubAccessConfig": { "HubContentArn": "string" }, "ManifestEtag": "string", "ManifestS3Uri": "string", "ModelAccessConfig": { "AcceptEula": boolean }, "S3DataType": "string", "S3Uri": "string" } }, "ModelDataUrl": "string", "ModelInput": { "DataInputConfig": "string" }, "NearestModelName": "string", "ProductId": "string" } ], "Description": "string", "Name": "string", "SupportedContentTypes": [ "string" ], "SupportedRealtimeInferenceInstanceTypes": [ "string" ], "SupportedResponseMIMETypes": [ "string" ], "SupportedTransformInstanceTypes": [ "string" ] } ], "CertifyForMarketplace": boolean, "ClientToken": "string", "CustomerMetadataProperties": { "string" : "string" }, "Domain": "string", "DriftCheckBaselines": { "Bias": { "ConfigFile": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" }, "PostTrainingConstraints": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" }, "PreTrainingConstraints": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" } }, "Explainability": { "ConfigFile": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" }, "Constraints": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" } }, "ModelDataQuality": { "Constraints": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" }, "Statistics": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" } }, "ModelQuality": { "Constraints": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" }, "Statistics": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" } } }, "InferenceSpecification": { "Containers": [ { "AdditionalS3DataSource": { "CompressionType": "string", "ETag": "string", "S3DataType": "string", "S3Uri": "string" }, "BaseModel": { "HubContentName": "string", "HubContentVersion": "string", "RecipeName": "string" }, "ContainerHostname": "string", "Environment": { "string" : "string" }, "Framework": "string", "FrameworkVersion": "string", "Image": "string", "ImageDigest": "string", "IsCheckpoint": boolean, "ModelDataETag": "string", "ModelDataSource": { "S3DataSource": { "CompressionType": "string", "ETag": "string", "HubAccessConfig": { "HubContentArn": "string" }, "ManifestEtag": "string", "ManifestS3Uri": "string", "ModelAccessConfig": { "AcceptEula": boolean }, "S3DataType": "string", "S3Uri": "string" } }, "ModelDataUrl": "string", "ModelInput": { "DataInputConfig": "string" }, "NearestModelName": "string", "ProductId": "string" } ], "SupportedContentTypes": [ "string" ], "SupportedRealtimeInferenceInstanceTypes": [ "string" ], "SupportedResponseMIMETypes": [ "string" ], "SupportedTransformInstanceTypes": [ "string" ] }, "MetadataProperties": { "CommitId": "string", "GeneratedBy": "string", "ProjectId": "string", "Repository": "string" }, "ModelApprovalStatus": "string", "ModelCard": { "ModelCardContent": "string", "ModelCardStatus": "string" }, "ModelLifeCycle": { "Stage": "string", "StageDescription": "string", "StageStatus": "string" }, "ModelMetrics": { "Bias": { "PostTrainingReport": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" }, "PreTrainingReport": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" }, "Report": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" } }, "Explainability": { "Report": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" } }, "ModelDataQuality": { "Constraints": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" }, "Statistics": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" } }, "ModelQuality": { "Constraints": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" }, "Statistics": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" } } }, "ModelPackageDescription": "string", "ModelPackageGroupName": "string", "ModelPackageName": "string", "ModelPackageRegistrationType": "string", "SamplePayloadUrl": "string", "SecurityConfig": { "KmsKeyId": "string" }, "SkipModelValidation": "string", "SourceAlgorithmSpecification": { "SourceAlgorithms": [ { "AlgorithmName": "string", "ModelDataETag": "string", "ModelDataSource": { "S3DataSource": { "CompressionType": "string", "ETag": "string", "HubAccessConfig": { "HubContentArn": "string" }, "ManifestEtag": "string", "ManifestS3Uri": "string", "ModelAccessConfig": { "AcceptEula": boolean }, "S3DataType": "string", "S3Uri": "string" } }, "ModelDataUrl": "string" } ] }, "SourceUri": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "Task": "string", "ValidationSpecification": { "ValidationProfiles": [ { "ProfileName": "string", "TransformJobDefinition": { "BatchStrategy": "string", "Environment": { "string" : "string" }, "MaxConcurrentTransforms": number, "MaxPayloadInMB": number, "TransformInput": { "CompressionType": "string", "ContentType": "string", "DataSource": { "S3DataSource": { "S3DataType": "string", "S3Uri": "string" } }, "SplitType": "string" }, "TransformOutput": { "Accept": "string", "AssembleWith": "string", "KmsKeyId": "string", "S3OutputPath": "string" }, "TransformResources": { "InstanceCount": number, "InstanceType": "string", "TransformAmiVersion": "string", "VolumeKmsKeyId": "string" } } } ], "ValidationRole": "string" } } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AdditionalInferenceSpecifications](#API_CreateModelPackage_RequestSyntax) ** An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts. Type: Array of [AdditionalInferenceSpecificationDefinition](API_AdditionalInferenceSpecificationDefinition.md) objects Array Members: Minimum number of 1 item. Maximum number of 15 items. Required: No ** [CertifyForMarketplace](#API_CreateModelPackage_RequestSyntax) ** 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. Type: Boolean Required: No ** [ClientToken](#API_CreateModelPackage_RequestSyntax) ** A unique token that guarantees that the call to this API is idempotent. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: `[a-zA-Z0-9-]+` Required: No ** [CustomerMetadataProperties](#API_CreateModelPackage_RequestSyntax) ** The metadata properties associated with the model package versions. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)${1,128}` Value Length Constraints: Minimum length of 1. Maximum length of 256. Value Pattern: `([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)${1,256}` Required: No ** [Domain](#API_CreateModelPackage_RequestSyntax) ** The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing. Type: String Required: No ** [DriftCheckBaselines](#API_CreateModelPackage_RequestSyntax) ** Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on [Drift Detection against Previous Baselines in SageMaker Pipelines](https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines-quality-clarify-baseline-lifecycle.html#pipelines-quality-clarify-baseline-drift-detection) in the *Amazon SageMaker Developer Guide*. Type: [DriftCheckBaselines](API_DriftCheckBaselines.md) object Required: No ** [InferenceSpecification](#API_CreateModelPackage_RequestSyntax) ** Specifies details about inference jobs that you can run with models based on this model package, including the following information: + 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. Type: [InferenceSpecification](API_InferenceSpecification.md) object Required: No ** [MetadataProperties](#API_CreateModelPackage_RequestSyntax) ** Metadata properties of the tracking entity, trial, or trial component. Type: [MetadataProperties](API_MetadataProperties.md) object Required: No ** [ModelApprovalStatus](#API_CreateModelPackage_RequestSyntax) ** 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. Type: String Valid Values: `Approved | Rejected | PendingManualApproval` Required: No ** [ModelCard](#API_CreateModelPackage_RequestSyntax) ** The model card associated with the model package. Since `ModelPackageModelCard` is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of `ModelCard`. The `ModelPackageModelCard` schema does not include `model_package_details`, and `model_overview` is composed of the `model_creator` and `model_artifact` properties. For more information about the model package model card schema, see [Model package model card schema](https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html#model-card-schema). For more information about the model card associated with the model package, see [View the Details of a Model Version](https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html). Type: [ModelPackageModelCard](API_ModelPackageModelCard.md) object Required: No ** [ModelLifeCycle](#API_CreateModelPackage_RequestSyntax) ** A structure describing the current state of the model in its life cycle. Type: [ModelLifeCycle](API_ModelLifeCycle.md) object Required: No ** [ModelMetrics](#API_CreateModelPackage_RequestSyntax) ** A structure that contains model metrics reports. Type: [ModelMetrics](API_ModelMetrics.md) object Required: No ** [ModelPackageDescription](#API_CreateModelPackage_RequestSyntax) ** A description of the model package. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*` Required: No ** [ModelPackageGroupName](#API_CreateModelPackage_RequestSyntax) ** The name or Amazon Resource Name (ARN) of the model package group that this model version belongs to. This parameter is required for versioned models, and does not apply to unversioned models. Type: String Length Constraints: Minimum length of 1. Maximum length of 170. 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 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: No ** [ModelPackageRegistrationType](#API_CreateModelPackage_RequestSyntax) ** The package registration type of the model package input. Type: String Valid Values: `Logged | Registered` Required: No ** [SamplePayloadUrl](#API_CreateModelPackage_RequestSyntax) ** The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). This archive can hold multiple files that are all equally used in the load test. Each file in the archive must satisfy the size constraints of the [InvokeEndpoint](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html#API_runtime_InvokeEndpoint_RequestSyntax) call. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `(https|s3)://([^/]+)/?(.*)` Required: No ** [SecurityConfig](#API_CreateModelPackage_RequestSyntax) ** The AWS KMS Key ID (`KMSKeyId`) used for encryption of model package information. Type: [ModelPackageSecurityConfig](API_ModelPackageSecurityConfig.md) object Required: No ** [SkipModelValidation](#API_CreateModelPackage_RequestSyntax) ** Indicates if you want to skip model validation. Type: String Valid Values: `All | None` Required: No ** [SourceAlgorithmSpecification](#API_CreateModelPackage_RequestSyntax) ** Details about the algorithm that was used to create the model package. Type: [SourceAlgorithmSpecification](API_SourceAlgorithmSpecification.md) object Required: No ** [SourceUri](#API_CreateModelPackage_RequestSyntax) ** The URI of the source for the model package. If you want to clone a model package, set it to the model package Amazon Resource Name (ARN). If you want to register a model, set it to the model ARN. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `[\p{L}\p{M}\p{Z}\p{N}\p{P}]{0,1024}` Required: No ** [Tags](#API_CreateModelPackage_RequestSyntax) ** A list of key value pairs associated with the model. For more information, see [Tagging AWS resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the * AWS General Reference Guide*. If you supply `ModelPackageGroupName`, your model package belongs to the model group you specify and uses the tags associated with the model group. In this case, you cannot supply a `tag` argument. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No ** [Task](#API_CreateModelPackage_RequestSyntax) ** The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification. The following tasks are supported by Inference Recommender: `"IMAGE_CLASSIFICATION"` \$1 `"OBJECT_DETECTION"` \$1 `"TEXT_GENERATION"` \$1`"IMAGE_SEGMENTATION"` \$1 `"FILL_MASK"` \$1 `"CLASSIFICATION"` \$1 `"REGRESSION"` \$1 `"OTHER"`. Specify "OTHER" if none of the tasks listed fit your use case. Type: String Required: No ** [ValidationSpecification](#API_CreateModelPackage_RequestSyntax) ** Specifies configurations for one or more transform jobs that SageMaker runs to test the model package. Type: [ModelPackageValidationSpecification](API_ModelPackageValidationSpecification.md) object Required: No ## Response Syntax ``` { "ModelPackageArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ModelPackageArn](#API_CreateModelPackage_ResponseSyntax) ** The Amazon Resource Name (ARN) of the new model package. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:model-package/[\S]{1,2048}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/CreateModelPackage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/CreateModelPackage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/CreateModelPackage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/CreateModelPackage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/CreateModelPackage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/CreateModelPackage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/CreateModelPackage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/CreateModelPackage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/CreateModelPackage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/CreateModelPackage) # CreateModelPackageGroup Creates a model group. A model group contains a group of model versions. ## Request Syntax ``` { "ModelPackageGroupDescription": "string", "ModelPackageGroupName": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ModelPackageGroupDescription](#API_CreateModelPackageGroup_RequestSyntax) ** A description for the model group. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*` Required: No ** [ModelPackageGroupName](#API_CreateModelPackageGroup_RequestSyntax) ** The name of the model group. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [Tags](#API_CreateModelPackageGroup_RequestSyntax) ** A list of key value pairs associated with the model group. For more information, see [Tagging AWS resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the * AWS General Reference Guide*. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No ## Response Syntax ``` { "ModelPackageGroupArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ModelPackageGroupArn](#API_CreateModelPackageGroup_ResponseSyntax) ** The Amazon Resource Name (ARN) of the model group. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:model-package-group/[\S]{1,2048}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/CreateModelPackageGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/CreateModelPackageGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/CreateModelPackageGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/CreateModelPackageGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/CreateModelPackageGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/CreateModelPackageGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/CreateModelPackageGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/CreateModelPackageGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/CreateModelPackageGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/CreateModelPackageGroup) # CreateModelQualityJobDefinition Creates a definition for a job that monitors model quality and drift. For information about model monitor, see [Amazon SageMaker AI Model Monitor](https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor.html). ## Request Syntax ``` { "JobDefinitionName": "string", "JobResources": { "ClusterConfig": { "InstanceCount": number, "InstanceType": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number } }, "ModelQualityAppSpecification": { "ContainerArguments": [ "string" ], "ContainerEntrypoint": [ "string" ], "Environment": { "string" : "string" }, "ImageUri": "string", "PostAnalyticsProcessorSourceUri": "string", "ProblemType": "string", "RecordPreprocessorSourceUri": "string" }, "ModelQualityBaselineConfig": { "BaseliningJobName": "string", "ConstraintsResource": { "S3Uri": "string" } }, "ModelQualityJobInput": { "BatchTransformInput": { "DataCapturedDestinationS3Uri": "string", "DatasetFormat": { "Csv": { "Header": boolean }, "Json": { "Line": boolean }, "Parquet": { } }, "EndTimeOffset": "string", "ExcludeFeaturesAttribute": "string", "FeaturesAttribute": "string", "InferenceAttribute": "string", "LocalPath": "string", "ProbabilityAttribute": "string", "ProbabilityThresholdAttribute": number, "S3DataDistributionType": "string", "S3InputMode": "string", "StartTimeOffset": "string" }, "EndpointInput": { "EndpointName": "string", "EndTimeOffset": "string", "ExcludeFeaturesAttribute": "string", "FeaturesAttribute": "string", "InferenceAttribute": "string", "LocalPath": "string", "ProbabilityAttribute": "string", "ProbabilityThresholdAttribute": number, "S3DataDistributionType": "string", "S3InputMode": "string", "StartTimeOffset": "string" }, "GroundTruthS3Input": { "S3Uri": "string" } }, "ModelQualityJobOutputConfig": { "KmsKeyId": "string", "MonitoringOutputs": [ { "S3Output": { "LocalPath": "string", "S3UploadMode": "string", "S3Uri": "string" } } ] }, "NetworkConfig": { "EnableInterContainerTrafficEncryption": boolean, "EnableNetworkIsolation": boolean, "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } }, "RoleArn": "string", "StoppingCondition": { "MaxRuntimeInSeconds": number }, "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [JobDefinitionName](#API_CreateModelQualityJobDefinition_RequestSyntax) ** The name of the monitoring job definition. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [JobResources](#API_CreateModelQualityJobDefinition_RequestSyntax) ** Identifies the resources to deploy for a monitoring job. Type: [MonitoringResources](API_MonitoringResources.md) object Required: Yes ** [ModelQualityAppSpecification](#API_CreateModelQualityJobDefinition_RequestSyntax) ** The container that runs the monitoring job. Type: [ModelQualityAppSpecification](API_ModelQualityAppSpecification.md) object Required: Yes ** [ModelQualityBaselineConfig](#API_CreateModelQualityJobDefinition_RequestSyntax) ** Specifies the constraints and baselines for the monitoring job. Type: [ModelQualityBaselineConfig](API_ModelQualityBaselineConfig.md) object Required: No ** [ModelQualityJobInput](#API_CreateModelQualityJobDefinition_RequestSyntax) ** A list of the inputs that are monitored. Currently endpoints are supported. Type: [ModelQualityJobInput](API_ModelQualityJobInput.md) object Required: Yes ** [ModelQualityJobOutputConfig](#API_CreateModelQualityJobDefinition_RequestSyntax) ** The output configuration for monitoring jobs. Type: [MonitoringOutputConfig](API_MonitoringOutputConfig.md) object Required: Yes ** [NetworkConfig](#API_CreateModelQualityJobDefinition_RequestSyntax) ** Specifies the network configuration for the monitoring job. Type: [MonitoringNetworkConfig](API_MonitoringNetworkConfig.md) object Required: No ** [RoleArn](#API_CreateModelQualityJobDefinition_RequestSyntax) ** The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` Required: Yes ** [StoppingCondition](#API_CreateModelQualityJobDefinition_RequestSyntax) ** A time limit for how long the monitoring job is allowed to run before stopping. Type: [MonitoringStoppingCondition](API_MonitoringStoppingCondition.md) object Required: No ** [Tags](#API_CreateModelQualityJobDefinition_RequestSyntax) ** (Optional) An array of key-value pairs. For more information, see [ Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL) in the * AWS Billing and Cost Management User Guide*. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No ## Response Syntax ``` { "JobDefinitionArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [JobDefinitionArn](#API_CreateModelQualityJobDefinition_ResponseSyntax) ** The Amazon Resource Name (ARN) of the model quality monitoring job. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/CreateModelQualityJobDefinition) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/CreateModelQualityJobDefinition) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/CreateModelQualityJobDefinition) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/CreateModelQualityJobDefinition) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/CreateModelQualityJobDefinition) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/CreateModelQualityJobDefinition) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/CreateModelQualityJobDefinition) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/CreateModelQualityJobDefinition) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/CreateModelQualityJobDefinition) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/CreateModelQualityJobDefinition) # CreateMonitoringSchedule Creates a schedule that regularly starts Amazon SageMaker AI Processing Jobs to monitor the data captured for an Amazon SageMaker AI Endpoint. ## Request Syntax ``` { "MonitoringScheduleConfig": { "MonitoringJobDefinition": { "BaselineConfig": { "BaseliningJobName": "string", "ConstraintsResource": { "S3Uri": "string" }, "StatisticsResource": { "S3Uri": "string" } }, "Environment": { "string" : "string" }, "MonitoringAppSpecification": { "ContainerArguments": [ "string" ], "ContainerEntrypoint": [ "string" ], "ImageUri": "string", "PostAnalyticsProcessorSourceUri": "string", "RecordPreprocessorSourceUri": "string" }, "MonitoringInputs": [ { "BatchTransformInput": { "DataCapturedDestinationS3Uri": "string", "DatasetFormat": { "Csv": { "Header": boolean }, "Json": { "Line": boolean }, "Parquet": { } }, "EndTimeOffset": "string", "ExcludeFeaturesAttribute": "string", "FeaturesAttribute": "string", "InferenceAttribute": "string", "LocalPath": "string", "ProbabilityAttribute": "string", "ProbabilityThresholdAttribute": number, "S3DataDistributionType": "string", "S3InputMode": "string", "StartTimeOffset": "string" }, "EndpointInput": { "EndpointName": "string", "EndTimeOffset": "string", "ExcludeFeaturesAttribute": "string", "FeaturesAttribute": "string", "InferenceAttribute": "string", "LocalPath": "string", "ProbabilityAttribute": "string", "ProbabilityThresholdAttribute": number, "S3DataDistributionType": "string", "S3InputMode": "string", "StartTimeOffset": "string" } } ], "MonitoringOutputConfig": { "KmsKeyId": "string", "MonitoringOutputs": [ { "S3Output": { "LocalPath": "string", "S3UploadMode": "string", "S3Uri": "string" } } ] }, "MonitoringResources": { "ClusterConfig": { "InstanceCount": number, "InstanceType": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number } }, "NetworkConfig": { "EnableInterContainerTrafficEncryption": boolean, "EnableNetworkIsolation": boolean, "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } }, "RoleArn": "string", "StoppingCondition": { "MaxRuntimeInSeconds": number } }, "MonitoringJobDefinitionName": "string", "MonitoringType": "string", "ScheduleConfig": { "DataAnalysisEndTime": "string", "DataAnalysisStartTime": "string", "ScheduleExpression": "string" } }, "MonitoringScheduleName": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [MonitoringScheduleConfig](#API_CreateMonitoringSchedule_RequestSyntax) ** The configuration object that specifies the monitoring schedule and defines the monitoring job. Type: [MonitoringScheduleConfig](API_MonitoringScheduleConfig.md) object Required: Yes ** [MonitoringScheduleName](#API_CreateMonitoringSchedule_RequestSyntax) ** The name of the monitoring schedule. The name must be unique within an AWS Region within an AWS account. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [Tags](#API_CreateMonitoringSchedule_RequestSyntax) ** (Optional) An array of key-value pairs. For more information, see [Using Cost Allocation Tags]( https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL) in the * AWS Billing and Cost Management User Guide*. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No ## Response Syntax ``` { "MonitoringScheduleArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [MonitoringScheduleArn](#API_CreateMonitoringSchedule_ResponseSyntax) ** The Amazon Resource Name (ARN) of the monitoring schedule. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/CreateMonitoringSchedule) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/CreateMonitoringSchedule) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/CreateMonitoringSchedule) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/CreateMonitoringSchedule) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/CreateMonitoringSchedule) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/CreateMonitoringSchedule) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/CreateMonitoringSchedule) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/CreateMonitoringSchedule) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/CreateMonitoringSchedule) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/CreateMonitoringSchedule) # CreateNotebookInstance Creates an SageMaker AI notebook instance. A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook. In a `CreateNotebookInstance` request, specify the type of ML compute instance that you want to run. SageMaker AI launches the instance, installs common libraries that you can use to explore datasets for model training, and attaches an ML storage volume to the notebook instance. SageMaker AI also provides a set of example notebooks. Each notebook demonstrates how to use SageMaker AI with a specific algorithm or with a machine learning framework. After receiving the request, SageMaker AI does the following: 1. Creates a network interface in the SageMaker AI VPC. 1. (Option) If you specified `SubnetId`, SageMaker AI creates a network interface in your own VPC, which is inferred from the subnet ID that you provide in the input. When creating this network interface, SageMaker AI attaches the security group that you specified in the request to the network interface that it creates in your VPC. 1. Launches an EC2 instance of the type specified in the request in the SageMaker AI VPC. If you specified `SubnetId` of your VPC, SageMaker AI specifies both network interfaces when launching this instance. This enables inbound traffic from your own VPC to the notebook instance, assuming that the security groups allow it. After creating the notebook instance, SageMaker AI returns its Amazon Resource Name (ARN). You can't change the name of a notebook instance after you create it. After SageMaker AI creates the notebook instance, you can connect to the Jupyter server and work in Jupyter notebooks. For example, you can write code to explore a dataset that you can use for model training, train a model, host models by creating SageMaker AI endpoints, and validate hosted models. For more information, see [How It Works](https://docs.aws.amazon.com/sagemaker/latest/dg/how-it-works.html). ## Request Syntax ``` { "AcceleratorTypes": [ "string" ], "AdditionalCodeRepositories": [ "string" ], "DefaultCodeRepository": "string", "DirectInternetAccess": "string", "InstanceMetadataServiceConfiguration": { "MinimumInstanceMetadataServiceVersion": "string" }, "InstanceType": "string", "IpAddressType": "string", "KmsKeyId": "string", "LifecycleConfigName": "string", "NotebookInstanceName": "string", "PlatformIdentifier": "string", "RoleArn": "string", "RootAccess": "string", "SecurityGroupIds": [ "string" ], "SubnetId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeSizeInGB": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AcceleratorTypes](#API_CreateNotebookInstance_RequestSyntax) ** This parameter is no longer supported. Elastic Inference (EI) is no longer available. This parameter was used to specify a list of EI instance types to associate with this notebook instance. Type: Array of strings Valid Values: `ml.eia1.medium | ml.eia1.large | ml.eia1.xlarge | ml.eia2.medium | ml.eia2.large | ml.eia2.xlarge` Required: No ** [AdditionalCodeRepositories](#API_CreateNotebookInstance_RequestSyntax) ** 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](https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) 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 SageMaker AI Notebook Instances](https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 3 items. Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `https://([^/]+)/?(.*)$|^[a-zA-Z0-9](-*[a-zA-Z0-9])*` Required: No ** [DefaultCodeRepository](#API_CreateNotebookInstance_RequestSyntax) ** 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](https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) 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 SageMaker AI Notebook Instances](https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `https://([^/]+)/?(.*)$|^[a-zA-Z0-9](-*[a-zA-Z0-9])*` Required: No ** [DirectInternetAccess](#API_CreateNotebookInstance_RequestSyntax) ** Sets whether SageMaker AI provides internet access to the notebook instance. If you set this to `Disabled` this notebook instance is able to access resources only in your VPC, and is not be able to connect to SageMaker AI training and endpoint services unless you configure a NAT Gateway in your VPC. For more information, see [Notebook Instances Are Internet-Enabled by Default](https://docs.aws.amazon.com/sagemaker/latest/dg/appendix-additional-considerations.html#appendix-notebook-and-internet-access). You can set the value of this parameter to `Disabled` only if you set a value for the `SubnetId` parameter. Type: String Valid Values: `Enabled | Disabled` Required: No ** [InstanceMetadataServiceConfiguration](#API_CreateNotebookInstance_RequestSyntax) ** Information on the IMDS configuration of the notebook instance Type: [InstanceMetadataServiceConfiguration](API_InstanceMetadataServiceConfiguration.md) object Required: No ** [InstanceType](#API_CreateNotebookInstance_RequestSyntax) ** The type of ML compute instance to launch for the notebook instance. Type: String Valid Values: `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.m5d.large | ml.m5d.xlarge | ml.m5d.2xlarge | ml.m5d.4xlarge | ml.m5d.8xlarge | ml.m5d.12xlarge | ml.m5d.16xlarge | ml.m5d.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 | ml.p3dn.24xlarge | 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.8xlarge | ml.r5.12xlarge | ml.r5.16xlarge | ml.r5.24xlarge | ml.g5.xlarge | ml.g5.2xlarge | ml.g5.4xlarge | ml.g5.8xlarge | ml.g5.16xlarge | ml.g5.12xlarge | ml.g5.24xlarge | ml.g5.48xlarge | ml.inf1.xlarge | ml.inf1.2xlarge | ml.inf1.6xlarge | ml.inf1.24xlarge | ml.trn1.2xlarge | ml.trn1.32xlarge | ml.trn1n.32xlarge | ml.inf2.xlarge | ml.inf2.8xlarge | ml.inf2.24xlarge | ml.inf2.48xlarge | ml.p4d.24xlarge | ml.p4de.24xlarge | ml.p5.48xlarge | ml.p6-b200.48xlarge | ml.m6i.large | ml.m6i.xlarge | ml.m6i.2xlarge | ml.m6i.4xlarge | ml.m6i.8xlarge | ml.m6i.12xlarge | ml.m6i.16xlarge | ml.m6i.24xlarge | ml.m6i.32xlarge | ml.m7i.large | ml.m7i.xlarge | ml.m7i.2xlarge | ml.m7i.4xlarge | ml.m7i.8xlarge | ml.m7i.12xlarge | ml.m7i.16xlarge | ml.m7i.24xlarge | ml.m7i.48xlarge | ml.c6i.large | ml.c6i.xlarge | ml.c6i.2xlarge | ml.c6i.4xlarge | ml.c6i.8xlarge | ml.c6i.12xlarge | ml.c6i.16xlarge | ml.c6i.24xlarge | ml.c6i.32xlarge | ml.c7i.large | ml.c7i.xlarge | ml.c7i.2xlarge | ml.c7i.4xlarge | ml.c7i.8xlarge | ml.c7i.12xlarge | ml.c7i.16xlarge | ml.c7i.24xlarge | ml.c7i.48xlarge | ml.r6i.large | ml.r6i.xlarge | ml.r6i.2xlarge | ml.r6i.4xlarge | ml.r6i.8xlarge | ml.r6i.12xlarge | ml.r6i.16xlarge | ml.r6i.24xlarge | ml.r6i.32xlarge | ml.r7i.large | ml.r7i.xlarge | ml.r7i.2xlarge | ml.r7i.4xlarge | ml.r7i.8xlarge | ml.r7i.12xlarge | ml.r7i.16xlarge | ml.r7i.24xlarge | ml.r7i.48xlarge | ml.m6id.large | ml.m6id.xlarge | ml.m6id.2xlarge | ml.m6id.4xlarge | ml.m6id.8xlarge | ml.m6id.12xlarge | ml.m6id.16xlarge | ml.m6id.24xlarge | ml.m6id.32xlarge | ml.c6id.large | ml.c6id.xlarge | ml.c6id.2xlarge | ml.c6id.4xlarge | ml.c6id.8xlarge | ml.c6id.12xlarge | ml.c6id.16xlarge | ml.c6id.24xlarge | ml.c6id.32xlarge | ml.r6id.large | ml.r6id.xlarge | ml.r6id.2xlarge | ml.r6id.4xlarge | ml.r6id.8xlarge | ml.r6id.12xlarge | ml.r6id.16xlarge | ml.r6id.24xlarge | ml.r6id.32xlarge | ml.g6.xlarge | ml.g6.2xlarge | ml.g6.4xlarge | ml.g6.8xlarge | ml.g6.12xlarge | ml.g6.16xlarge | ml.g6.24xlarge | ml.g6.48xlarge` Required: Yes ** [IpAddressType](#API_CreateNotebookInstance_RequestSyntax) ** The IP address type for the notebook instance. Specify `ipv4` for IPv4-only connectivity or `dualstack` for both IPv4 and IPv6 connectivity. When you specify `dualstack`, the subnet must support IPv6 CIDR blocks. If not specified, defaults to `ipv4`. Type: String Valid Values: `ipv4 | dualstack` Required: No ** [KmsKeyId](#API_CreateNotebookInstance_RequestSyntax) ** The Amazon Resource Name (ARN) of a AWS Key Management Service key that SageMaker AI 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](https://docs.aws.amazon.com/kms/latest/developerguide/enabling-keys.html) in the * AWS Key Management Service Developer Guide*. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `[a-zA-Z0-9:/_-]*` Required: No ** [LifecycleConfigName](#API_CreateNotebookInstance_RequestSyntax) ** 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](https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html). Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9])*` Required: No ** [NotebookInstanceName](#API_CreateNotebookInstance_RequestSyntax) ** The name of the new notebook instance. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9])*` Required: Yes ** [PlatformIdentifier](#API_CreateNotebookInstance_RequestSyntax) ** The platform identifier of the notebook instance runtime environment. The default value is `notebook-al2-v2`. Type: String Length Constraints: Minimum length of 0. Maximum length of 20. Pattern: `(notebook-al1-v1|notebook-al2-v1|notebook-al2-v2|notebook-al2-v3|notebook-al2023-v1)` Required: No ** [RoleArn](#API_CreateNotebookInstance_RequestSyntax) ** When you send any requests to AWS resources from the notebook instance, SageMaker AI assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so SageMaker AI can perform these tasks. The policy must allow the SageMaker AI service principal (sagemaker.amazonaws.com) permissions to assume this role. For more information, see [SageMaker AI Roles](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html). To be able to pass this role to SageMaker AI, the caller of this API must have the `iam:PassRole` permission. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` Required: Yes ** [RootAccess](#API_CreateNotebookInstance_RequestSyntax) ** 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. Type: String Valid Values: `Enabled | Disabled` Required: No ** [SecurityGroupIds](#API_CreateNotebookInstance_RequestSyntax) ** The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 5 items. Length Constraints: Minimum length of 0. Maximum length of 32. Pattern: `[-0-9a-zA-Z]+` Required: No ** [SubnetId](#API_CreateNotebookInstance_RequestSyntax) ** The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance. Type: String Length Constraints: Minimum length of 0. Maximum length of 32. Pattern: `[-0-9a-zA-Z]+` Required: No ** [Tags](#API_CreateNotebookInstance_RequestSyntax) ** 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](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No ** [VolumeSizeInGB](#API_CreateNotebookInstance_RequestSyntax) ** The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. Type: Integer Valid Range: Minimum value of 5. Maximum value of 16384. Required: No ## Response Syntax ``` { "NotebookInstanceArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NotebookInstanceArn](#API_CreateNotebookInstance_ResponseSyntax) ** The Amazon Resource Name (ARN) of the notebook instance. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/CreateNotebookInstance) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/CreateNotebookInstance) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/CreateNotebookInstance) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/CreateNotebookInstance) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/CreateNotebookInstance) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/CreateNotebookInstance) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/CreateNotebookInstance) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/CreateNotebookInstance) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/CreateNotebookInstance) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/CreateNotebookInstance) # CreateNotebookInstanceLifecycleConfig Creates a lifecycle configuration that you can associate with a notebook instance. A *lifecycle configuration* is a collection of shell scripts that run when you create or start a notebook instance. Each lifecycle configuration script has a limit of 16384 characters. The value of the `$PATH` environment variable that is available to both scripts is `/sbin:bin:/usr/sbin:/usr/bin`. View Amazon CloudWatch Logs for notebook instance lifecycle configurations in log group `/aws/sagemaker/NotebookInstances` in log stream `[notebook-instance-name]/[LifecycleConfigHook]`. Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started. For information about notebook instance lifestyle configurations, see [Step 2.1: (Optional) Customize a Notebook Instance](https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html). **Note** Lifecycle configuration scripts execute with root access and the notebook instance's IAM execution role privileges. Grant this permission only to trusted principals. See [Customize a Notebook Instance Using a Lifecycle Configuration Script](https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html) for security best practices. ## Request Syntax ``` { "NotebookInstanceLifecycleConfigName": "string", "OnCreate": [ { "Content": "string" } ], "OnStart": [ { "Content": "string" } ], "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [NotebookInstanceLifecycleConfigName](#API_CreateNotebookInstanceLifecycleConfig_RequestSyntax) ** The name of the lifecycle configuration. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9])*` Required: Yes ** [OnCreate](#API_CreateNotebookInstanceLifecycleConfig_RequestSyntax) ** A shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string. Type: Array of [NotebookInstanceLifecycleHook](API_NotebookInstanceLifecycleHook.md) objects Array Members: Minimum number of 0 items. Maximum number of 1 item. Required: No ** [OnStart](#API_CreateNotebookInstanceLifecycleConfig_RequestSyntax) ** 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. Type: Array of [NotebookInstanceLifecycleHook](API_NotebookInstanceLifecycleHook.md) objects Array Members: Minimum number of 0 items. Maximum number of 1 item. Required: No ** [Tags](#API_CreateNotebookInstanceLifecycleConfig_RequestSyntax) ** 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](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html). Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No ## Response Syntax ``` { "NotebookInstanceLifecycleConfigArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NotebookInstanceLifecycleConfigArn](#API_CreateNotebookInstanceLifecycleConfig_ResponseSyntax) ** The Amazon Resource Name (ARN) of the lifecycle configuration. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/CreateNotebookInstanceLifecycleConfig) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/CreateNotebookInstanceLifecycleConfig) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/CreateNotebookInstanceLifecycleConfig) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/CreateNotebookInstanceLifecycleConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/CreateNotebookInstanceLifecycleConfig) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/CreateNotebookInstanceLifecycleConfig) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/CreateNotebookInstanceLifecycleConfig) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/CreateNotebookInstanceLifecycleConfig) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/CreateNotebookInstanceLifecycleConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/CreateNotebookInstanceLifecycleConfig) # CreateOptimizationJob Creates a job that optimizes a model for inference performance. To create the job, you provide the location of a source model, and you provide the settings for the optimization techniques that you want the job to apply. When the job completes successfully, SageMaker uploads the new optimized model to the output destination that you specify. For more information about how to use this action, and about the supported optimization techniques, see [Optimize model inference with Amazon SageMaker](https://docs.aws.amazon.com/sagemaker/latest/dg/model-optimize.html). ## Request Syntax ``` { "DeploymentInstanceType": "string", "MaxInstanceCount": number, "ModelSource": { "S3": { "ModelAccessConfig": { "AcceptEula": boolean }, "S3Uri": "string" }, "SageMakerModel": { "ModelName": "string" } }, "OptimizationConfigs": [ { ... } ], "OptimizationEnvironment": { "string" : "string" }, "OptimizationJobName": "string", "OutputConfig": { "KmsKeyId": "string", "S3OutputLocation": "string", "SageMakerModel": { "ModelName": "string" } }, "RoleArn": "string", "StoppingCondition": { "MaxPendingTimeInSeconds": number, "MaxRuntimeInSeconds": number, "MaxWaitTimeInSeconds": number }, "Tags": [ { "Key": "string", "Value": "string" } ], "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DeploymentInstanceType](#API_CreateOptimizationJob_RequestSyntax) ** The type of instance that hosts the optimized model that you create with the optimization job. Type: String Valid Values: `ml.p4d.24xlarge | ml.p4de.24xlarge | ml.p5.48xlarge | ml.p5e.48xlarge | ml.p5en.48xlarge | ml.g5.xlarge | ml.g5.2xlarge | ml.g5.4xlarge | ml.g5.8xlarge | ml.g5.12xlarge | ml.g5.16xlarge | ml.g5.24xlarge | ml.g5.48xlarge | ml.g6.xlarge | ml.g6.2xlarge | ml.g6.4xlarge | ml.g6.8xlarge | ml.g6.12xlarge | ml.g6.16xlarge | ml.g6.24xlarge | ml.g6.48xlarge | ml.g6e.xlarge | ml.g6e.2xlarge | ml.g6e.4xlarge | ml.g6e.8xlarge | ml.g6e.12xlarge | ml.g6e.16xlarge | ml.g6e.24xlarge | ml.g6e.48xlarge | ml.inf2.xlarge | ml.inf2.8xlarge | ml.inf2.24xlarge | ml.inf2.48xlarge | ml.trn1.2xlarge | ml.trn1.32xlarge | ml.trn1n.32xlarge` Required: Yes ** [MaxInstanceCount](#API_CreateOptimizationJob_RequestSyntax) ** The maximum number of instances to use for the optimization job. Type: Integer Valid Range: Minimum value of 1. Required: No ** [ModelSource](#API_CreateOptimizationJob_RequestSyntax) ** The location of the source model to optimize with an optimization job. Type: [OptimizationJobModelSource](API_OptimizationJobModelSource.md) object Required: Yes ** [OptimizationConfigs](#API_CreateOptimizationJob_RequestSyntax) ** Settings for each of the optimization techniques that the job applies. Type: Array of [OptimizationConfig](API_OptimizationConfig.md) objects Array Members: Minimum number of 0 items. Maximum number of 10 items. Required: Yes ** [OptimizationEnvironment](#API_CreateOptimizationJob_RequestSyntax) ** The environment variables to set in the model container. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 25 items. Key Length Constraints: Minimum length of 0. Maximum length of 256. Key Pattern: `(?!\s*$).+` Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No ** [OptimizationJobName](#API_CreateOptimizationJob_RequestSyntax) ** A custom name for the new optimization job. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [OutputConfig](#API_CreateOptimizationJob_RequestSyntax) ** Details for where to store the optimized model that you create with the optimization job. Type: [OptimizationJobOutputConfig](API_OptimizationJobOutputConfig.md) object Required: Yes ** [RoleArn](#API_CreateOptimizationJob_RequestSyntax) ** The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf. During model optimization, Amazon SageMaker AI 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 AI, the caller of this API must have the `iam:PassRole` permission. For more information, see [Amazon SageMaker AI Roles.](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html) Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` Required: Yes ** [StoppingCondition](#API_CreateOptimizationJob_RequestSyntax) ** Specifies a limit to how long a job can run. When the job reaches the time limit, SageMaker ends the job. Use this API to cap costs. To stop a training job, 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 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. Type: [StoppingCondition](API_StoppingCondition.md) object Required: Yes ** [Tags](#API_CreateOptimizationJob_RequestSyntax) ** A list of key-value pairs associated with the optimization job. For more information, see [Tagging AWS resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the * AWS General Reference Guide*. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No ** [VpcConfig](#API_CreateOptimizationJob_RequestSyntax) ** A VPC in Amazon VPC that your optimized model has access to. Type: [OptimizationVpcConfig](API_OptimizationVpcConfig.md) object Required: No ## Response Syntax ``` { "OptimizationJobArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [OptimizationJobArn](#API_CreateOptimizationJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the optimization job. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:optimization-job/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/CreateOptimizationJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/CreateOptimizationJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/CreateOptimizationJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/CreateOptimizationJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/CreateOptimizationJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/CreateOptimizationJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/CreateOptimizationJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/CreateOptimizationJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/CreateOptimizationJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/CreateOptimizationJob) # CreatePartnerApp Creates an Amazon SageMaker Partner AI App. ## Request Syntax ``` { "ApplicationConfig": { "AdminUsers": [ "string" ], "Arguments": { "string" : "string" }, "AssignedGroupPatterns": [ "string" ], "RoleGroupAssignments": [ { "GroupPatterns": [ "string" ], "RoleName": "string" } ] }, "AuthType": "string", "ClientToken": "string", "EnableAutoMinorVersionUpgrade": boolean, "EnableIamSessionBasedIdentity": boolean, "ExecutionRoleArn": "string", "KmsKeyId": "string", "MaintenanceConfig": { "MaintenanceWindowStart": "string" }, "Name": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "Tier": "string", "Type": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ApplicationConfig](#API_CreatePartnerApp_RequestSyntax) ** Configuration settings for the SageMaker Partner AI App. Type: [PartnerAppConfig](API_PartnerAppConfig.md) object Required: No ** [AuthType](#API_CreatePartnerApp_RequestSyntax) ** The authorization type that users use to access the SageMaker Partner AI App. Type: String Valid Values: `IAM` Required: Yes ** [ClientToken](#API_CreatePartnerApp_RequestSyntax) ** A unique token that guarantees that the call to this API is idempotent. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: `[a-zA-Z0-9-]+` Required: No ** [EnableAutoMinorVersionUpgrade](#API_CreatePartnerApp_RequestSyntax) ** When set to `TRUE`, the SageMaker Partner AI App is automatically upgraded to the latest minor version during the next scheduled maintenance window, if one is available. Default is `FALSE`. Type: Boolean Required: No ** [EnableIamSessionBasedIdentity](#API_CreatePartnerApp_RequestSyntax) ** When set to `TRUE`, the SageMaker Partner AI App sets the AWS IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user. Type: Boolean Required: No ** [ExecutionRoleArn](#API_CreatePartnerApp_RequestSyntax) ** The ARN of the IAM role that the partner application uses. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` Required: Yes ** [KmsKeyId](#API_CreatePartnerApp_RequestSyntax) ** SageMaker Partner AI Apps uses AWS KMS to encrypt data at rest using an AWS managed key by default. For more control, specify a customer managed key. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `[a-zA-Z0-9:/_-]*` Required: No ** [MaintenanceConfig](#API_CreatePartnerApp_RequestSyntax) ** Maintenance configuration settings for the SageMaker Partner AI App. Type: [PartnerAppMaintenanceConfig](API_PartnerAppMaintenanceConfig.md) object Required: No ** [Name](#API_CreatePartnerApp_RequestSyntax) ** The name to give the SageMaker Partner AI App. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9]+` Required: Yes ** [Tags](#API_CreatePartnerApp_RequestSyntax) ** Each tag consists of a key and an optional value. Tag keys must be unique per resource. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No ** [Tier](#API_CreatePartnerApp_RequestSyntax) ** Indicates the instance type and size of the cluster attached to the SageMaker Partner AI App. Type: String Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: `(?!\s*$).+` Required: Yes ** [Type](#API_CreatePartnerApp_RequestSyntax) ** The type of SageMaker Partner AI App to create. Must be one of the following: `lakera-guard`, `comet`, `deepchecks-llm-evaluation`, or `fiddler`. Type: String Valid Values: `lakera-guard | comet | deepchecks-llm-evaluation | fiddler` Required: Yes ## Response Syntax ``` { "Arn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Arn](#API_CreatePartnerApp_ResponseSyntax) ** The ARN of the SageMaker Partner AI App. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:partner-app\/app-[A-Z0-9]{12}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/CreatePartnerApp) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/CreatePartnerApp) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/CreatePartnerApp) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/CreatePartnerApp) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/CreatePartnerApp) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/CreatePartnerApp) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/CreatePartnerApp) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/CreatePartnerApp) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/CreatePartnerApp) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/CreatePartnerApp) # CreatePartnerAppPresignedUrl Creates a presigned URL to access an Amazon SageMaker Partner AI App. ## Request Syntax ``` { "Arn": "string", "ExpiresInSeconds": number, "SessionExpirationDurationInSeconds": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Arn](#API_CreatePartnerAppPresignedUrl_RequestSyntax) ** The ARN of the SageMaker Partner AI App to create the presigned URL for. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:partner-app\/app-[A-Z0-9]{12}` Required: Yes ** [ExpiresInSeconds](#API_CreatePartnerAppPresignedUrl_RequestSyntax) ** The time that will pass before the presigned URL expires. Type: Integer Valid Range: Minimum value of 5. Maximum value of 300. Required: No ** [SessionExpirationDurationInSeconds](#API_CreatePartnerAppPresignedUrl_RequestSyntax) ** Indicates how long the Amazon SageMaker Partner AI App session can be accessed for after logging in. Type: Integer Valid Range: Minimum value of 1800. Maximum value of 43200. Required: No ## Response Syntax ``` { "Url": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Url](#API_CreatePartnerAppPresignedUrl_ResponseSyntax) ** The presigned URL that you can use to access the SageMaker Partner AI App. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/CreatePartnerAppPresignedUrl) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/CreatePartnerAppPresignedUrl) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/CreatePartnerAppPresignedUrl) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/CreatePartnerAppPresignedUrl) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/CreatePartnerAppPresignedUrl) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/CreatePartnerAppPresignedUrl) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/CreatePartnerAppPresignedUrl) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/CreatePartnerAppPresignedUrl) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/CreatePartnerAppPresignedUrl) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/CreatePartnerAppPresignedUrl) # CreatePipeline Creates a pipeline using a JSON pipeline definition. ## Request Syntax ``` { "ClientRequestToken": "string", "ParallelismConfiguration": { "MaxParallelExecutionSteps": number }, "PipelineDefinition": "string", "PipelineDefinitionS3Location": { "Bucket": "string", "ObjectKey": "string", "VersionId": "string" }, "PipelineDescription": "string", "PipelineDisplayName": "string", "PipelineName": "string", "RoleArn": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClientRequestToken](#API_CreatePipeline_RequestSyntax) ** A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time. Type: String Length Constraints: Minimum length of 32. Maximum length of 128. Required: Yes ** [ParallelismConfiguration](#API_CreatePipeline_RequestSyntax) ** This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default. Type: [ParallelismConfiguration](API_ParallelismConfiguration.md) object Required: No ** [PipelineDefinition](#API_CreatePipeline_RequestSyntax) ** The [JSON pipeline definition](https://aws-sagemaker-mlops.github.io/sagemaker-model-building-pipeline-definition-JSON-schema/) of the pipeline. Type: String Length Constraints: Minimum length of 1. Maximum length of 1048576. Pattern: `.*(?:[ \r\n\t].*)*` Required: No ** [PipelineDefinitionS3Location](#API_CreatePipeline_RequestSyntax) ** The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location. Type: [PipelineDefinitionS3Location](API_PipelineDefinitionS3Location.md) object Required: No ** [PipelineDescription](#API_CreatePipeline_RequestSyntax) ** A description of the pipeline. Type: String Length Constraints: Minimum length of 0. Maximum length of 3072. Pattern: `.*` Required: No ** [PipelineDisplayName](#API_CreatePipeline_RequestSyntax) ** The display name of the pipeline. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}` Required: No ** [PipelineName](#API_CreatePipeline_RequestSyntax) ** The name of the pipeline. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}` Required: Yes ** [RoleArn](#API_CreatePipeline_RequestSyntax) ** The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` Required: Yes ** [Tags](#API_CreatePipeline_RequestSyntax) ** A list of tags to apply to the created pipeline. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No ## Response Syntax ``` { "PipelineArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [PipelineArn](#API_CreatePipeline_ResponseSyntax) ** The Amazon Resource Name (ARN) of the created pipeline. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:pipeline/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/CreatePipeline) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/CreatePipeline) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/CreatePipeline) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/CreatePipeline) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/CreatePipeline) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/CreatePipeline) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/CreatePipeline) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/CreatePipeline) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/CreatePipeline) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/CreatePipeline) # CreatePresignedDomainUrl Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the user will be automatically signed in to the domain, and granted access to all of the Apps and files associated with the Domain's Amazon Elastic File System volume. This operation can only be called when the authentication mode equals IAM. The IAM role or user passed to this API defines the permissions to access the app. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the app. You can restrict access to this API and to the URL that it returns to a list of IP addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more information, see [Connect to Amazon SageMaker AI Studio Through an Interface VPC Endpoint](https://docs.aws.amazon.com/sagemaker/latest/dg/studio-interface-endpoint.html) . **Note** 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. The JupyterLab session default expiration time is 12 hours. You can configure this value using SessionExpirationDurationInSeconds. ## Request Syntax ``` { "DomainId": "string", "ExpiresInSeconds": number, "LandingUri": "string", "SessionExpirationDurationInSeconds": number, "SpaceName": "string", "UserProfileName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DomainId](#API_CreatePresignedDomainUrl_RequestSyntax) ** The domain ID. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `d-(-*[a-z0-9]){1,61}` Required: Yes ** [ExpiresInSeconds](#API_CreatePresignedDomainUrl_RequestSyntax) ** The number of seconds until the pre-signed URL expires. This value defaults to 300. Type: Integer Valid Range: Minimum value of 5. Maximum value of 300. Required: No ** [LandingUri](#API_CreatePresignedDomainUrl_RequestSyntax) ** The landing page that the user is directed to when accessing the presigned URL. Using this value, users can access Studio or Studio Classic, even if it is not the default experience for the domain. The supported values are: + `studio::relative/path`: Directs users to the relative path in Studio. + `app:JupyterServer:relative/path`: Directs users to the relative path in the Studio Classic application. + `app:JupyterLab:relative/path`: Directs users to the relative path in the JupyterLab application. + `app:RStudioServerPro:relative/path`: Directs users to the relative path in the RStudio application. + `app:CodeEditor:relative/path`: Directs users to the relative path in the Code Editor, based on Code-OSS, Visual Studio Code - Open Source application. + `app:Canvas:relative/path`: Directs users to the relative path in the Canvas application. Type: String Length Constraints: Minimum length of 0. Maximum length of 1023. Required: No ** [SessionExpirationDurationInSeconds](#API_CreatePresignedDomainUrl_RequestSyntax) ** The session expiration duration in seconds. This value defaults to 43200. Type: Integer Valid Range: Minimum value of 1800. Maximum value of 43200. Required: No ** [SpaceName](#API_CreatePresignedDomainUrl_RequestSyntax) ** The name of the space. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: No ** [UserProfileName](#API_CreatePresignedDomainUrl_RequestSyntax) ** The name of the UserProfile to sign-in as. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "AuthorizedUrl": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AuthorizedUrl](#API_CreatePresignedDomainUrl_ResponseSyntax) ** The presigned URL. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/CreatePresignedDomainUrl) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/CreatePresignedDomainUrl) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/CreatePresignedDomainUrl) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/CreatePresignedDomainUrl) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/CreatePresignedDomainUrl) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/CreatePresignedDomainUrl) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/CreatePresignedDomainUrl) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/CreatePresignedDomainUrl) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/CreatePresignedDomainUrl) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/CreatePresignedDomainUrl) # CreatePresignedMlflowAppUrl Returns a presigned URL that you can use to connect to the MLflow UI attached to your MLflow App. For more information, see [Launch the MLflow UI using a presigned URL](https://docs.aws.amazon.com/sagemaker/latest/dg/mlflow-launch-ui.html). ## Request Syntax ``` { "Arn": "string", "ExpiresInSeconds": number, "SessionExpirationDurationInSeconds": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Arn](#API_CreatePresignedMlflowAppUrl_RequestSyntax) ** The ARN of the MLflow App to connect to your MLflow UI. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:mlflow-app/.*` Required: Yes ** [ExpiresInSeconds](#API_CreatePresignedMlflowAppUrl_RequestSyntax) ** The duration in seconds that your presigned URL is valid. The presigned URL can be used only once. Type: Integer Valid Range: Minimum value of 5. Maximum value of 300. Required: No ** [SessionExpirationDurationInSeconds](#API_CreatePresignedMlflowAppUrl_RequestSyntax) ** The duration in seconds that your presigned URL is valid. The presigned URL can be used only once. Type: Integer Valid Range: Minimum value of 1800. Maximum value of 43200. Required: No ## Response Syntax ``` { "AuthorizedUrl": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AuthorizedUrl](#API_CreatePresignedMlflowAppUrl_ResponseSyntax) ** A presigned URL with an authorization token. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/CreatePresignedMlflowAppUrl) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/CreatePresignedMlflowAppUrl) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/CreatePresignedMlflowAppUrl) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/CreatePresignedMlflowAppUrl) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/CreatePresignedMlflowAppUrl) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/CreatePresignedMlflowAppUrl) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/CreatePresignedMlflowAppUrl) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/CreatePresignedMlflowAppUrl) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/CreatePresignedMlflowAppUrl) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/CreatePresignedMlflowAppUrl) # CreatePresignedMlflowTrackingServerUrl Returns a presigned URL that you can use to connect to the MLflow UI attached to your tracking server. For more information, see [Launch the MLflow UI using a presigned URL](https://docs.aws.amazon.com/sagemaker/latest/dg/mlflow-launch-ui.html). ## Request Syntax ``` { "ExpiresInSeconds": number, "SessionExpirationDurationInSeconds": number, "TrackingServerName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ExpiresInSeconds](#API_CreatePresignedMlflowTrackingServerUrl_RequestSyntax) ** The duration in seconds that your presigned URL is valid. The presigned URL can be used only once. Type: Integer Valid Range: Minimum value of 5. Maximum value of 300. Required: No ** [SessionExpirationDurationInSeconds](#API_CreatePresignedMlflowTrackingServerUrl_RequestSyntax) ** The duration in seconds that your MLflow UI session is valid. Type: Integer Valid Range: Minimum value of 1800. Maximum value of 43200. Required: No ** [TrackingServerName](#API_CreatePresignedMlflowTrackingServerUrl_RequestSyntax) ** The name of the tracking server to connect to your MLflow UI. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}` Required: Yes ## Response Syntax ``` { "AuthorizedUrl": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AuthorizedUrl](#API_CreatePresignedMlflowTrackingServerUrl_ResponseSyntax) ** A presigned URL with an authorization token. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/CreatePresignedMlflowTrackingServerUrl) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/CreatePresignedMlflowTrackingServerUrl) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/CreatePresignedMlflowTrackingServerUrl) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/CreatePresignedMlflowTrackingServerUrl) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/CreatePresignedMlflowTrackingServerUrl) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/CreatePresignedMlflowTrackingServerUrl) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/CreatePresignedMlflowTrackingServerUrl) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/CreatePresignedMlflowTrackingServerUrl) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/CreatePresignedMlflowTrackingServerUrl) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/CreatePresignedMlflowTrackingServerUrl) # CreatePresignedNotebookInstanceUrl Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the SageMaker AI console, when you choose `Open` next to a notebook instance, SageMaker AI opens a new tab showing the Jupyter server home page from the notebook instance. The console uses this API to get the URL and show the page. The IAM role or user used to call this API defines the permissions to access the notebook instance. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the notebook instance. You can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. Use the `NotIpAddress` condition operator and 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](https://docs.aws.amazon.com/sagemaker/latest/dg/security_iam_id-based-policy-examples.html#nbi-ip-filter). **Note** The URL that you get from a call to [CreatePresignedNotebookInstanceUrl](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreatePresignedNotebookInstanceUrl.html) 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. ## Request Syntax ``` { "NotebookInstanceName": "string", "SessionExpirationDurationInSeconds": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [NotebookInstanceName](#API_CreatePresignedNotebookInstanceUrl_RequestSyntax) ** The name of the notebook instance. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9])*` Required: Yes ** [SessionExpirationDurationInSeconds](#API_CreatePresignedNotebookInstanceUrl_RequestSyntax) ** The duration of the session, in seconds. The default is 12 hours. Type: Integer Valid Range: Minimum value of 1800. Maximum value of 43200. Required: No ## Response Syntax ``` { "AuthorizedUrl": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AuthorizedUrl](#API_CreatePresignedNotebookInstanceUrl_ResponseSyntax) ** A JSON object that contains the URL string. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/CreatePresignedNotebookInstanceUrl) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/CreatePresignedNotebookInstanceUrl) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/CreatePresignedNotebookInstanceUrl) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/CreatePresignedNotebookInstanceUrl) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/CreatePresignedNotebookInstanceUrl) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/CreatePresignedNotebookInstanceUrl) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/CreatePresignedNotebookInstanceUrl) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/CreatePresignedNotebookInstanceUrl) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/CreatePresignedNotebookInstanceUrl) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/CreatePresignedNotebookInstanceUrl) # CreateProcessingJob Creates a processing job. ## Request Syntax ``` { "AppSpecification": { "ContainerArguments": [ "string" ], "ContainerEntrypoint": [ "string" ], "ImageUri": "string" }, "Environment": { "string" : "string" }, "ExperimentConfig": { "ExperimentName": "string", "RunName": "string", "TrialComponentDisplayName": "string", "TrialName": "string" }, "NetworkConfig": { "EnableInterContainerTrafficEncryption": boolean, "EnableNetworkIsolation": boolean, "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } }, "ProcessingInputs": [ { "AppManaged": boolean, "DatasetDefinition": { "AthenaDatasetDefinition": { "Catalog": "string", "Database": "string", "KmsKeyId": "string", "OutputCompression": "string", "OutputFormat": "string", "OutputS3Uri": "string", "QueryString": "string", "WorkGroup": "string" }, "DataDistributionType": "string", "InputMode": "string", "LocalPath": "string", "RedshiftDatasetDefinition": { "ClusterId": "string", "ClusterRoleArn": "string", "Database": "string", "DbUser": "string", "KmsKeyId": "string", "OutputCompression": "string", "OutputFormat": "string", "OutputS3Uri": "string", "QueryString": "string" } }, "InputName": "string", "S3Input": { "LocalPath": "string", "S3CompressionType": "string", "S3DataDistributionType": "string", "S3DataType": "string", "S3InputMode": "string", "S3Uri": "string" } } ], "ProcessingJobName": "string", "ProcessingOutputConfig": { "KmsKeyId": "string", "Outputs": [ { "AppManaged": boolean, "FeatureStoreOutput": { "FeatureGroupName": "string" }, "OutputName": "string", "S3Output": { "LocalPath": "string", "S3UploadMode": "string", "S3Uri": "string" } } ] }, "ProcessingResources": { "ClusterConfig": { "InstanceCount": number, "InstanceType": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number } }, "RoleArn": "string", "StoppingCondition": { "MaxRuntimeInSeconds": number }, "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AppSpecification](#API_CreateProcessingJob_RequestSyntax) ** Configures the processing job to run a specified Docker container image. Type: [AppSpecification](API_AppSpecification.md) object Required: Yes ** [Environment](#API_CreateProcessingJob_RequestSyntax) ** The environment variables to set in the Docker container. Up to 100 key and values entries in the map are supported. Do not include any security-sensitive information including account access IDs, secrets, or tokens in any environment fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request environment variable or plain text fields. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 100 items. Key Length Constraints: Minimum length of 0. Maximum length of 256. Key Pattern: `[a-zA-Z_][a-zA-Z0-9_]*` Value Length Constraints: Minimum length of 0. Maximum length of 256. Value Pattern: `[\S\s]*` Required: No ** [ExperimentConfig](#API_CreateProcessingJob_RequestSyntax) ** Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs: + [CreateProcessingJob](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html) + [CreateTrainingJob](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html) + [CreateTransformJob](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html) Type: [ExperimentConfig](API_ExperimentConfig.md) object Required: No ** [NetworkConfig](#API_CreateProcessingJob_RequestSyntax) ** 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. Type: [NetworkConfig](API_NetworkConfig.md) object Required: No ** [ProcessingInputs](#API_CreateProcessingJob_RequestSyntax) ** An array of inputs configuring the data to download into the processing container. Type: Array of [ProcessingInput](API_ProcessingInput.md) objects Array Members: Minimum number of 0 items. Maximum number of 10 items. Required: No ** [ProcessingJobName](#API_CreateProcessingJob_RequestSyntax) ** The name of the processing job. The name must be unique within an AWS Region in the AWS account. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [ProcessingOutputConfig](#API_CreateProcessingJob_RequestSyntax) ** Output configuration for the processing job. Type: [ProcessingOutputConfig](API_ProcessingOutputConfig.md) object Required: No ** [ProcessingResources](#API_CreateProcessingJob_RequestSyntax) ** 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. Type: [ProcessingResources](API_ProcessingResources.md) object Required: Yes ** [RoleArn](#API_CreateProcessingJob_RequestSyntax) ** The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` Required: Yes ** [StoppingCondition](#API_CreateProcessingJob_RequestSyntax) ** The time limit for how long the processing job is allowed to run. Type: [ProcessingStoppingCondition](API_ProcessingStoppingCondition.md) object Required: No ** [Tags](#API_CreateProcessingJob_RequestSyntax) ** (Optional) An array of key-value pairs. For more information, see [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL) in the * AWS Billing and Cost Management User Guide*. Do not include any security-sensitive information including account access IDs, secrets, or tokens in any tags. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request tag variable or plain text fields. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No ## Response Syntax ``` { "ProcessingJobArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ProcessingJobArn](#API_CreateProcessingJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the processing job. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:processing-job/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/CreateProcessingJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/CreateProcessingJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/CreateProcessingJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/CreateProcessingJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/CreateProcessingJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/CreateProcessingJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/CreateProcessingJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/CreateProcessingJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/CreateProcessingJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/CreateProcessingJob) # CreateProject 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. ## Request Syntax ``` { "ProjectDescription": "string", "ProjectName": "string", "ServiceCatalogProvisioningDetails": { "PathId": "string", "ProductId": "string", "ProvisioningArtifactId": "string", "ProvisioningParameters": [ { "Key": "string", "Value": "string" } ] }, "Tags": [ { "Key": "string", "Value": "string" } ], "TemplateProviders": [ { "CfnTemplateProvider": { "Parameters": [ { "Key": "string", "Value": "string" } ], "RoleARN": "string", "TemplateName": "string", "TemplateURL": "string" } } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ProjectDescription](#API_CreateProject_RequestSyntax) ** A description for the project. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*` Required: No ** [ProjectName](#API_CreateProject_RequestSyntax) ** The name of the project. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}` Required: Yes ** [ServiceCatalogProvisioningDetails](#API_CreateProject_RequestSyntax) ** The product ID and provisioning artifact ID to provision a service catalog. The provisioning artifact ID will default to the latest provisioning artifact ID of the product, if you don't provide the provisioning artifact ID. For more information, see [What is AWS Service Catalog](https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html). Type: [ServiceCatalogProvisioningDetails](API_ServiceCatalogProvisioningDetails.md) object Required: No ** [Tags](#API_CreateProject_RequestSyntax) ** 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](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the * AWS General Reference Guide*. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No ** [TemplateProviders](#API_CreateProject_RequestSyntax) ** An array of template provider configurations for creating infrastructure resources for the project. Type: Array of [CreateTemplateProvider](API_CreateTemplateProvider.md) objects Array Members: Fixed number of 1 item. Required: No ## Response Syntax ``` { "ProjectArn": "string", "ProjectId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ProjectArn](#API_CreateProject_ResponseSyntax) ** The Amazon Resource Name (ARN) of the project. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:project/[\S]{1,2048}` ** [ProjectId](#API_CreateProject_ResponseSyntax) ** The ID of the new project. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9])*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/CreateProject) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/CreateProject) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/CreateProject) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/CreateProject) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/CreateProject) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/CreateProject) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/CreateProject) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/CreateProject) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/CreateProject) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/CreateProject) # CreateSpace Creates a private space or a space used for real time collaboration in a domain. ## Request Syntax ``` { "DomainId": "string", "OwnershipSettings": { "OwnerUserProfileName": "string" }, "SpaceDisplayName": "string", "SpaceName": "string", "SpaceSettings": { "AppType": "string", "CodeEditorAppSettings": { "AppLifecycleManagement": { "IdleSettings": { "IdleTimeoutInMinutes": number } }, "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" } }, "CustomFileSystems": [ { ... } ], "JupyterLabAppSettings": { "AppLifecycleManagement": { "IdleSettings": { "IdleTimeoutInMinutes": number } }, "CodeRepositories": [ { "RepositoryUrl": "string" } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" } }, "JupyterServerAppSettings": { "CodeRepositories": [ { "RepositoryUrl": "string" } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" }, "LifecycleConfigArns": [ "string" ] }, "KernelGatewayAppSettings": { "CustomImages": [ { "AppImageConfigName": "string", "ImageName": "string", "ImageVersionNumber": number } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" }, "LifecycleConfigArns": [ "string" ] }, "RemoteAccess": "string", "SpaceManagedResources": "string", "SpaceStorageSettings": { "EbsStorageSettings": { "EbsVolumeSizeInGb": number } } }, "SpaceSharingSettings": { "SharingType": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DomainId](#API_CreateSpace_RequestSyntax) ** The ID of the associated domain. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `d-(-*[a-z0-9]){1,61}` Required: Yes ** [OwnershipSettings](#API_CreateSpace_RequestSyntax) ** A collection of ownership settings. Type: [OwnershipSettings](API_OwnershipSettings.md) object Required: No ** [SpaceDisplayName](#API_CreateSpace_RequestSyntax) ** The name of the space that appears in the SageMaker Studio UI. Type: String Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: `(?!\s*$).+` Required: No ** [SpaceName](#API_CreateSpace_RequestSyntax) ** The name of the space. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [SpaceSettings](#API_CreateSpace_RequestSyntax) ** A collection of space settings. Type: [SpaceSettings](API_SpaceSettings.md) object Required: No ** [SpaceSharingSettings](#API_CreateSpace_RequestSyntax) ** A collection of space sharing settings. Type: [SpaceSharingSettings](API_SpaceSharingSettings.md) object Required: No ** [Tags](#API_CreateSpace_RequestSyntax) ** Tags to associated with the space. Each tag consists of a key and an optional value. Tag keys must be unique for each resource. Tags are searchable using the `Search` API. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No ## Response Syntax ``` { "SpaceArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [SpaceArn](#API_CreateSpace_ResponseSyntax) ** The space's Amazon Resource Name (ARN). Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:space/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/CreateSpace) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/CreateSpace) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/CreateSpace) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/CreateSpace) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/CreateSpace) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/CreateSpace) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/CreateSpace) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/CreateSpace) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/CreateSpace) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/CreateSpace) # CreateStudioLifecycleConfig Creates a new Amazon SageMaker AI Studio Lifecycle Configuration. ## Request Syntax ``` { "StudioLifecycleConfigAppType": "string", "StudioLifecycleConfigContent": "string", "StudioLifecycleConfigName": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [StudioLifecycleConfigAppType](#API_CreateStudioLifecycleConfig_RequestSyntax) ** The App type that the Lifecycle Configuration is attached to. Type: String Valid Values: `JupyterServer | KernelGateway | CodeEditor | JupyterLab` Required: Yes ** [StudioLifecycleConfigContent](#API_CreateStudioLifecycleConfig_RequestSyntax) ** The content of your Amazon SageMaker AI Studio Lifecycle Configuration script. This content must be base64 encoded. Type: String Length Constraints: Minimum length of 1. Maximum length of 16384. Pattern: `[\S\s]+` Required: Yes ** [StudioLifecycleConfigName](#API_CreateStudioLifecycleConfig_RequestSyntax) ** The name of the Amazon SageMaker AI Studio Lifecycle Configuration to create. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [Tags](#API_CreateStudioLifecycleConfig_RequestSyntax) ** Tags to be associated with the Lifecycle Configuration. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No ## Response Syntax ``` { "StudioLifecycleConfigArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [StudioLifecycleConfigArn](#API_CreateStudioLifecycleConfig_ResponseSyntax) ** The ARN of your created Lifecycle Configuration. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:studio-lifecycle-config/.*|None)` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/CreateStudioLifecycleConfig) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/CreateStudioLifecycleConfig) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/CreateStudioLifecycleConfig) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/CreateStudioLifecycleConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/CreateStudioLifecycleConfig) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/CreateStudioLifecycleConfig) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/CreateStudioLifecycleConfig) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/CreateStudioLifecycleConfig) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/CreateStudioLifecycleConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/CreateStudioLifecycleConfig) # CreateTrainingJob Starts a model training job. After training completes, SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify. If you choose to host your model using SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a machine learning service other than SageMaker, provided that you know how to use them for inference. In the request body, you provide the following: + `AlgorithmSpecification` - Identifies the training algorithm to use. + `HyperParameters` - Specify these algorithm-specific parameters to enable the estimation of model parameters during training. Hyperparameters can be tuned to optimize this learning process. For a list of hyperparameters for each training algorithm provided by SageMaker, see [Algorithms](https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html). **Important** Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request hyperparameter variable or plain text fields. + `InputDataConfig` - Describes the input required by the training job and the Amazon S3, EFS, or FSx location where it is stored. + `OutputDataConfig` - Identifies the Amazon S3 bucket where you want SageMaker to save the results of model training. + `ResourceConfig` - Identifies the resources, ML compute instances, and ML storage volumes to deploy for model training. In distributed training, you specify more than one instance. + `EnableManagedSpotTraining` - Optimize the cost of training machine learning models by up to 80% by using Amazon EC2 Spot instances. For more information, see [Managed Spot Training](https://docs.aws.amazon.com/sagemaker/latest/dg/model-managed-spot-training.html). + `RoleArn` - The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during model training. You must grant this role the necessary permissions so that SageMaker can successfully complete model training. + `StoppingCondition` - To help cap training costs, use `MaxRuntimeInSeconds` to set a time limit for training. Use `MaxWaitTimeInSeconds` to specify how long a managed spot training job has to complete. + `Environment` - The environment variables to set in the Docker container. **Important** Do not include any security-sensitive information including account access IDs, secrets, or tokens in any environment fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request environment variable or plain text fields. + `RetryStrategy` - The number of times to retry the job when the job fails due to an `InternalServerError`. For more information about SageMaker, see [How It Works](https://docs.aws.amazon.com/sagemaker/latest/dg/how-it-works.html). ## Request Syntax ``` { "AlgorithmSpecification": { "AlgorithmName": "string", "ContainerArguments": [ "string" ], "ContainerEntrypoint": [ "string" ], "EnableSageMakerMetricsTimeSeries": boolean, "MetricDefinitions": [ { "Name": "string", "Regex": "string" } ], "TrainingImage": "string", "TrainingImageConfig": { "TrainingRepositoryAccessMode": "string", "TrainingRepositoryAuthConfig": { "TrainingRepositoryCredentialsProviderArn": "string" } }, "TrainingInputMode": "string" }, "CheckpointConfig": { "LocalPath": "string", "S3Uri": "string" }, "DebugHookConfig": { "CollectionConfigurations": [ { "CollectionName": "string", "CollectionParameters": { "string" : "string" } } ], "HookParameters": { "string" : "string" }, "LocalPath": "string", "S3OutputPath": "string" }, "DebugRuleConfigurations": [ { "InstanceType": "string", "LocalPath": "string", "RuleConfigurationName": "string", "RuleEvaluatorImage": "string", "RuleParameters": { "string" : "string" }, "S3OutputPath": "string", "VolumeSizeInGB": number } ], "EnableInterContainerTrafficEncryption": boolean, "EnableManagedSpotTraining": boolean, "EnableNetworkIsolation": boolean, "Environment": { "string" : "string" }, "ExperimentConfig": { "ExperimentName": "string", "RunName": "string", "TrialComponentDisplayName": "string", "TrialName": "string" }, "HyperParameters": { "string" : "string" }, "InfraCheckConfig": { "EnableInfraCheck": boolean }, "InputDataConfig": [ { "ChannelName": "string", "CompressionType": "string", "ContentType": "string", "DataSource": { "FileSystemDataSource": { "DirectoryPath": "string", "FileSystemAccessMode": "string", "FileSystemId": "string", "FileSystemType": "string" }, "S3DataSource": { "AttributeNames": [ "string" ], "HubAccessConfig": { "HubContentArn": "string" }, "InstanceGroupNames": [ "string" ], "ModelAccessConfig": { "AcceptEula": boolean }, "S3DataDistributionType": "string", "S3DataType": "string", "S3Uri": "string" } }, "InputMode": "string", "RecordWrapperType": "string", "ShuffleConfig": { "Seed": number } } ], "MlflowConfig": { "MlflowExperimentName": "string", "MlflowResourceArn": "string", "MlflowRunName": "string" }, "ModelPackageConfig": { "ModelPackageGroupArn": "string", "SourceModelPackageArn": "string" }, "OutputDataConfig": { "CompressionType": "string", "KmsKeyId": "string", "S3OutputPath": "string" }, "ProfilerConfig": { "DisableProfiler": boolean, "ProfilingIntervalInMilliseconds": number, "ProfilingParameters": { "string" : "string" }, "S3OutputPath": "string" }, "ProfilerRuleConfigurations": [ { "InstanceType": "string", "LocalPath": "string", "RuleConfigurationName": "string", "RuleEvaluatorImage": "string", "RuleParameters": { "string" : "string" }, "S3OutputPath": "string", "VolumeSizeInGB": number } ], "RemoteDebugConfig": { "EnableRemoteDebug": boolean }, "ResourceConfig": { "InstanceCount": number, "InstanceGroups": [ { "InstanceCount": number, "InstanceGroupName": "string", "InstanceType": "string" } ], "InstancePlacementConfig": { "EnableMultipleJobs": boolean, "PlacementSpecifications": [ { "InstanceCount": number, "UltraServerId": "string" } ] }, "InstanceType": "string", "KeepAlivePeriodInSeconds": number, "TrainingPlanArn": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number }, "RetryStrategy": { "MaximumRetryAttempts": number }, "RoleArn": "string", "ServerlessJobConfig": { "AcceptEula": boolean, "BaseModelArn": "string", "CustomizationTechnique": "string", "EvaluationType": "string", "EvaluatorArn": "string", "JobType": "string", "Peft": "string" }, "SessionChainingConfig": { "EnableSessionTagChaining": boolean }, "StoppingCondition": { "MaxPendingTimeInSeconds": number, "MaxRuntimeInSeconds": number, "MaxWaitTimeInSeconds": number }, "Tags": [ { "Key": "string", "Value": "string" } ], "TensorBoardOutputConfig": { "LocalPath": "string", "S3OutputPath": "string" }, "TrainingJobName": "string", "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AlgorithmSpecification](#API_CreateTrainingJob_RequestSyntax) ** 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 SageMaker, see [Algorithms](https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html). For information about providing your own algorithms, see [Using Your Own Algorithms with Amazon SageMaker](https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html). Type: [AlgorithmSpecification](API_AlgorithmSpecification.md) object Required: No ** [CheckpointConfig](#API_CreateTrainingJob_RequestSyntax) ** Contains information about the output location for managed spot training checkpoint data. Type: [CheckpointConfig](API_CheckpointConfig.md) object Required: No ** [DebugHookConfig](#API_CreateTrainingJob_RequestSyntax) ** Configuration information for the Amazon SageMaker 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](https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html). Type: [DebugHookConfig](API_DebugHookConfig.md) object Required: No ** [DebugRuleConfigurations](#API_CreateTrainingJob_RequestSyntax) ** Configuration information for Amazon SageMaker Debugger rules for debugging output tensors. Type: Array of [DebugRuleConfiguration](API_DebugRuleConfiguration.md) objects Array Members: Minimum number of 0 items. Maximum number of 20 items. Required: No ** [EnableInterContainerTrafficEncryption](#API_CreateTrainingJob_RequestSyntax) ** 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](https://docs.aws.amazon.com/sagemaker/latest/dg/train-encrypt.html). Type: Boolean Required: No ** [EnableManagedSpotTraining](#API_CreateTrainingJob_RequestSyntax) ** 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. Type: Boolean Required: No ** [EnableNetworkIsolation](#API_CreateTrainingJob_RequestSyntax) ** 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, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access. Type: Boolean Required: No ** [Environment](#API_CreateTrainingJob_RequestSyntax) ** The environment variables to set in the Docker container. Do not include any security-sensitive information including account access IDs, secrets, or tokens in any environment fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request environment variable or plain text fields. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 100 items. Key Length Constraints: Minimum length of 0. Maximum length of 512. Key Pattern: `[a-zA-Z_][a-zA-Z0-9_]*` Value Length Constraints: Minimum length of 0. Maximum length of 512. Value Pattern: `[\S\s]*` Required: No ** [ExperimentConfig](#API_CreateTrainingJob_RequestSyntax) ** Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs: + [CreateProcessingJob](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html) + [CreateTrainingJob](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html) + [CreateTransformJob](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html) Type: [ExperimentConfig](API_ExperimentConfig.md) object Required: No ** [HyperParameters](#API_CreateTrainingJob_RequestSyntax) ** 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 SageMaker, see [Algorithms](https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html). 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`. Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by any security-sensitive information included in the request hyperparameter variable or plain text fields. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 100 items. Key Length Constraints: Minimum length of 0. Maximum length of 256. Key Pattern: `.*` Value Length Constraints: Minimum length of 0. Maximum length of 2500. Value Pattern: `.*` Required: No ** [InfraCheckConfig](#API_CreateTrainingJob_RequestSyntax) ** Contains information about the infrastructure health check configuration for the training job. Type: [InfraCheckConfig](API_InfraCheckConfig.md) object Required: No ** [InputDataConfig](#API_CreateTrainingJob_RequestSyntax) ** 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, 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 are available as input streams. They do not need to be downloaded. Your input must be in the same AWS region as your training job. Type: Array of [Channel](API_Channel.md) objects Array Members: Minimum number of 1 item. Maximum number of 20 items. Required: No ** [MlflowConfig](#API_CreateTrainingJob_RequestSyntax) ** The MLflow configuration using SageMaker managed MLflow. Type: [MlflowConfig](API_MlflowConfig.md) object Required: No ** [ModelPackageConfig](#API_CreateTrainingJob_RequestSyntax) ** The configuration for the model package. Type: [ModelPackageConfig](API_ModelPackageConfig.md) object Required: No ** [OutputDataConfig](#API_CreateTrainingJob_RequestSyntax) ** Specifies the path to the S3 location where you want to store model artifacts. SageMaker creates subfolders for the artifacts. Type: [OutputDataConfig](API_OutputDataConfig.md) object Required: Yes ** [ProfilerConfig](#API_CreateTrainingJob_RequestSyntax) ** Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths. Type: [ProfilerConfig](API_ProfilerConfig.md) object Required: No ** [ProfilerRuleConfigurations](#API_CreateTrainingJob_RequestSyntax) ** Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics. Type: Array of [ProfilerRuleConfiguration](API_ProfilerRuleConfiguration.md) objects Array Members: Minimum number of 0 items. Maximum number of 20 items. Required: No ** [RemoteDebugConfig](#API_CreateTrainingJob_RequestSyntax) ** Configuration for remote debugging. To learn more about the remote debugging functionality of SageMaker, see [Access a training container through AWS Systems Manager (SSM) for remote debugging](https://docs.aws.amazon.com/sagemaker/latest/dg/train-remote-debugging.html). Type: [RemoteDebugConfig](API_RemoteDebugConfig.md) object Required: No ** [ResourceConfig](#API_CreateTrainingJob_RequestSyntax) ** 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 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. Type: [ResourceConfig](API_ResourceConfig.md) object Required: No ** [RetryStrategy](#API_CreateTrainingJob_RequestSyntax) ** The number of times to retry the job when the job fails due to an `InternalServerError`. Type: [RetryStrategy](API_RetryStrategy.md) object Required: No ** [RoleArn](#API_CreateTrainingJob_RequestSyntax) ** The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to perform tasks on your behalf. During model training, 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 [SageMaker Roles](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html). To be able to pass this role to SageMaker, the caller of this API must have the `iam:PassRole` permission. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` Required: Yes ** [ServerlessJobConfig](#API_CreateTrainingJob_RequestSyntax) ** The configuration for serverless training jobs. Type: [ServerlessJobConfig](API_ServerlessJobConfig.md) object Required: No ** [SessionChainingConfig](#API_CreateTrainingJob_RequestSyntax) ** Contains information about attribute-based access control (ABAC) for the training job. Type: [SessionChainingConfig](API_SessionChainingConfig.md) object Required: No ** [StoppingCondition](#API_CreateTrainingJob_RequestSyntax) ** Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs. To stop a job, 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. Type: [StoppingCondition](API_StoppingCondition.md) object Required: No ** [Tags](#API_CreateTrainingJob_RequestSyntax) ** 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](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). Do not include any security-sensitive information including account access IDs, secrets, or tokens in any tags. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by any security-sensitive information included in the request tag variable or plain text fields. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No ** [TensorBoardOutputConfig](#API_CreateTrainingJob_RequestSyntax) ** Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data. Type: [TensorBoardOutputConfig](API_TensorBoardOutputConfig.md) object Required: No ** [TrainingJobName](#API_CreateTrainingJob_RequestSyntax) ** The name of the training job. The name must be unique within an AWS Region in an AWS account. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [VpcConfig](#API_CreateTrainingJob_RequestSyntax) ** A [VpcConfig](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html) 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](https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html). Type: [VpcConfig](API_VpcConfig.md) object Required: No ## Response Syntax ``` { "TrainingJobArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [TrainingJobArn](#API_CreateTrainingJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the training job. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:training-job/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/CreateTrainingJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/CreateTrainingJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/CreateTrainingJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/CreateTrainingJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/CreateTrainingJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/CreateTrainingJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/CreateTrainingJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/CreateTrainingJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/CreateTrainingJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/CreateTrainingJob) # CreateTrainingPlan Creates a new training plan in SageMaker to reserve compute capacity. Amazon SageMaker Training Plan is a capability within SageMaker that allows customers to reserve and manage GPU capacity for large-scale AI model training. It provides a way to secure predictable access to computational resources within specific timelines and budgets, without the need to manage underlying infrastructure. **How it works** Plans can be created for specific resources such as SageMaker Training Jobs or SageMaker HyperPod clusters, automatically provisioning resources, setting up infrastructure, executing workloads, and handling infrastructure failures. **Plan creation workflow** + Users search for available plan offerings based on their requirements (e.g., instance type, count, start time, duration) using the ` [SearchTrainingPlanOfferings](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_SearchTrainingPlanOfferings.html) ` API operation. + They create a plan that best matches their needs using the ID of the plan offering they want to use. + After successful upfront payment, the plan's status becomes `Scheduled`. + The plan can be used to: + Queue training jobs. + Allocate to an instance group of a SageMaker HyperPod cluster. + When the plan start date arrives, it becomes `Active`. Based on available reserved capacity: + Training jobs are launched. + Instance groups are provisioned. **Plan composition** A plan can consist of one or more Reserved Capacities, each defined by a specific instance type, quantity, Availability Zone, duration, and start and end times. For more information about Reserved Capacity, see ` [ReservedCapacitySummary](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ReservedCapacitySummary.html) `. ## Request Syntax ``` { "SpareInstanceCountPerUltraServer": number, "Tags": [ { "Key": "string", "Value": "string" } ], "TrainingPlanName": "string", "TrainingPlanOfferingId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [SpareInstanceCountPerUltraServer](#API_CreateTrainingPlan_RequestSyntax) ** Number of spare instances to reserve per UltraServer for enhanced resiliency. Default is 1. Type: Integer Valid Range: Minimum value of 0. Required: No ** [Tags](#API_CreateTrainingPlan_RequestSyntax) ** An array of key-value pairs to apply to this training plan. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No ** [TrainingPlanName](#API_CreateTrainingPlan_RequestSyntax) ** The name of the training plan to create. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}` Required: Yes ** [TrainingPlanOfferingId](#API_CreateTrainingPlan_RequestSyntax) ** The unique identifier of the training plan offering to use for creating this plan. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-z0-9\-]+` Required: Yes ## Response Syntax ``` { "TrainingPlanArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [TrainingPlanArn](#API_CreateTrainingPlan_ResponseSyntax) ** The Amazon Resource Name (ARN); of the created training plan. Type: String Length Constraints: Minimum length of 50. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:training-plan/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/CreateTrainingPlan) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/CreateTrainingPlan) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/CreateTrainingPlan) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/CreateTrainingPlan) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/CreateTrainingPlan) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/CreateTrainingPlan) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/CreateTrainingPlan) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/CreateTrainingPlan) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/CreateTrainingPlan) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/CreateTrainingPlan) # CreateTransformJob 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](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateModel.html). + `TransformInput` - Describes the dataset to be transformed and the Amazon S3 location where it is stored. + `TransformOutput` - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job. + `TransformResources` - Identifies the ML compute instances and AMI image versions for the transform job. For more information about how batch transformation works, see [Batch Transform](https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform.html). ## Request Syntax ``` { "BatchStrategy": "string", "DataCaptureConfig": { "DestinationS3Uri": "string", "GenerateInferenceId": boolean, "KmsKeyId": "string" }, "DataProcessing": { "InputFilter": "string", "JoinSource": "string", "OutputFilter": "string" }, "Environment": { "string" : "string" }, "ExperimentConfig": { "ExperimentName": "string", "RunName": "string", "TrialComponentDisplayName": "string", "TrialName": "string" }, "MaxConcurrentTransforms": number, "MaxPayloadInMB": number, "ModelClientConfig": { "InvocationsMaxRetries": number, "InvocationsTimeoutInSeconds": number }, "ModelName": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TransformInput": { "CompressionType": "string", "ContentType": "string", "DataSource": { "S3DataSource": { "S3DataType": "string", "S3Uri": "string" } }, "SplitType": "string" }, "TransformJobName": "string", "TransformOutput": { "Accept": "string", "AssembleWith": "string", "KmsKeyId": "string", "S3OutputPath": "string" }, "TransformResources": { "InstanceCount": number, "InstanceType": "string", "TransformAmiVersion": "string", "VolumeKmsKeyId": "string" } } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [BatchStrategy](#API_CreateTransformJob_RequestSyntax) ** 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`. Type: String Valid Values: `MultiRecord | SingleRecord` Required: No ** [DataCaptureConfig](#API_CreateTransformJob_RequestSyntax) ** Configuration to control how SageMaker captures inference data. Type: [BatchDataCaptureConfig](API_BatchDataCaptureConfig.md) object Required: No ** [DataProcessing](#API_CreateTransformJob_RequestSyntax) ** 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](https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html). Type: [DataProcessing](API_DataProcessing.md) object Required: No ** [Environment](#API_CreateTransformJob_RequestSyntax) ** The environment variables to set in the Docker container. Don't include any sensitive data in your environment variables. We support up to 16 key and values entries in the map. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 16 items. Key Length Constraints: Minimum length of 0. Maximum length of 1024. Key Pattern: `[a-zA-Z_][a-zA-Z0-9_]{0,1023}` Value Length Constraints: Minimum length of 0. Maximum length of 10240. Value Pattern: `[\S\s]*` Required: No ** [ExperimentConfig](#API_CreateTransformJob_RequestSyntax) ** Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs: + [CreateProcessingJob](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html) + [CreateTrainingJob](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html) + [CreateTransformJob](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html) Type: [ExperimentConfig](API_ExperimentConfig.md) object Required: No ** [MaxConcurrentTransforms](#API_CreateTransformJob_RequestSyntax) ** 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](https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-batch-code.html#your-algorithms-batch-code-how-containe-serves-requests). For built-in algorithms, you don't need to set a value for `MaxConcurrentTransforms`. Type: Integer Valid Range: Minimum value of 0. Required: No ** [MaxPayloadInMB](#API_CreateTransformJob_RequestSyntax) ** 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. The value of `MaxPayloadInMB` cannot be greater than 100 MB. If you specify the `MaxConcurrentTransforms` parameter, the value of `(MaxConcurrentTransforms * MaxPayloadInMB)` also cannot exceed 100 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. Type: Integer Valid Range: Minimum value of 0. Required: No ** [ModelClientConfig](#API_CreateTransformJob_RequestSyntax) ** Configures the timeout and maximum number of retries for processing a transform job invocation. Type: [ModelClientConfig](API_ModelClientConfig.md) object Required: No ** [ModelName](#API_CreateTransformJob_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9]([\-a-zA-Z0-9]*[a-zA-Z0-9])?` Required: Yes ** [Tags](#API_CreateTransformJob_RequestSyntax) ** (Optional) An array of key-value pairs. For more information, see [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what) in the * AWS Billing and Cost Management User Guide*. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No ** [TransformInput](#API_CreateTransformJob_RequestSyntax) ** Describes the input source and the way the transform job consumes it. Type: [TransformInput](API_TransformInput.md) object Required: Yes ** [TransformJobName](#API_CreateTransformJob_RequestSyntax) ** The name of the transform job. The name must be unique within an AWS Region in an AWS account. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [TransformOutput](#API_CreateTransformJob_RequestSyntax) ** Describes the results of the transform job. Type: [TransformOutput](API_TransformOutput.md) object Required: Yes ** [TransformResources](#API_CreateTransformJob_RequestSyntax) ** Describes the resources, including ML instance types and ML instance count, to use for the transform job. Type: [TransformResources](API_TransformResources.md) object Required: Yes ## Response Syntax ``` { "TransformJobArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [TransformJobArn](#API_CreateTransformJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the transform job. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:transform-job/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/CreateTransformJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/CreateTransformJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/CreateTransformJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/CreateTransformJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/CreateTransformJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/CreateTransformJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/CreateTransformJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/CreateTransformJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/CreateTransformJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/CreateTransformJob) # CreateTrial Creates an SageMaker *trial*. A trial is a set of steps called *trial components* that produce a machine learning model. A trial is part of a single SageMaker *experiment*. When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the 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](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) API to search for the tags. To get a list of all your trials, call the [ListTrials](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListTrials.html) API. To view a trial's properties, call the [DescribeTrial](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrial.html) API. To create a trial component, call the [CreateTrialComponent](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrialComponent.html) API. ## Request Syntax ``` { "DisplayName": "string", "ExperimentName": "string", "MetadataProperties": { "CommitId": "string", "GeneratedBy": "string", "ProjectId": "string", "Repository": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ], "TrialName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DisplayName](#API_CreateTrial_RequestSyntax) ** The name of the trial as displayed. The name doesn't need to be unique. If `DisplayName` isn't specified, `TrialName` is displayed. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` Required: No ** [ExperimentName](#API_CreateTrial_RequestSyntax) ** The name of the experiment to associate the trial with. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` Required: Yes ** [MetadataProperties](#API_CreateTrial_RequestSyntax) ** Metadata properties of the tracking entity, trial, or trial component. Type: [MetadataProperties](API_MetadataProperties.md) object Required: No ** [Tags](#API_CreateTrial_RequestSyntax) ** A list of tags to associate with the trial. You can use [Search](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) API to search on the tags. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No ** [TrialName](#API_CreateTrial_RequestSyntax) ** The name of the trial. The name must be unique in your AWS account and is not case-sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` Required: Yes ## Response Syntax ``` { "TrialArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [TrialArn](#API_CreateTrial_ResponseSyntax) ** The Amazon Resource Name (ARN) of the trial. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:experiment-trial/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/CreateTrial) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/CreateTrial) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/CreateTrial) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/CreateTrial) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/CreateTrial) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/CreateTrial) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/CreateTrial) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/CreateTrial) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/CreateTrial) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/CreateTrial) # CreateTrialComponent Creates a *trial component*, which is a stage of a machine learning *trial*. A trial is composed of one or more trial components. A trial component can be used in multiple trials. Trial components include pre-processing jobs, training jobs, and batch transform jobs. When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the 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](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) API to search for the tags. ## Request Syntax ``` { "DisplayName": "string", "EndTime": number, "InputArtifacts": { "string" : { "MediaType": "string", "Value": "string" } }, "MetadataProperties": { "CommitId": "string", "GeneratedBy": "string", "ProjectId": "string", "Repository": "string" }, "OutputArtifacts": { "string" : { "MediaType": "string", "Value": "string" } }, "Parameters": { "string" : { "NumberValue": number, "StringValue": "string" } }, "StartTime": number, "Status": { "Message": "string", "PrimaryStatus": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ], "TrialComponentName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DisplayName](#API_CreateTrialComponent_RequestSyntax) ** The name of the component as displayed. The name doesn't need to be unique. If `DisplayName` isn't specified, `TrialComponentName` is displayed. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` Required: No ** [EndTime](#API_CreateTrialComponent_RequestSyntax) ** When the component ended. Type: Timestamp Required: No ** [InputArtifacts](#API_CreateTrialComponent_RequestSyntax) ** The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types. Type: String to [TrialComponentArtifact](API_TrialComponentArtifact.md) object map Map Entries: Minimum number of 0 items. Maximum number of 60 items. Key Length Constraints: Minimum length of 0. Maximum length of 128. Key Pattern: `.*` Required: No ** [MetadataProperties](#API_CreateTrialComponent_RequestSyntax) ** Metadata properties of the tracking entity, trial, or trial component. Type: [MetadataProperties](API_MetadataProperties.md) object Required: No ** [OutputArtifacts](#API_CreateTrialComponent_RequestSyntax) ** The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images. Type: String to [TrialComponentArtifact](API_TrialComponentArtifact.md) object map Map Entries: Minimum number of 0 items. Maximum number of 60 items. Key Length Constraints: Minimum length of 0. Maximum length of 128. Key Pattern: `.*` Required: No ** [Parameters](#API_CreateTrialComponent_RequestSyntax) ** The hyperparameters for the component. Type: String to [TrialComponentParameterValue](API_TrialComponentParameterValue.md) object map Map Entries: Minimum number of 0 items. Maximum number of 300 items. Key Length Constraints: Minimum length of 0. Maximum length of 320. Key Pattern: `.*` Required: No ** [StartTime](#API_CreateTrialComponent_RequestSyntax) ** When the component started. Type: Timestamp Required: No ** [Status](#API_CreateTrialComponent_RequestSyntax) ** The status of the component. States include: + InProgress + Completed + Failed Type: [TrialComponentStatus](API_TrialComponentStatus.md) object Required: No ** [Tags](#API_CreateTrialComponent_RequestSyntax) ** A list of tags to associate with the component. You can use [Search](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) API to search on the tags. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No ** [TrialComponentName](#API_CreateTrialComponent_RequestSyntax) ** The name of the component. The name must be unique in your AWS account and is not case-sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` Required: Yes ## Response Syntax ``` { "TrialComponentArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [TrialComponentArn](#API_CreateTrialComponent_ResponseSyntax) ** The Amazon Resource Name (ARN) of the trial component. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:experiment-trial-component/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/CreateTrialComponent) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/CreateTrialComponent) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/CreateTrialComponent) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/CreateTrialComponent) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/CreateTrialComponent) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/CreateTrialComponent) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/CreateTrialComponent) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/CreateTrialComponent) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/CreateTrialComponent) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/CreateTrialComponent) # CreateUserProfile Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a "person" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to a domain. If an administrator invites a person by email or imports them from IAM Identity Center, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user's private Amazon Elastic File System home directory. ## Request Syntax ``` { "DomainId": "string", "SingleSignOnUserIdentifier": "string", "SingleSignOnUserValue": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "UserProfileName": "string", "UserSettings": { "AutoMountHomeEFS": "string", "CanvasAppSettings": { "DirectDeploySettings": { "Status": "string" }, "EmrServerlessSettings": { "ExecutionRoleArn": "string", "Status": "string" }, "GenerativeAiSettings": { "AmazonBedrockRoleArn": "string" }, "IdentityProviderOAuthSettings": [ { "DataSourceName": "string", "SecretArn": "string", "Status": "string" } ], "KendraSettings": { "Status": "string" }, "ModelRegisterSettings": { "CrossAccountModelRegisterRoleArn": "string", "Status": "string" }, "TimeSeriesForecastingSettings": { "AmazonForecastRoleArn": "string", "Status": "string" }, "WorkspaceSettings": { "S3ArtifactPath": "string", "S3KmsKeyId": "string" } }, "CodeEditorAppSettings": { "AppLifecycleManagement": { "IdleSettings": { "IdleTimeoutInMinutes": number, "LifecycleManagement": "string", "MaxIdleTimeoutInMinutes": number, "MinIdleTimeoutInMinutes": number } }, "BuiltInLifecycleConfigArn": "string", "CustomImages": [ { "AppImageConfigName": "string", "ImageName": "string", "ImageVersionNumber": number } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" }, "LifecycleConfigArns": [ "string" ] }, "CustomFileSystemConfigs": [ { ... } ], "CustomPosixUserConfig": { "Gid": number, "Uid": number }, "DefaultLandingUri": "string", "ExecutionRole": "string", "JupyterLabAppSettings": { "AppLifecycleManagement": { "IdleSettings": { "IdleTimeoutInMinutes": number, "LifecycleManagement": "string", "MaxIdleTimeoutInMinutes": number, "MinIdleTimeoutInMinutes": number } }, "BuiltInLifecycleConfigArn": "string", "CodeRepositories": [ { "RepositoryUrl": "string" } ], "CustomImages": [ { "AppImageConfigName": "string", "ImageName": "string", "ImageVersionNumber": number } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" }, "EmrSettings": { "AssumableRoleArns": [ "string" ], "ExecutionRoleArns": [ "string" ] }, "LifecycleConfigArns": [ "string" ] }, "JupyterServerAppSettings": { "CodeRepositories": [ { "RepositoryUrl": "string" } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" }, "LifecycleConfigArns": [ "string" ] }, "KernelGatewayAppSettings": { "CustomImages": [ { "AppImageConfigName": "string", "ImageName": "string", "ImageVersionNumber": number } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" }, "LifecycleConfigArns": [ "string" ] }, "RSessionAppSettings": { "CustomImages": [ { "AppImageConfigName": "string", "ImageName": "string", "ImageVersionNumber": number } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" } }, "RStudioServerProAppSettings": { "AccessStatus": "string", "UserGroup": "string" }, "SecurityGroups": [ "string" ], "SharingSettings": { "NotebookOutputOption": "string", "S3KmsKeyId": "string", "S3OutputPath": "string" }, "SpaceStorageSettings": { "DefaultEbsStorageSettings": { "DefaultEbsVolumeSizeInGb": number, "MaximumEbsVolumeSizeInGb": number } }, "StudioWebPortal": "string", "StudioWebPortalSettings": { "HiddenAppTypes": [ "string" ], "HiddenInstanceTypes": [ "string" ], "HiddenMlTools": [ "string" ], "HiddenSageMakerImageVersionAliases": [ { "SageMakerImageName": "string", "VersionAliases": [ "string" ] } ] }, "TensorBoardAppSettings": { "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" } } } } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DomainId](#API_CreateUserProfile_RequestSyntax) ** The ID of the associated Domain. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `d-(-*[a-z0-9]){1,61}` Required: Yes ** [SingleSignOnUserIdentifier](#API_CreateUserProfile_RequestSyntax) ** A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". If the Domain's AuthMode is IAM Identity Center, this field is required. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified. Type: String Pattern: `UserName` Required: No ** [SingleSignOnUserValue](#API_CreateUserProfile_RequestSyntax) ** The username of the associated AWS Single Sign-On User for this UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Required: No ** [Tags](#API_CreateUserProfile_RequestSyntax) ** Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags that you specify for the User Profile are also added to all Apps that the User Profile launches. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No ** [UserProfileName](#API_CreateUserProfile_RequestSyntax) ** A name for the UserProfile. This value is not case sensitive. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [UserSettings](#API_CreateUserProfile_RequestSyntax) ** A collection of settings. Type: [UserSettings](API_UserSettings.md) object Required: No ## Response Syntax ``` { "UserProfileArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [UserProfileArn](#API_CreateUserProfile_ResponseSyntax) ** The user profile Amazon Resource Name (ARN). Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:user-profile/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/CreateUserProfile) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/CreateUserProfile) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/CreateUserProfile) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/CreateUserProfile) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/CreateUserProfile) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/CreateUserProfile) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/CreateUserProfile) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/CreateUserProfile) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/CreateUserProfile) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/CreateUserProfile) # CreateWorkforce 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 [DeleteWorkforce](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteWorkforce.html) 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)](https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private.html). 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)](https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private-oidc.html). ## Request Syntax ``` { "CognitoConfig": { "ClientId": "string", "UserPool": "string" }, "IpAddressType": "string", "OidcConfig": { "AuthenticationRequestExtraParams": { "string" : "string" }, "AuthorizationEndpoint": "string", "ClientId": "string", "ClientSecret": "string", "Issuer": "string", "JwksUri": "string", "LogoutEndpoint": "string", "Scope": "string", "TokenEndpoint": "string", "UserInfoEndpoint": "string" }, "SourceIpConfig": { "Cidrs": [ "string" ] }, "Tags": [ { "Key": "string", "Value": "string" } ], "WorkforceName": "string", "WorkforceVpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ], "VpcId": "string" } } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CognitoConfig](#API_CreateWorkforce_RequestSyntax) ** 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](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html). Do not use `OidcConfig` if you specify values for `CognitoConfig`. Type: [CognitoConfig](API_CognitoConfig.md) object Required: No ** [IpAddressType](#API_CreateWorkforce_RequestSyntax) ** Use this parameter to specify whether you want `IPv4` only or `dualstack` (`IPv4` and `IPv6`) to support your labeling workforce. Type: String Valid Values: `ipv4 | dualstack` Required: No ** [OidcConfig](#API_CreateWorkforce_RequestSyntax) ** Use this parameter to configure a private workforce using your own OIDC Identity Provider. Do not use `CognitoConfig` if you specify values for `OidcConfig`. Type: [OidcConfig](API_OidcConfig.md) object Required: No ** [SourceIpConfig](#API_CreateWorkforce_RequestSyntax) ** A list of IP address ranges ([CIDRs](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html)). Used to create an allow list of IP addresses for a private workforce. Workers will only be able to log in to their worker portal from an IP address within this range. By default, a workforce isn't restricted to specific IP addresses. Type: [SourceIpConfig](API_SourceIpConfig.md) object Required: No ** [Tags](#API_CreateWorkforce_RequestSyntax) ** 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. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No ** [WorkforceName](#API_CreateWorkforce_RequestSyntax) ** The name of the private workforce. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9]([a-zA-Z0-9\-]){0,62}` Required: Yes ** [WorkforceVpcConfig](#API_CreateWorkforce_RequestSyntax) ** Use this parameter to configure a workforce using VPC. Type: [WorkforceVpcConfigRequest](API_WorkforceVpcConfigRequest.md) object Required: No ## Response Syntax ``` { "WorkforceArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [WorkforceArn](#API_CreateWorkforce_ResponseSyntax) ** The Amazon Resource Name (ARN) of the workforce. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:workforce/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/CreateWorkforce) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/CreateWorkforce) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/CreateWorkforce) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/CreateWorkforce) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/CreateWorkforce) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/CreateWorkforce) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/CreateWorkforce) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/CreateWorkforce) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/CreateWorkforce) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/CreateWorkforce) # CreateWorkteam 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. ## Request Syntax ``` { "Description": "string", "MemberDefinitions": [ { "CognitoMemberDefinition": { "ClientId": "string", "UserGroup": "string", "UserPool": "string" }, "OidcMemberDefinition": { "Groups": [ "string" ] } } ], "NotificationConfiguration": { "NotificationTopicArn": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ], "WorkerAccessConfiguration": { "S3Presign": { "IamPolicyConstraints": { "SourceIp": "string", "VpcSourceIp": "string" } } }, "WorkforceName": "string", "WorkteamName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Description](#API_CreateWorkteam_RequestSyntax) ** A description of the work team. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: `.+` Required: Yes ** [MemberDefinitions](#API_CreateWorkteam_RequestSyntax) ** 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](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html). 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`. Type: Array of [MemberDefinition](API_MemberDefinition.md) objects Array Members: Minimum number of 1 item. Maximum number of 10 items. Required: Yes ** [NotificationConfiguration](#API_CreateWorkteam_RequestSyntax) ** Configures notification of workers regarding available or expiring work items. Type: [NotificationConfiguration](API_NotificationConfiguration.md) object Required: No ** [Tags](#API_CreateWorkteam_RequestSyntax) ** An array of key-value pairs. For more information, see [Resource Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) and [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what) in the * AWS Billing and Cost Management User Guide*. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No ** [WorkerAccessConfiguration](#API_CreateWorkteam_RequestSyntax) ** Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL. Type: [WorkerAccessConfiguration](API_WorkerAccessConfiguration.md) object Required: No ** [WorkforceName](#API_CreateWorkteam_RequestSyntax) ** The name of the workforce. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9]([a-zA-Z0-9\-]){0,62}` Required: No ** [WorkteamName](#API_CreateWorkteam_RequestSyntax) ** The name of the work team. Use this name to identify the work team. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "WorkteamArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [WorkteamArn](#API_CreateWorkteam_ResponseSyntax) ** The Amazon Resource Name (ARN) of the work team. You can use this ARN to identify the work team. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:workteam/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/CreateWorkteam) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/CreateWorkteam) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/CreateWorkteam) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/CreateWorkteam) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/CreateWorkteam) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/CreateWorkteam) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/CreateWorkteam) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/CreateWorkteam) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/CreateWorkteam) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/CreateWorkteam) # DeleteAction Deletes an action. ## Request Syntax ``` { "ActionName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ActionName](#API_DeleteAction_RequestSyntax) ** The name of the action to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` Required: Yes ## Response Syntax ``` { "ActionArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ActionArn](#API_DeleteAction_ResponseSyntax) ** The Amazon Resource Name (ARN) of the action. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:action/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteAction) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteAction) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteAction) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteAction) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteAction) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteAction) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteAction) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteAction) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteAction) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteAction) # DeleteAlgorithm Removes the specified algorithm from your account. ## Request Syntax ``` { "AlgorithmName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AlgorithmName](#API_DeleteAlgorithm_RequestSyntax) ** The name of the algorithm to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteAlgorithm) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteAlgorithm) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteAlgorithm) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteAlgorithm) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteAlgorithm) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteAlgorithm) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteAlgorithm) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteAlgorithm) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteAlgorithm) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteAlgorithm) # DeleteApp Used to stop and delete an app. ## Request Syntax ``` { "AppName": "string", "AppType": "string", "DomainId": "string", "SpaceName": "string", "UserProfileName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AppName](#API_DeleteApp_RequestSyntax) ** The name of the app. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [AppType](#API_DeleteApp_RequestSyntax) ** The type of app. Type: String Valid Values: `JupyterServer | KernelGateway | DetailedProfiler | TensorBoard | CodeEditor | JupyterLab | RStudioServerPro | RSessionGateway | Canvas` Required: Yes ** [DomainId](#API_DeleteApp_RequestSyntax) ** The domain ID. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `d-(-*[a-z0-9]){1,61}` Required: Yes ** [SpaceName](#API_DeleteApp_RequestSyntax) ** The name of the space. If this value is not set, then `UserProfileName` must be set. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: No ** [UserProfileName](#API_DeleteApp_RequestSyntax) ** The user profile name. If this value is not set, then `SpaceName` must be set. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: No ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteApp) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteApp) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteApp) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteApp) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteApp) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteApp) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteApp) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteApp) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteApp) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteApp) # DeleteAppImageConfig Deletes an AppImageConfig. ## Request Syntax ``` { "AppImageConfigName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AppImageConfigName](#API_DeleteAppImageConfig_RequestSyntax) ** The name of the AppImageConfig to delete. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteAppImageConfig) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteAppImageConfig) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteAppImageConfig) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteAppImageConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteAppImageConfig) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteAppImageConfig) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteAppImageConfig) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteAppImageConfig) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteAppImageConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteAppImageConfig) # DeleteArtifact Deletes an artifact. Either `ArtifactArn` or `Source` must be specified. ## Request Syntax ``` { "ArtifactArn": "string", "Source": { "SourceTypes": [ { "SourceIdType": "string", "Value": "string" } ], "SourceUri": "string" } } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ArtifactArn](#API_DeleteArtifact_RequestSyntax) ** The Amazon Resource Name (ARN) of the artifact to delete. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:artifact/.*` Required: No ** [Source](#API_DeleteArtifact_RequestSyntax) ** The URI of the source. Type: [ArtifactSource](API_ArtifactSource.md) object Required: No ## Response Syntax ``` { "ArtifactArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ArtifactArn](#API_DeleteArtifact_ResponseSyntax) ** The Amazon Resource Name (ARN) of the artifact. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:artifact/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteArtifact) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteArtifact) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteArtifact) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteArtifact) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteArtifact) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteArtifact) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteArtifact) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteArtifact) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteArtifact) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteArtifact) # DeleteAssociation Deletes an association. ## Request Syntax ``` { "DestinationArn": "string", "SourceArn": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DestinationArn](#API_DeleteAssociation_RequestSyntax) ** The Amazon Resource Name (ARN) of the destination. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:(experiment|experiment-trial-component|artifact|action|context)/.*` Required: Yes ** [SourceArn](#API_DeleteAssociation_RequestSyntax) ** The ARN of the source. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:(experiment|experiment-trial-component|artifact|action|context)/.*` Required: Yes ## Response Syntax ``` { "DestinationArn": "string", "SourceArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DestinationArn](#API_DeleteAssociation_ResponseSyntax) ** The Amazon Resource Name (ARN) of the destination. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:(experiment|experiment-trial-component|artifact|action|context)/.*` ** [SourceArn](#API_DeleteAssociation_ResponseSyntax) ** The ARN of the source. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:(experiment|experiment-trial-component|artifact|action|context)/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteAssociation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteAssociation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteAssociation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteAssociation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteAssociation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteAssociation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteAssociation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteAssociation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteAssociation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteAssociation) # DeleteCluster Delete a SageMaker HyperPod cluster. ## Request Syntax ``` { "ClusterName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClusterName](#API_DeleteCluster_RequestSyntax) ** The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})` Required: Yes ## Response Syntax ``` { "ClusterArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ClusterArn](#API_DeleteCluster_ResponseSyntax) ** The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteCluster) # DeleteClusterSchedulerConfig Deletes the cluster policy of the cluster. ## Request Syntax ``` { "ClusterSchedulerConfigId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClusterSchedulerConfigId](#API_DeleteClusterSchedulerConfig_RequestSyntax) ** ID of the cluster policy. Type: String Length Constraints: Minimum length of 0. Maximum length of 12. Pattern: `[a-z0-9]{12}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteClusterSchedulerConfig) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteClusterSchedulerConfig) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteClusterSchedulerConfig) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteClusterSchedulerConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteClusterSchedulerConfig) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteClusterSchedulerConfig) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteClusterSchedulerConfig) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteClusterSchedulerConfig) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteClusterSchedulerConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteClusterSchedulerConfig) # DeleteCodeRepository Deletes the specified Git repository from your account. ## Request Syntax ``` { "CodeRepositoryName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CodeRepositoryName](#API_DeleteCodeRepository_RequestSyntax) ** The name of the Git repository to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteCodeRepository) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteCodeRepository) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteCodeRepository) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteCodeRepository) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteCodeRepository) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteCodeRepository) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteCodeRepository) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteCodeRepository) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteCodeRepository) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteCodeRepository) # DeleteCompilationJob Deletes the specified compilation job. This action deletes only the compilation job resource in Amazon SageMaker AI. It doesn't delete other resources that are related to that job, such as the model artifacts that the job creates, the compilation logs in CloudWatch, the compiled model, or the IAM role. You can delete a compilation job only if its current status is `COMPLETED`, `FAILED`, or `STOPPED`. If the job status is `STARTING` or `INPROGRESS`, stop the job, and then delete it after its status becomes `STOPPED`. ## Request Syntax ``` { "CompilationJobName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CompilationJobName](#API_DeleteCompilationJob_RequestSyntax) ** The name of the compilation job to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteCompilationJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteCompilationJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteCompilationJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteCompilationJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteCompilationJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteCompilationJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteCompilationJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteCompilationJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteCompilationJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteCompilationJob) # DeleteComputeQuota Deletes the compute allocation from the cluster. ## Request Syntax ``` { "ComputeQuotaId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ComputeQuotaId](#API_DeleteComputeQuota_RequestSyntax) ** ID of the compute allocation definition. Type: String Pattern: `[a-z0-9]{12}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteComputeQuota) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteComputeQuota) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteComputeQuota) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteComputeQuota) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteComputeQuota) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteComputeQuota) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteComputeQuota) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteComputeQuota) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteComputeQuota) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteComputeQuota) # DeleteContext Deletes an context. ## Request Syntax ``` { "ContextName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ContextName](#API_DeleteContext_RequestSyntax) ** The name of the context to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,119}` Required: Yes ## Response Syntax ``` { "ContextArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ContextArn](#API_DeleteContext_ResponseSyntax) ** The Amazon Resource Name (ARN) of the context. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:context/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteContext) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteContext) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteContext) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteContext) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteContext) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteContext) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteContext) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteContext) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteContext) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteContext) # DeleteDataQualityJobDefinition Deletes a data quality monitoring job definition. ## Request Syntax ``` { "JobDefinitionName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [JobDefinitionName](#API_DeleteDataQualityJobDefinition_RequestSyntax) ** The name of the data quality monitoring job definition to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteDataQualityJobDefinition) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteDataQualityJobDefinition) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteDataQualityJobDefinition) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteDataQualityJobDefinition) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteDataQualityJobDefinition) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteDataQualityJobDefinition) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteDataQualityJobDefinition) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteDataQualityJobDefinition) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteDataQualityJobDefinition) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteDataQualityJobDefinition) # DeleteDeviceFleet Deletes a fleet. ## Request Syntax ``` { "DeviceFleetName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DeviceFleetName](#API_DeleteDeviceFleet_RequestSyntax) ** The name of the fleet to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteDeviceFleet) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteDeviceFleet) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteDeviceFleet) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteDeviceFleet) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteDeviceFleet) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteDeviceFleet) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteDeviceFleet) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteDeviceFleet) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteDeviceFleet) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteDeviceFleet) # DeleteDomain Used to delete a domain. If you onboarded with IAM mode, you will need to delete your domain to onboard again using IAM Identity Center. Use with caution. All of the members of the domain will lose access to their EFS volume, including data, notebooks, and other artifacts. ## Request Syntax ``` { "DomainId": "string", "RetentionPolicy": { "HomeEfsFileSystem": "string" } } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DomainId](#API_DeleteDomain_RequestSyntax) ** The domain ID. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `d-(-*[a-z0-9]){1,61}` Required: Yes ** [RetentionPolicy](#API_DeleteDomain_RequestSyntax) ** 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). Type: [RetentionPolicy](API_RetentionPolicy.md) object Required: No ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteDomain) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteDomain) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteDomain) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteDomain) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteDomain) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteDomain) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteDomain) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteDomain) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteDomain) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteDomain) # DeleteEdgeDeploymentPlan Deletes an edge deployment plan if (and only if) all the stages in the plan are inactive or there are no stages in the plan. ## Request Syntax ``` { "EdgeDeploymentPlanName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [EdgeDeploymentPlanName](#API_DeleteEdgeDeploymentPlan_RequestSyntax) ** The name of the edge deployment plan to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteEdgeDeploymentPlan) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteEdgeDeploymentPlan) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteEdgeDeploymentPlan) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteEdgeDeploymentPlan) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteEdgeDeploymentPlan) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteEdgeDeploymentPlan) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteEdgeDeploymentPlan) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteEdgeDeploymentPlan) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteEdgeDeploymentPlan) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteEdgeDeploymentPlan) # DeleteEdgeDeploymentStage Delete a stage in an edge deployment plan if (and only if) the stage is inactive. ## Request Syntax ``` { "EdgeDeploymentPlanName": "string", "StageName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [EdgeDeploymentPlanName](#API_DeleteEdgeDeploymentStage_RequestSyntax) ** The name of the edge deployment plan from which the stage will be deleted. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [StageName](#API_DeleteEdgeDeploymentStage_RequestSyntax) ** The name of the stage. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteEdgeDeploymentStage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteEdgeDeploymentStage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteEdgeDeploymentStage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteEdgeDeploymentStage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteEdgeDeploymentStage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteEdgeDeploymentStage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteEdgeDeploymentStage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteEdgeDeploymentStage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteEdgeDeploymentStage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteEdgeDeploymentStage) # DeleteEndpoint Deletes an endpoint. SageMaker frees up all of the resources that were deployed when the endpoint was created. SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't need to use the [RevokeGrant](http://docs.aws.amazon.com/kms/latest/APIReference/API_RevokeGrant.html) API call. When you delete your endpoint, SageMaker asynchronously deletes associated endpoint resources such as KMS key grants. You might still see these resources in your account for a few minutes after deleting your endpoint. Do not delete or revoke the permissions for your ` [ExecutionRoleArn](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateModel.html#sagemaker-CreateModel-request-ExecutionRoleArn) `, otherwise SageMaker cannot delete these resources. ## Request Syntax ``` { "EndpointName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [EndpointName](#API_DeleteEndpoint_RequestSyntax) ** The name of the endpoint that you want to delete. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteEndpoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteEndpoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteEndpoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteEndpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteEndpoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteEndpoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteEndpoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteEndpoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteEndpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteEndpoint) # DeleteEndpointConfig 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. ## Request Syntax ``` { "EndpointConfigName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [EndpointConfigName](#API_DeleteEndpointConfig_RequestSyntax) ** The name of the endpoint configuration that you want to delete. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteEndpointConfig) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteEndpointConfig) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteEndpointConfig) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteEndpointConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteEndpointConfig) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteEndpointConfig) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteEndpointConfig) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteEndpointConfig) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteEndpointConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteEndpointConfig) # DeleteExperiment Deletes an SageMaker experiment. All trials associated with the experiment must be deleted first. Use the [ListTrials](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListTrials.html) API to get a list of the trials associated with the experiment. ## Request Syntax ``` { "ExperimentName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ExperimentName](#API_DeleteExperiment_RequestSyntax) ** The name of the experiment to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` Required: Yes ## Response Syntax ``` { "ExperimentArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ExperimentArn](#API_DeleteExperiment_ResponseSyntax) ** The Amazon Resource Name (ARN) of the experiment that is being deleted. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:experiment/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteExperiment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteExperiment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteExperiment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteExperiment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteExperiment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteExperiment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteExperiment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteExperiment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteExperiment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteExperiment) # DeleteFeatureGroup 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. Note that it can take approximately 10-15 minutes to delete an `OnlineStore` `FeatureGroup` with the `InMemory` `StorageType`. ## Request Syntax ``` { "FeatureGroupName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [FeatureGroupName](#API_DeleteFeatureGroup_RequestSyntax) ** The name of the `FeatureGroup` you want to delete. The name must be unique within an AWS Region in an AWS account. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[a-zA-Z0-9]([_-]*[a-zA-Z0-9]){0,63}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteFeatureGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteFeatureGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteFeatureGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteFeatureGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteFeatureGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteFeatureGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteFeatureGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteFeatureGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteFeatureGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteFeatureGroup) # DeleteFlowDefinition Deletes the specified flow definition. ## Request Syntax ``` { "FlowDefinitionName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [FlowDefinitionName](#API_DeleteFlowDefinition_RequestSyntax) ** The name of the flow definition you are deleting. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-z0-9](-*[a-z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteFlowDefinition) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteFlowDefinition) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteFlowDefinition) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteFlowDefinition) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteFlowDefinition) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteFlowDefinition) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteFlowDefinition) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteFlowDefinition) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteFlowDefinition) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteFlowDefinition) # DeleteHub Delete a hub. ## Request Syntax ``` { "HubName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [HubName](#API_DeleteHub_RequestSyntax) ** The name of the hub to delete. Type: String Pattern: `(arn:[a-z0-9-\.]{1,63}:sagemaker:\w+(?:-\w+)+:(\d{12}|aws):hub\/)?[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteHub) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteHub) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteHub) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteHub) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteHub) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteHub) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteHub) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteHub) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteHub) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteHub) # DeleteHubContent Delete the contents of a hub. ## Request Syntax ``` { "HubContentName": "string", "HubContentType": "string", "HubContentVersion": "string", "HubName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [HubContentName](#API_DeleteHubContent_RequestSyntax) ** The name of the content that you want to delete from a hub. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [HubContentType](#API_DeleteHubContent_RequestSyntax) ** The type of content that you want to delete from a hub. Type: String Valid Values: `Model | Notebook | ModelReference | DataSet | JsonDoc` Required: Yes ** [HubContentVersion](#API_DeleteHubContent_RequestSyntax) ** The version of the content that you want to delete from a hub. Type: String Length Constraints: Minimum length of 5. Maximum length of 14. Pattern: `\d{1,4}.\d{1,4}.\d{1,4}` Required: Yes ** [HubName](#API_DeleteHubContent_RequestSyntax) ** The name of the hub that you want to delete content in. Type: String Pattern: `(arn:[a-z0-9-\.]{1,63}:sagemaker:\w+(?:-\w+)+:(\d{12}|aws):hub\/)?[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteHubContent) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteHubContent) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteHubContent) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteHubContent) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteHubContent) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteHubContent) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteHubContent) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteHubContent) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteHubContent) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteHubContent) # DeleteHubContentReference Delete a hub content reference in order to remove a model from a private hub. ## Request Syntax ``` { "HubContentName": "string", "HubContentType": "string", "HubName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [HubContentName](#API_DeleteHubContentReference_RequestSyntax) ** The name of the hub content to delete. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [HubContentType](#API_DeleteHubContentReference_RequestSyntax) ** The type of hub content reference to delete. The only supported type of hub content reference to delete is `ModelReference`. Type: String Valid Values: `Model | Notebook | ModelReference | DataSet | JsonDoc` Required: Yes ** [HubName](#API_DeleteHubContentReference_RequestSyntax) ** The name of the hub to delete the hub content reference from. Type: String Pattern: `(arn:[a-z0-9-\.]{1,63}:sagemaker:\w+(?:-\w+)+:(\d{12}|aws):hub\/)?[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteHubContentReference) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteHubContentReference) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteHubContentReference) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteHubContentReference) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteHubContentReference) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteHubContentReference) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteHubContentReference) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteHubContentReference) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteHubContentReference) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteHubContentReference) # DeleteHumanTaskUi Use this operation to delete a human task user interface (worker task template). To see a list of human task user interfaces (work task templates) in your account, use [ListHumanTaskUis](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListHumanTaskUis.html). When you delete a worker task template, it no longer appears when you call `ListHumanTaskUis`. ## Request Syntax ``` { "HumanTaskUiName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [HumanTaskUiName](#API_DeleteHumanTaskUi_RequestSyntax) ** The name of the human task user interface (work task template) you want to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-z0-9](-*[a-z0-9])*` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteHumanTaskUi) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteHumanTaskUi) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteHumanTaskUi) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteHumanTaskUi) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteHumanTaskUi) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteHumanTaskUi) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteHumanTaskUi) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteHumanTaskUi) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteHumanTaskUi) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteHumanTaskUi) # DeleteHyperParameterTuningJob Deletes a hyperparameter tuning job. The `DeleteHyperParameterTuningJob` API deletes only the tuning job entry that was created in SageMaker when you called the `CreateHyperParameterTuningJob` API. It does not delete training jobs, artifacts, or the IAM role that you specified when creating the model. ## Request Syntax ``` { "HyperParameterTuningJobName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [HyperParameterTuningJobName](#API_DeleteHyperParameterTuningJob_RequestSyntax) ** The name of the hyperparameter tuning job that you want to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteHyperParameterTuningJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteHyperParameterTuningJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteHyperParameterTuningJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteHyperParameterTuningJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteHyperParameterTuningJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteHyperParameterTuningJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteHyperParameterTuningJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteHyperParameterTuningJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteHyperParameterTuningJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteHyperParameterTuningJob) # DeleteImage Deletes a SageMaker AI image and all versions of the image. The container images aren't deleted. ## Request Syntax ``` { "ImageName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ImageName](#API_DeleteImage_RequestSyntax) ** The name of the image to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteImage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteImage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteImage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteImage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteImage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteImage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteImage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteImage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteImage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteImage) # DeleteImageVersion Deletes a version of a SageMaker AI image. The container image the version represents isn't deleted. ## Request Syntax ``` { "Alias": "string", "ImageName": "string", "Version": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Alias](#API_DeleteImageVersion_RequestSyntax) ** The alias of the image to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `(?!^[.-])^([a-zA-Z0-9-_.]+)` Required: No ** [ImageName](#API_DeleteImageVersion_RequestSyntax) ** The name of the image to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}` Required: Yes ** [Version](#API_DeleteImageVersion_RequestSyntax) ** The version to delete. Type: Integer Valid Range: Minimum value of 0. Required: No ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteImageVersion) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteImageVersion) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteImageVersion) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteImageVersion) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteImageVersion) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteImageVersion) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteImageVersion) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteImageVersion) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteImageVersion) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteImageVersion) # DeleteInferenceComponent Deletes an inference component. ## Request Syntax ``` { "InferenceComponentName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [InferenceComponentName](#API_DeleteInferenceComponent_RequestSyntax) ** The name of the inference component to delete. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9]([\-a-zA-Z0-9]*[a-zA-Z0-9])?` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteInferenceComponent) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteInferenceComponent) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteInferenceComponent) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteInferenceComponent) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteInferenceComponent) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteInferenceComponent) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteInferenceComponent) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteInferenceComponent) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteInferenceComponent) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteInferenceComponent) # DeleteInferenceExperiment Deletes an inference experiment. **Note** This operation does not delete your endpoint, variants, or any underlying resources. This operation only deletes the metadata of your experiment. ## Request Syntax ``` { "Name": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Name](#API_DeleteInferenceExperiment_RequestSyntax) ** The name of the inference experiment you want to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` Required: Yes ## Response Syntax ``` { "InferenceExperimentArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [InferenceExperimentArn](#API_DeleteInferenceExperiment_ResponseSyntax) ** The ARN of the deleted inference experiment. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:inference-experiment/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteInferenceExperiment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteInferenceExperiment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteInferenceExperiment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteInferenceExperiment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteInferenceExperiment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteInferenceExperiment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteInferenceExperiment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteInferenceExperiment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteInferenceExperiment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteInferenceExperiment) # DeleteMlflowApp Deletes an MLflow App. ## Request Syntax ``` { "Arn": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Arn](#API_DeleteMlflowApp_RequestSyntax) ** The ARN of the MLflow App to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:mlflow-app/.*` Required: Yes ## Response Syntax ``` { "Arn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Arn](#API_DeleteMlflowApp_ResponseSyntax) ** The ARN of the deleted MLflow App. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:mlflow-app/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteMlflowApp) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteMlflowApp) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteMlflowApp) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteMlflowApp) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteMlflowApp) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteMlflowApp) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteMlflowApp) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteMlflowApp) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteMlflowApp) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteMlflowApp) # DeleteMlflowTrackingServer Deletes an MLflow Tracking Server. For more information, see [Clean up MLflow resources](https://docs.aws.amazon.com/sagemaker/latest/dg/mlflow-cleanup.html.html). ## Request Syntax ``` { "TrackingServerName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [TrackingServerName](#API_DeleteMlflowTrackingServer_RequestSyntax) ** The name of the the tracking server to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}` Required: Yes ## Response Syntax ``` { "TrackingServerArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [TrackingServerArn](#API_DeleteMlflowTrackingServer_ResponseSyntax) ** A `TrackingServerArn` object, the ARN of the tracking server that is deleted if successfully found. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:mlflow-tracking-server/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteMlflowTrackingServer) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteMlflowTrackingServer) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteMlflowTrackingServer) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteMlflowTrackingServer) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteMlflowTrackingServer) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteMlflowTrackingServer) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteMlflowTrackingServer) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteMlflowTrackingServer) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteMlflowTrackingServer) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteMlflowTrackingServer) # DeleteModel Deletes a model. The `DeleteModel` API deletes only the model entry that was created in 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. ## Request Syntax ``` { "ModelName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ModelName](#API_DeleteModel_RequestSyntax) ** The name of the model to delete. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9]([\-a-zA-Z0-9]*[a-zA-Z0-9])?` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteModel) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteModel) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteModel) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteModel) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteModel) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteModel) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteModel) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteModel) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteModel) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteModel) # DeleteModelBiasJobDefinition Deletes an Amazon SageMaker AI model bias job definition. ## Request Syntax ``` { "JobDefinitionName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [JobDefinitionName](#API_DeleteModelBiasJobDefinition_RequestSyntax) ** The name of the model bias job definition to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteModelBiasJobDefinition) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteModelBiasJobDefinition) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteModelBiasJobDefinition) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteModelBiasJobDefinition) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteModelBiasJobDefinition) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteModelBiasJobDefinition) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteModelBiasJobDefinition) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteModelBiasJobDefinition) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteModelBiasJobDefinition) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteModelBiasJobDefinition) # DeleteModelCard Deletes an Amazon SageMaker Model Card. ## Request Syntax ``` { "ModelCardName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ModelCardName](#API_DeleteModelCard_RequestSyntax) ** The name of the model card to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteModelCard) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteModelCard) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteModelCard) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteModelCard) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteModelCard) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteModelCard) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteModelCard) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteModelCard) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteModelCard) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteModelCard) # DeleteModelExplainabilityJobDefinition Deletes an Amazon SageMaker AI model explainability job definition. ## Request Syntax ``` { "JobDefinitionName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [JobDefinitionName](#API_DeleteModelExplainabilityJobDefinition_RequestSyntax) ** The name of the model explainability job definition to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteModelExplainabilityJobDefinition) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteModelExplainabilityJobDefinition) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteModelExplainabilityJobDefinition) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteModelExplainabilityJobDefinition) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteModelExplainabilityJobDefinition) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteModelExplainabilityJobDefinition) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteModelExplainabilityJobDefinition) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteModelExplainabilityJobDefinition) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteModelExplainabilityJobDefinition) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteModelExplainabilityJobDefinition) # DeleteModelPackage Deletes a model package. A model package is used to create SageMaker models or list on AWS Marketplace. Buyers can subscribe to model packages listed on AWS Marketplace to create models in SageMaker. ## Request Syntax ``` { "ModelPackageName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ModelPackageName](#API_DeleteModelPackage_RequestSyntax) ** The name or Amazon Resource Name (ARN) of the model package to delete. When you specify a name, the name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen). Type: String Length Constraints: Minimum length of 1. Maximum length of 176. 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 name of the model group to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 170. 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 name of the model group for which to delete the policy. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteModelPackageGroupPolicy) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteModelPackageGroupPolicy) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteModelPackageGroupPolicy) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteModelPackageGroupPolicy) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteModelPackageGroupPolicy) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteModelPackageGroupPolicy) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteModelPackageGroupPolicy) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteModelPackageGroupPolicy) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteModelPackageGroupPolicy) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteModelPackageGroupPolicy) # DeleteModelQualityJobDefinition Deletes the secified model quality monitoring job definition. ## Request Syntax ``` { "JobDefinitionName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [JobDefinitionName](#API_DeleteModelQualityJobDefinition_RequestSyntax) ** The name of the model quality monitoring job definition to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteModelQualityJobDefinition) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteModelQualityJobDefinition) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteModelQualityJobDefinition) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteModelQualityJobDefinition) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteModelQualityJobDefinition) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteModelQualityJobDefinition) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteModelQualityJobDefinition) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteModelQualityJobDefinition) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteModelQualityJobDefinition) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteModelQualityJobDefinition) # DeleteMonitoringSchedule 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. ## Request Syntax ``` { "MonitoringScheduleName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [MonitoringScheduleName](#API_DeleteMonitoringSchedule_RequestSyntax) ** The name of the monitoring schedule to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteMonitoringSchedule) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteMonitoringSchedule) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteMonitoringSchedule) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteMonitoringSchedule) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteMonitoringSchedule) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteMonitoringSchedule) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteMonitoringSchedule) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteMonitoringSchedule) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteMonitoringSchedule) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteMonitoringSchedule) # DeleteNotebookInstance Deletes an SageMaker AI notebook instance. Before you can delete a notebook instance, you must call the `StopNotebookInstance` API. **Important** When you delete a notebook instance, you lose all of your data. SageMaker AI removes the ML compute instance, and deletes the ML storage volume and the network interface associated with the notebook instance. ## Request Syntax ``` { "NotebookInstanceName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [NotebookInstanceName](#API_DeleteNotebookInstance_RequestSyntax) ** The name of the SageMaker AI notebook instance to delete. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9])*` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteNotebookInstance) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteNotebookInstance) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteNotebookInstance) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteNotebookInstance) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteNotebookInstance) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteNotebookInstance) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteNotebookInstance) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteNotebookInstance) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteNotebookInstance) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteNotebookInstance) # DeleteNotebookInstanceLifecycleConfig Deletes a notebook instance lifecycle configuration. ## Request Syntax ``` { "NotebookInstanceLifecycleConfigName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [NotebookInstanceLifecycleConfigName](#API_DeleteNotebookInstanceLifecycleConfig_RequestSyntax) ** The name of the lifecycle configuration to delete. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9])*` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteNotebookInstanceLifecycleConfig) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteNotebookInstanceLifecycleConfig) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteNotebookInstanceLifecycleConfig) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteNotebookInstanceLifecycleConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteNotebookInstanceLifecycleConfig) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteNotebookInstanceLifecycleConfig) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteNotebookInstanceLifecycleConfig) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteNotebookInstanceLifecycleConfig) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteNotebookInstanceLifecycleConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteNotebookInstanceLifecycleConfig) # DeleteOptimizationJob Deletes an optimization job. ## Request Syntax ``` { "OptimizationJobName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [OptimizationJobName](#API_DeleteOptimizationJob_RequestSyntax) ** The name that you assigned to the optimization job. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteOptimizationJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteOptimizationJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteOptimizationJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteOptimizationJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteOptimizationJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteOptimizationJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteOptimizationJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteOptimizationJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteOptimizationJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteOptimizationJob) # DeletePartnerApp Deletes a SageMaker Partner AI App. ## Request Syntax ``` { "Arn": "string", "ClientToken": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Arn](#API_DeletePartnerApp_RequestSyntax) ** The ARN of the SageMaker Partner AI App to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:partner-app\/app-[A-Z0-9]{12}` Required: Yes ** [ClientToken](#API_DeletePartnerApp_RequestSyntax) ** A unique token that guarantees that the call to this API is idempotent. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: `[a-zA-Z0-9-]+` Required: No ## Response Syntax ``` { "Arn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Arn](#API_DeletePartnerApp_ResponseSyntax) ** The ARN of the SageMaker Partner AI App that was deleted. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:partner-app\/app-[A-Z0-9]{12}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeletePartnerApp) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeletePartnerApp) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeletePartnerApp) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeletePartnerApp) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeletePartnerApp) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeletePartnerApp) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeletePartnerApp) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeletePartnerApp) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeletePartnerApp) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeletePartnerApp) # DeletePipeline Deletes a pipeline if there are no running instances of the pipeline. To delete a pipeline, you must stop all running instances of the pipeline using the `StopPipelineExecution` API. When you delete a pipeline, all instances of the pipeline are deleted. ## Request Syntax ``` { "ClientRequestToken": "string", "PipelineName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClientRequestToken](#API_DeletePipeline_RequestSyntax) ** A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time. Type: String Length Constraints: Minimum length of 32. Maximum length of 128. Required: Yes ** [PipelineName](#API_DeletePipeline_RequestSyntax) ** The name of the pipeline to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}` Required: Yes ## Response Syntax ``` { "PipelineArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [PipelineArn](#API_DeletePipeline_ResponseSyntax) ** The Amazon Resource Name (ARN) of the pipeline to delete. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:pipeline/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeletePipeline) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeletePipeline) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeletePipeline) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeletePipeline) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeletePipeline) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeletePipeline) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeletePipeline) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeletePipeline) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeletePipeline) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeletePipeline) # DeleteProcessingJob Deletes a processing job. After Amazon SageMaker deletes a processing job, all of the metadata for the processing job is lost. You can delete only processing jobs that are in a terminal state (`Stopped`, `Failed`, or `Completed`). You cannot delete a job that is in the `InProgress` or `Stopping` state. After deleting the job, you can reuse its name to create another processing job. ## Request Syntax ``` { "ProcessingJobName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ProcessingJobName](#API_DeleteProcessingJob_RequestSyntax) ** The name of the processing job to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteProcessingJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteProcessingJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteProcessingJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteProcessingJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteProcessingJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteProcessingJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteProcessingJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteProcessingJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteProcessingJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteProcessingJob) # DeleteProject Delete the specified project. ## Request Syntax ``` { "ProjectName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ProjectName](#API_DeleteProject_RequestSyntax) ** The name of the project to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteProject) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteProject) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteProject) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteProject) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteProject) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteProject) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteProject) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteProject) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteProject) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteProject) # DeleteSpace Used to delete a space. ## Request Syntax ``` { "DomainId": "string", "SpaceName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DomainId](#API_DeleteSpace_RequestSyntax) ** The ID of the associated domain. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `d-(-*[a-z0-9]){1,61}` Required: Yes ** [SpaceName](#API_DeleteSpace_RequestSyntax) ** The name of the space. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteSpace) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteSpace) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteSpace) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteSpace) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteSpace) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteSpace) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteSpace) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteSpace) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteSpace) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteSpace) # DeleteStudioLifecycleConfig Deletes the Amazon SageMaker AI Studio Lifecycle Configuration. In order to delete the Lifecycle Configuration, there must be no running apps using the Lifecycle Configuration. You must also remove the Lifecycle Configuration from UserSettings in all Domains and UserProfiles. ## Request Syntax ``` { "StudioLifecycleConfigName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [StudioLifecycleConfigName](#API_DeleteStudioLifecycleConfig_RequestSyntax) ** The name of the Amazon SageMaker AI Studio Lifecycle Configuration to delete. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteStudioLifecycleConfig) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteStudioLifecycleConfig) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteStudioLifecycleConfig) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteStudioLifecycleConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteStudioLifecycleConfig) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteStudioLifecycleConfig) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteStudioLifecycleConfig) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteStudioLifecycleConfig) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteStudioLifecycleConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteStudioLifecycleConfig) # DeleteTags Deletes the specified tags from an SageMaker resource. To list a resource's tags, use the `ListTags` API. **Note** 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. **Note** When you call this API to delete tags from a SageMaker Domain or User Profile, the deleted tags are not removed from Apps that the SageMaker Domain or User Profile launched before you called this API. ## Request Syntax ``` { "ResourceArn": "string", "TagKeys": [ "string" ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ResourceArn](#API_DeleteTags_RequestSyntax) ** The Amazon Resource Name (ARN) of the resource whose tags you want to delete. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z-]*:sagemaker:[a-z0-9-]*:[0-9]{12}:.+` Required: Yes ** [TagKeys](#API_DeleteTags_RequestSyntax) ** An array or one or more tag keys to delete. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 50 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteTags) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteTags) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteTags) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteTags) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteTags) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteTags) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteTags) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteTags) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteTags) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteTags) # DeleteTrainingJob Deletes a training job. After SageMaker deletes a training job, all of the metadata for the training job is lost. You can delete only training jobs that are in a terminal state (`Stopped`, `Failed`, or `Completed`) and don't retain an `Available` [managed warm pool](https://docs.aws.amazon.com/sagemaker/latest/dg/train-warm-pools.html). You cannot delete a job that is in the `InProgress` or `Stopping` state. After deleting the job, you can reuse its name to create another training job. ## Request Syntax ``` { "TrainingJobName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [TrainingJobName](#API_DeleteTrainingJob_RequestSyntax) ** The name of the training job to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteTrainingJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteTrainingJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteTrainingJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteTrainingJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteTrainingJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteTrainingJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteTrainingJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteTrainingJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteTrainingJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteTrainingJob) # DeleteTrial Deletes the specified trial. All trial components that make up the trial must be deleted first. Use the [DescribeTrialComponent](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrialComponent.html) API to get the list of trial components. ## Request Syntax ``` { "TrialName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [TrialName](#API_DeleteTrial_RequestSyntax) ** The name of the trial to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` Required: Yes ## Response Syntax ``` { "TrialArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [TrialArn](#API_DeleteTrial_ResponseSyntax) ** The Amazon Resource Name (ARN) of the trial that is being deleted. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:experiment-trial/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteTrial) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteTrial) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteTrial) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteTrial) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteTrial) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteTrial) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteTrial) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteTrial) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteTrial) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteTrial) # DeleteTrialComponent 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](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DisassociateTrialComponent.html) API. ## Request Syntax ``` { "TrialComponentName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [TrialComponentName](#API_DeleteTrialComponent_RequestSyntax) ** The name of the component to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` Required: Yes ## Response Syntax ``` { "TrialComponentArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [TrialComponentArn](#API_DeleteTrialComponent_ResponseSyntax) ** The Amazon Resource Name (ARN) of the component is being deleted. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:experiment-trial-component/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteTrialComponent) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteTrialComponent) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteTrialComponent) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteTrialComponent) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteTrialComponent) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteTrialComponent) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteTrialComponent) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteTrialComponent) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteTrialComponent) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteTrialComponent) # DeleteUserProfile Deletes a user profile. When a user profile is deleted, the user loses access to their EFS volume, including data, notebooks, and other artifacts. ## Request Syntax ``` { "DomainId": "string", "UserProfileName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DomainId](#API_DeleteUserProfile_RequestSyntax) ** The domain ID. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `d-(-*[a-z0-9]){1,61}` Required: Yes ** [UserProfileName](#API_DeleteUserProfile_RequestSyntax) ** The user profile name. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteUserProfile) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteUserProfile) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteUserProfile) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteUserProfile) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteUserProfile) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteUserProfile) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteUserProfile) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteUserProfile) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteUserProfile) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteUserProfile) # DeleteWorkforce 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 [CreateWorkforce](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateWorkforce.html) to create a new workforce. **Important** If a private workforce contains one or more work teams, you must use the [DeleteWorkteam](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteWorkteam.html) operation to delete all work teams before you delete the workforce. If you try to delete a workforce that contains one or more work teams, you will receive a `ResourceInUse` error. ## Request Syntax ``` { "WorkforceName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [WorkforceName](#API_DeleteWorkforce_RequestSyntax) ** The name of the workforce. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9]([a-zA-Z0-9\-]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteWorkforce) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteWorkforce) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteWorkforce) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteWorkforce) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteWorkforce) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteWorkforce) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteWorkforce) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteWorkforce) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteWorkforce) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteWorkforce) # DeleteWorkteam Deletes an existing work team. This operation can't be undone. ## Request Syntax ``` { "WorkteamName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [WorkteamName](#API_DeleteWorkteam_RequestSyntax) ** The name of the work team to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "Success": boolean } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Success](#API_DeleteWorkteam_ResponseSyntax) ** Returns `true` if the work team was successfully deleted; otherwise, returns `false`. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeleteWorkteam) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeleteWorkteam) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeleteWorkteam) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeleteWorkteam) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeleteWorkteam) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeleteWorkteam) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeleteWorkteam) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeleteWorkteam) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeleteWorkteam) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeleteWorkteam) # DeregisterDevices Deregisters the specified devices. After you deregister a device, you will need to re-register the devices. ## Request Syntax ``` { "DeviceFleetName": "string", "DeviceNames": [ "string" ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DeviceFleetName](#API_DeregisterDevices_RequestSyntax) ** The name of the fleet the devices belong to. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [DeviceNames](#API_DeregisterDevices_RequestSyntax) ** The unique IDs of the devices. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DeregisterDevices) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DeregisterDevices) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DeregisterDevices) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DeregisterDevices) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DeregisterDevices) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DeregisterDevices) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DeregisterDevices) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DeregisterDevices) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DeregisterDevices) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DeregisterDevices) # DescribeAction Describes an action. ## Request Syntax ``` { "ActionName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ActionName](#API_DescribeAction_RequestSyntax) ** The name of the action to describe. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:(experiment|experiment-trial|experiment-trial-component|artifact|action|context)\/)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,119})` Required: Yes ## Response Syntax ``` { "ActionArn": "string", "ActionName": "string", "ActionType": "string", "CreatedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "Description": "string", "LastModifiedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "LineageGroupArn": "string", "MetadataProperties": { "CommitId": "string", "GeneratedBy": "string", "ProjectId": "string", "Repository": "string" }, "Properties": { "string" : "string" }, "Source": { "SourceId": "string", "SourceType": "string", "SourceUri": "string" }, "Status": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ActionArn](#API_DescribeAction_ResponseSyntax) ** The Amazon Resource Name (ARN) of the action. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:action/.*` ** [ActionName](#API_DescribeAction_ResponseSyntax) ** The name of the action. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:(experiment|experiment-trial|experiment-trial-component|artifact|action|context)\/)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,119})` ** [ActionType](#API_DescribeAction_ResponseSyntax) ** The type of the action. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. ** [CreatedBy](#API_DescribeAction_ResponseSyntax) ** Information about the user who created or modified a SageMaker resource. Type: [UserContext](API_UserContext.md) object ** [CreationTime](#API_DescribeAction_ResponseSyntax) ** When the action was created. Type: Timestamp ** [Description](#API_DescribeAction_ResponseSyntax) ** The description of the action. Type: String Length Constraints: Minimum length of 0. Maximum length of 3072. Pattern: `.*` ** [LastModifiedBy](#API_DescribeAction_ResponseSyntax) ** Information about the user who created or modified a SageMaker resource. Type: [UserContext](API_UserContext.md) object ** [LastModifiedTime](#API_DescribeAction_ResponseSyntax) ** When the action was last modified. Type: Timestamp ** [LineageGroupArn](#API_DescribeAction_ResponseSyntax) ** The Amazon Resource Name (ARN) of the lineage group. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:lineage-group/.*` ** [MetadataProperties](#API_DescribeAction_ResponseSyntax) ** Metadata properties of the tracking entity, trial, or trial component. Type: [MetadataProperties](API_MetadataProperties.md) object ** [Properties](#API_DescribeAction_ResponseSyntax) ** A list of the action's properties. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 30 items. Key Length Constraints: Minimum length of 0. Maximum length of 2500. Key Pattern: `.*` Value Length Constraints: Minimum length of 0. Maximum length of 2500. Value Pattern: `.*` ** [Source](#API_DescribeAction_ResponseSyntax) ** The source of the action. Type: [ActionSource](API_ActionSource.md) object ** [Status](#API_DescribeAction_ResponseSyntax) ** The status of the action. Type: String Valid Values: `Unknown | InProgress | Completed | Failed | Stopping | Stopped` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeAction) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeAction) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeAction) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeAction) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeAction) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeAction) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeAction) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeAction) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeAction) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeAction) # DescribeAlgorithm Returns a description of the specified algorithm that is in your account. ## Request Syntax ``` { "AlgorithmName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AlgorithmName](#API_DescribeAlgorithm_RequestSyntax) ** The name of the algorithm to describe. Type: String Length Constraints: Minimum length of 1. Maximum length of 170. 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 Amazon Resource Name (ARN) of the algorithm. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:algorithm/[\S]{1,2048}` ** [AlgorithmDescription](#API_DescribeAlgorithm_ResponseSyntax) ** A brief summary about the algorithm. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*` ** [AlgorithmName](#API_DescribeAlgorithm_ResponseSyntax) ** The name of the algorithm being described. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [AlgorithmStatus](#API_DescribeAlgorithm_ResponseSyntax) ** The current status of the algorithm. Type: String Valid Values: `Pending | InProgress | Completed | Failed | Deleting` ** [AlgorithmStatusDetails](#API_DescribeAlgorithm_ResponseSyntax) ** Details about the current status of the algorithm. Type: [AlgorithmStatusDetails](API_AlgorithmStatusDetails.md) object ** [CertifyForMarketplace](#API_DescribeAlgorithm_ResponseSyntax) ** Whether the algorithm is certified to be listed in AWS Marketplace. Type: Boolean ** [CreationTime](#API_DescribeAlgorithm_ResponseSyntax) ** A timestamp specifying when the algorithm was created. Type: Timestamp ** [InferenceSpecification](#API_DescribeAlgorithm_ResponseSyntax) ** Details about inference jobs that the algorithm runs. Type: [InferenceSpecification](API_InferenceSpecification.md) object ** [ProductId](#API_DescribeAlgorithm_ResponseSyntax) ** The product identifier of the algorithm. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9])*` ** [TrainingSpecification](#API_DescribeAlgorithm_ResponseSyntax) ** Details about training jobs run by this algorithm. Type: [TrainingSpecification](API_TrainingSpecification.md) object ** [ValidationSpecification](#API_DescribeAlgorithm_ResponseSyntax) ** Details about configurations for one or more training jobs that SageMaker runs to test the algorithm. Type: [AlgorithmValidationSpecification](API_AlgorithmValidationSpecification.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeAlgorithm) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeAlgorithm) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeAlgorithm) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeAlgorithm) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeAlgorithm) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeAlgorithm) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeAlgorithm) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeAlgorithm) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeAlgorithm) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeAlgorithm) # DescribeApp Describes the app. ## Request Syntax ``` { "AppName": "string", "AppType": "string", "DomainId": "string", "SpaceName": "string", "UserProfileName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AppName](#API_DescribeApp_RequestSyntax) ** The name of the app. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [AppType](#API_DescribeApp_RequestSyntax) ** The type of app. Type: String Valid Values: `JupyterServer | KernelGateway` Required: Yes ** [DomainId](#API_DescribeApp_RequestSyntax) ** The domain ID. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `d-(-*[a-z0-9]){1,61}` Required: Yes ** [SpaceName](#API_DescribeApp_RequestSyntax) ** The name of the space. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: No ** [UserProfileName](#API_DescribeApp_RequestSyntax) ** The user profile name. If this value is not set, then `SpaceName` must be set. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: No ## Response Syntax ``` { "AppArn": "string", "AppName": "string", "AppType": "string", "BuiltInLifecycleConfigArn": "string", "CreationTime": number, "DomainId": "string", "EffectiveTrustedIdentityPropagationStatus": "string", "FailureReason": "string", "LastHealthCheckTimestamp": number, "LastUserActivityTimestamp": number, "RecoveryMode": boolean, "ResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" }, "SpaceName": "string", "Status": "string", "UserProfileName": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AppArn](#API_DescribeApp_ResponseSyntax) ** The Amazon Resource Name (ARN) of the app. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:app/.*` ** [AppName](#API_DescribeApp_ResponseSyntax) ** The name of the app. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [AppType](#API_DescribeApp_ResponseSyntax) ** The type of app. Type: String Valid Values: `JupyterServer | KernelGateway` ** [BuiltInLifecycleConfigArn](#API_DescribeApp_ResponseSyntax) ** The lifecycle configuration that runs before the default lifecycle configuration Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:studio-lifecycle-config/.*|None)` ** [CreationTime](#API_DescribeApp_ResponseSyntax) ** The creation time of the application. After an application has been shut down for 24 hours, SageMaker AI deletes all metadata for the application. To be considered an update and retain application metadata, applications must be restarted within 24 hours after the previous application has been shut down. After this time window, creation of an application is considered a new application rather than an update of the previous application. Type: Timestamp ** [DomainId](#API_DescribeApp_ResponseSyntax) ** The domain ID. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `d-(-*[a-z0-9]){1,61}` ** [EffectiveTrustedIdentityPropagationStatus](#API_DescribeApp_ResponseSyntax) ** The effective status of Trusted Identity Propagation (TIP) for this application. When enabled, user identities from IAM Identity Center are being propagated through the application to TIP enabled AWS services. When disabled, standard IAM role-based access is used. Type: String Valid Values: `ENABLED | DISABLED` ** [FailureReason](#API_DescribeApp_ResponseSyntax) ** The failure reason. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. ** [LastHealthCheckTimestamp](#API_DescribeApp_ResponseSyntax) ** The timestamp of the last health check. Type: Timestamp ** [LastUserActivityTimestamp](#API_DescribeApp_ResponseSyntax) ** The timestamp of the last user's activity. `LastUserActivityTimestamp` is also updated when SageMaker AI performs health checks without user activity. As a result, this value is set to the same value as `LastHealthCheckTimestamp`. Type: Timestamp ** [RecoveryMode](#API_DescribeApp_ResponseSyntax) ** Indicates whether the application is launched in recovery mode. Type: Boolean ** [ResourceSpec](#API_DescribeApp_ResponseSyntax) ** The instance type and the Amazon Resource Name (ARN) of the SageMaker AI image created on the instance. Type: [ResourceSpec](API_ResourceSpec.md) object ** [SpaceName](#API_DescribeApp_ResponseSyntax) ** The name of the space. If this value is not set, then `UserProfileName` must be set. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [Status](#API_DescribeApp_ResponseSyntax) ** The status. Type: String Valid Values: `Deleted | Deleting | Failed | InService | Pending` ** [UserProfileName](#API_DescribeApp_ResponseSyntax) ** The user profile name. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeApp) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeApp) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeApp) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeApp) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeApp) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeApp) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeApp) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeApp) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeApp) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeApp) # DescribeAppImageConfig Describes an AppImageConfig. ## Request Syntax ``` { "AppImageConfigName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AppImageConfigName](#API_DescribeAppImageConfig_RequestSyntax) ** The name of the AppImageConfig to describe. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "AppImageConfigArn": "string", "AppImageConfigName": "string", "CodeEditorAppImageConfig": { "ContainerConfig": { "ContainerArguments": [ "string" ], "ContainerEntrypoint": [ "string" ], "ContainerEnvironmentVariables": { "string" : "string" } }, "FileSystemConfig": { "DefaultGid": number, "DefaultUid": number, "MountPath": "string" } }, "CreationTime": number, "JupyterLabAppImageConfig": { "ContainerConfig": { "ContainerArguments": [ "string" ], "ContainerEntrypoint": [ "string" ], "ContainerEnvironmentVariables": { "string" : "string" } }, "FileSystemConfig": { "DefaultGid": number, "DefaultUid": number, "MountPath": "string" } }, "KernelGatewayImageConfig": { "FileSystemConfig": { "DefaultGid": number, "DefaultUid": number, "MountPath": "string" }, "KernelSpecs": [ { "DisplayName": "string", "Name": "string" } ] }, "LastModifiedTime": number } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AppImageConfigArn](#API_DescribeAppImageConfig_ResponseSyntax) ** The ARN of the AppImageConfig. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:app-image-config/.*` ** [AppImageConfigName](#API_DescribeAppImageConfig_ResponseSyntax) ** The name of the AppImageConfig. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [CodeEditorAppImageConfig](#API_DescribeAppImageConfig_ResponseSyntax) ** The configuration of the Code Editor app. Type: [CodeEditorAppImageConfig](API_CodeEditorAppImageConfig.md) object ** [CreationTime](#API_DescribeAppImageConfig_ResponseSyntax) ** When the AppImageConfig was created. Type: Timestamp ** [JupyterLabAppImageConfig](#API_DescribeAppImageConfig_ResponseSyntax) ** The configuration of the JupyterLab app. Type: [JupyterLabAppImageConfig](API_JupyterLabAppImageConfig.md) object ** [KernelGatewayImageConfig](#API_DescribeAppImageConfig_ResponseSyntax) ** The configuration of a KernelGateway app. Type: [KernelGatewayImageConfig](API_KernelGatewayImageConfig.md) object ** [LastModifiedTime](#API_DescribeAppImageConfig_ResponseSyntax) ** When the AppImageConfig was last modified. Type: Timestamp ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeAppImageConfig) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeAppImageConfig) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeAppImageConfig) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeAppImageConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeAppImageConfig) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeAppImageConfig) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeAppImageConfig) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeAppImageConfig) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeAppImageConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeAppImageConfig) # DescribeArtifact Describes an artifact. ## Request Syntax ``` { "ArtifactArn": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ArtifactArn](#API_DescribeArtifact_RequestSyntax) ** The Amazon Resource Name (ARN) of the artifact to describe. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:artifact/.*` Required: Yes ## Response Syntax ``` { "ArtifactArn": "string", "ArtifactName": "string", "ArtifactType": "string", "CreatedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "LastModifiedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "LineageGroupArn": "string", "MetadataProperties": { "CommitId": "string", "GeneratedBy": "string", "ProjectId": "string", "Repository": "string" }, "Properties": { "string" : "string" }, "Source": { "SourceTypes": [ { "SourceIdType": "string", "Value": "string" } ], "SourceUri": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ArtifactArn](#API_DescribeArtifact_ResponseSyntax) ** The Amazon Resource Name (ARN) of the artifact. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:artifact/.*` ** [ArtifactName](#API_DescribeArtifact_ResponseSyntax) ** The name of the artifact. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:(experiment|experiment-trial|experiment-trial-component|artifact|action|context)\/)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,119})` ** [ArtifactType](#API_DescribeArtifact_ResponseSyntax) ** The type of the artifact. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. ** [CreatedBy](#API_DescribeArtifact_ResponseSyntax) ** Information about the user who created or modified a SageMaker resource. Type: [UserContext](API_UserContext.md) object ** [CreationTime](#API_DescribeArtifact_ResponseSyntax) ** When the artifact was created. Type: Timestamp ** [LastModifiedBy](#API_DescribeArtifact_ResponseSyntax) ** Information about the user who created or modified a SageMaker resource. Type: [UserContext](API_UserContext.md) object ** [LastModifiedTime](#API_DescribeArtifact_ResponseSyntax) ** When the artifact was last modified. Type: Timestamp ** [LineageGroupArn](#API_DescribeArtifact_ResponseSyntax) ** The Amazon Resource Name (ARN) of the lineage group. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:lineage-group/.*` ** [MetadataProperties](#API_DescribeArtifact_ResponseSyntax) ** Metadata properties of the tracking entity, trial, or trial component. Type: [MetadataProperties](API_MetadataProperties.md) object ** [Properties](#API_DescribeArtifact_ResponseSyntax) ** A list of the artifact's properties. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 30 items. Key Length Constraints: Minimum length of 0. Maximum length of 2500. Key Pattern: `.*` Value Length Constraints: Minimum length of 0. Maximum length of 2500. Value Pattern: `.*` ** [Source](#API_DescribeArtifact_ResponseSyntax) ** The source of the artifact. Type: [ArtifactSource](API_ArtifactSource.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeArtifact) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeArtifact) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeArtifact) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeArtifact) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeArtifact) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeArtifact) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeArtifact) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeArtifact) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeArtifact) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeArtifact) # DescribeAutoMLJob Returns information about an AutoML job created by calling [CreateAutoMLJob](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJob.html). **Note** AutoML jobs created by calling [CreateAutoMLJobV2](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html) cannot be described by `DescribeAutoMLJob`. ## Request Syntax ``` { "AutoMLJobName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AutoMLJobName](#API_DescribeAutoMLJob_RequestSyntax) ** Requests information about an AutoML job using its unique name. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}` Required: Yes ## Response Syntax ``` { "AutoMLJobArn": "string", "AutoMLJobArtifacts": { "CandidateDefinitionNotebookLocation": "string", "DataExplorationNotebookLocation": "string" }, "AutoMLJobConfig": { "CandidateGenerationConfig": { "AlgorithmsConfig": [ { "AutoMLAlgorithms": [ "string" ] } ], "FeatureSpecificationS3Uri": "string" }, "CompletionCriteria": { "MaxAutoMLJobRuntimeInSeconds": number, "MaxCandidates": number, "MaxRuntimePerTrainingJobInSeconds": number }, "DataSplitConfig": { "ValidationFraction": number }, "Mode": "string", "SecurityConfig": { "EnableInterContainerTrafficEncryption": boolean, "VolumeKmsKeyId": "string", "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } } }, "AutoMLJobName": "string", "AutoMLJobObjective": { "MetricName": "string" }, "AutoMLJobSecondaryStatus": "string", "AutoMLJobStatus": "string", "BestCandidate": { "CandidateName": "string", "CandidateProperties": { "CandidateArtifactLocations": { "BacktestResults": "string", "Explainability": "string", "ModelInsights": "string" }, "CandidateMetrics": [ { "MetricName": "string", "Set": "string", "StandardMetricName": "string", "Value": number } ] }, "CandidateStatus": "string", "CandidateSteps": [ { "CandidateStepArn": "string", "CandidateStepName": "string", "CandidateStepType": "string" } ], "CreationTime": number, "EndTime": number, "FailureReason": "string", "FinalAutoMLJobObjectiveMetric": { "MetricName": "string", "StandardMetricName": "string", "Type": "string", "Value": number }, "InferenceContainerDefinitions": { "string" : [ { "Environment": { "string" : "string" }, "Image": "string", "ModelDataUrl": "string" } ] }, "InferenceContainers": [ { "Environment": { "string" : "string" }, "Image": "string", "ModelDataUrl": "string" } ], "LastModifiedTime": number, "ObjectiveStatus": "string" }, "CreationTime": number, "EndTime": number, "FailureReason": "string", "GenerateCandidateDefinitionsOnly": boolean, "InputDataConfig": [ { "ChannelType": "string", "CompressionType": "string", "ContentType": "string", "DataSource": { "S3DataSource": { "S3DataType": "string", "S3Uri": "string" } }, "SampleWeightAttributeName": "string", "TargetAttributeName": "string" } ], "LastModifiedTime": number, "ModelDeployConfig": { "AutoGenerateEndpointName": boolean, "EndpointName": "string" }, "ModelDeployResult": { "EndpointName": "string" }, "OutputDataConfig": { "KmsKeyId": "string", "S3OutputPath": "string" }, "PartialFailureReasons": [ { "PartialFailureMessage": "string" } ], "ProblemType": "string", "ResolvedAttributes": { "AutoMLJobObjective": { "MetricName": "string" }, "CompletionCriteria": { "MaxAutoMLJobRuntimeInSeconds": number, "MaxCandidates": number, "MaxRuntimePerTrainingJobInSeconds": number }, "ProblemType": "string" }, "RoleArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AutoMLJobArn](#API_DescribeAutoMLJob_ResponseSyntax) ** Returns the ARN of the AutoML job. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:automl-job/.*` ** [AutoMLJobArtifacts](#API_DescribeAutoMLJob_ResponseSyntax) ** Returns information on the job's artifacts found in `AutoMLJobArtifacts`. Type: [AutoMLJobArtifacts](API_AutoMLJobArtifacts.md) object ** [AutoMLJobConfig](#API_DescribeAutoMLJob_ResponseSyntax) ** Returns the configuration for the AutoML job. Type: [AutoMLJobConfig](API_AutoMLJobConfig.md) object ** [AutoMLJobName](#API_DescribeAutoMLJob_ResponseSyntax) ** Returns the name of the AutoML job. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}` ** [AutoMLJobObjective](#API_DescribeAutoMLJob_ResponseSyntax) ** Returns the job's objective. Type: [AutoMLJobObjective](API_AutoMLJobObjective.md) object ** [AutoMLJobSecondaryStatus](#API_DescribeAutoMLJob_ResponseSyntax) ** Returns the secondary status of the AutoML job. Type: String Valid Values: `Starting | MaxCandidatesReached | Failed | Stopped | MaxAutoMLJobRuntimeReached | Stopping | CandidateDefinitionsGenerated | Completed | ExplainabilityError | DeployingModel | ModelDeploymentError | GeneratingModelInsightsReport | ModelInsightsError | AnalyzingData | FeatureEngineering | ModelTuning | GeneratingExplainabilityReport | TrainingModels | PreTraining` ** [AutoMLJobStatus](#API_DescribeAutoMLJob_ResponseSyntax) ** Returns the status of the AutoML job. Type: String Valid Values: `Completed | InProgress | Failed | Stopped | Stopping` ** [BestCandidate](#API_DescribeAutoMLJob_ResponseSyntax) ** The best model candidate selected by SageMaker AI Autopilot using both the best objective metric and lowest [InferenceLatency](https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-metrics-validation.html) for an experiment. Type: [AutoMLCandidate](API_AutoMLCandidate.md) object ** [CreationTime](#API_DescribeAutoMLJob_ResponseSyntax) ** Returns the creation time of the AutoML job. Type: Timestamp ** [EndTime](#API_DescribeAutoMLJob_ResponseSyntax) ** Returns the end time of the AutoML job. Type: Timestamp ** [FailureReason](#API_DescribeAutoMLJob_ResponseSyntax) ** Returns the failure reason for an AutoML job, when applicable. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. ** [GenerateCandidateDefinitionsOnly](#API_DescribeAutoMLJob_ResponseSyntax) ** Indicates whether the output for an AutoML job generates candidate definitions only. Type: Boolean ** [InputDataConfig](#API_DescribeAutoMLJob_ResponseSyntax) ** Returns the input data configuration for the AutoML job. Type: Array of [AutoMLChannel](API_AutoMLChannel.md) objects Array Members: Minimum number of 1 item. Maximum number of 2 items. ** [LastModifiedTime](#API_DescribeAutoMLJob_ResponseSyntax) ** Returns the job's last modified time. Type: Timestamp ** [ModelDeployConfig](#API_DescribeAutoMLJob_ResponseSyntax) ** Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically. Type: [ModelDeployConfig](API_ModelDeployConfig.md) object ** [ModelDeployResult](#API_DescribeAutoMLJob_ResponseSyntax) ** Provides information about endpoint for the model deployment. Type: [ModelDeployResult](API_ModelDeployResult.md) object ** [OutputDataConfig](#API_DescribeAutoMLJob_ResponseSyntax) ** Returns the job's output data config. Type: [AutoMLOutputDataConfig](API_AutoMLOutputDataConfig.md) object ** [PartialFailureReasons](#API_DescribeAutoMLJob_ResponseSyntax) ** Returns a list of reasons for partial failures within an AutoML job. Type: Array of [AutoMLPartialFailureReason](API_AutoMLPartialFailureReason.md) objects Array Members: Minimum number of 1 item. Maximum number of 5 items. ** [ProblemType](#API_DescribeAutoMLJob_ResponseSyntax) ** Returns the job's problem type. Type: String Valid Values: `BinaryClassification | MulticlassClassification | Regression` ** [ResolvedAttributes](#API_DescribeAutoMLJob_ResponseSyntax) ** Contains `ProblemType`, `AutoMLJobObjective`, and `CompletionCriteria`. If you do not provide these values, they are inferred. Type: [ResolvedAttributes](API_ResolvedAttributes.md) object ** [RoleArn](#API_DescribeAutoMLJob_ResponseSyntax) ** The ARN of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeAutoMLJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeAutoMLJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeAutoMLJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeAutoMLJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeAutoMLJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeAutoMLJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeAutoMLJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeAutoMLJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeAutoMLJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeAutoMLJob) # DescribeAutoMLJobV2 Returns information about an AutoML job created by calling [CreateAutoMLJobV2](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html) or [CreateAutoMLJob](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJob.html). ## Request Syntax ``` { "AutoMLJobName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AutoMLJobName](#API_DescribeAutoMLJobV2_RequestSyntax) ** Requests information about an AutoML job V2 using its unique name. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}` Required: Yes ## Response Syntax ``` { "AutoMLComputeConfig": { "EmrServerlessComputeConfig": { "ExecutionRoleARN": "string" } }, "AutoMLJobArn": "string", "AutoMLJobArtifacts": { "CandidateDefinitionNotebookLocation": "string", "DataExplorationNotebookLocation": "string" }, "AutoMLJobInputDataConfig": [ { "ChannelType": "string", "CompressionType": "string", "ContentType": "string", "DataSource": { "S3DataSource": { "S3DataType": "string", "S3Uri": "string" } } } ], "AutoMLJobName": "string", "AutoMLJobObjective": { "MetricName": "string" }, "AutoMLJobSecondaryStatus": "string", "AutoMLJobStatus": "string", "AutoMLProblemTypeConfig": { ... }, "AutoMLProblemTypeConfigName": "string", "BestCandidate": { "CandidateName": "string", "CandidateProperties": { "CandidateArtifactLocations": { "BacktestResults": "string", "Explainability": "string", "ModelInsights": "string" }, "CandidateMetrics": [ { "MetricName": "string", "Set": "string", "StandardMetricName": "string", "Value": number } ] }, "CandidateStatus": "string", "CandidateSteps": [ { "CandidateStepArn": "string", "CandidateStepName": "string", "CandidateStepType": "string" } ], "CreationTime": number, "EndTime": number, "FailureReason": "string", "FinalAutoMLJobObjectiveMetric": { "MetricName": "string", "StandardMetricName": "string", "Type": "string", "Value": number }, "InferenceContainerDefinitions": { "string" : [ { "Environment": { "string" : "string" }, "Image": "string", "ModelDataUrl": "string" } ] }, "InferenceContainers": [ { "Environment": { "string" : "string" }, "Image": "string", "ModelDataUrl": "string" } ], "LastModifiedTime": number, "ObjectiveStatus": "string" }, "CreationTime": number, "DataSplitConfig": { "ValidationFraction": number }, "EndTime": number, "FailureReason": "string", "LastModifiedTime": number, "ModelDeployConfig": { "AutoGenerateEndpointName": boolean, "EndpointName": "string" }, "ModelDeployResult": { "EndpointName": "string" }, "OutputDataConfig": { "KmsKeyId": "string", "S3OutputPath": "string" }, "PartialFailureReasons": [ { "PartialFailureMessage": "string" } ], "ResolvedAttributes": { "AutoMLJobObjective": { "MetricName": "string" }, "AutoMLProblemTypeResolvedAttributes": { ... }, "CompletionCriteria": { "MaxAutoMLJobRuntimeInSeconds": number, "MaxCandidates": number, "MaxRuntimePerTrainingJobInSeconds": number } }, "RoleArn": "string", "SecurityConfig": { "EnableInterContainerTrafficEncryption": boolean, "VolumeKmsKeyId": "string", "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AutoMLComputeConfig](#API_DescribeAutoMLJobV2_ResponseSyntax) ** The compute configuration used for the AutoML job V2. Type: [AutoMLComputeConfig](API_AutoMLComputeConfig.md) object ** [AutoMLJobArn](#API_DescribeAutoMLJobV2_ResponseSyntax) ** Returns the Amazon Resource Name (ARN) of the AutoML job V2. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:automl-job/.*` ** [AutoMLJobArtifacts](#API_DescribeAutoMLJobV2_ResponseSyntax) ** The artifacts that are generated during an AutoML job. Type: [AutoMLJobArtifacts](API_AutoMLJobArtifacts.md) object ** [AutoMLJobInputDataConfig](#API_DescribeAutoMLJobV2_ResponseSyntax) ** Returns an array of channel objects describing the input data and their location. Type: Array of [AutoMLJobChannel](API_AutoMLJobChannel.md) objects Array Members: Minimum number of 1 item. Maximum number of 2 items. ** [AutoMLJobName](#API_DescribeAutoMLJobV2_ResponseSyntax) ** Returns the name of the AutoML job V2. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}` ** [AutoMLJobObjective](#API_DescribeAutoMLJobV2_ResponseSyntax) ** Returns the job's objective. Type: [AutoMLJobObjective](API_AutoMLJobObjective.md) object ** [AutoMLJobSecondaryStatus](#API_DescribeAutoMLJobV2_ResponseSyntax) ** Returns the secondary status of the AutoML job V2. Type: String Valid Values: `Starting | MaxCandidatesReached | Failed | Stopped | MaxAutoMLJobRuntimeReached | Stopping | CandidateDefinitionsGenerated | Completed | ExplainabilityError | DeployingModel | ModelDeploymentError | GeneratingModelInsightsReport | ModelInsightsError | AnalyzingData | FeatureEngineering | ModelTuning | GeneratingExplainabilityReport | TrainingModels | PreTraining` ** [AutoMLJobStatus](#API_DescribeAutoMLJobV2_ResponseSyntax) ** Returns the status of the AutoML job V2. Type: String Valid Values: `Completed | InProgress | Failed | Stopped | Stopping` ** [AutoMLProblemTypeConfig](#API_DescribeAutoMLJobV2_ResponseSyntax) ** Returns the configuration settings of the problem type set for the AutoML job V2. Type: [AutoMLProblemTypeConfig](API_AutoMLProblemTypeConfig.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. ** [AutoMLProblemTypeConfigName](#API_DescribeAutoMLJobV2_ResponseSyntax) ** Returns the name of the problem type configuration set for the AutoML job V2. Type: String Valid Values: `ImageClassification | TextClassification | TimeSeriesForecasting | Tabular | TextGeneration` ** [BestCandidate](#API_DescribeAutoMLJobV2_ResponseSyntax) ** Information about the candidate produced by an AutoML training job V2, including its status, steps, and other properties. Type: [AutoMLCandidate](API_AutoMLCandidate.md) object ** [CreationTime](#API_DescribeAutoMLJobV2_ResponseSyntax) ** Returns the creation time of the AutoML job V2. Type: Timestamp ** [DataSplitConfig](#API_DescribeAutoMLJobV2_ResponseSyntax) ** Returns the configuration settings of how the data are split into train and validation datasets. Type: [AutoMLDataSplitConfig](API_AutoMLDataSplitConfig.md) object ** [EndTime](#API_DescribeAutoMLJobV2_ResponseSyntax) ** Returns the end time of the AutoML job V2. Type: Timestamp ** [FailureReason](#API_DescribeAutoMLJobV2_ResponseSyntax) ** Returns the reason for the failure of the AutoML job V2, when applicable. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. ** [LastModifiedTime](#API_DescribeAutoMLJobV2_ResponseSyntax) ** Returns the job's last modified time. Type: Timestamp ** [ModelDeployConfig](#API_DescribeAutoMLJobV2_ResponseSyntax) ** Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically. Type: [ModelDeployConfig](API_ModelDeployConfig.md) object ** [ModelDeployResult](#API_DescribeAutoMLJobV2_ResponseSyntax) ** Provides information about endpoint for the model deployment. Type: [ModelDeployResult](API_ModelDeployResult.md) object ** [OutputDataConfig](#API_DescribeAutoMLJobV2_ResponseSyntax) ** Returns the job's output data config. Type: [AutoMLOutputDataConfig](API_AutoMLOutputDataConfig.md) object ** [PartialFailureReasons](#API_DescribeAutoMLJobV2_ResponseSyntax) ** Returns a list of reasons for partial failures within an AutoML job V2. Type: Array of [AutoMLPartialFailureReason](API_AutoMLPartialFailureReason.md) objects Array Members: Minimum number of 1 item. Maximum number of 5 items. ** [ResolvedAttributes](#API_DescribeAutoMLJobV2_ResponseSyntax) ** Returns the resolved attributes used by the AutoML job V2. Type: [AutoMLResolvedAttributes](API_AutoMLResolvedAttributes.md) object ** [RoleArn](#API_DescribeAutoMLJobV2_ResponseSyntax) ** The ARN of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` ** [SecurityConfig](#API_DescribeAutoMLJobV2_ResponseSyntax) ** Returns the security configuration for traffic encryption or Amazon VPC settings. Type: [AutoMLSecurityConfig](API_AutoMLSecurityConfig.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeAutoMLJobV2) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeAutoMLJobV2) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeAutoMLJobV2) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeAutoMLJobV2) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeAutoMLJobV2) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeAutoMLJobV2) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeAutoMLJobV2) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeAutoMLJobV2) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeAutoMLJobV2) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeAutoMLJobV2) # DescribeCluster Retrieves information of a SageMaker HyperPod cluster. ## Request Syntax ``` { "ClusterName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClusterName](#API_DescribeCluster_RequestSyntax) ** The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})` Required: Yes ## Response Syntax ``` { "AutoScaling": { "AutoScalerType": "string", "FailureMessage": "string", "Mode": "string", "Status": "string" }, "ClusterArn": "string", "ClusterName": "string", "ClusterRole": "string", "ClusterStatus": "string", "CreationTime": number, "FailureMessage": "string", "InstanceGroups": [ { "ActiveOperations": { "string" : number }, "ActiveSoftwareUpdateConfig": { "AutoRollbackConfiguration": [ { "AlarmName": "string" } ], "RollingUpdatePolicy": { "MaximumBatchSize": { "Type": "string", "Value": number }, "RollbackMaximumBatchSize": { "Type": "string", "Value": number } }, "WaitIntervalInSeconds": number }, "CapacityRequirements": { "OnDemand": { }, "Spot": { } }, "CurrentCount": number, "CurrentImageId": "string", "DesiredImageId": "string", "ExecutionRole": "string", "InstanceGroupName": "string", "InstanceStorageConfigs": [ { ... } ], "InstanceType": "string", "KubernetesConfig": { "CurrentLabels": { "string" : "string" }, "CurrentTaints": [ { "Effect": "string", "Key": "string", "Value": "string" } ], "DesiredLabels": { "string" : "string" }, "DesiredTaints": [ { "Effect": "string", "Key": "string", "Value": "string" } ] }, "LifeCycleConfig": { "OnCreate": "string", "SourceS3Uri": "string" }, "MinCount": number, "OnStartDeepHealthChecks": [ "string" ], "OverrideVpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] }, "ScheduledUpdateConfig": { "DeploymentConfig": { "AutoRollbackConfiguration": [ { "AlarmName": "string" } ], "RollingUpdatePolicy": { "MaximumBatchSize": { "Type": "string", "Value": number }, "RollbackMaximumBatchSize": { "Type": "string", "Value": number } }, "WaitIntervalInSeconds": number }, "ScheduleExpression": "string" }, "SlurmConfig": { "NodeType": "string", "PartitionNames": [ "string" ] }, "SoftwareUpdateStatus": "string", "Status": "string", "TargetCount": number, "TargetStateCount": number, "ThreadsPerCore": number, "TrainingPlanArn": "string", "TrainingPlanStatus": "string" } ], "NodeProvisioningMode": "string", "NodeRecovery": "string", "Orchestrator": { "Eks": { "ClusterArn": "string" }, "Slurm": { "SlurmConfigStrategy": "string" } }, "RestrictedInstanceGroups": [ { "CurrentCount": number, "EnvironmentConfig": { "FSxLustreConfig": { "PerUnitStorageThroughput": number, "SizeInGiB": number }, "S3OutputPath": "string" }, "ExecutionRole": "string", "InstanceGroupName": "string", "InstanceStorageConfigs": [ { ... } ], "InstanceType": "string", "OnStartDeepHealthChecks": [ "string" ], "OverrideVpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] }, "ScheduledUpdateConfig": { "DeploymentConfig": { "AutoRollbackConfiguration": [ { "AlarmName": "string" } ], "RollingUpdatePolicy": { "MaximumBatchSize": { "Type": "string", "Value": number }, "RollbackMaximumBatchSize": { "Type": "string", "Value": number } }, "WaitIntervalInSeconds": number }, "ScheduleExpression": "string" }, "Status": "string", "TargetCount": number, "ThreadsPerCore": number, "TrainingPlanArn": "string", "TrainingPlanStatus": "string" } ], "TieredStorageConfig": { "InstanceMemoryAllocationPercentage": number, "Mode": "string" }, "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AutoScaling](#API_DescribeCluster_ResponseSyntax) ** The current autoscaling configuration and status for the autoscaler. Type: [ClusterAutoScalingConfigOutput](API_ClusterAutoScalingConfigOutput.md) object ** [ClusterArn](#API_DescribeCluster_ResponseSyntax) ** The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12}` ** [ClusterName](#API_DescribeCluster_ResponseSyntax) ** The name of the SageMaker HyperPod cluster. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9])*` ** [ClusterRole](#API_DescribeCluster_ResponseSyntax) ** The Amazon Resource Name (ARN) of the IAM role that HyperPod uses for cluster autoscaling operations. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` ** [ClusterStatus](#API_DescribeCluster_ResponseSyntax) ** The status of the SageMaker HyperPod cluster. Type: String Valid Values: `Creating | Deleting | Failed | InService | RollingBack | SystemUpdating | Updating` ** [CreationTime](#API_DescribeCluster_ResponseSyntax) ** The time when the SageMaker Cluster is created. Type: Timestamp ** [FailureMessage](#API_DescribeCluster_ResponseSyntax) ** The failure message of the SageMaker HyperPod cluster. Type: String ** [InstanceGroups](#API_DescribeCluster_ResponseSyntax) ** The instance groups of the SageMaker HyperPod cluster. Type: Array of [ClusterInstanceGroupDetails](API_ClusterInstanceGroupDetails.md) objects ** [NodeProvisioningMode](#API_DescribeCluster_ResponseSyntax) ** The mode used for provisioning nodes in the cluster. Type: String Valid Values: `Continuous` ** [NodeRecovery](#API_DescribeCluster_ResponseSyntax) ** The node recovery mode configured for the SageMaker HyperPod cluster. Type: String Valid Values: `Automatic | None` ** [Orchestrator](#API_DescribeCluster_ResponseSyntax) ** The type of orchestrator used for the SageMaker HyperPod cluster. Type: [ClusterOrchestrator](API_ClusterOrchestrator.md) object ** [RestrictedInstanceGroups](#API_DescribeCluster_ResponseSyntax) ** The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster. Type: Array of [ClusterRestrictedInstanceGroupDetails](API_ClusterRestrictedInstanceGroupDetails.md) objects ** [TieredStorageConfig](#API_DescribeCluster_ResponseSyntax) ** The current configuration for managed tier checkpointing on the HyperPod cluster. For example, this shows whether the feature is enabled and the percentage of cluster memory allocated for checkpoint storage. Type: [ClusterTieredStorageConfig](API_ClusterTieredStorageConfig.md) object ** [VpcConfig](#API_DescribeCluster_ResponseSyntax) ** Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see [Give SageMaker Access to Resources in your Amazon VPC](https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html). Type: [VpcConfig](API_VpcConfig.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeCluster) # DescribeClusterEvent Retrieves detailed information about a specific event for a given HyperPod cluster. This functionality is only supported when the `NodeProvisioningMode` is set to `Continuous`. ## Request Syntax ``` { "ClusterName": "string", "EventId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClusterName](#API_DescribeClusterEvent_RequestSyntax) ** The name or Amazon Resource Name (ARN) of the HyperPod cluster associated with the event. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})` Required: Yes ** [EventId](#API_DescribeClusterEvent_RequestSyntax) ** The unique identifier (UUID) of the event to describe. This ID can be obtained from the `ListClusterEvents` operation. Type: String Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` Required: Yes ## Response Syntax ``` { "EventDetails": { "ClusterArn": "string", "ClusterName": "string", "Description": "string", "EventDetails": { "EventMetadata": { ... } }, "EventId": "string", "EventTime": number, "InstanceGroupName": "string", "InstanceId": "string", "ResourceType": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [EventDetails](#API_DescribeClusterEvent_ResponseSyntax) ** Detailed information about the requested cluster event, including event metadata for various resource types such as `Cluster`, `InstanceGroup`, `Instance`, and their associated attributes. Type: [ClusterEventDetail](API_ClusterEventDetail.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeClusterEvent) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeClusterEvent) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeClusterEvent) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeClusterEvent) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeClusterEvent) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeClusterEvent) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeClusterEvent) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeClusterEvent) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeClusterEvent) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeClusterEvent) # DescribeClusterNode Retrieves information of a node (also called a *instance* interchangeably) of a SageMaker HyperPod cluster. ## Request Syntax ``` { "ClusterName": "string", "NodeId": "string", "NodeLogicalId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClusterName](#API_DescribeClusterNode_RequestSyntax) ** The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which the node is. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})` Required: Yes ** [NodeId](#API_DescribeClusterNode_RequestSyntax) ** The ID of the SageMaker HyperPod cluster node. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `i-[a-f0-9]{8}(?:[a-f0-9]{9})?` Required: No ** [NodeLogicalId](#API_DescribeClusterNode_RequestSyntax) ** The logical identifier of the node to describe. You can specify either `NodeLogicalId` or `InstanceId`, but not both. `NodeLogicalId` can be used to describe nodes that are still being provisioned and don't yet have an `InstanceId` assigned. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9]` Required: No ## Response Syntax ``` { "NodeDetails": { "CapacityType": "string", "CurrentImageId": "string", "DesiredImageId": "string", "InstanceGroupName": "string", "InstanceId": "string", "InstanceStatus": { "Message": "string", "Status": "string" }, "InstanceStorageConfigs": [ { ... } ], "InstanceType": "string", "KubernetesConfig": { "CurrentLabels": { "string" : "string" }, "CurrentTaints": [ { "Effect": "string", "Key": "string", "Value": "string" } ], "DesiredLabels": { "string" : "string" }, "DesiredTaints": [ { "Effect": "string", "Key": "string", "Value": "string" } ] }, "LastSoftwareUpdateTime": number, "LaunchTime": number, "LifeCycleConfig": { "OnCreate": "string", "SourceS3Uri": "string" }, "NodeLogicalId": "string", "OverrideVpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] }, "Placement": { "AvailabilityZone": "string", "AvailabilityZoneId": "string" }, "PrivateDnsHostname": "string", "PrivatePrimaryIp": "string", "PrivatePrimaryIpv6": "string", "ThreadsPerCore": number, "UltraServerInfo": { "Id": "string", "Type": "string" } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NodeDetails](#API_DescribeClusterNode_ResponseSyntax) ** The details of the SageMaker HyperPod cluster node. Type: [ClusterNodeDetails](API_ClusterNodeDetails.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeClusterNode) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeClusterNode) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeClusterNode) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeClusterNode) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeClusterNode) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeClusterNode) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeClusterNode) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeClusterNode) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeClusterNode) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeClusterNode) # DescribeClusterSchedulerConfig Description of the cluster policy. This policy is used for task prioritization and fair-share allocation. This helps prioritize critical workloads and distributes idle compute across entities. ## Request Syntax ``` { "ClusterSchedulerConfigId": "string", "ClusterSchedulerConfigVersion": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClusterSchedulerConfigId](#API_DescribeClusterSchedulerConfig_RequestSyntax) ** ID of the cluster policy. Type: String Length Constraints: Minimum length of 0. Maximum length of 12. Pattern: `[a-z0-9]{12}` Required: Yes ** [ClusterSchedulerConfigVersion](#API_DescribeClusterSchedulerConfig_RequestSyntax) ** Version of the cluster policy. Type: Integer Required: No ## Response Syntax ``` { "ClusterArn": "string", "ClusterSchedulerConfigArn": "string", "ClusterSchedulerConfigId": "string", "ClusterSchedulerConfigVersion": number, "CreatedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "Description": "string", "FailureReason": "string", "LastModifiedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "Name": "string", "SchedulerConfig": { "FairShare": "string", "IdleResourceSharing": "string", "PriorityClasses": [ { "Name": "string", "Weight": number } ] }, "Status": "string", "StatusDetails": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ClusterArn](#API_DescribeClusterSchedulerConfig_ResponseSyntax) ** ARN of the cluster where the cluster policy is applied. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12}` ** [ClusterSchedulerConfigArn](#API_DescribeClusterSchedulerConfig_ResponseSyntax) ** ARN of the cluster policy. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:cluster-scheduler-config/[a-z0-9]{12}` ** [ClusterSchedulerConfigId](#API_DescribeClusterSchedulerConfig_ResponseSyntax) ** ID of the cluster policy. Type: String Length Constraints: Minimum length of 0. Maximum length of 12. Pattern: `[a-z0-9]{12}` ** [ClusterSchedulerConfigVersion](#API_DescribeClusterSchedulerConfig_ResponseSyntax) ** Version of the cluster policy. Type: Integer ** [CreatedBy](#API_DescribeClusterSchedulerConfig_ResponseSyntax) ** Information about the user who created or modified a SageMaker resource. Type: [UserContext](API_UserContext.md) object ** [CreationTime](#API_DescribeClusterSchedulerConfig_ResponseSyntax) ** Creation time of the cluster policy. Type: Timestamp ** [Description](#API_DescribeClusterSchedulerConfig_ResponseSyntax) ** Description of the cluster policy. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*` ** [FailureReason](#API_DescribeClusterSchedulerConfig_ResponseSyntax) ** Failure reason of the cluster policy. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. ** [LastModifiedBy](#API_DescribeClusterSchedulerConfig_ResponseSyntax) ** Information about the user who created or modified a SageMaker resource. Type: [UserContext](API_UserContext.md) object ** [LastModifiedTime](#API_DescribeClusterSchedulerConfig_ResponseSyntax) ** Last modified time of the cluster policy. Type: Timestamp ** [Name](#API_DescribeClusterSchedulerConfig_ResponseSyntax) ** Name of the cluster policy. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [SchedulerConfig](#API_DescribeClusterSchedulerConfig_ResponseSyntax) ** Cluster policy configuration. This policy is used for task prioritization and fair-share allocation. This helps prioritize critical workloads and distributes idle compute across entities. Type: [SchedulerConfig](API_SchedulerConfig.md) object ** [Status](#API_DescribeClusterSchedulerConfig_ResponseSyntax) ** Status of the cluster policy. Type: String Valid Values: `Creating | CreateFailed | CreateRollbackFailed | Created | Updating | UpdateFailed | UpdateRollbackFailed | Updated | Deleting | DeleteFailed | DeleteRollbackFailed | Deleted` ** [StatusDetails](#API_DescribeClusterSchedulerConfig_ResponseSyntax) ** Additional details about the status of the cluster policy. This field provides context when the policy is in a non-active state, such as during creation, updates, or if failures occur. Type: String to string map Valid Keys: `PriorityClasses | FairShare | IdleResourceSharing` Valid Values: `Creating | CreateFailed | CreateRollbackFailed | Created | Updating | UpdateFailed | UpdateRollbackFailed | Updated | Deleting | DeleteFailed | DeleteRollbackFailed | Deleted` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeClusterSchedulerConfig) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeClusterSchedulerConfig) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeClusterSchedulerConfig) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeClusterSchedulerConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeClusterSchedulerConfig) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeClusterSchedulerConfig) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeClusterSchedulerConfig) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeClusterSchedulerConfig) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeClusterSchedulerConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeClusterSchedulerConfig) # DescribeCodeRepository Gets details about the specified Git repository. ## Request Syntax ``` { "CodeRepositoryName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CodeRepositoryName](#API_DescribeCodeRepository_RequestSyntax) ** The name of the Git repository to describe. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "CodeRepositoryArn": "string", "CodeRepositoryName": "string", "CreationTime": number, "GitConfig": { "Branch": "string", "RepositoryUrl": "string", "SecretArn": "string" }, "LastModifiedTime": number } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CodeRepositoryArn](#API_DescribeCodeRepository_ResponseSyntax) ** The Amazon Resource Name (ARN) of the Git repository. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:code-repository/[\S]{1,2048}` ** [CodeRepositoryName](#API_DescribeCodeRepository_ResponseSyntax) ** The name of the Git repository. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [CreationTime](#API_DescribeCodeRepository_ResponseSyntax) ** The date and time that the repository was created. Type: Timestamp ** [GitConfig](#API_DescribeCodeRepository_ResponseSyntax) ** 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. Type: [GitConfig](API_GitConfig.md) object ** [LastModifiedTime](#API_DescribeCodeRepository_ResponseSyntax) ** The date and time that the repository was last changed. Type: Timestamp ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeCodeRepository) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeCodeRepository) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeCodeRepository) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeCodeRepository) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeCodeRepository) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeCodeRepository) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeCodeRepository) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeCodeRepository) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeCodeRepository) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeCodeRepository) # DescribeCompilationJob Returns information about a model compilation job. To create a model compilation job, use [CreateCompilationJob](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateCompilationJob.html). To get information about multiple model compilation jobs, use [ListCompilationJobs](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListCompilationJobs.html). ## Request Syntax ``` { "CompilationJobName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CompilationJobName](#API_DescribeCompilationJob_RequestSyntax) ** The name of the model compilation job that you want information about. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "CompilationEndTime": number, "CompilationJobArn": "string", "CompilationJobName": "string", "CompilationJobStatus": "string", "CompilationStartTime": number, "CreationTime": number, "DerivedInformation": { "DerivedDataInputConfig": "string" }, "FailureReason": "string", "InferenceImage": "string", "InputConfig": { "DataInputConfig": "string", "Framework": "string", "FrameworkVersion": "string", "S3Uri": "string" }, "LastModifiedTime": number, "ModelArtifacts": { "S3ModelArtifacts": "string" }, "ModelDigests": { "ArtifactDigest": "string" }, "ModelPackageVersionArn": "string", "OutputConfig": { "CompilerOptions": "string", "KmsKeyId": "string", "S3OutputLocation": "string", "TargetDevice": "string", "TargetPlatform": { "Accelerator": "string", "Arch": "string", "Os": "string" } }, "RoleArn": "string", "StoppingCondition": { "MaxPendingTimeInSeconds": number, "MaxRuntimeInSeconds": number, "MaxWaitTimeInSeconds": number }, "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CompilationEndTime](#API_DescribeCompilationJob_ResponseSyntax) ** 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 AI detected that the job failed. Type: Timestamp ** [CompilationJobArn](#API_DescribeCompilationJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the model compilation job. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:compilation-job/.*` ** [CompilationJobName](#API_DescribeCompilationJob_ResponseSyntax) ** The name of the model compilation job. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [CompilationJobStatus](#API_DescribeCompilationJob_ResponseSyntax) ** The status of the model compilation job. Type: String Valid Values: `INPROGRESS | COMPLETED | FAILED | STARTING | STOPPING | STOPPED` ** [CompilationStartTime](#API_DescribeCompilationJob_ResponseSyntax) ** 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 `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. Type: Timestamp ** [CreationTime](#API_DescribeCompilationJob_ResponseSyntax) ** The time that the model compilation job was created. Type: Timestamp ** [DerivedInformation](#API_DescribeCompilationJob_ResponseSyntax) ** Information that SageMaker Neo automatically derived about the model. Type: [DerivedInformation](API_DerivedInformation.md) object ** [FailureReason](#API_DescribeCompilationJob_ResponseSyntax) ** If a model compilation job failed, the reason it failed. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. ** [InferenceImage](#API_DescribeCompilationJob_ResponseSyntax) ** The inference image to use when compiling a model. Specify an image only if the target device is a cloud instance. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. ** [InputConfig](#API_DescribeCompilationJob_ResponseSyntax) ** 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. Type: [InputConfig](API_InputConfig.md) object ** [LastModifiedTime](#API_DescribeCompilationJob_ResponseSyntax) ** The time that the status of the model compilation job was last modified. Type: Timestamp ** [ModelArtifacts](#API_DescribeCompilationJob_ResponseSyntax) ** Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job. Type: [ModelArtifacts](API_ModelArtifacts.md) object ** [ModelDigests](#API_DescribeCompilationJob_ResponseSyntax) ** Provides a BLAKE2 hash value that identifies the compiled model artifacts in Amazon S3. Type: [ModelDigests](API_ModelDigests.md) object ** [ModelPackageVersionArn](#API_DescribeCompilationJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the versioned model package that was provided to SageMaker Neo when you initiated a compilation job. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:model-package/[\S]{1,2048}` ** [OutputConfig](#API_DescribeCompilationJob_ResponseSyntax) ** Information about the output location for the compiled model and the target device that the model runs on. Type: [OutputConfig](API_OutputConfig.md) object ** [RoleArn](#API_DescribeCompilationJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI assumes to perform the model compilation job. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` ** [StoppingCondition](#API_DescribeCompilationJob_ResponseSyntax) ** Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker AI ends the compilation job. Use this API to cap model training costs. Type: [StoppingCondition](API_StoppingCondition.md) object ** [VpcConfig](#API_DescribeCompilationJob_ResponseSyntax) ** A [VpcConfig](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html) object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see [Protect Compilation Jobs by Using an Amazon Virtual Private Cloud](https://docs.aws.amazon.com/sagemaker/latest/dg/neo-vpc.html). Type: [NeoVpcConfig](API_NeoVpcConfig.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeCompilationJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeCompilationJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeCompilationJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeCompilationJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeCompilationJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeCompilationJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeCompilationJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeCompilationJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeCompilationJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeCompilationJob) # DescribeComputeQuota Description of the compute allocation definition. ## Request Syntax ``` { "ComputeQuotaId": "string", "ComputeQuotaVersion": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ComputeQuotaId](#API_DescribeComputeQuota_RequestSyntax) ** ID of the compute allocation definition. Type: String Pattern: `[a-z0-9]{12}` Required: Yes ** [ComputeQuotaVersion](#API_DescribeComputeQuota_RequestSyntax) ** Version of the compute allocation definition. Type: Integer Required: No ## Response Syntax ``` { "ActivationState": "string", "ClusterArn": "string", "ComputeQuotaArn": "string", "ComputeQuotaConfig": { "ComputeQuotaResources": [ { "AcceleratorPartition": { "Count": number, "Type": "string" }, "Accelerators": number, "Count": number, "InstanceType": "string", "MemoryInGiB": number, "VCpu": number } ], "PreemptTeamTasks": "string", "ResourceSharingConfig": { "AbsoluteBorrowLimits": [ { "AcceleratorPartition": { "Count": number, "Type": "string" }, "Accelerators": number, "Count": number, "InstanceType": "string", "MemoryInGiB": number, "VCpu": number } ], "BorrowLimit": number, "Strategy": "string" } }, "ComputeQuotaId": "string", "ComputeQuotaTarget": { "FairShareWeight": number, "TeamName": "string" }, "ComputeQuotaVersion": number, "CreatedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "Description": "string", "FailureReason": "string", "LastModifiedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "Name": "string", "Status": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ActivationState](#API_DescribeComputeQuota_ResponseSyntax) ** The state of the compute allocation being described. Use to enable or disable compute allocation. Default is `Enabled`. Type: String Valid Values: `Enabled | Disabled` ** [ClusterArn](#API_DescribeComputeQuota_ResponseSyntax) ** ARN of the cluster. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12}` ** [ComputeQuotaArn](#API_DescribeComputeQuota_ResponseSyntax) ** ARN of the compute allocation definition. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:compute-quota/[a-z0-9]{12}` ** [ComputeQuotaConfig](#API_DescribeComputeQuota_ResponseSyntax) ** Configuration of the compute allocation definition. This includes the resource sharing option, and the setting to preempt low priority tasks. Type: [ComputeQuotaConfig](API_ComputeQuotaConfig.md) object ** [ComputeQuotaId](#API_DescribeComputeQuota_ResponseSyntax) ** ID of the compute allocation definition. Type: String Pattern: `[a-z0-9]{12}` ** [ComputeQuotaTarget](#API_DescribeComputeQuota_ResponseSyntax) ** The target entity to allocate compute resources to. Type: [ComputeQuotaTarget](API_ComputeQuotaTarget.md) object ** [ComputeQuotaVersion](#API_DescribeComputeQuota_ResponseSyntax) ** Version of the compute allocation definition. Type: Integer ** [CreatedBy](#API_DescribeComputeQuota_ResponseSyntax) ** Information about the user who created or modified a SageMaker resource. Type: [UserContext](API_UserContext.md) object ** [CreationTime](#API_DescribeComputeQuota_ResponseSyntax) ** Creation time of the compute allocation configuration. Type: Timestamp ** [Description](#API_DescribeComputeQuota_ResponseSyntax) ** Description of the compute allocation definition. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*` ** [FailureReason](#API_DescribeComputeQuota_ResponseSyntax) ** Failure reason of the compute allocation definition. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. ** [LastModifiedBy](#API_DescribeComputeQuota_ResponseSyntax) ** Information about the user who created or modified a SageMaker resource. Type: [UserContext](API_UserContext.md) object ** [LastModifiedTime](#API_DescribeComputeQuota_ResponseSyntax) ** Last modified time of the compute allocation configuration. Type: Timestamp ** [Name](#API_DescribeComputeQuota_ResponseSyntax) ** Name of the compute allocation definition. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [Status](#API_DescribeComputeQuota_ResponseSyntax) ** Status of the compute allocation definition. Type: String Valid Values: `Creating | CreateFailed | CreateRollbackFailed | Created | Updating | UpdateFailed | UpdateRollbackFailed | Updated | Deleting | DeleteFailed | DeleteRollbackFailed | Deleted` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeComputeQuota) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeComputeQuota) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeComputeQuota) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeComputeQuota) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeComputeQuota) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeComputeQuota) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeComputeQuota) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeComputeQuota) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeComputeQuota) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeComputeQuota) # DescribeContext Describes a context. ## Request Syntax ``` { "ContextName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ContextName](#API_DescribeContext_RequestSyntax) ** The name of the context to describe. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:context\/)?([a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,119})` Required: Yes ## Response Syntax ``` { "ContextArn": "string", "ContextName": "string", "ContextType": "string", "CreatedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "Description": "string", "LastModifiedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "LineageGroupArn": "string", "Properties": { "string" : "string" }, "Source": { "SourceId": "string", "SourceType": "string", "SourceUri": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ContextArn](#API_DescribeContext_ResponseSyntax) ** The Amazon Resource Name (ARN) of the context. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:context/.*` ** [ContextName](#API_DescribeContext_ResponseSyntax) ** The name of the context. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,119}` ** [ContextType](#API_DescribeContext_ResponseSyntax) ** The type of the context. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. ** [CreatedBy](#API_DescribeContext_ResponseSyntax) ** Information about the user who created or modified a SageMaker resource. Type: [UserContext](API_UserContext.md) object ** [CreationTime](#API_DescribeContext_ResponseSyntax) ** When the context was created. Type: Timestamp ** [Description](#API_DescribeContext_ResponseSyntax) ** The description of the context. Type: String Length Constraints: Minimum length of 0. Maximum length of 3072. Pattern: `.*` ** [LastModifiedBy](#API_DescribeContext_ResponseSyntax) ** Information about the user who created or modified a SageMaker resource. Type: [UserContext](API_UserContext.md) object ** [LastModifiedTime](#API_DescribeContext_ResponseSyntax) ** When the context was last modified. Type: Timestamp ** [LineageGroupArn](#API_DescribeContext_ResponseSyntax) ** The Amazon Resource Name (ARN) of the lineage group. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:lineage-group/.*` ** [Properties](#API_DescribeContext_ResponseSyntax) ** A list of the context's properties. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 30 items. Key Length Constraints: Minimum length of 0. Maximum length of 2500. Key Pattern: `.*` Value Length Constraints: Minimum length of 0. Maximum length of 2500. Value Pattern: `.*` ** [Source](#API_DescribeContext_ResponseSyntax) ** The source of the context. Type: [ContextSource](API_ContextSource.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeContext) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeContext) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeContext) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeContext) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeContext) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeContext) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeContext) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeContext) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeContext) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeContext) # DescribeDataQualityJobDefinition Gets the details of a data quality monitoring job definition. ## Request Syntax ``` { "JobDefinitionName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [JobDefinitionName](#API_DescribeDataQualityJobDefinition_RequestSyntax) ** The name of the data quality monitoring job definition to describe. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "CreationTime": number, "DataQualityAppSpecification": { "ContainerArguments": [ "string" ], "ContainerEntrypoint": [ "string" ], "Environment": { "string" : "string" }, "ImageUri": "string", "PostAnalyticsProcessorSourceUri": "string", "RecordPreprocessorSourceUri": "string" }, "DataQualityBaselineConfig": { "BaseliningJobName": "string", "ConstraintsResource": { "S3Uri": "string" }, "StatisticsResource": { "S3Uri": "string" } }, "DataQualityJobInput": { "BatchTransformInput": { "DataCapturedDestinationS3Uri": "string", "DatasetFormat": { "Csv": { "Header": boolean }, "Json": { "Line": boolean }, "Parquet": { } }, "EndTimeOffset": "string", "ExcludeFeaturesAttribute": "string", "FeaturesAttribute": "string", "InferenceAttribute": "string", "LocalPath": "string", "ProbabilityAttribute": "string", "ProbabilityThresholdAttribute": number, "S3DataDistributionType": "string", "S3InputMode": "string", "StartTimeOffset": "string" }, "EndpointInput": { "EndpointName": "string", "EndTimeOffset": "string", "ExcludeFeaturesAttribute": "string", "FeaturesAttribute": "string", "InferenceAttribute": "string", "LocalPath": "string", "ProbabilityAttribute": "string", "ProbabilityThresholdAttribute": number, "S3DataDistributionType": "string", "S3InputMode": "string", "StartTimeOffset": "string" } }, "DataQualityJobOutputConfig": { "KmsKeyId": "string", "MonitoringOutputs": [ { "S3Output": { "LocalPath": "string", "S3UploadMode": "string", "S3Uri": "string" } } ] }, "JobDefinitionArn": "string", "JobDefinitionName": "string", "JobResources": { "ClusterConfig": { "InstanceCount": number, "InstanceType": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number } }, "NetworkConfig": { "EnableInterContainerTrafficEncryption": boolean, "EnableNetworkIsolation": boolean, "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } }, "RoleArn": "string", "StoppingCondition": { "MaxRuntimeInSeconds": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreationTime](#API_DescribeDataQualityJobDefinition_ResponseSyntax) ** The time that the data quality monitoring job definition was created. Type: Timestamp ** [DataQualityAppSpecification](#API_DescribeDataQualityJobDefinition_ResponseSyntax) ** Information about the container that runs the data quality monitoring job. Type: [DataQualityAppSpecification](API_DataQualityAppSpecification.md) object ** [DataQualityBaselineConfig](#API_DescribeDataQualityJobDefinition_ResponseSyntax) ** The constraints and baselines for the data quality monitoring job definition. Type: [DataQualityBaselineConfig](API_DataQualityBaselineConfig.md) object ** [DataQualityJobInput](#API_DescribeDataQualityJobDefinition_ResponseSyntax) ** The list of inputs for the data quality monitoring job. Currently endpoints are supported. Type: [DataQualityJobInput](API_DataQualityJobInput.md) object ** [DataQualityJobOutputConfig](#API_DescribeDataQualityJobDefinition_ResponseSyntax) ** The output configuration for monitoring jobs. Type: [MonitoringOutputConfig](API_MonitoringOutputConfig.md) object ** [JobDefinitionArn](#API_DescribeDataQualityJobDefinition_ResponseSyntax) ** The Amazon Resource Name (ARN) of the data quality monitoring job definition. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `.*` ** [JobDefinitionName](#API_DescribeDataQualityJobDefinition_ResponseSyntax) ** The name of the data quality monitoring job definition. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [JobResources](#API_DescribeDataQualityJobDefinition_ResponseSyntax) ** Identifies the resources to deploy for a monitoring job. Type: [MonitoringResources](API_MonitoringResources.md) object ** [NetworkConfig](#API_DescribeDataQualityJobDefinition_ResponseSyntax) ** The networking configuration for the data quality monitoring job. Type: [MonitoringNetworkConfig](API_MonitoringNetworkConfig.md) object ** [RoleArn](#API_DescribeDataQualityJobDefinition_ResponseSyntax) ** The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` ** [StoppingCondition](#API_DescribeDataQualityJobDefinition_ResponseSyntax) ** A time limit for how long the monitoring job is allowed to run before stopping. Type: [MonitoringStoppingCondition](API_MonitoringStoppingCondition.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeDataQualityJobDefinition) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeDataQualityJobDefinition) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeDataQualityJobDefinition) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeDataQualityJobDefinition) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeDataQualityJobDefinition) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeDataQualityJobDefinition) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeDataQualityJobDefinition) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeDataQualityJobDefinition) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeDataQualityJobDefinition) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeDataQualityJobDefinition) # DescribeDevice Describes the device. ## Request Syntax ``` { "DeviceFleetName": "string", "DeviceName": "string", "NextToken": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DeviceFleetName](#API_DescribeDevice_RequestSyntax) ** The name of the fleet the devices belong to. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [DeviceName](#API_DescribeDevice_RequestSyntax) ** The unique ID of the device. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [NextToken](#API_DescribeDevice_RequestSyntax) ** Next token of device description. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ## Response Syntax ``` { "AgentVersion": "string", "Description": "string", "DeviceArn": "string", "DeviceFleetName": "string", "DeviceName": "string", "IotThingName": "string", "LatestHeartbeat": number, "MaxModels": number, "Models": [ { "LatestInference": number, "LatestSampleTime": number, "ModelName": "string", "ModelVersion": "string" } ], "NextToken": "string", "RegistrationTime": number } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AgentVersion](#API_DescribeDevice_ResponseSyntax) ** Edge Manager agent version. Type: String Length Constraints: Minimum length of 1. Maximum length of 30. Pattern: `[a-zA-Z0-9\ \_\.]+` ** [Description](#API_DescribeDevice_ResponseSyntax) ** A description of the device. Type: String Length Constraints: Minimum length of 1. Maximum length of 40. Pattern: `[-a-zA-Z0-9_.,;:! ]*` ** [DeviceArn](#API_DescribeDevice_ResponseSyntax) ** The Amazon Resource Name (ARN) of the device. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:[a-z\-]*:[a-z\-]*:\d{12}:[a-z\-]*/?[a-zA-Z_0-9+=,.@\-_/]+` ** [DeviceFleetName](#API_DescribeDevice_ResponseSyntax) ** The name of the fleet the device belongs to. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [DeviceName](#API_DescribeDevice_ResponseSyntax) ** The unique identifier of the device. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [IotThingName](#API_DescribeDevice_ResponseSyntax) ** The AWS Internet of Things (IoT) object thing name associated with the device. Type: String Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `[a-zA-Z0-9:_-]+` ** [LatestHeartbeat](#API_DescribeDevice_ResponseSyntax) ** The last heartbeat received from the device. Type: Timestamp ** [MaxModels](#API_DescribeDevice_ResponseSyntax) ** The maximum number of models. Type: Integer ** [Models](#API_DescribeDevice_ResponseSyntax) ** Models on the device. Type: Array of [EdgeModel](API_EdgeModel.md) objects ** [NextToken](#API_DescribeDevice_ResponseSyntax) ** The response from the last list when returning a list large enough to need tokening. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ** [RegistrationTime](#API_DescribeDevice_ResponseSyntax) ** The timestamp of the last registration or de-reregistration. Type: Timestamp ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeDevice) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeDevice) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeDevice) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeDevice) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeDevice) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeDevice) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeDevice) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeDevice) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeDevice) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeDevice) # DescribeDeviceFleet A description of the fleet the device belongs to. ## Request Syntax ``` { "DeviceFleetName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DeviceFleetName](#API_DescribeDeviceFleet_RequestSyntax) ** The name of the fleet. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "CreationTime": number, "Description": "string", "DeviceFleetArn": "string", "DeviceFleetName": "string", "IotRoleAlias": "string", "LastModifiedTime": number, "OutputConfig": { "KmsKeyId": "string", "PresetDeploymentConfig": "string", "PresetDeploymentType": "string", "S3OutputLocation": "string" }, "RoleArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreationTime](#API_DescribeDeviceFleet_ResponseSyntax) ** Timestamp of when the device fleet was created. Type: Timestamp ** [Description](#API_DescribeDeviceFleet_ResponseSyntax) ** A description of the fleet. Type: String Length Constraints: Minimum length of 1. Maximum length of 800. Pattern: `[-a-zA-Z0-9_.,;:! ]*` ** [DeviceFleetArn](#API_DescribeDeviceFleet_ResponseSyntax) ** The The Amazon Resource Name (ARN) of the fleet. Type: String Pattern: `arn:aws[a-z\-]*:iam::\d{12}:device-fleet/?[a-zA-Z_0-9+=,.@\-_/]+` ** [DeviceFleetName](#API_DescribeDeviceFleet_ResponseSyntax) ** The name of the fleet. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [IotRoleAlias](#API_DescribeDeviceFleet_ResponseSyntax) ** The Amazon Resource Name (ARN) alias created in AWS Internet of Things (IoT). Type: String Pattern: `arn:aws[a-z\-]*:iam::\d{12}:rolealias/?[a-zA-Z_0-9+=,.@\-_/]+` ** [LastModifiedTime](#API_DescribeDeviceFleet_ResponseSyntax) ** Timestamp of when the device fleet was last updated. Type: Timestamp ** [OutputConfig](#API_DescribeDeviceFleet_ResponseSyntax) ** The output configuration for storing sampled data. Type: [EdgeOutputConfig](API_EdgeOutputConfig.md) object ** [RoleArn](#API_DescribeDeviceFleet_ResponseSyntax) ** The Amazon Resource Name (ARN) that has access to AWS Internet of Things (IoT). Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeDeviceFleet) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeDeviceFleet) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeDeviceFleet) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeDeviceFleet) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeDeviceFleet) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeDeviceFleet) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeDeviceFleet) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeDeviceFleet) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeDeviceFleet) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeDeviceFleet) # DescribeDomain The description of the domain. ## Request Syntax ``` { "DomainId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DomainId](#API_DescribeDomain_RequestSyntax) ** The domain ID. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `d-(-*[a-z0-9]){1,61}` Required: Yes ## Response Syntax ``` { "AppNetworkAccessType": "string", "AppSecurityGroupManagement": "string", "AuthMode": "string", "CreationTime": number, "DefaultSpaceSettings": { "CustomFileSystemConfigs": [ { ... } ], "CustomPosixUserConfig": { "Gid": number, "Uid": number }, "ExecutionRole": "string", "JupyterLabAppSettings": { "AppLifecycleManagement": { "IdleSettings": { "IdleTimeoutInMinutes": number, "LifecycleManagement": "string", "MaxIdleTimeoutInMinutes": number, "MinIdleTimeoutInMinutes": number } }, "BuiltInLifecycleConfigArn": "string", "CodeRepositories": [ { "RepositoryUrl": "string" } ], "CustomImages": [ { "AppImageConfigName": "string", "ImageName": "string", "ImageVersionNumber": number } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" }, "EmrSettings": { "AssumableRoleArns": [ "string" ], "ExecutionRoleArns": [ "string" ] }, "LifecycleConfigArns": [ "string" ] }, "JupyterServerAppSettings": { "CodeRepositories": [ { "RepositoryUrl": "string" } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" }, "LifecycleConfigArns": [ "string" ] }, "KernelGatewayAppSettings": { "CustomImages": [ { "AppImageConfigName": "string", "ImageName": "string", "ImageVersionNumber": number } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" }, "LifecycleConfigArns": [ "string" ] }, "SecurityGroups": [ "string" ], "SpaceStorageSettings": { "DefaultEbsStorageSettings": { "DefaultEbsVolumeSizeInGb": number, "MaximumEbsVolumeSizeInGb": number } } }, "DefaultUserSettings": { "AutoMountHomeEFS": "string", "CanvasAppSettings": { "DirectDeploySettings": { "Status": "string" }, "EmrServerlessSettings": { "ExecutionRoleArn": "string", "Status": "string" }, "GenerativeAiSettings": { "AmazonBedrockRoleArn": "string" }, "IdentityProviderOAuthSettings": [ { "DataSourceName": "string", "SecretArn": "string", "Status": "string" } ], "KendraSettings": { "Status": "string" }, "ModelRegisterSettings": { "CrossAccountModelRegisterRoleArn": "string", "Status": "string" }, "TimeSeriesForecastingSettings": { "AmazonForecastRoleArn": "string", "Status": "string" }, "WorkspaceSettings": { "S3ArtifactPath": "string", "S3KmsKeyId": "string" } }, "CodeEditorAppSettings": { "AppLifecycleManagement": { "IdleSettings": { "IdleTimeoutInMinutes": number, "LifecycleManagement": "string", "MaxIdleTimeoutInMinutes": number, "MinIdleTimeoutInMinutes": number } }, "BuiltInLifecycleConfigArn": "string", "CustomImages": [ { "AppImageConfigName": "string", "ImageName": "string", "ImageVersionNumber": number } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" }, "LifecycleConfigArns": [ "string" ] }, "CustomFileSystemConfigs": [ { ... } ], "CustomPosixUserConfig": { "Gid": number, "Uid": number }, "DefaultLandingUri": "string", "ExecutionRole": "string", "JupyterLabAppSettings": { "AppLifecycleManagement": { "IdleSettings": { "IdleTimeoutInMinutes": number, "LifecycleManagement": "string", "MaxIdleTimeoutInMinutes": number, "MinIdleTimeoutInMinutes": number } }, "BuiltInLifecycleConfigArn": "string", "CodeRepositories": [ { "RepositoryUrl": "string" } ], "CustomImages": [ { "AppImageConfigName": "string", "ImageName": "string", "ImageVersionNumber": number } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" }, "EmrSettings": { "AssumableRoleArns": [ "string" ], "ExecutionRoleArns": [ "string" ] }, "LifecycleConfigArns": [ "string" ] }, "JupyterServerAppSettings": { "CodeRepositories": [ { "RepositoryUrl": "string" } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" }, "LifecycleConfigArns": [ "string" ] }, "KernelGatewayAppSettings": { "CustomImages": [ { "AppImageConfigName": "string", "ImageName": "string", "ImageVersionNumber": number } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" }, "LifecycleConfigArns": [ "string" ] }, "RSessionAppSettings": { "CustomImages": [ { "AppImageConfigName": "string", "ImageName": "string", "ImageVersionNumber": number } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" } }, "RStudioServerProAppSettings": { "AccessStatus": "string", "UserGroup": "string" }, "SecurityGroups": [ "string" ], "SharingSettings": { "NotebookOutputOption": "string", "S3KmsKeyId": "string", "S3OutputPath": "string" }, "SpaceStorageSettings": { "DefaultEbsStorageSettings": { "DefaultEbsVolumeSizeInGb": number, "MaximumEbsVolumeSizeInGb": number } }, "StudioWebPortal": "string", "StudioWebPortalSettings": { "HiddenAppTypes": [ "string" ], "HiddenInstanceTypes": [ "string" ], "HiddenMlTools": [ "string" ], "HiddenSageMakerImageVersionAliases": [ { "SageMakerImageName": "string", "VersionAliases": [ "string" ] } ] }, "TensorBoardAppSettings": { "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" } } }, "DomainArn": "string", "DomainId": "string", "DomainName": "string", "DomainSettings": { "AmazonQSettings": { "QProfileArn": "string", "Status": "string" }, "DockerSettings": { "EnableDockerAccess": "string", "RootlessDocker": "string", "VpcOnlyTrustedAccounts": [ "string" ] }, "ExecutionRoleIdentityConfig": "string", "IpAddressType": "string", "RStudioServerProDomainSettings": { "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" }, "DomainExecutionRoleArn": "string", "RStudioConnectUrl": "string", "RStudioPackageManagerUrl": "string" }, "SecurityGroupIds": [ "string" ], "TrustedIdentityPropagationSettings": { "Status": "string" }, "UnifiedStudioSettings": { "DomainAccountId": "string", "DomainId": "string", "DomainRegion": "string", "EnvironmentId": "string", "ProjectId": "string", "ProjectS3Path": "string", "SingleSignOnApplicationArn": "string", "StudioWebPortalAccess": "string" } }, "FailureReason": "string", "HomeEfsFileSystemId": "string", "HomeEfsFileSystemKmsKeyId": "string", "KmsKeyId": "string", "LastModifiedTime": number, "SecurityGroupIdForDomainBoundary": "string", "SingleSignOnApplicationArn": "string", "SingleSignOnManagedApplicationInstanceId": "string", "Status": "string", "SubnetIds": [ "string" ], "TagPropagation": "string", "Url": "string", "VpcId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AppNetworkAccessType](#API_DescribeDomain_ResponseSyntax) ** 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 AI, which allows direct internet access + `VpcOnly` - All traffic is through the specified VPC and subnets Type: String Valid Values: `PublicInternetOnly | VpcOnly` ** [AppSecurityGroupManagement](#API_DescribeDomain_ResponseSyntax) ** The entity that creates and manages the required security groups for inter-app communication in `VPCOnly` mode. Required when `CreateDomain.AppNetworkAccessType` is `VPCOnly` and `DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn` is provided. Type: String Valid Values: `Service | Customer` ** [AuthMode](#API_DescribeDomain_ResponseSyntax) ** The domain's authentication mode. Type: String Valid Values: `SSO | IAM` ** [CreationTime](#API_DescribeDomain_ResponseSyntax) ** The creation time. Type: Timestamp ** [DefaultSpaceSettings](#API_DescribeDomain_ResponseSyntax) ** The default settings for shared spaces that users create in the domain. Type: [DefaultSpaceSettings](API_DefaultSpaceSettings.md) object ** [DefaultUserSettings](#API_DescribeDomain_ResponseSyntax) ** Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given UserProfile. Type: [UserSettings](API_UserSettings.md) object ** [DomainArn](#API_DescribeDomain_ResponseSyntax) ** The domain's Amazon Resource Name (ARN). Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:domain/.*` ** [DomainId](#API_DescribeDomain_ResponseSyntax) ** The domain ID. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `d-(-*[a-z0-9]){1,61}` ** [DomainName](#API_DescribeDomain_ResponseSyntax) ** The domain name. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [DomainSettings](#API_DescribeDomain_ResponseSyntax) ** A collection of `Domain` settings. Type: [DomainSettings](API_DomainSettings.md) object ** [FailureReason](#API_DescribeDomain_ResponseSyntax) ** The failure reason. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. ** [HomeEfsFileSystemId](#API_DescribeDomain_ResponseSyntax) ** The ID of the Amazon Elastic File System managed by this Domain. Type: String Length Constraints: Minimum length of 0. Maximum length of 32. ** [HomeEfsFileSystemKmsKeyId](#API_DescribeDomain_ResponseSyntax) ** *This parameter has been deprecated.* Use `KmsKeyId`. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `[a-zA-Z0-9:/_-]*` ** [KmsKeyId](#API_DescribeDomain_ResponseSyntax) ** The AWS KMS customer managed key used to encrypt the EFS volume attached to the domain. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `[a-zA-Z0-9:/_-]*` ** [LastModifiedTime](#API_DescribeDomain_ResponseSyntax) ** The last modified time. Type: Timestamp ** [SecurityGroupIdForDomainBoundary](#API_DescribeDomain_ResponseSyntax) ** The ID of the security group that authorizes traffic between the `RSessionGateway` apps and the `RStudioServerPro` app. Type: String Length Constraints: Minimum length of 0. Maximum length of 32. Pattern: `[-0-9a-zA-Z]+` ** [SingleSignOnApplicationArn](#API_DescribeDomain_ResponseSyntax) ** The ARN of the application managed by SageMaker AI in IAM Identity Center. This value is only returned for domains created after October 1, 2023. Type: String Pattern: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::[0-9]+:application\/[a-zA-Z0-9-_.]+\/apl-[a-zA-Z0-9]+` ** [SingleSignOnManagedApplicationInstanceId](#API_DescribeDomain_ResponseSyntax) ** The IAM Identity Center managed application instance ID. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. ** [Status](#API_DescribeDomain_ResponseSyntax) ** The status. Type: String Valid Values: `Deleting | Failed | InService | Pending | Updating | Update_Failed | Delete_Failed` ** [SubnetIds](#API_DescribeDomain_ResponseSyntax) ** The VPC subnets that the domain uses for communication. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 16 items. Length Constraints: Minimum length of 0. Maximum length of 32. Pattern: `[-0-9a-zA-Z]+` ** [TagPropagation](#API_DescribeDomain_ResponseSyntax) ** Indicates whether custom tag propagation is supported for the domain. Type: String Valid Values: `ENABLED | DISABLED` ** [Url](#API_DescribeDomain_ResponseSyntax) ** The domain's URL. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. ** [VpcId](#API_DescribeDomain_ResponseSyntax) ** The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication. Type: String Length Constraints: Minimum length of 0. Maximum length of 32. Pattern: `[-0-9a-zA-Z]+` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeDomain) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeDomain) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeDomain) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeDomain) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeDomain) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeDomain) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeDomain) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeDomain) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeDomain) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeDomain) # DescribeEdgeDeploymentPlan Describes an edge deployment plan with deployment status per stage. ## Request Syntax ``` { "EdgeDeploymentPlanName": "string", "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [EdgeDeploymentPlanName](#API_DescribeEdgeDeploymentPlan_RequestSyntax) ** The name of the deployment plan to describe. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [MaxResults](#API_DescribeEdgeDeploymentPlan_RequestSyntax) ** The maximum number of results to select (50 by default). Type: Integer Valid Range: Maximum value of 10. Required: No ** [NextToken](#API_DescribeEdgeDeploymentPlan_RequestSyntax) ** If the edge deployment plan has enough stages to require tokening, then this is the response from the last list of stages returned. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ## Response Syntax ``` { "CreationTime": number, "DeviceFleetName": "string", "EdgeDeploymentFailed": number, "EdgeDeploymentPending": number, "EdgeDeploymentPlanArn": "string", "EdgeDeploymentPlanName": "string", "EdgeDeploymentSuccess": number, "LastModifiedTime": number, "ModelConfigs": [ { "EdgePackagingJobName": "string", "ModelHandle": "string" } ], "NextToken": "string", "Stages": [ { "DeploymentConfig": { "FailureHandlingPolicy": "string" }, "DeploymentStatus": { "EdgeDeploymentFailedInStage": number, "EdgeDeploymentPendingInStage": number, "EdgeDeploymentStageStartTime": number, "EdgeDeploymentStatusMessage": "string", "EdgeDeploymentSuccessInStage": number, "StageStatus": "string" }, "DeviceSelectionConfig": { "DeviceNameContains": "string", "DeviceNames": [ "string" ], "DeviceSubsetType": "string", "Percentage": number }, "StageName": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreationTime](#API_DescribeEdgeDeploymentPlan_ResponseSyntax) ** The time when the edge deployment plan was created. Type: Timestamp ** [DeviceFleetName](#API_DescribeEdgeDeploymentPlan_ResponseSyntax) ** The device fleet used for this edge deployment plan. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [EdgeDeploymentFailed](#API_DescribeEdgeDeploymentPlan_ResponseSyntax) ** The number of edge devices that failed the deployment. Type: Integer ** [EdgeDeploymentPending](#API_DescribeEdgeDeploymentPlan_ResponseSyntax) ** The number of edge devices yet to pick up deployment, or in progress. Type: Integer ** [EdgeDeploymentPlanArn](#API_DescribeEdgeDeploymentPlan_ResponseSyntax) ** The ARN of edge deployment plan. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z\-]*:\d{12}:edge-deployment/?[a-zA-Z_0-9+=,.@\-_/]+` ** [EdgeDeploymentPlanName](#API_DescribeEdgeDeploymentPlan_ResponseSyntax) ** The name of the edge deployment plan. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [EdgeDeploymentSuccess](#API_DescribeEdgeDeploymentPlan_ResponseSyntax) ** The number of edge devices with the successful deployment. Type: Integer ** [LastModifiedTime](#API_DescribeEdgeDeploymentPlan_ResponseSyntax) ** The time when the edge deployment plan was last updated. Type: Timestamp ** [ModelConfigs](#API_DescribeEdgeDeploymentPlan_ResponseSyntax) ** List of models associated with the edge deployment plan. Type: Array of [EdgeDeploymentModelConfig](API_EdgeDeploymentModelConfig.md) objects ** [NextToken](#API_DescribeEdgeDeploymentPlan_ResponseSyntax) ** Token to use when calling the next set of stages in the edge deployment plan. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ** [Stages](#API_DescribeEdgeDeploymentPlan_ResponseSyntax) ** List of stages in the edge deployment plan. Type: Array of [DeploymentStageStatusSummary](API_DeploymentStageStatusSummary.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeEdgeDeploymentPlan) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeEdgeDeploymentPlan) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeEdgeDeploymentPlan) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeEdgeDeploymentPlan) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeEdgeDeploymentPlan) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeEdgeDeploymentPlan) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeEdgeDeploymentPlan) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeEdgeDeploymentPlan) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeEdgeDeploymentPlan) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeEdgeDeploymentPlan) # DescribeEdgePackagingJob A description of edge packaging jobs. ## Request Syntax ``` { "EdgePackagingJobName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [EdgePackagingJobName](#API_DescribeEdgePackagingJob_RequestSyntax) ** The name of the edge packaging job. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "CompilationJobName": "string", "CreationTime": number, "EdgePackagingJobArn": "string", "EdgePackagingJobName": "string", "EdgePackagingJobStatus": "string", "EdgePackagingJobStatusMessage": "string", "LastModifiedTime": number, "ModelArtifact": "string", "ModelName": "string", "ModelSignature": "string", "ModelVersion": "string", "OutputConfig": { "KmsKeyId": "string", "PresetDeploymentConfig": "string", "PresetDeploymentType": "string", "S3OutputLocation": "string" }, "PresetDeploymentOutput": { "Artifact": "string", "Status": "string", "StatusMessage": "string", "Type": "string" }, "ResourceKey": "string", "RoleArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CompilationJobName](#API_DescribeEdgePackagingJob_ResponseSyntax) ** The name of the SageMaker Neo compilation job that is used to locate model artifacts that are being packaged. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [CreationTime](#API_DescribeEdgePackagingJob_ResponseSyntax) ** The timestamp of when the packaging job was created. Type: Timestamp ** [EdgePackagingJobArn](#API_DescribeEdgePackagingJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the edge packaging job. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z\-]*:\d{12}:edge-packaging-job/?[a-zA-Z_0-9+=,.@\-_/]+` ** [EdgePackagingJobName](#API_DescribeEdgePackagingJob_ResponseSyntax) ** The name of the edge packaging job. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [EdgePackagingJobStatus](#API_DescribeEdgePackagingJob_ResponseSyntax) ** The current status of the packaging job. Type: String Valid Values: `STARTING | INPROGRESS | COMPLETED | FAILED | STOPPING | STOPPED` ** [EdgePackagingJobStatusMessage](#API_DescribeEdgePackagingJob_ResponseSyntax) ** Returns a message describing the job status and error messages. Type: String ** [LastModifiedTime](#API_DescribeEdgePackagingJob_ResponseSyntax) ** The timestamp of when the job was last updated. Type: Timestamp ** [ModelArtifact](#API_DescribeEdgePackagingJob_ResponseSyntax) ** The Amazon Simple Storage (S3) URI where model artifacts ares stored. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `(https|s3)://([^/]+)/?(.*)` ** [ModelName](#API_DescribeEdgePackagingJob_ResponseSyntax) ** The name of the model. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [ModelSignature](#API_DescribeEdgePackagingJob_ResponseSyntax) ** The signature document of files in the model artifact. Type: String ** [ModelVersion](#API_DescribeEdgePackagingJob_ResponseSyntax) ** The version of the model. Type: String Length Constraints: Minimum length of 1. Maximum length of 30. Pattern: `[a-zA-Z0-9\ \_\.]+` ** [OutputConfig](#API_DescribeEdgePackagingJob_ResponseSyntax) ** The output configuration for the edge packaging job. Type: [EdgeOutputConfig](API_EdgeOutputConfig.md) object ** [PresetDeploymentOutput](#API_DescribeEdgePackagingJob_ResponseSyntax) ** The output of a SageMaker Edge Manager deployable resource. Type: [EdgePresetDeploymentOutput](API_EdgePresetDeploymentOutput.md) object ** [ResourceKey](#API_DescribeEdgePackagingJob_ResponseSyntax) ** The AWS KMS key to use when encrypting the EBS volume the job run on. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `[a-zA-Z0-9:/_-]*` ** [RoleArn](#API_DescribeEdgePackagingJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact Neo. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeEdgePackagingJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeEdgePackagingJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeEdgePackagingJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeEdgePackagingJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeEdgePackagingJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeEdgePackagingJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeEdgePackagingJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeEdgePackagingJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeEdgePackagingJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeEdgePackagingJob) # DescribeEndpoint Returns the description of an endpoint. ## Request Syntax ``` { "EndpointName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [EndpointName](#API_DescribeEndpoint_RequestSyntax) ** The name of the endpoint. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "AsyncInferenceConfig": { "ClientConfig": { "MaxConcurrentInvocationsPerInstance": number }, "OutputConfig": { "KmsKeyId": "string", "NotificationConfig": { "ErrorTopic": "string", "IncludeInferenceResponseIn": [ "string" ], "SuccessTopic": "string" }, "S3FailurePath": "string", "S3OutputPath": "string" } }, "CreationTime": number, "DataCaptureConfig": { "CaptureStatus": "string", "CurrentSamplingPercentage": number, "DestinationS3Uri": "string", "EnableCapture": boolean, "KmsKeyId": "string" }, "EndpointArn": "string", "EndpointConfigName": "string", "EndpointName": "string", "EndpointStatus": "string", "ExplainerConfig": { "ClarifyExplainerConfig": { "EnableExplanations": "string", "InferenceConfig": { "ContentTemplate": "string", "FeatureHeaders": [ "string" ], "FeaturesAttribute": "string", "FeatureTypes": [ "string" ], "LabelAttribute": "string", "LabelHeaders": [ "string" ], "LabelIndex": number, "MaxPayloadInMB": number, "MaxRecordCount": number, "ProbabilityAttribute": "string", "ProbabilityIndex": number }, "ShapConfig": { "NumberOfSamples": number, "Seed": number, "ShapBaselineConfig": { "MimeType": "string", "ShapBaseline": "string", "ShapBaselineUri": "string" }, "TextConfig": { "Granularity": "string", "Language": "string" }, "UseLogit": boolean } } }, "FailureReason": "string", "LastDeploymentConfig": { "AutoRollbackConfiguration": { "Alarms": [ { "AlarmName": "string" } ] }, "BlueGreenUpdatePolicy": { "MaximumExecutionTimeoutInSeconds": number, "TerminationWaitInSeconds": number, "TrafficRoutingConfiguration": { "CanarySize": { "Type": "string", "Value": number }, "LinearStepSize": { "Type": "string", "Value": number }, "Type": "string", "WaitIntervalInSeconds": number } }, "RollingUpdatePolicy": { "MaximumBatchSize": { "Type": "string", "Value": number }, "MaximumExecutionTimeoutInSeconds": number, "RollbackMaximumBatchSize": { "Type": "string", "Value": number }, "WaitIntervalInSeconds": number } }, "LastModifiedTime": number, "MetricsConfig": { "EnableEnhancedMetrics": boolean, "MetricPublishFrequencyInSeconds": number }, "PendingDeploymentSummary": { "EndpointConfigName": "string", "ProductionVariants": [ { "AcceleratorType": "string", "CurrentInstanceCount": number, "CurrentServerlessConfig": { "MaxConcurrency": number, "MemorySizeInMB": number, "ProvisionedConcurrency": number }, "CurrentWeight": number, "DeployedImages": [ { "ResolutionTime": number, "ResolvedImage": "string", "SpecifiedImage": "string" } ], "DesiredInstanceCount": number, "DesiredServerlessConfig": { "MaxConcurrency": number, "MemorySizeInMB": number, "ProvisionedConcurrency": number }, "DesiredWeight": number, "InstanceType": "string", "ManagedInstanceScaling": { "MaxInstanceCount": number, "MinInstanceCount": number, "ScaleInPolicy": { "CooldownInMinutes": number, "MaximumStepSize": number, "Strategy": "string" }, "Status": "string" }, "RoutingConfig": { "RoutingStrategy": "string" }, "VariantName": "string", "VariantStatus": [ { "StartTime": number, "Status": "string", "StatusMessage": "string" } ] } ], "ShadowProductionVariants": [ { "AcceleratorType": "string", "CurrentInstanceCount": number, "CurrentServerlessConfig": { "MaxConcurrency": number, "MemorySizeInMB": number, "ProvisionedConcurrency": number }, "CurrentWeight": number, "DeployedImages": [ { "ResolutionTime": number, "ResolvedImage": "string", "SpecifiedImage": "string" } ], "DesiredInstanceCount": number, "DesiredServerlessConfig": { "MaxConcurrency": number, "MemorySizeInMB": number, "ProvisionedConcurrency": number }, "DesiredWeight": number, "InstanceType": "string", "ManagedInstanceScaling": { "MaxInstanceCount": number, "MinInstanceCount": number, "ScaleInPolicy": { "CooldownInMinutes": number, "MaximumStepSize": number, "Strategy": "string" }, "Status": "string" }, "RoutingConfig": { "RoutingStrategy": "string" }, "VariantName": "string", "VariantStatus": [ { "StartTime": number, "Status": "string", "StatusMessage": "string" } ] } ], "StartTime": number }, "ProductionVariants": [ { "CapacityReservationConfig": { "AvailableInstanceCount": number, "CapacityReservationPreference": "string", "Ec2CapacityReservations": [ { "AvailableInstanceCount": number, "Ec2CapacityReservationId": "string", "TotalInstanceCount": number, "UsedByCurrentEndpoint": number } ], "MlReservationArn": "string", "TotalInstanceCount": number, "UsedByCurrentEndpoint": number }, "CurrentInstanceCount": number, "CurrentServerlessConfig": { "MaxConcurrency": number, "MemorySizeInMB": number, "ProvisionedConcurrency": number }, "CurrentWeight": number, "DeployedImages": [ { "ResolutionTime": number, "ResolvedImage": "string", "SpecifiedImage": "string" } ], "DesiredInstanceCount": number, "DesiredServerlessConfig": { "MaxConcurrency": number, "MemorySizeInMB": number, "ProvisionedConcurrency": number }, "DesiredWeight": number, "ManagedInstanceScaling": { "MaxInstanceCount": number, "MinInstanceCount": number, "ScaleInPolicy": { "CooldownInMinutes": number, "MaximumStepSize": number, "Strategy": "string" }, "Status": "string" }, "RoutingConfig": { "RoutingStrategy": "string" }, "VariantName": "string", "VariantStatus": [ { "StartTime": number, "Status": "string", "StatusMessage": "string" } ] } ], "ShadowProductionVariants": [ { "CapacityReservationConfig": { "AvailableInstanceCount": number, "CapacityReservationPreference": "string", "Ec2CapacityReservations": [ { "AvailableInstanceCount": number, "Ec2CapacityReservationId": "string", "TotalInstanceCount": number, "UsedByCurrentEndpoint": number } ], "MlReservationArn": "string", "TotalInstanceCount": number, "UsedByCurrentEndpoint": number }, "CurrentInstanceCount": number, "CurrentServerlessConfig": { "MaxConcurrency": number, "MemorySizeInMB": number, "ProvisionedConcurrency": number }, "CurrentWeight": number, "DeployedImages": [ { "ResolutionTime": number, "ResolvedImage": "string", "SpecifiedImage": "string" } ], "DesiredInstanceCount": number, "DesiredServerlessConfig": { "MaxConcurrency": number, "MemorySizeInMB": number, "ProvisionedConcurrency": number }, "DesiredWeight": number, "ManagedInstanceScaling": { "MaxInstanceCount": number, "MinInstanceCount": number, "ScaleInPolicy": { "CooldownInMinutes": number, "MaximumStepSize": number, "Strategy": "string" }, "Status": "string" }, "RoutingConfig": { "RoutingStrategy": "string" }, "VariantName": "string", "VariantStatus": [ { "StartTime": number, "Status": "string", "StatusMessage": "string" } ] } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AsyncInferenceConfig](#API_DescribeEndpoint_ResponseSyntax) ** Returns the description of an endpoint configuration created using the [https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html) API. Type: [AsyncInferenceConfig](API_AsyncInferenceConfig.md) object ** [CreationTime](#API_DescribeEndpoint_ResponseSyntax) ** A timestamp that shows when the endpoint was created. Type: Timestamp ** [DataCaptureConfig](#API_DescribeEndpoint_ResponseSyntax) ** The currently active data capture configuration used by your Endpoint. Type: [DataCaptureConfigSummary](API_DataCaptureConfigSummary.md) object ** [EndpointArn](#API_DescribeEndpoint_ResponseSyntax) ** The Amazon Resource Name (ARN) of the endpoint. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:endpoint/.*` ** [EndpointConfigName](#API_DescribeEndpoint_ResponseSyntax) ** The name of the endpoint configuration associated with this endpoint. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [EndpointName](#API_DescribeEndpoint_ResponseSyntax) ** Name of the endpoint. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [EndpointStatus](#API_DescribeEndpoint_ResponseSyntax) ** The status of the endpoint. + `OutOfService`: Endpoint is not available to take incoming requests. + `Creating`: [CreateEndpoint](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html) is executing. + `Updating`: [UpdateEndpoint](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html) or [UpdateEndpointWeightsAndCapacities](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html) 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](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html) call or when the [UpdateEndpointWeightsAndCapacities](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html) operation is called explicitly. + `InService`: Endpoint is available to process incoming requests. + `Deleting`: [DeleteEndpoint](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html) is executing. + `Failed`: Endpoint could not be created, updated, or re-scaled. Use the `FailureReason` value returned by [DescribeEndpoint](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html) for information about the failure. [DeleteEndpoint](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html) is the only operation that can be performed on a failed endpoint. + `UpdateRollbackFailed`: Both the rolling deployment and auto-rollback failed. Your endpoint is in service with a mix of the old and new endpoint configurations. For information about how to remedy this issue and restore the endpoint's status to `InService`, see [Rolling Deployments](https://docs.aws.amazon.com/sagemaker/latest/dg/deployment-guardrails-rolling.html). Type: String Valid Values: `OutOfService | Creating | Updating | SystemUpdating | RollingBack | InService | Deleting | Failed | UpdateRollbackFailed` ** [ExplainerConfig](#API_DescribeEndpoint_ResponseSyntax) ** The configuration parameters for an explainer. Type: [ExplainerConfig](API_ExplainerConfig.md) object ** [FailureReason](#API_DescribeEndpoint_ResponseSyntax) ** If the status of the endpoint is `Failed`, the reason why it failed. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. ** [LastDeploymentConfig](#API_DescribeEndpoint_ResponseSyntax) ** The most recent deployment configuration for the endpoint. Type: [DeploymentConfig](API_DeploymentConfig.md) object ** [LastModifiedTime](#API_DescribeEndpoint_ResponseSyntax) ** A timestamp that shows when the endpoint was last modified. Type: Timestamp ** [MetricsConfig](#API_DescribeEndpoint_ResponseSyntax) ** The configuration parameters for utilization metrics. Type: [MetricsConfig](API_MetricsConfig.md) object ** [PendingDeploymentSummary](#API_DescribeEndpoint_ResponseSyntax) ** Returns the summary of an in-progress deployment. This field is only returned when the endpoint is creating or updating with a new endpoint configuration. Type: [PendingDeploymentSummary](API_PendingDeploymentSummary.md) object ** [ProductionVariants](#API_DescribeEndpoint_ResponseSyntax) ** An array of [ProductionVariantSummary](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariantSummary.html) objects, one for each model hosted behind this endpoint. Type: Array of [ProductionVariantSummary](API_ProductionVariantSummary.md) objects Array Members: Minimum number of 1 item. ** [ShadowProductionVariants](#API_DescribeEndpoint_ResponseSyntax) ** An array of [ProductionVariantSummary](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariantSummary.html) objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on `ProductionVariants`. Type: Array of [ProductionVariantSummary](API_ProductionVariantSummary.md) objects Array Members: Minimum number of 1 item. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeEndpoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeEndpoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeEndpoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeEndpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeEndpoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeEndpoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeEndpoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeEndpoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeEndpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeEndpoint) # DescribeEndpointConfig Returns the description of an endpoint configuration created using the `CreateEndpointConfig` API. ## Request Syntax ``` { "EndpointConfigName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [EndpointConfigName](#API_DescribeEndpointConfig_RequestSyntax) ** The name of the endpoint configuration. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "AsyncInferenceConfig": { "ClientConfig": { "MaxConcurrentInvocationsPerInstance": number }, "OutputConfig": { "KmsKeyId": "string", "NotificationConfig": { "ErrorTopic": "string", "IncludeInferenceResponseIn": [ "string" ], "SuccessTopic": "string" }, "S3FailurePath": "string", "S3OutputPath": "string" } }, "CreationTime": number, "DataCaptureConfig": { "CaptureContentTypeHeader": { "CsvContentTypes": [ "string" ], "JsonContentTypes": [ "string" ] }, "CaptureOptions": [ { "CaptureMode": "string" } ], "DestinationS3Uri": "string", "EnableCapture": boolean, "InitialSamplingPercentage": number, "KmsKeyId": "string" }, "EnableNetworkIsolation": boolean, "EndpointConfigArn": "string", "EndpointConfigName": "string", "ExecutionRoleArn": "string", "ExplainerConfig": { "ClarifyExplainerConfig": { "EnableExplanations": "string", "InferenceConfig": { "ContentTemplate": "string", "FeatureHeaders": [ "string" ], "FeaturesAttribute": "string", "FeatureTypes": [ "string" ], "LabelAttribute": "string", "LabelHeaders": [ "string" ], "LabelIndex": number, "MaxPayloadInMB": number, "MaxRecordCount": number, "ProbabilityAttribute": "string", "ProbabilityIndex": number }, "ShapConfig": { "NumberOfSamples": number, "Seed": number, "ShapBaselineConfig": { "MimeType": "string", "ShapBaseline": "string", "ShapBaselineUri": "string" }, "TextConfig": { "Granularity": "string", "Language": "string" }, "UseLogit": boolean } } }, "KmsKeyId": "string", "MetricsConfig": { "EnableEnhancedMetrics": boolean, "MetricPublishFrequencyInSeconds": number }, "ProductionVariants": [ { "AcceleratorType": "string", "CapacityReservationConfig": { "CapacityReservationPreference": "string", "MlReservationArn": "string" }, "ContainerStartupHealthCheckTimeoutInSeconds": number, "CoreDumpConfig": { "DestinationS3Uri": "string", "KmsKeyId": "string" }, "EnableSSMAccess": boolean, "InferenceAmiVersion": "string", "InitialInstanceCount": number, "InitialVariantWeight": number, "InstanceType": "string", "ManagedInstanceScaling": { "MaxInstanceCount": number, "MinInstanceCount": number, "ScaleInPolicy": { "CooldownInMinutes": number, "MaximumStepSize": number, "Strategy": "string" }, "Status": "string" }, "ModelDataDownloadTimeoutInSeconds": number, "ModelName": "string", "RoutingConfig": { "RoutingStrategy": "string" }, "ServerlessConfig": { "MaxConcurrency": number, "MemorySizeInMB": number, "ProvisionedConcurrency": number }, "VariantName": "string", "VolumeSizeInGB": number } ], "ShadowProductionVariants": [ { "AcceleratorType": "string", "CapacityReservationConfig": { "CapacityReservationPreference": "string", "MlReservationArn": "string" }, "ContainerStartupHealthCheckTimeoutInSeconds": number, "CoreDumpConfig": { "DestinationS3Uri": "string", "KmsKeyId": "string" }, "EnableSSMAccess": boolean, "InferenceAmiVersion": "string", "InitialInstanceCount": number, "InitialVariantWeight": number, "InstanceType": "string", "ManagedInstanceScaling": { "MaxInstanceCount": number, "MinInstanceCount": number, "ScaleInPolicy": { "CooldownInMinutes": number, "MaximumStepSize": number, "Strategy": "string" }, "Status": "string" }, "ModelDataDownloadTimeoutInSeconds": number, "ModelName": "string", "RoutingConfig": { "RoutingStrategy": "string" }, "ServerlessConfig": { "MaxConcurrency": number, "MemorySizeInMB": number, "ProvisionedConcurrency": number }, "VariantName": "string", "VolumeSizeInGB": number } ], "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AsyncInferenceConfig](#API_DescribeEndpointConfig_ResponseSyntax) ** Returns the description of an endpoint configuration created using the [https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html) API. Type: [AsyncInferenceConfig](API_AsyncInferenceConfig.md) object ** [CreationTime](#API_DescribeEndpointConfig_ResponseSyntax) ** A timestamp that shows when the endpoint configuration was created. Type: Timestamp ** [DataCaptureConfig](#API_DescribeEndpointConfig_ResponseSyntax) ** Configuration to control how SageMaker AI captures inference data. Type: [DataCaptureConfig](API_DataCaptureConfig.md) object ** [EnableNetworkIsolation](#API_DescribeEndpointConfig_ResponseSyntax) ** Indicates whether all model containers deployed to the endpoint are isolated. If they are, no inbound or outbound network calls can be made to or from the model containers. Type: Boolean ** [EndpointConfigArn](#API_DescribeEndpointConfig_ResponseSyntax) ** The Amazon Resource Name (ARN) of the endpoint configuration. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:endpoint-config/.*` ** [EndpointConfigName](#API_DescribeEndpointConfig_ResponseSyntax) ** Name of the SageMaker endpoint configuration. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [ExecutionRoleArn](#API_DescribeEndpointConfig_ResponseSyntax) ** The Amazon Resource Name (ARN) of the IAM role that you assigned to the endpoint configuration. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` ** [ExplainerConfig](#API_DescribeEndpointConfig_ResponseSyntax) ** The configuration parameters for an explainer. Type: [ExplainerConfig](API_ExplainerConfig.md) object ** [KmsKeyId](#API_DescribeEndpointConfig_ResponseSyntax) ** AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `[a-zA-Z0-9:/_-]*` ** [MetricsConfig](#API_DescribeEndpointConfig_ResponseSyntax) ** The configuration parameters for utilization metrics. Type: [MetricsConfig](API_MetricsConfig.md) object ** [ProductionVariants](#API_DescribeEndpointConfig_ResponseSyntax) ** An array of `ProductionVariant` objects, one for each model that you want to host at this endpoint. Type: Array of [ProductionVariant](API_ProductionVariant.md) objects Array Members: Minimum number of 1 item. Maximum number of 10 items. ** [ShadowProductionVariants](#API_DescribeEndpointConfig_ResponseSyntax) ** An array of `ProductionVariant` objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on `ProductionVariants`. Type: Array of [ProductionVariant](API_ProductionVariant.md) objects Array Members: Minimum number of 1 item. Maximum number of 10 items. ** [VpcConfig](#API_DescribeEndpointConfig_ResponseSyntax) ** Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see [Give SageMaker Access to Resources in your Amazon VPC](https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html). Type: [VpcConfig](API_VpcConfig.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeEndpointConfig) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeEndpointConfig) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeEndpointConfig) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeEndpointConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeEndpointConfig) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeEndpointConfig) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeEndpointConfig) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeEndpointConfig) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeEndpointConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeEndpointConfig) # DescribeExperiment Provides a list of an experiment's properties. ## Request Syntax ``` { "ExperimentName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ExperimentName](#API_DescribeExperiment_RequestSyntax) ** The name of the experiment to describe. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` Required: Yes ## Response Syntax ``` { "CreatedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "Description": "string", "DisplayName": "string", "ExperimentArn": "string", "ExperimentName": "string", "LastModifiedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "Source": { "SourceArn": "string", "SourceType": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreatedBy](#API_DescribeExperiment_ResponseSyntax) ** Who created the experiment. Type: [UserContext](API_UserContext.md) object ** [CreationTime](#API_DescribeExperiment_ResponseSyntax) ** When the experiment was created. Type: Timestamp ** [Description](#API_DescribeExperiment_ResponseSyntax) ** The description of the experiment. Type: String Length Constraints: Minimum length of 0. Maximum length of 3072. Pattern: `.*` ** [DisplayName](#API_DescribeExperiment_ResponseSyntax) ** The name of the experiment as displayed. If `DisplayName` isn't specified, `ExperimentName` is displayed. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` ** [ExperimentArn](#API_DescribeExperiment_ResponseSyntax) ** The Amazon Resource Name (ARN) of the experiment. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:experiment/.*` ** [ExperimentName](#API_DescribeExperiment_ResponseSyntax) ** The name of the experiment. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` ** [LastModifiedBy](#API_DescribeExperiment_ResponseSyntax) ** Who last modified the experiment. Type: [UserContext](API_UserContext.md) object ** [LastModifiedTime](#API_DescribeExperiment_ResponseSyntax) ** When the experiment was last modified. Type: Timestamp ** [Source](#API_DescribeExperiment_ResponseSyntax) ** The Amazon Resource Name (ARN) of the source and, optionally, the type. Type: [ExperimentSource](API_ExperimentSource.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeExperiment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeExperiment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeExperiment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeExperiment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeExperiment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeExperiment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeExperiment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeExperiment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeExperiment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeExperiment) # DescribeFeatureGroup 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. ## Request Syntax ``` { "FeatureGroupName": "string", "NextToken": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [FeatureGroupName](#API_DescribeFeatureGroup_RequestSyntax) ** The name or Amazon Resource Name (ARN) of the `FeatureGroup` you want described. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:feature-group\/)?([a-zA-Z0-9]([_-]*[a-zA-Z0-9]){0,63})` Required: Yes ** [NextToken](#API_DescribeFeatureGroup_RequestSyntax) ** A token to resume pagination of the list of `Features` (`FeatureDefinitions`). 2,500 `Features` are returned by default. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ## Response Syntax ``` { "CreationTime": number, "Description": "string", "EventTimeFeatureName": "string", "FailureReason": "string", "FeatureDefinitions": [ { "CollectionConfig": { ... }, "CollectionType": "string", "FeatureName": "string", "FeatureType": "string" } ], "FeatureGroupArn": "string", "FeatureGroupName": "string", "FeatureGroupStatus": "string", "LastModifiedTime": number, "LastUpdateStatus": { "FailureReason": "string", "Status": "string" }, "NextToken": "string", "OfflineStoreConfig": { "DataCatalogConfig": { "Catalog": "string", "Database": "string", "TableName": "string" }, "DisableGlueTableCreation": boolean, "S3StorageConfig": { "KmsKeyId": "string", "ResolvedOutputS3Uri": "string", "S3Uri": "string" }, "TableFormat": "string" }, "OfflineStoreStatus": { "BlockedReason": "string", "Status": "string" }, "OnlineStoreConfig": { "EnableOnlineStore": boolean, "SecurityConfig": { "KmsKeyId": "string" }, "StorageType": "string", "TtlDuration": { "Unit": "string", "Value": number } }, "OnlineStoreTotalSizeBytes": number, "RecordIdentifierFeatureName": "string", "RoleArn": "string", "ThroughputConfig": { "ProvisionedReadCapacityUnits": number, "ProvisionedWriteCapacityUnits": number, "ThroughputMode": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreationTime](#API_DescribeFeatureGroup_ResponseSyntax) ** A timestamp indicating when SageMaker created the `FeatureGroup`. Type: Timestamp ** [Description](#API_DescribeFeatureGroup_ResponseSyntax) ** A free form description of the feature group. Type: String Length Constraints: Minimum length of 0. Maximum length of 128. ** [EventTimeFeatureName](#API_DescribeFeatureGroup_ResponseSyntax) ** 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`. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63}` ** [FailureReason](#API_DescribeFeatureGroup_ResponseSyntax) ** 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`. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. ** [FeatureDefinitions](#API_DescribeFeatureGroup_ResponseSyntax) ** A list of the `Features` in the `FeatureGroup`. Each feature is defined by a `FeatureName` and `FeatureType`. Type: Array of [FeatureDefinition](API_FeatureDefinition.md) objects Array Members: Minimum number of 1 item. Maximum number of 2500 items. ** [FeatureGroupArn](#API_DescribeFeatureGroup_ResponseSyntax) ** The Amazon Resource Name (ARN) of the `FeatureGroup`. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:feature-group/.*` ** [FeatureGroupName](#API_DescribeFeatureGroup_ResponseSyntax) ** he name of the `FeatureGroup`. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[a-zA-Z0-9]([_-]*[a-zA-Z0-9]){0,63}` ** [FeatureGroupStatus](#API_DescribeFeatureGroup_ResponseSyntax) ** The status of the feature group. Type: String Valid Values: `Creating | Created | CreateFailed | Deleting | DeleteFailed` ** [LastModifiedTime](#API_DescribeFeatureGroup_ResponseSyntax) ** A timestamp indicating when the feature group was last updated. Type: Timestamp ** [LastUpdateStatus](#API_DescribeFeatureGroup_ResponseSyntax) ** A value indicating whether the update made to the feature group was successful. Type: [LastUpdateStatus](API_LastUpdateStatus.md) object ** [NextToken](#API_DescribeFeatureGroup_ResponseSyntax) ** A token to resume pagination of the list of `Features` (`FeatureDefinitions`). Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ** [OfflineStoreConfig](#API_DescribeFeatureGroup_ResponseSyntax) ** The configuration of the offline store. It includes the following configurations: + Amazon S3 location of the offline store. + Configuration of the Glue data catalog. + Table format of the offline store. + Option to disable the automatic creation of a Glue table for the offline store. + Encryption configuration. Type: [OfflineStoreConfig](API_OfflineStoreConfig.md) object ** [OfflineStoreStatus](#API_DescribeFeatureGroup_ResponseSyntax) ** The status of the `OfflineStore`. Notifies you if replicating data into the `OfflineStore` has failed. Returns either: `Active` or `Blocked` Type: [OfflineStoreStatus](API_OfflineStoreStatus.md) object ** [OnlineStoreConfig](#API_DescribeFeatureGroup_ResponseSyntax) ** The configuration for the `OnlineStore`. Type: [OnlineStoreConfig](API_OnlineStoreConfig.md) object ** [OnlineStoreTotalSizeBytes](#API_DescribeFeatureGroup_ResponseSyntax) ** The size of the `OnlineStore` in bytes. Type: Long ** [RecordIdentifierFeatureName](#API_DescribeFeatureGroup_ResponseSyntax) ** The name of the `Feature` used for `RecordIdentifier`, whose value uniquely identifies a record stored in the feature store. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63}` ** [RoleArn](#API_DescribeFeatureGroup_ResponseSyntax) ** The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` ** [ThroughputConfig](#API_DescribeFeatureGroup_ResponseSyntax) ** Active throughput configuration of the feature group. There are two modes: `ON_DEMAND` and `PROVISIONED`. With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled. Note: `PROVISIONED` throughput mode is supported only for feature groups that are offline-only, or use the [https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OnlineStoreConfig.html#sagemaker-Type-OnlineStoreConfig-StorageType](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OnlineStoreConfig.html#sagemaker-Type-OnlineStoreConfig-StorageType) tier online store. Type: [ThroughputConfigDescription](API_ThroughputConfigDescription.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeFeatureGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeFeatureGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeFeatureGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeFeatureGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeFeatureGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeFeatureGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeFeatureGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeFeatureGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeFeatureGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeFeatureGroup) # DescribeFeatureMetadata Shows the metadata for a feature within a feature group. ## Request Syntax ``` { "FeatureGroupName": "string", "FeatureName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [FeatureGroupName](#API_DescribeFeatureMetadata_RequestSyntax) ** The name or Amazon Resource Name (ARN) of the feature group containing the feature. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:feature-group\/)?([a-zA-Z0-9]([_-]*[a-zA-Z0-9]){0,63})` Required: Yes ** [FeatureName](#API_DescribeFeatureMetadata_RequestSyntax) ** The name of the feature. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63}` Required: Yes ## Response Syntax ``` { "CreationTime": number, "Description": "string", "FeatureGroupArn": "string", "FeatureGroupName": "string", "FeatureName": "string", "FeatureType": "string", "LastModifiedTime": number, "Parameters": [ { "Key": "string", "Value": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreationTime](#API_DescribeFeatureMetadata_ResponseSyntax) ** A timestamp indicating when the feature was created. Type: Timestamp ** [Description](#API_DescribeFeatureMetadata_ResponseSyntax) ** The description you added to describe the feature. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: `.*` ** [FeatureGroupArn](#API_DescribeFeatureMetadata_ResponseSyntax) ** The Amazon Resource Number (ARN) of the feature group that contains the feature. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:feature-group/.*` ** [FeatureGroupName](#API_DescribeFeatureMetadata_ResponseSyntax) ** The name of the feature group that you've specified. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[a-zA-Z0-9]([_-]*[a-zA-Z0-9]){0,63}` ** [FeatureName](#API_DescribeFeatureMetadata_ResponseSyntax) ** The name of the feature that you've specified. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63}` ** [FeatureType](#API_DescribeFeatureMetadata_ResponseSyntax) ** The data type of the feature. Type: String Valid Values: `Integral | Fractional | String` ** [LastModifiedTime](#API_DescribeFeatureMetadata_ResponseSyntax) ** A timestamp indicating when the metadata for the feature group was modified. For example, if you add a parameter describing the feature, the timestamp changes to reflect the last time you Type: Timestamp ** [Parameters](#API_DescribeFeatureMetadata_ResponseSyntax) ** The key-value pairs that you added to describe the feature. Type: Array of [FeatureParameter](API_FeatureParameter.md) objects Array Members: Minimum number of 0 items. Maximum number of 25 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeFeatureMetadata) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeFeatureMetadata) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeFeatureMetadata) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeFeatureMetadata) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeFeatureMetadata) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeFeatureMetadata) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeFeatureMetadata) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeFeatureMetadata) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeFeatureMetadata) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeFeatureMetadata) # DescribeFlowDefinition Returns information about the specified flow definition. ## Request Syntax ``` { "FlowDefinitionName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [FlowDefinitionName](#API_DescribeFlowDefinition_RequestSyntax) ** The name of the flow definition. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-z0-9](-*[a-z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "CreationTime": number, "FailureReason": "string", "FlowDefinitionArn": "string", "FlowDefinitionName": "string", "FlowDefinitionStatus": "string", "HumanLoopActivationConfig": { "HumanLoopActivationConditionsConfig": { "HumanLoopActivationConditions": "string" } }, "HumanLoopConfig": { "HumanTaskUiArn": "string", "PublicWorkforceTaskPrice": { "AmountInUsd": { "Cents": number, "Dollars": number, "TenthFractionsOfACent": number } }, "TaskAvailabilityLifetimeInSeconds": number, "TaskCount": number, "TaskDescription": "string", "TaskKeywords": [ "string" ], "TaskTimeLimitInSeconds": number, "TaskTitle": "string", "WorkteamArn": "string" }, "HumanLoopRequestSource": { "AwsManagedHumanLoopRequestSource": "string" }, "OutputConfig": { "KmsKeyId": "string", "S3OutputPath": "string" }, "RoleArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreationTime](#API_DescribeFlowDefinition_ResponseSyntax) ** The timestamp when the flow definition was created. Type: Timestamp ** [FailureReason](#API_DescribeFlowDefinition_ResponseSyntax) ** The reason your flow definition failed. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. ** [FlowDefinitionArn](#API_DescribeFlowDefinition_ResponseSyntax) ** The Amazon Resource Name (ARN) of the flow defintion. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]+:[0-9]{12}:flow-definition/.*` ** [FlowDefinitionName](#API_DescribeFlowDefinition_ResponseSyntax) ** The Amazon Resource Name (ARN) of the flow definition. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-z0-9](-*[a-z0-9]){0,62}` ** [FlowDefinitionStatus](#API_DescribeFlowDefinition_ResponseSyntax) ** The status of the flow definition. Valid values are listed below. Type: String Valid Values: `Initializing | Active | Failed | Deleting` ** [HumanLoopActivationConfig](#API_DescribeFlowDefinition_ResponseSyntax) ** An object containing information about what triggers a human review workflow. Type: [HumanLoopActivationConfig](API_HumanLoopActivationConfig.md) object ** [HumanLoopConfig](#API_DescribeFlowDefinition_ResponseSyntax) ** An object containing information about who works on the task, the workforce task price, and other task details. Type: [HumanLoopConfig](API_HumanLoopConfig.md) object ** [HumanLoopRequestSource](#API_DescribeFlowDefinition_ResponseSyntax) ** Container for configuring the source of human task requests. Used to specify if Amazon Rekognition or Amazon Textract is used as an integration source. Type: [HumanLoopRequestSource](API_HumanLoopRequestSource.md) object ** [OutputConfig](#API_DescribeFlowDefinition_ResponseSyntax) ** An object containing information about the output file. Type: [FlowDefinitionOutputConfig](API_FlowDefinitionOutputConfig.md) object ** [RoleArn](#API_DescribeFlowDefinition_ResponseSyntax) ** The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) execution role for the flow definition. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeFlowDefinition) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeFlowDefinition) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeFlowDefinition) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeFlowDefinition) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeFlowDefinition) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeFlowDefinition) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeFlowDefinition) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeFlowDefinition) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeFlowDefinition) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeFlowDefinition) # DescribeHub Describes a hub. ## Request Syntax ``` { "HubName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [HubName](#API_DescribeHub_RequestSyntax) ** The name of the hub to describe. Type: String Pattern: `(arn:[a-z0-9-\.]{1,63}:sagemaker:\w+(?:-\w+)+:(\d{12}|aws):hub\/)?[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "CreationTime": number, "FailureReason": "string", "HubArn": "string", "HubDescription": "string", "HubDisplayName": "string", "HubName": "string", "HubSearchKeywords": [ "string" ], "HubStatus": "string", "LastModifiedTime": number, "S3StorageConfig": { "S3OutputPath": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreationTime](#API_DescribeHub_ResponseSyntax) ** The date and time that the hub was created. Type: Timestamp ** [FailureReason](#API_DescribeHub_ResponseSyntax) ** The failure reason if importing hub content failed. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. ** [HubArn](#API_DescribeHub_ResponseSyntax) ** The Amazon Resource Name (ARN) of the hub. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: `.*` ** [HubDescription](#API_DescribeHub_ResponseSyntax) ** A description of the hub. Type: String Length Constraints: Minimum length of 0. Maximum length of 1023. Pattern: `.*` ** [HubDisplayName](#API_DescribeHub_ResponseSyntax) ** The display name of the hub. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: `.*` ** [HubName](#API_DescribeHub_ResponseSyntax) ** The name of the hub. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [HubSearchKeywords](#API_DescribeHub_ResponseSyntax) ** The searchable keywords for the hub. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 50 items. Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: `[^A-Z]*` ** [HubStatus](#API_DescribeHub_ResponseSyntax) ** The status of the hub. Type: String Valid Values: `InService | Creating | Updating | Deleting | CreateFailed | UpdateFailed | DeleteFailed` ** [LastModifiedTime](#API_DescribeHub_ResponseSyntax) ** The date and time that the hub was last modified. Type: Timestamp ** [S3StorageConfig](#API_DescribeHub_ResponseSyntax) ** The Amazon S3 storage configuration for the hub. Type: [HubS3StorageConfig](API_HubS3StorageConfig.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeHub) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeHub) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeHub) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeHub) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeHub) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeHub) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeHub) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeHub) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeHub) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeHub) # DescribeHubContent Describe the content of a hub. ## Request Syntax ``` { "HubContentName": "string", "HubContentType": "string", "HubContentVersion": "string", "HubName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [HubContentName](#API_DescribeHubContent_RequestSyntax) ** The name of the content to describe. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [HubContentType](#API_DescribeHubContent_RequestSyntax) ** The type of content in the hub. Type: String Valid Values: `Model | Notebook | ModelReference | DataSet | JsonDoc` Required: Yes ** [HubContentVersion](#API_DescribeHubContent_RequestSyntax) ** The version of the content to describe. Type: String Length Constraints: Minimum length of 5. Maximum length of 14. Pattern: `\d{1,4}.\d{1,4}.\d{1,4}` Required: No ** [HubName](#API_DescribeHubContent_RequestSyntax) ** The name of the hub that contains the content to describe. Type: String Pattern: `(arn:[a-z0-9-\.]{1,63}:sagemaker:\w+(?:-\w+)+:(\d{12}|aws):hub\/)?[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "CreationTime": number, "DocumentSchemaVersion": "string", "FailureReason": "string", "HubArn": "string", "HubContentArn": "string", "HubContentDependencies": [ { "DependencyCopyPath": "string", "DependencyOriginPath": "string" } ], "HubContentDescription": "string", "HubContentDisplayName": "string", "HubContentDocument": "string", "HubContentMarkdown": "string", "HubContentName": "string", "HubContentSearchKeywords": [ "string" ], "HubContentStatus": "string", "HubContentType": "string", "HubContentVersion": "string", "HubName": "string", "LastModifiedTime": number, "ReferenceMinVersion": "string", "SageMakerPublicHubContentArn": "string", "SupportStatus": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreationTime](#API_DescribeHubContent_ResponseSyntax) ** The date and time that hub content was created. Type: Timestamp ** [DocumentSchemaVersion](#API_DescribeHubContent_ResponseSyntax) ** The document schema version for the hub content. Type: String Length Constraints: Minimum length of 5. Maximum length of 14. Pattern: `\d{1,4}.\d{1,4}.\d{1,4}` ** [FailureReason](#API_DescribeHubContent_ResponseSyntax) ** The failure reason if importing hub content failed. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. ** [HubArn](#API_DescribeHubContent_ResponseSyntax) ** The Amazon Resource Name (ARN) of the hub that contains the content. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: `.*` ** [HubContentArn](#API_DescribeHubContent_ResponseSyntax) ** The Amazon Resource Name (ARN) of the hub content. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: `.*` ** [HubContentDependencies](#API_DescribeHubContent_ResponseSyntax) ** The location of any dependencies that the hub content has, such as scripts, model artifacts, datasets, or notebooks. Type: Array of [HubContentDependency](API_HubContentDependency.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. ** [HubContentDescription](#API_DescribeHubContent_ResponseSyntax) ** A description of the hub content. Type: String Length Constraints: Minimum length of 0. Maximum length of 1023. Pattern: `.*` ** [HubContentDisplayName](#API_DescribeHubContent_ResponseSyntax) ** The display name of the hub content. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: `.*` ** [HubContentDocument](#API_DescribeHubContent_ResponseSyntax) ** The hub content document that describes information about the hub content such as type, associated containers, scripts, and more. Type: String Length Constraints: Minimum length of 0. Maximum length of 327680. Pattern: `.*` ** [HubContentMarkdown](#API_DescribeHubContent_ResponseSyntax) ** A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating. Type: String Length Constraints: Minimum length of 0. Maximum length of 170391. ** [HubContentName](#API_DescribeHubContent_ResponseSyntax) ** The name of the hub content. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [HubContentSearchKeywords](#API_DescribeHubContent_ResponseSyntax) ** The searchable keywords for the hub content. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 50 items. Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: `.*` ** [HubContentStatus](#API_DescribeHubContent_ResponseSyntax) ** The status of the hub content. Type: String Valid Values: `Available | Importing | Deleting | ImportFailed | DeleteFailed | PendingImport | PendingDelete` ** [HubContentType](#API_DescribeHubContent_ResponseSyntax) ** The type of hub content. Type: String Valid Values: `Model | Notebook | ModelReference | DataSet | JsonDoc` ** [HubContentVersion](#API_DescribeHubContent_ResponseSyntax) ** The version of the hub content. Type: String Length Constraints: Minimum length of 5. Maximum length of 14. Pattern: `\d{1,4}.\d{1,4}.\d{1,4}` ** [HubName](#API_DescribeHubContent_ResponseSyntax) ** The name of the hub that contains the content. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [LastModifiedTime](#API_DescribeHubContent_ResponseSyntax) ** The last modified time of the hub content. Type: Timestamp ** [ReferenceMinVersion](#API_DescribeHubContent_ResponseSyntax) ** The minimum version of the hub content. Type: String Length Constraints: Minimum length of 5. Maximum length of 14. Pattern: `\d{1,4}.\d{1,4}.\d{1,4}` ** [SageMakerPublicHubContentArn](#API_DescribeHubContent_ResponseSyntax) ** The ARN of the public hub content. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: `arn:[a-z0-9-\.]{1,63}:sagemaker:\w+(?:-\w+)+:aws:hub-content\/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}\/Model\/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}` ** [SupportStatus](#API_DescribeHubContent_ResponseSyntax) ** The support status of the hub content. Type: String Valid Values: `Supported | Deprecated | Restricted` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeHubContent) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeHubContent) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeHubContent) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeHubContent) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeHubContent) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeHubContent) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeHubContent) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeHubContent) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeHubContent) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeHubContent) # DescribeHumanTaskUi Returns information about the requested human task user interface (worker task template). ## Request Syntax ``` { "HumanTaskUiName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [HumanTaskUiName](#API_DescribeHumanTaskUi_RequestSyntax) ** The name of the human task user interface (worker task template) you want information about. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-z0-9](-*[a-z0-9])*` Required: Yes ## Response Syntax ``` { "CreationTime": number, "HumanTaskUiArn": "string", "HumanTaskUiName": "string", "HumanTaskUiStatus": "string", "UiTemplate": { "ContentSha256": "string", "Url": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreationTime](#API_DescribeHumanTaskUi_ResponseSyntax) ** The timestamp when the human task user interface was created. Type: Timestamp ** [HumanTaskUiArn](#API_DescribeHumanTaskUi_ResponseSyntax) ** The Amazon Resource Name (ARN) of the human task user interface (worker task template). Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]+:[0-9]{12}:human-task-ui/.*` ** [HumanTaskUiName](#API_DescribeHumanTaskUi_ResponseSyntax) ** The name of the human task user interface (worker task template). Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-z0-9](-*[a-z0-9])*` ** [HumanTaskUiStatus](#API_DescribeHumanTaskUi_ResponseSyntax) ** The status of the human task user interface (worker task template). Valid values are listed below. Type: String Valid Values: `Active | Deleting` ** [UiTemplate](#API_DescribeHumanTaskUi_ResponseSyntax) ** Container for user interface template information. Type: [UiTemplateInfo](API_UiTemplateInfo.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeHumanTaskUi) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeHumanTaskUi) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeHumanTaskUi) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeHumanTaskUi) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeHumanTaskUi) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeHumanTaskUi) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeHumanTaskUi) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeHumanTaskUi) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeHumanTaskUi) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeHumanTaskUi) # DescribeHyperParameterTuningJob Returns a description of a hyperparameter tuning job, depending on the fields selected. These fields can include the name, Amazon Resource Name (ARN), job status of your tuning job and more. ## Request Syntax ``` { "HyperParameterTuningJobName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [HyperParameterTuningJobName](#API_DescribeHyperParameterTuningJob_RequestSyntax) ** The name of the tuning job. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}` Required: Yes ## Response Syntax ``` { "Autotune": { "Mode": "string" }, "BestTrainingJob": { "CreationTime": number, "FailureReason": "string", "FinalHyperParameterTuningJobObjectiveMetric": { "MetricName": "string", "Type": "string", "Value": number }, "ObjectiveStatus": "string", "TrainingEndTime": number, "TrainingJobArn": "string", "TrainingJobDefinitionName": "string", "TrainingJobName": "string", "TrainingJobStatus": "string", "TrainingStartTime": number, "TunedHyperParameters": { "string" : "string" }, "TuningJobName": "string" }, "ConsumedResources": { "RuntimeInSeconds": number }, "CreationTime": number, "FailureReason": "string", "HyperParameterTuningEndTime": number, "HyperParameterTuningJobArn": "string", "HyperParameterTuningJobConfig": { "HyperParameterTuningJobObjective": { "MetricName": "string", "Type": "string" }, "ParameterRanges": { "AutoParameters": [ { "Name": "string", "ValueHint": "string" } ], "CategoricalParameterRanges": [ { "Name": "string", "Values": [ "string" ] } ], "ContinuousParameterRanges": [ { "MaxValue": "string", "MinValue": "string", "Name": "string", "ScalingType": "string" } ], "IntegerParameterRanges": [ { "MaxValue": "string", "MinValue": "string", "Name": "string", "ScalingType": "string" } ] }, "RandomSeed": number, "ResourceLimits": { "MaxNumberOfTrainingJobs": number, "MaxParallelTrainingJobs": number, "MaxRuntimeInSeconds": number }, "Strategy": "string", "StrategyConfig": { "HyperbandStrategyConfig": { "MaxResource": number, "MinResource": number } }, "TrainingJobEarlyStoppingType": "string", "TuningJobCompletionCriteria": { "BestObjectiveNotImproving": { "MaxNumberOfTrainingJobsNotImproving": number }, "ConvergenceDetected": { "CompleteOnConvergence": "string" }, "TargetObjectiveMetricValue": number } }, "HyperParameterTuningJobName": "string", "HyperParameterTuningJobStatus": "string", "LastModifiedTime": number, "ObjectiveStatusCounters": { "Failed": number, "Pending": number, "Succeeded": number }, "OverallBestTrainingJob": { "CreationTime": number, "FailureReason": "string", "FinalHyperParameterTuningJobObjectiveMetric": { "MetricName": "string", "Type": "string", "Value": number }, "ObjectiveStatus": "string", "TrainingEndTime": number, "TrainingJobArn": "string", "TrainingJobDefinitionName": "string", "TrainingJobName": "string", "TrainingJobStatus": "string", "TrainingStartTime": number, "TunedHyperParameters": { "string" : "string" }, "TuningJobName": "string" }, "TrainingJobDefinition": { "AlgorithmSpecification": { "AlgorithmName": "string", "MetricDefinitions": [ { "Name": "string", "Regex": "string" } ], "TrainingImage": "string", "TrainingInputMode": "string" }, "CheckpointConfig": { "LocalPath": "string", "S3Uri": "string" }, "DefinitionName": "string", "EnableInterContainerTrafficEncryption": boolean, "EnableManagedSpotTraining": boolean, "EnableNetworkIsolation": boolean, "Environment": { "string" : "string" }, "HyperParameterRanges": { "AutoParameters": [ { "Name": "string", "ValueHint": "string" } ], "CategoricalParameterRanges": [ { "Name": "string", "Values": [ "string" ] } ], "ContinuousParameterRanges": [ { "MaxValue": "string", "MinValue": "string", "Name": "string", "ScalingType": "string" } ], "IntegerParameterRanges": [ { "MaxValue": "string", "MinValue": "string", "Name": "string", "ScalingType": "string" } ] }, "HyperParameterTuningResourceConfig": { "AllocationStrategy": "string", "InstanceConfigs": [ { "InstanceCount": number, "InstanceType": "string", "VolumeSizeInGB": number } ], "InstanceCount": number, "InstanceType": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number }, "InputDataConfig": [ { "ChannelName": "string", "CompressionType": "string", "ContentType": "string", "DataSource": { "FileSystemDataSource": { "DirectoryPath": "string", "FileSystemAccessMode": "string", "FileSystemId": "string", "FileSystemType": "string" }, "S3DataSource": { "AttributeNames": [ "string" ], "HubAccessConfig": { "HubContentArn": "string" }, "InstanceGroupNames": [ "string" ], "ModelAccessConfig": { "AcceptEula": boolean }, "S3DataDistributionType": "string", "S3DataType": "string", "S3Uri": "string" } }, "InputMode": "string", "RecordWrapperType": "string", "ShuffleConfig": { "Seed": number } } ], "OutputDataConfig": { "CompressionType": "string", "KmsKeyId": "string", "S3OutputPath": "string" }, "ResourceConfig": { "InstanceCount": number, "InstanceGroups": [ { "InstanceCount": number, "InstanceGroupName": "string", "InstanceType": "string" } ], "InstancePlacementConfig": { "EnableMultipleJobs": boolean, "PlacementSpecifications": [ { "InstanceCount": number, "UltraServerId": "string" } ] }, "InstanceType": "string", "KeepAlivePeriodInSeconds": number, "TrainingPlanArn": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number }, "RetryStrategy": { "MaximumRetryAttempts": number }, "RoleArn": "string", "StaticHyperParameters": { "string" : "string" }, "StoppingCondition": { "MaxPendingTimeInSeconds": number, "MaxRuntimeInSeconds": number, "MaxWaitTimeInSeconds": number }, "TuningObjective": { "MetricName": "string", "Type": "string" }, "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } }, "TrainingJobDefinitions": [ { "AlgorithmSpecification": { "AlgorithmName": "string", "MetricDefinitions": [ { "Name": "string", "Regex": "string" } ], "TrainingImage": "string", "TrainingInputMode": "string" }, "CheckpointConfig": { "LocalPath": "string", "S3Uri": "string" }, "DefinitionName": "string", "EnableInterContainerTrafficEncryption": boolean, "EnableManagedSpotTraining": boolean, "EnableNetworkIsolation": boolean, "Environment": { "string" : "string" }, "HyperParameterRanges": { "AutoParameters": [ { "Name": "string", "ValueHint": "string" } ], "CategoricalParameterRanges": [ { "Name": "string", "Values": [ "string" ] } ], "ContinuousParameterRanges": [ { "MaxValue": "string", "MinValue": "string", "Name": "string", "ScalingType": "string" } ], "IntegerParameterRanges": [ { "MaxValue": "string", "MinValue": "string", "Name": "string", "ScalingType": "string" } ] }, "HyperParameterTuningResourceConfig": { "AllocationStrategy": "string", "InstanceConfigs": [ { "InstanceCount": number, "InstanceType": "string", "VolumeSizeInGB": number } ], "InstanceCount": number, "InstanceType": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number }, "InputDataConfig": [ { "ChannelName": "string", "CompressionType": "string", "ContentType": "string", "DataSource": { "FileSystemDataSource": { "DirectoryPath": "string", "FileSystemAccessMode": "string", "FileSystemId": "string", "FileSystemType": "string" }, "S3DataSource": { "AttributeNames": [ "string" ], "HubAccessConfig": { "HubContentArn": "string" }, "InstanceGroupNames": [ "string" ], "ModelAccessConfig": { "AcceptEula": boolean }, "S3DataDistributionType": "string", "S3DataType": "string", "S3Uri": "string" } }, "InputMode": "string", "RecordWrapperType": "string", "ShuffleConfig": { "Seed": number } } ], "OutputDataConfig": { "CompressionType": "string", "KmsKeyId": "string", "S3OutputPath": "string" }, "ResourceConfig": { "InstanceCount": number, "InstanceGroups": [ { "InstanceCount": number, "InstanceGroupName": "string", "InstanceType": "string" } ], "InstancePlacementConfig": { "EnableMultipleJobs": boolean, "PlacementSpecifications": [ { "InstanceCount": number, "UltraServerId": "string" } ] }, "InstanceType": "string", "KeepAlivePeriodInSeconds": number, "TrainingPlanArn": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number }, "RetryStrategy": { "MaximumRetryAttempts": number }, "RoleArn": "string", "StaticHyperParameters": { "string" : "string" }, "StoppingCondition": { "MaxPendingTimeInSeconds": number, "MaxRuntimeInSeconds": number, "MaxWaitTimeInSeconds": number }, "TuningObjective": { "MetricName": "string", "Type": "string" }, "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } } ], "TrainingJobStatusCounters": { "Completed": number, "InProgress": number, "NonRetryableError": number, "RetryableError": number, "Stopped": number }, "TuningJobCompletionDetails": { "ConvergenceDetectedTime": number, "NumberOfTrainingJobsObjectiveNotImproving": number }, "WarmStartConfig": { "ParentHyperParameterTuningJobs": [ { "HyperParameterTuningJobName": "string" } ], "WarmStartType": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Autotune](#API_DescribeHyperParameterTuningJob_ResponseSyntax) ** A flag to indicate if autotune is enabled for the hyperparameter tuning job. Type: [Autotune](API_Autotune.md) object ** [BestTrainingJob](#API_DescribeHyperParameterTuningJob_ResponseSyntax) ** A [TrainingJobSummary](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html) object that describes the training job that completed with the best current [HyperParameterTuningJobObjective](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobObjective.html). Type: [HyperParameterTrainingJobSummary](API_HyperParameterTrainingJobSummary.md) object ** [ConsumedResources](#API_DescribeHyperParameterTuningJob_ResponseSyntax) ** The total resources consumed by your hyperparameter tuning job. Type: [HyperParameterTuningJobConsumedResources](API_HyperParameterTuningJobConsumedResources.md) object ** [CreationTime](#API_DescribeHyperParameterTuningJob_ResponseSyntax) ** The date and time that the tuning job started. Type: Timestamp ** [FailureReason](#API_DescribeHyperParameterTuningJob_ResponseSyntax) ** If the tuning job failed, the reason it failed. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. ** [HyperParameterTuningEndTime](#API_DescribeHyperParameterTuningJob_ResponseSyntax) ** The date and time that the tuning job ended. Type: Timestamp ** [HyperParameterTuningJobArn](#API_DescribeHyperParameterTuningJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the tuning job. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:hyper-parameter-tuning-job/.*` ** [HyperParameterTuningJobConfig](#API_DescribeHyperParameterTuningJob_ResponseSyntax) ** The [HyperParameterTuningJobConfig](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html) object that specifies the configuration of the tuning job. Type: [HyperParameterTuningJobConfig](API_HyperParameterTuningJobConfig.md) object ** [HyperParameterTuningJobName](#API_DescribeHyperParameterTuningJob_ResponseSyntax) ** The name of the hyperparameter tuning job. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}` ** [HyperParameterTuningJobStatus](#API_DescribeHyperParameterTuningJob_ResponseSyntax) ** The status of the tuning job. Type: String Valid Values: `Completed | InProgress | Failed | Stopped | Stopping | Deleting | DeleteFailed` ** [LastModifiedTime](#API_DescribeHyperParameterTuningJob_ResponseSyntax) ** The date and time that the status of the tuning job was modified. Type: Timestamp ** [ObjectiveStatusCounters](#API_DescribeHyperParameterTuningJob_ResponseSyntax) ** The [ObjectiveStatusCounters](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ObjectiveStatusCounters.html) object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched. Type: [ObjectiveStatusCounters](API_ObjectiveStatusCounters.md) object ** [OverallBestTrainingJob](#API_DescribeHyperParameterTuningJob_ResponseSyntax) ** If the hyperparameter tuning job is an warm start tuning job with a `WarmStartType` of `IDENTICAL_DATA_AND_ALGORITHM`, this is the [TrainingJobSummary](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html) 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. Type: [HyperParameterTrainingJobSummary](API_HyperParameterTrainingJobSummary.md) object ** [TrainingJobDefinition](#API_DescribeHyperParameterTuningJob_ResponseSyntax) ** The [HyperParameterTrainingJobDefinition](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html) object that specifies the definition of the training jobs that this tuning job launches. Type: [HyperParameterTrainingJobDefinition](API_HyperParameterTrainingJobDefinition.md) object ** [TrainingJobDefinitions](#API_DescribeHyperParameterTuningJob_ResponseSyntax) ** A list of the [HyperParameterTrainingJobDefinition](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html) objects launched for this tuning job. Type: Array of [HyperParameterTrainingJobDefinition](API_HyperParameterTrainingJobDefinition.md) objects Array Members: Minimum number of 1 item. Maximum number of 10 items. ** [TrainingJobStatusCounters](#API_DescribeHyperParameterTuningJob_ResponseSyntax) ** The [TrainingJobStatusCounters](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobStatusCounters.html) object that specifies the number of training jobs, categorized by status, that this tuning job launched. Type: [TrainingJobStatusCounters](API_TrainingJobStatusCounters.md) object ** [TuningJobCompletionDetails](#API_DescribeHyperParameterTuningJob_ResponseSyntax) ** Tuning job completion information returned as the response from a hyperparameter tuning job. This information tells if your tuning job has or has not converged. It also includes the number of training jobs that have not improved model performance as evaluated against the objective function. Type: [HyperParameterTuningJobCompletionDetails](API_HyperParameterTuningJobCompletionDetails.md) object ** [WarmStartConfig](#API_DescribeHyperParameterTuningJob_ResponseSyntax) ** 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. Type: [HyperParameterTuningJobWarmStartConfig](API_HyperParameterTuningJobWarmStartConfig.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeHyperParameterTuningJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeHyperParameterTuningJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeHyperParameterTuningJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeHyperParameterTuningJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeHyperParameterTuningJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeHyperParameterTuningJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeHyperParameterTuningJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeHyperParameterTuningJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeHyperParameterTuningJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeHyperParameterTuningJob) # DescribeImage Describes a SageMaker AI image. ## Request Syntax ``` { "ImageName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ImageName](#API_DescribeImage_RequestSyntax) ** The name of the image to describe. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "CreationTime": number, "Description": "string", "DisplayName": "string", "FailureReason": "string", "ImageArn": "string", "ImageName": "string", "ImageStatus": "string", "LastModifiedTime": number, "RoleArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreationTime](#API_DescribeImage_ResponseSyntax) ** When the image was created. Type: Timestamp ** [Description](#API_DescribeImage_ResponseSyntax) ** The description of the image. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Pattern: `.*` ** [DisplayName](#API_DescribeImage_ResponseSyntax) ** The name of the image as displayed. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `\S(.*\S)?` ** [FailureReason](#API_DescribeImage_ResponseSyntax) ** When a create, update, or delete operation fails, the reason for the failure. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. ** [ImageArn](#API_DescribeImage_ResponseSyntax) ** The ARN of the image. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-zA-Z0-9]([-.]?[a-zA-Z0-9])*` ** [ImageName](#API_DescribeImage_ResponseSyntax) ** The name of the image. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}` ** [ImageStatus](#API_DescribeImage_ResponseSyntax) ** The status of the image. Type: String Valid Values: `CREATING | CREATED | CREATE_FAILED | UPDATING | UPDATE_FAILED | DELETING | DELETE_FAILED` ** [LastModifiedTime](#API_DescribeImage_ResponseSyntax) ** When the image was last modified. Type: Timestamp ** [RoleArn](#API_DescribeImage_ResponseSyntax) ** The ARN of the IAM role that enables Amazon SageMaker AI to perform tasks on your behalf. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeImage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeImage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeImage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeImage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeImage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeImage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeImage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeImage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeImage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeImage) # DescribeImageVersion Describes a version of a SageMaker AI image. ## Request Syntax ``` { "Alias": "string", "ImageName": "string", "Version": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Alias](#API_DescribeImageVersion_RequestSyntax) ** The alias of the image version. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `(?!^[.-])^([a-zA-Z0-9-_.]+)` Required: No ** [ImageName](#API_DescribeImageVersion_RequestSyntax) ** The name of the image. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}` Required: Yes ** [Version](#API_DescribeImageVersion_RequestSyntax) ** The version of the image. If not specified, the latest version is described. Type: Integer Valid Range: Minimum value of 0. Required: No ## Response Syntax ``` { "BaseImage": "string", "ContainerImage": "string", "CreationTime": number, "FailureReason": "string", "Horovod": boolean, "ImageArn": "string", "ImageVersionArn": "string", "ImageVersionStatus": "string", "JobType": "string", "LastModifiedTime": number, "MLFramework": "string", "Processor": "string", "ProgrammingLang": "string", "ReleaseNotes": "string", "VendorGuidance": "string", "Version": number } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [BaseImage](#API_DescribeImageVersion_ResponseSyntax) ** The registry path of the container image on which this image version is based. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `.*` ** [ContainerImage](#API_DescribeImageVersion_ResponseSyntax) ** The registry path of the container image that contains this image version. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [CreationTime](#API_DescribeImageVersion_ResponseSyntax) ** When the version was created. Type: Timestamp ** [FailureReason](#API_DescribeImageVersion_ResponseSyntax) ** When a create or delete operation fails, the reason for the failure. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. ** [Horovod](#API_DescribeImageVersion_ResponseSyntax) ** Indicates Horovod compatibility. Type: Boolean ** [ImageArn](#API_DescribeImageVersion_ResponseSyntax) ** The ARN of the image the version is based on. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-zA-Z0-9]([-.]?[a-zA-Z0-9])*` ** [ImageVersionArn](#API_DescribeImageVersion_ResponseSyntax) ** The ARN of the version. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `(arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+|None)` ** [ImageVersionStatus](#API_DescribeImageVersion_ResponseSyntax) ** The status of the version. Type: String Valid Values: `CREATING | CREATED | CREATE_FAILED | DELETING | DELETE_FAILED` ** [JobType](#API_DescribeImageVersion_ResponseSyntax) ** Indicates SageMaker AI job type compatibility. + `TRAINING`: The image version is compatible with SageMaker AI training jobs. + `INFERENCE`: The image version is compatible with SageMaker AI inference jobs. + `NOTEBOOK_KERNEL`: The image version is compatible with SageMaker AI notebook kernels. Type: String Valid Values: `TRAINING | INFERENCE | NOTEBOOK_KERNEL` ** [LastModifiedTime](#API_DescribeImageVersion_ResponseSyntax) ** When the version was last modified. Type: Timestamp ** [MLFramework](#API_DescribeImageVersion_ResponseSyntax) ** The machine learning framework vended in the image version. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z]+ ?\d+\.\d+(\.\d+)?` ** [Processor](#API_DescribeImageVersion_ResponseSyntax) ** Indicates CPU or GPU compatibility. + `CPU`: The image version is compatible with CPU. + `GPU`: The image version is compatible with GPU. Type: String Valid Values: `CPU | GPU` ** [ProgrammingLang](#API_DescribeImageVersion_ResponseSyntax) ** The supported programming language and its version. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z]+ ?\d+\.\d+(\.\d+)?` ** [ReleaseNotes](#API_DescribeImageVersion_ResponseSyntax) ** The maintainer description of the image version. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `.*` ** [VendorGuidance](#API_DescribeImageVersion_ResponseSyntax) ** The stability of the image version specified by the maintainer. + `NOT_PROVIDED`: The maintainers did not provide a status for image version stability. + `STABLE`: The image version is stable. + `TO_BE_ARCHIVED`: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months. + `ARCHIVED`: The image version is archived. Archived image versions are not searchable and are no longer actively supported. Type: String Valid Values: `NOT_PROVIDED | STABLE | TO_BE_ARCHIVED | ARCHIVED` ** [Version](#API_DescribeImageVersion_ResponseSyntax) ** The version number. Type: Integer Valid Range: Minimum value of 0. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeImageVersion) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeImageVersion) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeImageVersion) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeImageVersion) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeImageVersion) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeImageVersion) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeImageVersion) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeImageVersion) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeImageVersion) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeImageVersion) # DescribeInferenceComponent Returns information about an inference component. ## Request Syntax ``` { "InferenceComponentName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [InferenceComponentName](#API_DescribeInferenceComponent_RequestSyntax) ** The name of the inference component. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9]([\-a-zA-Z0-9]*[a-zA-Z0-9])?` Required: Yes ## Response Syntax ``` { "CreationTime": number, "EndpointArn": "string", "EndpointName": "string", "FailureReason": "string", "InferenceComponentArn": "string", "InferenceComponentName": "string", "InferenceComponentStatus": "string", "LastDeploymentConfig": { "AutoRollbackConfiguration": { "Alarms": [ { "AlarmName": "string" } ] }, "RollingUpdatePolicy": { "MaximumBatchSize": { "Type": "string", "Value": number }, "MaximumExecutionTimeoutInSeconds": number, "RollbackMaximumBatchSize": { "Type": "string", "Value": number }, "WaitIntervalInSeconds": number } }, "LastModifiedTime": number, "RuntimeConfig": { "CurrentCopyCount": number, "DesiredCopyCount": number }, "Specification": { "BaseInferenceComponentName": "string", "ComputeResourceRequirements": { "MaxMemoryRequiredInMb": number, "MinMemoryRequiredInMb": number, "NumberOfAcceleratorDevicesRequired": number, "NumberOfCpuCoresRequired": number }, "Container": { "ArtifactUrl": "string", "DeployedImage": { "ResolutionTime": number, "ResolvedImage": "string", "SpecifiedImage": "string" }, "Environment": { "string" : "string" } }, "DataCacheConfig": { "EnableCaching": boolean }, "ModelName": "string", "SchedulingConfig": { "AvailabilityZoneBalance": { "EnforcementMode": "string", "MaxImbalance": number }, "PlacementStrategy": "string" }, "StartupParameters": { "ContainerStartupHealthCheckTimeoutInSeconds": number, "ModelDataDownloadTimeoutInSeconds": number } }, "VariantName": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreationTime](#API_DescribeInferenceComponent_ResponseSyntax) ** The time when the inference component was created. Type: Timestamp ** [EndpointArn](#API_DescribeInferenceComponent_ResponseSyntax) ** The Amazon Resource Name (ARN) of the endpoint that hosts the inference component. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:endpoint/.*` ** [EndpointName](#API_DescribeInferenceComponent_ResponseSyntax) ** The name of the endpoint that hosts the inference component. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [FailureReason](#API_DescribeInferenceComponent_ResponseSyntax) ** If the inference component status is `Failed`, the reason for the failure. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. ** [InferenceComponentArn](#API_DescribeInferenceComponent_ResponseSyntax) ** The Amazon Resource Name (ARN) of the inference component. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. ** [InferenceComponentName](#API_DescribeInferenceComponent_ResponseSyntax) ** The name of the inference component. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9]([\-a-zA-Z0-9]*[a-zA-Z0-9])?` ** [InferenceComponentStatus](#API_DescribeInferenceComponent_ResponseSyntax) ** The status of the inference component. Type: String Valid Values: `InService | Creating | Updating | Failed | Deleting` ** [LastDeploymentConfig](#API_DescribeInferenceComponent_ResponseSyntax) ** The deployment and rollback settings that you assigned to the inference component. Type: [InferenceComponentDeploymentConfig](API_InferenceComponentDeploymentConfig.md) object ** [LastModifiedTime](#API_DescribeInferenceComponent_ResponseSyntax) ** The time when the inference component was last updated. Type: Timestamp ** [RuntimeConfig](#API_DescribeInferenceComponent_ResponseSyntax) ** Details about the runtime settings for the model that is deployed with the inference component. Type: [InferenceComponentRuntimeConfigSummary](API_InferenceComponentRuntimeConfigSummary.md) object ** [Specification](#API_DescribeInferenceComponent_ResponseSyntax) ** Details about the resources that are deployed with this inference component. Type: [InferenceComponentSpecificationSummary](API_InferenceComponentSpecificationSummary.md) object ** [VariantName](#API_DescribeInferenceComponent_ResponseSyntax) ** The name of the production variant that hosts the inference component. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeInferenceComponent) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeInferenceComponent) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeInferenceComponent) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeInferenceComponent) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeInferenceComponent) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeInferenceComponent) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeInferenceComponent) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeInferenceComponent) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeInferenceComponent) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeInferenceComponent) # DescribeInferenceExperiment Returns details about an inference experiment. ## Request Syntax ``` { "Name": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Name](#API_DescribeInferenceExperiment_RequestSyntax) ** The name of the inference experiment to describe. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` Required: Yes ## Response Syntax ``` { "Arn": "string", "CompletionTime": number, "CreationTime": number, "DataStorageConfig": { "ContentType": { "CsvContentTypes": [ "string" ], "JsonContentTypes": [ "string" ] }, "Destination": "string", "KmsKey": "string" }, "Description": "string", "EndpointMetadata": { "EndpointConfigName": "string", "EndpointName": "string", "EndpointStatus": "string", "FailureReason": "string" }, "KmsKey": "string", "LastModifiedTime": number, "ModelVariants": [ { "InfrastructureConfig": { "InfrastructureType": "string", "RealTimeInferenceConfig": { "InstanceCount": number, "InstanceType": "string" } }, "ModelName": "string", "Status": "string", "VariantName": "string" } ], "Name": "string", "RoleArn": "string", "Schedule": { "EndTime": number, "StartTime": number }, "ShadowModeConfig": { "ShadowModelVariants": [ { "SamplingPercentage": number, "ShadowModelVariantName": "string" } ], "SourceModelVariantName": "string" }, "Status": "string", "StatusReason": "string", "Type": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Arn](#API_DescribeInferenceExperiment_ResponseSyntax) ** The ARN of the inference experiment being described. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:inference-experiment/.*` ** [CompletionTime](#API_DescribeInferenceExperiment_ResponseSyntax) ** The timestamp at which the inference experiment was completed. Type: Timestamp ** [CreationTime](#API_DescribeInferenceExperiment_ResponseSyntax) ** The timestamp at which you created the inference experiment. Type: Timestamp ** [DataStorageConfig](#API_DescribeInferenceExperiment_ResponseSyntax) ** The Amazon S3 location and configuration for storing inference request and response data. Type: [InferenceExperimentDataStorageConfig](API_InferenceExperimentDataStorageConfig.md) object ** [Description](#API_DescribeInferenceExperiment_ResponseSyntax) ** The description of the inference experiment. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `.*` ** [EndpointMetadata](#API_DescribeInferenceExperiment_ResponseSyntax) ** The metadata of the endpoint on which the inference experiment ran. Type: [EndpointMetadata](API_EndpointMetadata.md) object ** [KmsKey](#API_DescribeInferenceExperiment_ResponseSyntax) ** 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 that hosts the endpoint. For more information, see [CreateInferenceExperiment](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateInferenceExperiment.html). Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `[a-zA-Z0-9:/_-]*` ** [LastModifiedTime](#API_DescribeInferenceExperiment_ResponseSyntax) ** The timestamp at which you last modified the inference experiment. Type: Timestamp ** [ModelVariants](#API_DescribeInferenceExperiment_ResponseSyntax) ** An array of `ModelVariantConfigSummary` objects. There is one for each variant in the inference experiment. Each `ModelVariantConfigSummary` object in the array describes the infrastructure configuration for deploying the corresponding variant. Type: Array of [ModelVariantConfigSummary](API_ModelVariantConfigSummary.md) objects ** [Name](#API_DescribeInferenceExperiment_ResponseSyntax) ** The name of the inference experiment. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` ** [RoleArn](#API_DescribeInferenceExperiment_ResponseSyntax) ** The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` ** [Schedule](#API_DescribeInferenceExperiment_ResponseSyntax) ** The duration for which the inference experiment ran or will run. Type: [InferenceExperimentSchedule](API_InferenceExperimentSchedule.md) object ** [ShadowModeConfig](#API_DescribeInferenceExperiment_ResponseSyntax) ** The configuration of `ShadowMode` inference experiment type, which shows the production variant that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates. Type: [ShadowModeConfig](API_ShadowModeConfig.md) object ** [Status](#API_DescribeInferenceExperiment_ResponseSyntax) ** The status of the inference experiment. The following are the possible statuses for an inference experiment: + `Creating` - Amazon SageMaker is creating your experiment. + `Created` - Amazon SageMaker has finished the creation of your experiment and will begin the experiment at the scheduled time. + `Updating` - When you make changes to your experiment, your experiment shows as updating. + `Starting` - Amazon SageMaker is beginning your experiment. + `Running` - Your experiment is in progress. + `Stopping` - Amazon SageMaker is stopping your experiment. + `Completed` - Your experiment has completed. + `Cancelled` - When you conclude your experiment early using the [StopInferenceExperiment](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopInferenceExperiment.html) API, or if any operation fails with an unexpected error, it shows as cancelled. Type: String Valid Values: `Creating | Created | Updating | Running | Starting | Stopping | Completed | Cancelled` ** [StatusReason](#API_DescribeInferenceExperiment_ResponseSyntax) ** The error message or client-specified `Reason` from the [StopInferenceExperiment](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopInferenceExperiment.html) API, that explains the status of the inference experiment. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `.*` ** [Type](#API_DescribeInferenceExperiment_ResponseSyntax) ** The type of the inference experiment. Type: String Valid Values: `ShadowMode` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeInferenceExperiment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeInferenceExperiment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeInferenceExperiment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeInferenceExperiment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeInferenceExperiment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeInferenceExperiment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeInferenceExperiment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeInferenceExperiment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeInferenceExperiment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeInferenceExperiment) # DescribeInferenceRecommendationsJob Provides the results of the Inference Recommender job. One or more recommendation jobs are returned. ## Request Syntax ``` { "JobName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [JobName](#API_DescribeInferenceRecommendationsJob_RequestSyntax) ** The name of the job. The name must be unique within an AWS Region in the AWS account. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}` Required: Yes ## Response Syntax ``` { "CompletionTime": number, "CreationTime": number, "EndpointPerformances": [ { "EndpointInfo": { "EndpointName": "string" }, "Metrics": { "MaxInvocations": number, "ModelLatency": number } } ], "FailureReason": "string", "InferenceRecommendations": [ { "EndpointConfiguration": { "EndpointName": "string", "InitialInstanceCount": number, "InstanceType": "string", "ServerlessConfig": { "MaxConcurrency": number, "MemorySizeInMB": number, "ProvisionedConcurrency": number }, "VariantName": "string" }, "InvocationEndTime": number, "InvocationStartTime": number, "Metrics": { "CostPerHour": number, "CostPerInference": number, "CpuUtilization": number, "MaxInvocations": number, "MemoryUtilization": number, "ModelLatency": number, "ModelSetupTime": number }, "ModelConfiguration": { "CompilationJobName": "string", "EnvironmentParameters": [ { "Key": "string", "Value": "string", "ValueType": "string" } ], "InferenceSpecificationName": "string" }, "RecommendationId": "string" } ], "InputConfig": { "ContainerConfig": { "DataInputConfig": "string", "Domain": "string", "Framework": "string", "FrameworkVersion": "string", "NearestModelName": "string", "PayloadConfig": { "SamplePayloadUrl": "string", "SupportedContentTypes": [ "string" ] }, "SupportedEndpointType": "string", "SupportedInstanceTypes": [ "string" ], "SupportedResponseMIMETypes": [ "string" ], "Task": "string" }, "EndpointConfigurations": [ { "EnvironmentParameterRanges": { "CategoricalParameterRanges": [ { "Name": "string", "Value": [ "string" ] } ] }, "InferenceSpecificationName": "string", "InstanceType": "string", "ServerlessConfig": { "MaxConcurrency": number, "MemorySizeInMB": number, "ProvisionedConcurrency": number } } ], "Endpoints": [ { "EndpointName": "string" } ], "JobDurationInSeconds": number, "ModelName": "string", "ModelPackageVersionArn": "string", "ResourceLimit": { "MaxNumberOfTests": number, "MaxParallelOfTests": number }, "TrafficPattern": { "Phases": [ { "DurationInSeconds": number, "InitialNumberOfUsers": number, "SpawnRate": number } ], "Stairs": { "DurationInSeconds": number, "NumberOfSteps": number, "UsersPerStep": number }, "TrafficType": "string" }, "VolumeKmsKeyId": "string", "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } }, "JobArn": "string", "JobDescription": "string", "JobName": "string", "JobType": "string", "LastModifiedTime": number, "RoleArn": "string", "Status": "string", "StoppingConditions": { "FlatInvocations": "string", "MaxInvocations": number, "ModelLatencyThresholds": [ { "Percentile": "string", "ValueInMilliseconds": number } ] } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CompletionTime](#API_DescribeInferenceRecommendationsJob_ResponseSyntax) ** A timestamp that shows when the job completed. Type: Timestamp ** [CreationTime](#API_DescribeInferenceRecommendationsJob_ResponseSyntax) ** A timestamp that shows when the job was created. Type: Timestamp ** [EndpointPerformances](#API_DescribeInferenceRecommendationsJob_ResponseSyntax) ** The performance results from running an Inference Recommender job on an existing endpoint. Type: Array of [EndpointPerformance](API_EndpointPerformance.md) objects Array Members: Minimum number of 0 items. Maximum number of 1 item. ** [FailureReason](#API_DescribeInferenceRecommendationsJob_ResponseSyntax) ** If the job fails, provides information why the job failed. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. ** [InferenceRecommendations](#API_DescribeInferenceRecommendationsJob_ResponseSyntax) ** The recommendations made by Inference Recommender. Type: Array of [InferenceRecommendation](API_InferenceRecommendation.md) objects Array Members: Minimum number of 1 item. Maximum number of 10 items. ** [InputConfig](#API_DescribeInferenceRecommendationsJob_ResponseSyntax) ** Returns information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations you provided when you initiated the job. Type: [RecommendationJobInputConfig](API_RecommendationJobInputConfig.md) object ** [JobArn](#API_DescribeInferenceRecommendationsJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the job. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:inference-recommendations-job/.*` ** [JobDescription](#API_DescribeInferenceRecommendationsJob_ResponseSyntax) ** The job description that you provided when you initiated the job. Type: String Length Constraints: Minimum length of 0. Maximum length of 128. ** [JobName](#API_DescribeInferenceRecommendationsJob_ResponseSyntax) ** The name of the job. The name must be unique within an AWS Region in the AWS account. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}` ** [JobType](#API_DescribeInferenceRecommendationsJob_ResponseSyntax) ** The job type that you provided when you initiated the job. Type: String Valid Values: `Default | Advanced` ** [LastModifiedTime](#API_DescribeInferenceRecommendationsJob_ResponseSyntax) ** A timestamp that shows when the job was last modified. Type: Timestamp ** [RoleArn](#API_DescribeInferenceRecommendationsJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role you provided when you initiated the job. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` ** [Status](#API_DescribeInferenceRecommendationsJob_ResponseSyntax) ** The status of the job. Type: String Valid Values: `PENDING | IN_PROGRESS | COMPLETED | FAILED | STOPPING | STOPPED | DELETING | DELETED` ** [StoppingConditions](#API_DescribeInferenceRecommendationsJob_ResponseSyntax) ** The stopping conditions that you provided when you initiated the job. Type: [RecommendationJobStoppingConditions](API_RecommendationJobStoppingConditions.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeInferenceRecommendationsJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeInferenceRecommendationsJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeInferenceRecommendationsJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeInferenceRecommendationsJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeInferenceRecommendationsJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeInferenceRecommendationsJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeInferenceRecommendationsJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeInferenceRecommendationsJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeInferenceRecommendationsJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeInferenceRecommendationsJob) # DescribeLabelingJob Gets information about a labeling job. ## Request Syntax ``` { "LabelingJobName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [LabelingJobName](#API_DescribeLabelingJob_RequestSyntax) ** The name of the labeling job to return information for. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "CreationTime": number, "FailureReason": "string", "HumanTaskConfig": { "AnnotationConsolidationConfig": { "AnnotationConsolidationLambdaArn": "string" }, "MaxConcurrentTaskCount": number, "NumberOfHumanWorkersPerDataObject": number, "PreHumanTaskLambdaArn": "string", "PublicWorkforceTaskPrice": { "AmountInUsd": { "Cents": number, "Dollars": number, "TenthFractionsOfACent": number } }, "TaskAvailabilityLifetimeInSeconds": number, "TaskDescription": "string", "TaskKeywords": [ "string" ], "TaskTimeLimitInSeconds": number, "TaskTitle": "string", "UiConfig": { "HumanTaskUiArn": "string", "UiTemplateS3Uri": "string" }, "WorkteamArn": "string" }, "InputConfig": { "DataAttributes": { "ContentClassifiers": [ "string" ] }, "DataSource": { "S3DataSource": { "ManifestS3Uri": "string" }, "SnsDataSource": { "SnsTopicArn": "string" } } }, "JobReferenceCode": "string", "LabelAttributeName": "string", "LabelCategoryConfigS3Uri": "string", "LabelCounters": { "FailedNonRetryableError": number, "HumanLabeled": number, "MachineLabeled": number, "TotalLabeled": number, "Unlabeled": number }, "LabelingJobAlgorithmsConfig": { "InitialActiveLearningModelArn": "string", "LabelingJobAlgorithmSpecificationArn": "string", "LabelingJobResourceConfig": { "VolumeKmsKeyId": "string", "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } } }, "LabelingJobArn": "string", "LabelingJobName": "string", "LabelingJobOutput": { "FinalActiveLearningModelArn": "string", "OutputDatasetS3Uri": "string" }, "LabelingJobStatus": "string", "LastModifiedTime": number, "OutputConfig": { "KmsKeyId": "string", "S3OutputPath": "string", "SnsTopicArn": "string" }, "RoleArn": "string", "StoppingConditions": { "MaxHumanLabeledObjectCount": number, "MaxPercentageOfInputDatasetLabeled": number }, "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreationTime](#API_DescribeLabelingJob_ResponseSyntax) ** The date and time that the labeling job was created. Type: Timestamp ** [FailureReason](#API_DescribeLabelingJob_ResponseSyntax) ** If the job failed, the reason that it failed. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. ** [HumanTaskConfig](#API_DescribeLabelingJob_ResponseSyntax) ** Configuration information required for human workers to complete a labeling task. Type: [HumanTaskConfig](API_HumanTaskConfig.md) object ** [InputConfig](#API_DescribeLabelingJob_ResponseSyntax) ** 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. Type: [LabelingJobInputConfig](API_LabelingJobInputConfig.md) object ** [JobReferenceCode](#API_DescribeLabelingJob_ResponseSyntax) ** A unique identifier for work done as part of a labeling job. Type: String Length Constraints: Minimum length of 1. Pattern: `.+` ** [LabelAttributeName](#API_DescribeLabelingJob_ResponseSyntax) ** The attribute used as the label in the output manifest file. Type: String Length Constraints: Minimum length of 1. Maximum length of 127. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,126}` ** [LabelCategoryConfigS3Uri](#API_DescribeLabelingJob_ResponseSyntax) ** 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"` ` }` ` ]` `}` Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `(https|s3)://([^/]+)/?(.*)` ** [LabelCounters](#API_DescribeLabelingJob_ResponseSyntax) ** 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. Type: [LabelCounters](API_LabelCounters.md) object ** [LabelingJobAlgorithmsConfig](#API_DescribeLabelingJob_ResponseSyntax) ** Configuration information for automated data labeling. Type: [LabelingJobAlgorithmsConfig](API_LabelingJobAlgorithmsConfig.md) object ** [LabelingJobArn](#API_DescribeLabelingJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the labeling job. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:labeling-job/.*` ** [LabelingJobName](#API_DescribeLabelingJob_ResponseSyntax) ** The name assigned to the labeling job when it was created. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [LabelingJobOutput](#API_DescribeLabelingJob_ResponseSyntax) ** The location of the output produced by the labeling job. Type: [LabelingJobOutput](API_LabelingJobOutput.md) object ** [LabelingJobStatus](#API_DescribeLabelingJob_ResponseSyntax) ** The processing status of the labeling job. Type: String Valid Values: `Initializing | InProgress | Completed | Failed | Stopping | Stopped` ** [LastModifiedTime](#API_DescribeLabelingJob_ResponseSyntax) ** The date and time that the labeling job was last updated. Type: Timestamp ** [OutputConfig](#API_DescribeLabelingJob_ResponseSyntax) ** 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. Type: [LabelingJobOutputConfig](API_LabelingJobOutputConfig.md) object ** [RoleArn](#API_DescribeLabelingJob_ResponseSyntax) ** The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during data labeling. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` ** [StoppingConditions](#API_DescribeLabelingJob_ResponseSyntax) ** A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped. Type: [LabelingJobStoppingConditions](API_LabelingJobStoppingConditions.md) object ** [Tags](#API_DescribeLabelingJob_ResponseSyntax) ** 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](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeLabelingJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeLabelingJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeLabelingJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeLabelingJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeLabelingJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeLabelingJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeLabelingJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeLabelingJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeLabelingJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeLabelingJob) # DescribeLineageGroup Provides a list of properties for the requested lineage group. For more information, see [ Cross-Account Lineage Tracking ](https://docs.aws.amazon.com/sagemaker/latest/dg/xaccount-lineage-tracking.html) in the *Amazon SageMaker Developer Guide*. ## Request Syntax ``` { "LineageGroupName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [LineageGroupName](#API_DescribeLineageGroup_RequestSyntax) ** The name of the lineage group. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` Required: Yes ## Response Syntax ``` { "CreatedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "Description": "string", "DisplayName": "string", "LastModifiedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "LineageGroupArn": "string", "LineageGroupName": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreatedBy](#API_DescribeLineageGroup_ResponseSyntax) ** Information about the user who created or modified a SageMaker resource. Type: [UserContext](API_UserContext.md) object ** [CreationTime](#API_DescribeLineageGroup_ResponseSyntax) ** The creation time of lineage group. Type: Timestamp ** [Description](#API_DescribeLineageGroup_ResponseSyntax) ** The description of the lineage group. Type: String Length Constraints: Minimum length of 0. Maximum length of 3072. Pattern: `.*` ** [DisplayName](#API_DescribeLineageGroup_ResponseSyntax) ** The display name of the lineage group. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` ** [LastModifiedBy](#API_DescribeLineageGroup_ResponseSyntax) ** Information about the user who created or modified a SageMaker resource. Type: [UserContext](API_UserContext.md) object ** [LastModifiedTime](#API_DescribeLineageGroup_ResponseSyntax) ** The last modified time of the lineage group. Type: Timestamp ** [LineageGroupArn](#API_DescribeLineageGroup_ResponseSyntax) ** The Amazon Resource Name (ARN) of the lineage group. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:lineage-group/.*` ** [LineageGroupName](#API_DescribeLineageGroup_ResponseSyntax) ** The name of the lineage group. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeLineageGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeLineageGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeLineageGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeLineageGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeLineageGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeLineageGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeLineageGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeLineageGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeLineageGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeLineageGroup) # DescribeMlflowApp Returns information about an MLflow App. ## Request Syntax ``` { "Arn": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Arn](#API_DescribeMlflowApp_RequestSyntax) ** The ARN of the MLflow App for which to get information. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:mlflow-app/.*` Required: Yes ## Response Syntax ``` { "AccountDefaultStatus": "string", "Arn": "string", "ArtifactStoreUri": "string", "CreatedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "DefaultDomainIdList": [ "string" ], "LastModifiedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "MaintenanceStatus": "string", "MlflowVersion": "string", "ModelRegistrationMode": "string", "Name": "string", "RoleArn": "string", "Status": "string", "WeeklyMaintenanceWindowStart": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AccountDefaultStatus](#API_DescribeMlflowApp_ResponseSyntax) ** Indicates whether this MLflow app is the default for the entire account. Type: String Valid Values: `ENABLED | DISABLED` ** [Arn](#API_DescribeMlflowApp_ResponseSyntax) ** The ARN of the MLflow App. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:mlflow-app/.*` ** [ArtifactStoreUri](#API_DescribeMlflowApp_ResponseSyntax) ** The S3 URI of the general purpose bucket used as the MLflow App artifact store. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `(https|s3)://([^/]+)/?(.*)` ** [CreatedBy](#API_DescribeMlflowApp_ResponseSyntax) ** Information about the user who created or modified a SageMaker resource. Type: [UserContext](API_UserContext.md) object ** [CreationTime](#API_DescribeMlflowApp_ResponseSyntax) ** The timestamp when the MLflow App was created. Type: Timestamp ** [DefaultDomainIdList](#API_DescribeMlflowApp_ResponseSyntax) ** List of SageMaker Domain IDs for which this MLflow App is the default. Type: Array of strings Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `d-(-*[a-z0-9]){1,61}` ** [LastModifiedBy](#API_DescribeMlflowApp_ResponseSyntax) ** Information about the user who created or modified a SageMaker resource. Type: [UserContext](API_UserContext.md) object ** [LastModifiedTime](#API_DescribeMlflowApp_ResponseSyntax) ** The timestamp when the MLflow App was last modified. Type: Timestamp ** [MaintenanceStatus](#API_DescribeMlflowApp_ResponseSyntax) ** Current maintenance status of the MLflow App. Type: String Valid Values: `MaintenanceInProgress | MaintenanceComplete | MaintenanceFailed` ** [MlflowVersion](#API_DescribeMlflowApp_ResponseSyntax) ** The MLflow version used. Type: String Length Constraints: Minimum length of 0. Maximum length of 16. Pattern: `[0-9]*.[0-9]*.[0-9]*` ** [ModelRegistrationMode](#API_DescribeMlflowApp_ResponseSyntax) ** Whether automatic registration of new MLflow models to the SageMaker Model Registry is enabled. Type: String Valid Values: `AutoModelRegistrationEnabled | AutoModelRegistrationDisabled` ** [Name](#API_DescribeMlflowApp_ResponseSyntax) ** The name of the MLflow App. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}` ** [RoleArn](#API_DescribeMlflowApp_ResponseSyntax) ** The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow App uses to access the artifact store in Amazon S3. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` ** [Status](#API_DescribeMlflowApp_ResponseSyntax) ** The current creation status of the described MLflow App. Type: String Valid Values: `Creating | Created | CreateFailed | Updating | Updated | UpdateFailed | Deleting | DeleteFailed | Deleted` ** [WeeklyMaintenanceWindowStart](#API_DescribeMlflowApp_ResponseSyntax) ** The day and time of the week when weekly maintenance occurs. Type: String Length Constraints: Minimum length of 0. Maximum length of 9. Pattern: `(Mon|Tue|Wed|Thu|Fri|Sat|Sun):([01]\d|2[0-3]):([0-5]\d)` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeMlflowApp) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeMlflowApp) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeMlflowApp) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeMlflowApp) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeMlflowApp) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeMlflowApp) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeMlflowApp) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeMlflowApp) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeMlflowApp) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeMlflowApp) # DescribeMlflowTrackingServer Returns information about an MLflow Tracking Server. ## Request Syntax ``` { "TrackingServerName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [TrackingServerName](#API_DescribeMlflowTrackingServer_RequestSyntax) ** The name of the MLflow Tracking Server to describe. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}` Required: Yes ## Response Syntax ``` { "ArtifactStoreUri": "string", "AutomaticModelRegistration": boolean, "CreatedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "IsActive": "string", "LastModifiedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "MlflowVersion": "string", "RoleArn": "string", "S3BucketOwnerAccountId": "string", "S3BucketOwnerVerification": boolean, "TrackingServerArn": "string", "TrackingServerMaintenanceStatus": "string", "TrackingServerName": "string", "TrackingServerSize": "string", "TrackingServerStatus": "string", "TrackingServerUrl": "string", "WeeklyMaintenanceWindowStart": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ArtifactStoreUri](#API_DescribeMlflowTrackingServer_ResponseSyntax) ** The S3 URI of the general purpose bucket used as the MLflow Tracking Server artifact store. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `(https|s3)://([^/]+)/?(.*)` ** [AutomaticModelRegistration](#API_DescribeMlflowTrackingServer_ResponseSyntax) ** Whether automatic registration of new MLflow models to the SageMaker Model Registry is enabled. Type: Boolean ** [CreatedBy](#API_DescribeMlflowTrackingServer_ResponseSyntax) ** Information about the user who created or modified a SageMaker resource. Type: [UserContext](API_UserContext.md) object ** [CreationTime](#API_DescribeMlflowTrackingServer_ResponseSyntax) ** The timestamp of when the described MLflow Tracking Server was created. Type: Timestamp ** [IsActive](#API_DescribeMlflowTrackingServer_ResponseSyntax) ** Whether the described MLflow Tracking Server is currently active. Type: String Valid Values: `Active | Inactive` ** [LastModifiedBy](#API_DescribeMlflowTrackingServer_ResponseSyntax) ** Information about the user who created or modified a SageMaker resource. Type: [UserContext](API_UserContext.md) object ** [LastModifiedTime](#API_DescribeMlflowTrackingServer_ResponseSyntax) ** The timestamp of when the described MLflow Tracking Server was last modified. Type: Timestamp ** [MlflowVersion](#API_DescribeMlflowTrackingServer_ResponseSyntax) ** The MLflow version used for the described tracking server. Type: String Length Constraints: Minimum length of 0. Maximum length of 16. Pattern: `[0-9]*.[0-9]*.[0-9]*` ** [RoleArn](#API_DescribeMlflowTrackingServer_ResponseSyntax) ** The Amazon Resource Name (ARN) for an IAM role in your account that the described MLflow Tracking Server uses to access the artifact store in Amazon S3. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` ** [S3BucketOwnerAccountId](#API_DescribeMlflowTrackingServer_ResponseSyntax) ** Expected AWS account ID that owns the Amazon S3 bucket for artifact storage. Type: String Length Constraints: Fixed length of 12. Pattern: `\d+` ** [S3BucketOwnerVerification](#API_DescribeMlflowTrackingServer_ResponseSyntax) ** Whether Amazon S3 Bucket Ownership checks are enabled whenever the tracking server interacts with Amazon Amazon S3. Type: Boolean ** [TrackingServerArn](#API_DescribeMlflowTrackingServer_ResponseSyntax) ** The ARN of the described tracking server. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:mlflow-tracking-server/.*` ** [TrackingServerMaintenanceStatus](#API_DescribeMlflowTrackingServer_ResponseSyntax) ** The current maintenance status of the described MLflow Tracking Server. Type: String Valid Values: `MaintenanceInProgress | MaintenanceComplete | MaintenanceFailed` ** [TrackingServerName](#API_DescribeMlflowTrackingServer_ResponseSyntax) ** The name of the described tracking server. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}` ** [TrackingServerSize](#API_DescribeMlflowTrackingServer_ResponseSyntax) ** The size of the described tracking server. Type: String Valid Values: `Small | Medium | Large` ** [TrackingServerStatus](#API_DescribeMlflowTrackingServer_ResponseSyntax) ** The current creation status of the described MLflow Tracking Server. Type: String Valid Values: `Creating | Created | CreateFailed | Updating | Updated | UpdateFailed | Deleting | DeleteFailed | Stopping | Stopped | StopFailed | Starting | Started | StartFailed | MaintenanceInProgress | MaintenanceComplete | MaintenanceFailed` ** [TrackingServerUrl](#API_DescribeMlflowTrackingServer_ResponseSyntax) ** The URL to connect to the MLflow user interface for the described tracking server. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. ** [WeeklyMaintenanceWindowStart](#API_DescribeMlflowTrackingServer_ResponseSyntax) ** The day and time of the week when weekly maintenance occurs on the described tracking server. Type: String Length Constraints: Minimum length of 0. Maximum length of 9. Pattern: `(Mon|Tue|Wed|Thu|Fri|Sat|Sun):([01]\d|2[0-3]):([0-5]\d)` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeMlflowTrackingServer) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeMlflowTrackingServer) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeMlflowTrackingServer) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeMlflowTrackingServer) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeMlflowTrackingServer) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeMlflowTrackingServer) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeMlflowTrackingServer) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeMlflowTrackingServer) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeMlflowTrackingServer) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeMlflowTrackingServer) # DescribeModel Describes a model that you created using the `CreateModel` API. ## Request Syntax ``` { "ModelName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ModelName](#API_DescribeModel_RequestSyntax) ** The name of the model. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9]([\-a-zA-Z0-9]*[a-zA-Z0-9])?` Required: Yes ## Response Syntax ``` { "Containers": [ { "AdditionalModelDataSources": [ { "ChannelName": "string", "S3DataSource": { "CompressionType": "string", "ETag": "string", "HubAccessConfig": { "HubContentArn": "string" }, "ManifestEtag": "string", "ManifestS3Uri": "string", "ModelAccessConfig": { "AcceptEula": boolean }, "S3DataType": "string", "S3Uri": "string" } } ], "ContainerHostname": "string", "Environment": { "string" : "string" }, "Image": "string", "ImageConfig": { "RepositoryAccessMode": "string", "RepositoryAuthConfig": { "RepositoryCredentialsProviderArn": "string" } }, "InferenceSpecificationName": "string", "Mode": "string", "ModelDataSource": { "S3DataSource": { "CompressionType": "string", "ETag": "string", "HubAccessConfig": { "HubContentArn": "string" }, "ManifestEtag": "string", "ManifestS3Uri": "string", "ModelAccessConfig": { "AcceptEula": boolean }, "S3DataType": "string", "S3Uri": "string" } }, "ModelDataUrl": "string", "ModelPackageName": "string", "MultiModelConfig": { "ModelCacheSetting": "string" } } ], "CreationTime": number, "DeploymentRecommendation": { "RealTimeInferenceRecommendations": [ { "Environment": { "string" : "string" }, "InstanceType": "string", "RecommendationId": "string" } ], "RecommendationStatus": "string" }, "EnableNetworkIsolation": boolean, "ExecutionRoleArn": "string", "InferenceExecutionConfig": { "Mode": "string" }, "ModelArn": "string", "ModelName": "string", "PrimaryContainer": { "AdditionalModelDataSources": [ { "ChannelName": "string", "S3DataSource": { "CompressionType": "string", "ETag": "string", "HubAccessConfig": { "HubContentArn": "string" }, "ManifestEtag": "string", "ManifestS3Uri": "string", "ModelAccessConfig": { "AcceptEula": boolean }, "S3DataType": "string", "S3Uri": "string" } } ], "ContainerHostname": "string", "Environment": { "string" : "string" }, "Image": "string", "ImageConfig": { "RepositoryAccessMode": "string", "RepositoryAuthConfig": { "RepositoryCredentialsProviderArn": "string" } }, "InferenceSpecificationName": "string", "Mode": "string", "ModelDataSource": { "S3DataSource": { "CompressionType": "string", "ETag": "string", "HubAccessConfig": { "HubContentArn": "string" }, "ManifestEtag": "string", "ManifestS3Uri": "string", "ModelAccessConfig": { "AcceptEula": boolean }, "S3DataType": "string", "S3Uri": "string" } }, "ModelDataUrl": "string", "ModelPackageName": "string", "MultiModelConfig": { "ModelCacheSetting": "string" } }, "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Containers](#API_DescribeModel_ResponseSyntax) ** The containers in the inference pipeline. Type: Array of [ContainerDefinition](API_ContainerDefinition.md) objects Array Members: Minimum number of 0 items. Maximum number of 15 items. ** [CreationTime](#API_DescribeModel_ResponseSyntax) ** A timestamp that shows when the model was created. Type: Timestamp ** [DeploymentRecommendation](#API_DescribeModel_ResponseSyntax) ** A set of recommended deployment configurations for the model. Type: [DeploymentRecommendation](API_DeploymentRecommendation.md) object ** [EnableNetworkIsolation](#API_DescribeModel_ResponseSyntax) ** If `True`, no inbound or outbound network calls can be made to or from the model container. Type: Boolean ** [ExecutionRoleArn](#API_DescribeModel_ResponseSyntax) ** The Amazon Resource Name (ARN) of the IAM role that you specified for the model. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` ** [InferenceExecutionConfig](#API_DescribeModel_ResponseSyntax) ** Specifies details of how containers in a multi-container endpoint are called. Type: [InferenceExecutionConfig](API_InferenceExecutionConfig.md) object ** [ModelArn](#API_DescribeModel_ResponseSyntax) ** The Amazon Resource Name (ARN) of the model. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:model/.*` ** [ModelName](#API_DescribeModel_ResponseSyntax) ** Name of the SageMaker model. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9]([\-a-zA-Z0-9]*[a-zA-Z0-9])?` ** [PrimaryContainer](#API_DescribeModel_ResponseSyntax) ** The location of the primary inference code, associated artifacts, and custom environment map that the inference code uses when it is deployed in production. Type: [ContainerDefinition](API_ContainerDefinition.md) object ** [VpcConfig](#API_DescribeModel_ResponseSyntax) ** A [VpcConfig](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html) object that specifies the VPC that this model has access to. For more information, see [Protect Endpoints by Using an Amazon Virtual Private Cloud](https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html) Type: [VpcConfig](API_VpcConfig.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeModel) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeModel) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeModel) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeModel) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeModel) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeModel) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeModel) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeModel) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeModel) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeModel) # DescribeModelBiasJobDefinition Returns a description of a model bias job definition. ## Request Syntax ``` { "JobDefinitionName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [JobDefinitionName](#API_DescribeModelBiasJobDefinition_RequestSyntax) ** The name of the model bias job definition. The name must be unique within an AWS Region in the AWS account. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "CreationTime": number, "JobDefinitionArn": "string", "JobDefinitionName": "string", "JobResources": { "ClusterConfig": { "InstanceCount": number, "InstanceType": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number } }, "ModelBiasAppSpecification": { "ConfigUri": "string", "Environment": { "string" : "string" }, "ImageUri": "string" }, "ModelBiasBaselineConfig": { "BaseliningJobName": "string", "ConstraintsResource": { "S3Uri": "string" } }, "ModelBiasJobInput": { "BatchTransformInput": { "DataCapturedDestinationS3Uri": "string", "DatasetFormat": { "Csv": { "Header": boolean }, "Json": { "Line": boolean }, "Parquet": { } }, "EndTimeOffset": "string", "ExcludeFeaturesAttribute": "string", "FeaturesAttribute": "string", "InferenceAttribute": "string", "LocalPath": "string", "ProbabilityAttribute": "string", "ProbabilityThresholdAttribute": number, "S3DataDistributionType": "string", "S3InputMode": "string", "StartTimeOffset": "string" }, "EndpointInput": { "EndpointName": "string", "EndTimeOffset": "string", "ExcludeFeaturesAttribute": "string", "FeaturesAttribute": "string", "InferenceAttribute": "string", "LocalPath": "string", "ProbabilityAttribute": "string", "ProbabilityThresholdAttribute": number, "S3DataDistributionType": "string", "S3InputMode": "string", "StartTimeOffset": "string" }, "GroundTruthS3Input": { "S3Uri": "string" } }, "ModelBiasJobOutputConfig": { "KmsKeyId": "string", "MonitoringOutputs": [ { "S3Output": { "LocalPath": "string", "S3UploadMode": "string", "S3Uri": "string" } } ] }, "NetworkConfig": { "EnableInterContainerTrafficEncryption": boolean, "EnableNetworkIsolation": boolean, "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } }, "RoleArn": "string", "StoppingCondition": { "MaxRuntimeInSeconds": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreationTime](#API_DescribeModelBiasJobDefinition_ResponseSyntax) ** The time at which the model bias job was created. Type: Timestamp ** [JobDefinitionArn](#API_DescribeModelBiasJobDefinition_ResponseSyntax) ** The Amazon Resource Name (ARN) of the model bias job. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `.*` ** [JobDefinitionName](#API_DescribeModelBiasJobDefinition_ResponseSyntax) ** The name of the bias job definition. The name must be unique within an AWS Region in the AWS account. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [JobResources](#API_DescribeModelBiasJobDefinition_ResponseSyntax) ** Identifies the resources to deploy for a monitoring job. Type: [MonitoringResources](API_MonitoringResources.md) object ** [ModelBiasAppSpecification](#API_DescribeModelBiasJobDefinition_ResponseSyntax) ** Configures the model bias job to run a specified Docker container image. Type: [ModelBiasAppSpecification](API_ModelBiasAppSpecification.md) object ** [ModelBiasBaselineConfig](#API_DescribeModelBiasJobDefinition_ResponseSyntax) ** The baseline configuration for a model bias job. Type: [ModelBiasBaselineConfig](API_ModelBiasBaselineConfig.md) object ** [ModelBiasJobInput](#API_DescribeModelBiasJobDefinition_ResponseSyntax) ** Inputs for the model bias job. Type: [ModelBiasJobInput](API_ModelBiasJobInput.md) object ** [ModelBiasJobOutputConfig](#API_DescribeModelBiasJobDefinition_ResponseSyntax) ** The output configuration for monitoring jobs. Type: [MonitoringOutputConfig](API_MonitoringOutputConfig.md) object ** [NetworkConfig](#API_DescribeModelBiasJobDefinition_ResponseSyntax) ** Networking options for a model bias job. Type: [MonitoringNetworkConfig](API_MonitoringNetworkConfig.md) object ** [RoleArn](#API_DescribeModelBiasJobDefinition_ResponseSyntax) ** The Amazon Resource Name (ARN) of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` ** [StoppingCondition](#API_DescribeModelBiasJobDefinition_ResponseSyntax) ** A time limit for how long the monitoring job is allowed to run before stopping. Type: [MonitoringStoppingCondition](API_MonitoringStoppingCondition.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeModelBiasJobDefinition) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeModelBiasJobDefinition) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeModelBiasJobDefinition) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeModelBiasJobDefinition) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeModelBiasJobDefinition) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeModelBiasJobDefinition) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeModelBiasJobDefinition) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeModelBiasJobDefinition) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeModelBiasJobDefinition) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeModelBiasJobDefinition) # DescribeModelCard Describes the content, creation time, and security configuration of an Amazon SageMaker Model Card. ## Request Syntax ``` { "ModelCardName": "string", "ModelCardVersion": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ModelCardName](#API_DescribeModelCard_RequestSyntax) ** The name or Amazon Resource Name (ARN) of the model card to describe. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:model-card/.*)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})` Required: Yes ** [ModelCardVersion](#API_DescribeModelCard_RequestSyntax) ** The version of the model card to describe. If a version is not provided, then the latest version of the model card is described. Type: Integer Required: No ## Response Syntax ``` { "Content": "string", "CreatedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "LastModifiedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "ModelCardArn": "string", "ModelCardName": "string", "ModelCardProcessingStatus": "string", "ModelCardStatus": "string", "ModelCardVersion": number, "SecurityConfig": { "KmsKeyId": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Content](#API_DescribeModelCard_ResponseSyntax) ** The content of the model card. Type: String Length Constraints: Minimum length of 0. Maximum length of 100000. Pattern: `.*` ** [CreatedBy](#API_DescribeModelCard_ResponseSyntax) ** Information about the user who created or modified a SageMaker resource. Type: [UserContext](API_UserContext.md) object ** [CreationTime](#API_DescribeModelCard_ResponseSyntax) ** The date and time the model card was created. Type: Timestamp ** [LastModifiedBy](#API_DescribeModelCard_ResponseSyntax) ** Information about the user who created or modified a SageMaker resource. Type: [UserContext](API_UserContext.md) object ** [LastModifiedTime](#API_DescribeModelCard_ResponseSyntax) ** The date and time the model card was last modified. Type: Timestamp ** [ModelCardArn](#API_DescribeModelCard_ResponseSyntax) ** The Amazon Resource Name (ARN) of the model card. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [ModelCardName](#API_DescribeModelCard_ResponseSyntax) ** The name of the model card. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [ModelCardProcessingStatus](#API_DescribeModelCard_ResponseSyntax) ** The processing status of model card deletion. The `ModelCardProcessingStatus` updates throughout the different deletion steps. + `DeletePending`: Model card deletion request received. + `DeleteInProgress`: Model card deletion is in progress. + `ContentDeleted`: Deleted model card content. + `ExportJobsDeleted`: Deleted all export jobs associated with the model card. + `DeleteCompleted`: Successfully deleted the model card. + `DeleteFailed`: The model card failed to delete. Type: String Valid Values: `DeleteInProgress | DeletePending | ContentDeleted | ExportJobsDeleted | DeleteCompleted | DeleteFailed` ** [ModelCardStatus](#API_DescribeModelCard_ResponseSyntax) ** The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval. + `Draft`: The model card is a work in progress. + `PendingReview`: The model card is pending review. + `Approved`: The model card is approved. + `Archived`: The model card is archived. No more updates should be made to the model card, but it can still be exported. Type: String Valid Values: `Draft | PendingReview | Approved | Archived` ** [ModelCardVersion](#API_DescribeModelCard_ResponseSyntax) ** The version of the model card. Type: Integer ** [SecurityConfig](#API_DescribeModelCard_ResponseSyntax) ** The security configuration used to protect model card content. Type: [ModelCardSecurityConfig](API_ModelCardSecurityConfig.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeModelCard) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeModelCard) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeModelCard) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeModelCard) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeModelCard) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeModelCard) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeModelCard) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeModelCard) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeModelCard) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeModelCard) # DescribeModelCardExportJob Describes an Amazon SageMaker Model Card export job. ## Request Syntax ``` { "ModelCardExportJobArn": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ModelCardExportJobArn](#API_DescribeModelCardExportJob_RequestSyntax) ** The Amazon Resource Name (ARN) of the model card export job to describe. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}/export-job/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "CreatedAt": number, "ExportArtifacts": { "S3ExportArtifacts": "string" }, "FailureReason": "string", "LastModifiedAt": number, "ModelCardExportJobArn": "string", "ModelCardExportJobName": "string", "ModelCardName": "string", "ModelCardVersion": number, "OutputConfig": { "S3OutputPath": "string" }, "Status": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreatedAt](#API_DescribeModelCardExportJob_ResponseSyntax) ** The date and time that the model export job was created. Type: Timestamp ** [ExportArtifacts](#API_DescribeModelCardExportJob_ResponseSyntax) ** The exported model card artifacts. Type: [ModelCardExportArtifacts](API_ModelCardExportArtifacts.md) object ** [FailureReason](#API_DescribeModelCardExportJob_ResponseSyntax) ** The failure reason if the model export job fails. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. ** [LastModifiedAt](#API_DescribeModelCardExportJob_ResponseSyntax) ** The date and time that the model export job was last modified. Type: Timestamp ** [ModelCardExportJobArn](#API_DescribeModelCardExportJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the model card export job. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}/export-job/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [ModelCardExportJobName](#API_DescribeModelCardExportJob_ResponseSyntax) ** The name of the model card export job to describe. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [ModelCardName](#API_DescribeModelCardExportJob_ResponseSyntax) ** The name or Amazon Resource Name (ARN) of the model card that the model export job exports. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [ModelCardVersion](#API_DescribeModelCardExportJob_ResponseSyntax) ** The version of the model card that the model export job exports. Type: Integer ** [OutputConfig](#API_DescribeModelCardExportJob_ResponseSyntax) ** The export output details for the model card. Type: [ModelCardExportOutputConfig](API_ModelCardExportOutputConfig.md) object ** [Status](#API_DescribeModelCardExportJob_ResponseSyntax) ** The completion status of the model card export job. + `InProgress`: The model card export job is in progress. + `Completed`: The model card export job is complete. + `Failed`: The model card export job failed. To see the reason for the failure, see the `FailureReason` field in the response to a `DescribeModelCardExportJob` call. Type: String Valid Values: `InProgress | Completed | Failed` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeModelCardExportJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeModelCardExportJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeModelCardExportJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeModelCardExportJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeModelCardExportJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeModelCardExportJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeModelCardExportJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeModelCardExportJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeModelCardExportJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeModelCardExportJob) # DescribeModelExplainabilityJobDefinition Returns a description of a model explainability job definition. ## Request Syntax ``` { "JobDefinitionName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [JobDefinitionName](#API_DescribeModelExplainabilityJobDefinition_RequestSyntax) ** The name of the model explainability job definition. The name must be unique within an AWS Region in the AWS account. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "CreationTime": number, "JobDefinitionArn": "string", "JobDefinitionName": "string", "JobResources": { "ClusterConfig": { "InstanceCount": number, "InstanceType": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number } }, "ModelExplainabilityAppSpecification": { "ConfigUri": "string", "Environment": { "string" : "string" }, "ImageUri": "string" }, "ModelExplainabilityBaselineConfig": { "BaseliningJobName": "string", "ConstraintsResource": { "S3Uri": "string" } }, "ModelExplainabilityJobInput": { "BatchTransformInput": { "DataCapturedDestinationS3Uri": "string", "DatasetFormat": { "Csv": { "Header": boolean }, "Json": { "Line": boolean }, "Parquet": { } }, "EndTimeOffset": "string", "ExcludeFeaturesAttribute": "string", "FeaturesAttribute": "string", "InferenceAttribute": "string", "LocalPath": "string", "ProbabilityAttribute": "string", "ProbabilityThresholdAttribute": number, "S3DataDistributionType": "string", "S3InputMode": "string", "StartTimeOffset": "string" }, "EndpointInput": { "EndpointName": "string", "EndTimeOffset": "string", "ExcludeFeaturesAttribute": "string", "FeaturesAttribute": "string", "InferenceAttribute": "string", "LocalPath": "string", "ProbabilityAttribute": "string", "ProbabilityThresholdAttribute": number, "S3DataDistributionType": "string", "S3InputMode": "string", "StartTimeOffset": "string" } }, "ModelExplainabilityJobOutputConfig": { "KmsKeyId": "string", "MonitoringOutputs": [ { "S3Output": { "LocalPath": "string", "S3UploadMode": "string", "S3Uri": "string" } } ] }, "NetworkConfig": { "EnableInterContainerTrafficEncryption": boolean, "EnableNetworkIsolation": boolean, "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } }, "RoleArn": "string", "StoppingCondition": { "MaxRuntimeInSeconds": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreationTime](#API_DescribeModelExplainabilityJobDefinition_ResponseSyntax) ** The time at which the model explainability job was created. Type: Timestamp ** [JobDefinitionArn](#API_DescribeModelExplainabilityJobDefinition_ResponseSyntax) ** The Amazon Resource Name (ARN) of the model explainability job. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `.*` ** [JobDefinitionName](#API_DescribeModelExplainabilityJobDefinition_ResponseSyntax) ** The name of the explainability job definition. The name must be unique within an AWS Region in the AWS account. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [JobResources](#API_DescribeModelExplainabilityJobDefinition_ResponseSyntax) ** Identifies the resources to deploy for a monitoring job. Type: [MonitoringResources](API_MonitoringResources.md) object ** [ModelExplainabilityAppSpecification](#API_DescribeModelExplainabilityJobDefinition_ResponseSyntax) ** Configures the model explainability job to run a specified Docker container image. Type: [ModelExplainabilityAppSpecification](API_ModelExplainabilityAppSpecification.md) object ** [ModelExplainabilityBaselineConfig](#API_DescribeModelExplainabilityJobDefinition_ResponseSyntax) ** The baseline configuration for a model explainability job. Type: [ModelExplainabilityBaselineConfig](API_ModelExplainabilityBaselineConfig.md) object ** [ModelExplainabilityJobInput](#API_DescribeModelExplainabilityJobDefinition_ResponseSyntax) ** Inputs for the model explainability job. Type: [ModelExplainabilityJobInput](API_ModelExplainabilityJobInput.md) object ** [ModelExplainabilityJobOutputConfig](#API_DescribeModelExplainabilityJobDefinition_ResponseSyntax) ** The output configuration for monitoring jobs. Type: [MonitoringOutputConfig](API_MonitoringOutputConfig.md) object ** [NetworkConfig](#API_DescribeModelExplainabilityJobDefinition_ResponseSyntax) ** Networking options for a model explainability job. Type: [MonitoringNetworkConfig](API_MonitoringNetworkConfig.md) object ** [RoleArn](#API_DescribeModelExplainabilityJobDefinition_ResponseSyntax) ** The Amazon Resource Name (ARN) of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` ** [StoppingCondition](#API_DescribeModelExplainabilityJobDefinition_ResponseSyntax) ** A time limit for how long the monitoring job is allowed to run before stopping. Type: [MonitoringStoppingCondition](API_MonitoringStoppingCondition.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeModelExplainabilityJobDefinition) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeModelExplainabilityJobDefinition) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeModelExplainabilityJobDefinition) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeModelExplainabilityJobDefinition) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeModelExplainabilityJobDefinition) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeModelExplainabilityJobDefinition) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeModelExplainabilityJobDefinition) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeModelExplainabilityJobDefinition) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeModelExplainabilityJobDefinition) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeModelExplainabilityJobDefinition) # DescribeModelPackage Returns a description of the specified model package, which is used to create SageMaker models or list them on AWS Marketplace. **Important** If you provided a AWS KMS Key ID when you created your model package, you will see the [KMS Decrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Decrypt.html) API call in your CloudTrail logs when you use this API. To create models in SageMaker, buyers can subscribe to model packages listed on AWS Marketplace. ## Request Syntax ``` { "ModelPackageName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ModelPackageName](#API_DescribeModelPackage_RequestSyntax) ** The name or Amazon Resource Name (ARN) of the model package to describe. When you specify a name, the name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen). Type: String Length Constraints: Minimum length of 1. Maximum length of 176. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:[a-z\-]*\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(? An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts. Type: Array of [AdditionalInferenceSpecificationDefinition](API_AdditionalInferenceSpecificationDefinition.md) objects Array Members: Minimum number of 1 item. Maximum number of 15 items. ** [ApprovalDescription](#API_DescribeModelPackage_ResponseSyntax) ** A description provided for the model approval. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `.*` ** [CertifyForMarketplace](#API_DescribeModelPackage_ResponseSyntax) ** Whether the model package is certified for listing on AWS Marketplace. Type: Boolean ** [CreatedBy](#API_DescribeModelPackage_ResponseSyntax) ** Information about the user who created or modified a SageMaker resource. Type: [UserContext](API_UserContext.md) object ** [CreationTime](#API_DescribeModelPackage_ResponseSyntax) ** A timestamp specifying when the model package was created. Type: Timestamp ** [CustomerMetadataProperties](#API_DescribeModelPackage_ResponseSyntax) ** The metadata properties associated with the model package versions. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)${1,128}` Value Length Constraints: Minimum length of 1. Maximum length of 256. Value Pattern: `([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)${1,256}` ** [Domain](#API_DescribeModelPackage_ResponseSyntax) ** The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing. Type: String ** [DriftCheckBaselines](#API_DescribeModelPackage_ResponseSyntax) ** Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on [Drift Detection against Previous Baselines in SageMaker Pipelines](https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines-quality-clarify-baseline-lifecycle.html#pipelines-quality-clarify-baseline-drift-detection) in the *Amazon SageMaker Developer Guide*. Type: [DriftCheckBaselines](API_DriftCheckBaselines.md) object ** [InferenceSpecification](#API_DescribeModelPackage_ResponseSyntax) ** Details about inference jobs that you can run with models based on this model package. Type: [InferenceSpecification](API_InferenceSpecification.md) object ** [LastModifiedBy](#API_DescribeModelPackage_ResponseSyntax) ** Information about the user who created or modified a SageMaker resource. Type: [UserContext](API_UserContext.md) object ** [LastModifiedTime](#API_DescribeModelPackage_ResponseSyntax) ** The last time that the model package was modified. Type: Timestamp ** [MetadataProperties](#API_DescribeModelPackage_ResponseSyntax) ** Metadata properties of the tracking entity, trial, or trial component. Type: [MetadataProperties](API_MetadataProperties.md) object ** [ModelApprovalStatus](#API_DescribeModelPackage_ResponseSyntax) ** The approval status of the model package. Type: String Valid Values: `Approved | Rejected | PendingManualApproval` ** [ModelCard](#API_DescribeModelPackage_ResponseSyntax) ** The model card associated with the model package. Since `ModelPackageModelCard` is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of `ModelCard`. The `ModelPackageModelCard` schema does not include `model_package_details`, and `model_overview` is composed of the `model_creator` and `model_artifact` properties. For more information about the model package model card schema, see [Model package model card schema](https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html#model-card-schema). For more information about the model card associated with the model package, see [View the Details of a Model Version](https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html). Type: [ModelPackageModelCard](API_ModelPackageModelCard.md) object ** [ModelLifeCycle](#API_DescribeModelPackage_ResponseSyntax) ** A structure describing the current state of the model in its life cycle. Type: [ModelLifeCycle](API_ModelLifeCycle.md) object ** [ModelMetrics](#API_DescribeModelPackage_ResponseSyntax) ** Metrics for the model. Type: [ModelMetrics](API_ModelMetrics.md) object ** [ModelPackageArn](#API_DescribeModelPackage_ResponseSyntax) ** The Amazon Resource Name (ARN) of the model package. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:model-package/[\S]{1,2048}` ** [ModelPackageDescription](#API_DescribeModelPackage_ResponseSyntax) ** A brief summary of the model package. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*` ** [ModelPackageGroupName](#API_DescribeModelPackage_ResponseSyntax) ** If the model is a versioned model, the name of the model group that the versioned model belongs to. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [ModelPackageName](#API_DescribeModelPackage_ResponseSyntax) ** The name of the model package being described. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [ModelPackageRegistrationType](#API_DescribeModelPackage_ResponseSyntax) ** The package registration type of the model package output. Type: String Valid Values: `Logged | Registered` ** [ModelPackageStatus](#API_DescribeModelPackage_ResponseSyntax) ** The current status of the model package. Type: String Valid Values: `Pending | InProgress | Completed | Failed | Deleting` ** [ModelPackageStatusDetails](#API_DescribeModelPackage_ResponseSyntax) ** Details about the current status of the model package. Type: [ModelPackageStatusDetails](API_ModelPackageStatusDetails.md) object ** [ModelPackageVersion](#API_DescribeModelPackage_ResponseSyntax) ** The version of the model package. Type: Integer Valid Range: Minimum value of 1. ** [SamplePayloadUrl](#API_DescribeModelPackage_ResponseSyntax) ** The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points to a single gzip compressed tar archive (.tar.gz suffix). Type: String ** [SecurityConfig](#API_DescribeModelPackage_ResponseSyntax) ** The AWS KMS Key ID (`KMSKeyId`) used for encryption of model package information. Type: [ModelPackageSecurityConfig](API_ModelPackageSecurityConfig.md) object ** [SkipModelValidation](#API_DescribeModelPackage_ResponseSyntax) ** Indicates if you want to skip model validation. Type: String Valid Values: `All | None` ** [SourceAlgorithmSpecification](#API_DescribeModelPackage_ResponseSyntax) ** Details about the algorithm that was used to create the model package. Type: [SourceAlgorithmSpecification](API_SourceAlgorithmSpecification.md) object ** [SourceUri](#API_DescribeModelPackage_ResponseSyntax) ** The URI of the source for the model package. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `[\p{L}\p{M}\p{Z}\p{N}\p{P}]{0,1024}` ** [Task](#API_DescribeModelPackage_ResponseSyntax) ** The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification. Type: String ** [ValidationSpecification](#API_DescribeModelPackage_ResponseSyntax) ** Configurations for one or more transform jobs that SageMaker runs to test the model package. Type: [ModelPackageValidationSpecification](API_ModelPackageValidationSpecification.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeModelPackage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeModelPackage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeModelPackage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeModelPackage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeModelPackage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeModelPackage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeModelPackage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeModelPackage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeModelPackage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeModelPackage) # DescribeModelPackageGroup Gets a description for the specified model group. ## Request Syntax ``` { "ModelPackageGroupName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ModelPackageGroupName](#API_DescribeModelPackageGroup_RequestSyntax) ** The name of the model group to describe. Type: String Length Constraints: Minimum length of 1. Maximum length of 170. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:[a-z\-]*\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(? Information about the user who created or modified a SageMaker resource. Type: [UserContext](API_UserContext.md) object ** [CreationTime](#API_DescribeModelPackageGroup_ResponseSyntax) ** The time that the model group was created. Type: Timestamp ** [ModelPackageGroupArn](#API_DescribeModelPackageGroup_ResponseSyntax) ** The Amazon Resource Name (ARN) of the model group. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:model-package-group/[\S]{1,2048}` ** [ModelPackageGroupDescription](#API_DescribeModelPackageGroup_ResponseSyntax) ** A description of the model group. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*` ** [ModelPackageGroupName](#API_DescribeModelPackageGroup_ResponseSyntax) ** The name of the model group. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [ModelPackageGroupStatus](#API_DescribeModelPackageGroup_ResponseSyntax) ** The status of the model group. Type: String Valid Values: `Pending | InProgress | Completed | Failed | Deleting | DeleteFailed` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeModelPackageGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeModelPackageGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeModelPackageGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeModelPackageGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeModelPackageGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeModelPackageGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeModelPackageGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeModelPackageGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeModelPackageGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeModelPackageGroup) # DescribeModelQualityJobDefinition Returns a description of a model quality job definition. ## Request Syntax ``` { "JobDefinitionName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [JobDefinitionName](#API_DescribeModelQualityJobDefinition_RequestSyntax) ** The name of the model quality job. The name must be unique within an AWS Region in the AWS account. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "CreationTime": number, "JobDefinitionArn": "string", "JobDefinitionName": "string", "JobResources": { "ClusterConfig": { "InstanceCount": number, "InstanceType": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number } }, "ModelQualityAppSpecification": { "ContainerArguments": [ "string" ], "ContainerEntrypoint": [ "string" ], "Environment": { "string" : "string" }, "ImageUri": "string", "PostAnalyticsProcessorSourceUri": "string", "ProblemType": "string", "RecordPreprocessorSourceUri": "string" }, "ModelQualityBaselineConfig": { "BaseliningJobName": "string", "ConstraintsResource": { "S3Uri": "string" } }, "ModelQualityJobInput": { "BatchTransformInput": { "DataCapturedDestinationS3Uri": "string", "DatasetFormat": { "Csv": { "Header": boolean }, "Json": { "Line": boolean }, "Parquet": { } }, "EndTimeOffset": "string", "ExcludeFeaturesAttribute": "string", "FeaturesAttribute": "string", "InferenceAttribute": "string", "LocalPath": "string", "ProbabilityAttribute": "string", "ProbabilityThresholdAttribute": number, "S3DataDistributionType": "string", "S3InputMode": "string", "StartTimeOffset": "string" }, "EndpointInput": { "EndpointName": "string", "EndTimeOffset": "string", "ExcludeFeaturesAttribute": "string", "FeaturesAttribute": "string", "InferenceAttribute": "string", "LocalPath": "string", "ProbabilityAttribute": "string", "ProbabilityThresholdAttribute": number, "S3DataDistributionType": "string", "S3InputMode": "string", "StartTimeOffset": "string" }, "GroundTruthS3Input": { "S3Uri": "string" } }, "ModelQualityJobOutputConfig": { "KmsKeyId": "string", "MonitoringOutputs": [ { "S3Output": { "LocalPath": "string", "S3UploadMode": "string", "S3Uri": "string" } } ] }, "NetworkConfig": { "EnableInterContainerTrafficEncryption": boolean, "EnableNetworkIsolation": boolean, "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } }, "RoleArn": "string", "StoppingCondition": { "MaxRuntimeInSeconds": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreationTime](#API_DescribeModelQualityJobDefinition_ResponseSyntax) ** The time at which the model quality job was created. Type: Timestamp ** [JobDefinitionArn](#API_DescribeModelQualityJobDefinition_ResponseSyntax) ** The Amazon Resource Name (ARN) of the model quality job. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `.*` ** [JobDefinitionName](#API_DescribeModelQualityJobDefinition_ResponseSyntax) ** The name of the quality job definition. The name must be unique within an AWS Region in the AWS account. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [JobResources](#API_DescribeModelQualityJobDefinition_ResponseSyntax) ** Identifies the resources to deploy for a monitoring job. Type: [MonitoringResources](API_MonitoringResources.md) object ** [ModelQualityAppSpecification](#API_DescribeModelQualityJobDefinition_ResponseSyntax) ** Configures the model quality job to run a specified Docker container image. Type: [ModelQualityAppSpecification](API_ModelQualityAppSpecification.md) object ** [ModelQualityBaselineConfig](#API_DescribeModelQualityJobDefinition_ResponseSyntax) ** The baseline configuration for a model quality job. Type: [ModelQualityBaselineConfig](API_ModelQualityBaselineConfig.md) object ** [ModelQualityJobInput](#API_DescribeModelQualityJobDefinition_ResponseSyntax) ** Inputs for the model quality job. Type: [ModelQualityJobInput](API_ModelQualityJobInput.md) object ** [ModelQualityJobOutputConfig](#API_DescribeModelQualityJobDefinition_ResponseSyntax) ** The output configuration for monitoring jobs. Type: [MonitoringOutputConfig](API_MonitoringOutputConfig.md) object ** [NetworkConfig](#API_DescribeModelQualityJobDefinition_ResponseSyntax) ** Networking options for a model quality job. Type: [MonitoringNetworkConfig](API_MonitoringNetworkConfig.md) object ** [RoleArn](#API_DescribeModelQualityJobDefinition_ResponseSyntax) ** The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` ** [StoppingCondition](#API_DescribeModelQualityJobDefinition_ResponseSyntax) ** A time limit for how long the monitoring job is allowed to run before stopping. Type: [MonitoringStoppingCondition](API_MonitoringStoppingCondition.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeModelQualityJobDefinition) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeModelQualityJobDefinition) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeModelQualityJobDefinition) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeModelQualityJobDefinition) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeModelQualityJobDefinition) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeModelQualityJobDefinition) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeModelQualityJobDefinition) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeModelQualityJobDefinition) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeModelQualityJobDefinition) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeModelQualityJobDefinition) # DescribeMonitoringSchedule Describes the schedule for a monitoring job. ## Request Syntax ``` { "MonitoringScheduleName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [MonitoringScheduleName](#API_DescribeMonitoringSchedule_RequestSyntax) ** Name of a previously created monitoring schedule. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "CreationTime": number, "EndpointName": "string", "FailureReason": "string", "LastModifiedTime": number, "LastMonitoringExecutionSummary": { "CreationTime": number, "EndpointName": "string", "FailureReason": "string", "LastModifiedTime": number, "MonitoringExecutionStatus": "string", "MonitoringJobDefinitionName": "string", "MonitoringScheduleName": "string", "MonitoringType": "string", "ProcessingJobArn": "string", "ScheduledTime": number }, "MonitoringScheduleArn": "string", "MonitoringScheduleConfig": { "MonitoringJobDefinition": { "BaselineConfig": { "BaseliningJobName": "string", "ConstraintsResource": { "S3Uri": "string" }, "StatisticsResource": { "S3Uri": "string" } }, "Environment": { "string" : "string" }, "MonitoringAppSpecification": { "ContainerArguments": [ "string" ], "ContainerEntrypoint": [ "string" ], "ImageUri": "string", "PostAnalyticsProcessorSourceUri": "string", "RecordPreprocessorSourceUri": "string" }, "MonitoringInputs": [ { "BatchTransformInput": { "DataCapturedDestinationS3Uri": "string", "DatasetFormat": { "Csv": { "Header": boolean }, "Json": { "Line": boolean }, "Parquet": { } }, "EndTimeOffset": "string", "ExcludeFeaturesAttribute": "string", "FeaturesAttribute": "string", "InferenceAttribute": "string", "LocalPath": "string", "ProbabilityAttribute": "string", "ProbabilityThresholdAttribute": number, "S3DataDistributionType": "string", "S3InputMode": "string", "StartTimeOffset": "string" }, "EndpointInput": { "EndpointName": "string", "EndTimeOffset": "string", "ExcludeFeaturesAttribute": "string", "FeaturesAttribute": "string", "InferenceAttribute": "string", "LocalPath": "string", "ProbabilityAttribute": "string", "ProbabilityThresholdAttribute": number, "S3DataDistributionType": "string", "S3InputMode": "string", "StartTimeOffset": "string" } } ], "MonitoringOutputConfig": { "KmsKeyId": "string", "MonitoringOutputs": [ { "S3Output": { "LocalPath": "string", "S3UploadMode": "string", "S3Uri": "string" } } ] }, "MonitoringResources": { "ClusterConfig": { "InstanceCount": number, "InstanceType": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number } }, "NetworkConfig": { "EnableInterContainerTrafficEncryption": boolean, "EnableNetworkIsolation": boolean, "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } }, "RoleArn": "string", "StoppingCondition": { "MaxRuntimeInSeconds": number } }, "MonitoringJobDefinitionName": "string", "MonitoringType": "string", "ScheduleConfig": { "DataAnalysisEndTime": "string", "DataAnalysisStartTime": "string", "ScheduleExpression": "string" } }, "MonitoringScheduleName": "string", "MonitoringScheduleStatus": "string", "MonitoringType": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreationTime](#API_DescribeMonitoringSchedule_ResponseSyntax) ** The time at which the monitoring job was created. Type: Timestamp ** [EndpointName](#API_DescribeMonitoringSchedule_ResponseSyntax) ** The name of the endpoint for the monitoring job. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [FailureReason](#API_DescribeMonitoringSchedule_ResponseSyntax) ** A string, up to one KB in size, that contains the reason a monitoring job failed, if it failed. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. ** [LastModifiedTime](#API_DescribeMonitoringSchedule_ResponseSyntax) ** The time at which the monitoring job was last modified. Type: Timestamp ** [LastMonitoringExecutionSummary](#API_DescribeMonitoringSchedule_ResponseSyntax) ** Describes metadata on the last execution to run, if there was one. Type: [MonitoringExecutionSummary](API_MonitoringExecutionSummary.md) object ** [MonitoringScheduleArn](#API_DescribeMonitoringSchedule_ResponseSyntax) ** The Amazon Resource Name (ARN) of the monitoring schedule. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `.*` ** [MonitoringScheduleConfig](#API_DescribeMonitoringSchedule_ResponseSyntax) ** The configuration object that specifies the monitoring schedule and defines the monitoring job. Type: [MonitoringScheduleConfig](API_MonitoringScheduleConfig.md) object ** [MonitoringScheduleName](#API_DescribeMonitoringSchedule_ResponseSyntax) ** Name of the monitoring schedule. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [MonitoringScheduleStatus](#API_DescribeMonitoringSchedule_ResponseSyntax) ** The status of an monitoring job. Type: String Valid Values: `Pending | Failed | Scheduled | Stopped` ** [MonitoringType](#API_DescribeMonitoringSchedule_ResponseSyntax) ** 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. Type: String Valid Values: `DataQuality | ModelQuality | ModelBias | ModelExplainability` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeMonitoringSchedule) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeMonitoringSchedule) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeMonitoringSchedule) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeMonitoringSchedule) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeMonitoringSchedule) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeMonitoringSchedule) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeMonitoringSchedule) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeMonitoringSchedule) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeMonitoringSchedule) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeMonitoringSchedule) # DescribeNotebookInstance Returns information about a notebook instance. ## Request Syntax ``` { "NotebookInstanceName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [NotebookInstanceName](#API_DescribeNotebookInstance_RequestSyntax) ** The name of the notebook instance that you want information about. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9])*` Required: Yes ## Response Syntax ``` { "AcceleratorTypes": [ "string" ], "AdditionalCodeRepositories": [ "string" ], "CreationTime": number, "DefaultCodeRepository": "string", "DirectInternetAccess": "string", "FailureReason": "string", "InstanceMetadataServiceConfiguration": { "MinimumInstanceMetadataServiceVersion": "string" }, "InstanceType": "string", "IpAddressType": "string", "KmsKeyId": "string", "LastModifiedTime": number, "NetworkInterfaceId": "string", "NotebookInstanceArn": "string", "NotebookInstanceLifecycleConfigName": "string", "NotebookInstanceName": "string", "NotebookInstanceStatus": "string", "PlatformIdentifier": "string", "RoleArn": "string", "RootAccess": "string", "SecurityGroups": [ "string" ], "SubnetId": "string", "Url": "string", "VolumeSizeInGB": number } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AcceleratorTypes](#API_DescribeNotebookInstance_ResponseSyntax) ** This parameter is no longer supported. Elastic Inference (EI) is no longer available. This parameter was used to specify a list of the EI instance types associated with this notebook instance. Type: Array of strings Valid Values: `ml.eia1.medium | ml.eia1.large | ml.eia1.xlarge | ml.eia2.medium | ml.eia2.large | ml.eia2.xlarge` ** [AdditionalCodeRepositories](#API_DescribeNotebookInstance_ResponseSyntax) ** 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](https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) 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 SageMaker AI Notebook Instances](https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 3 items. Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `https://([^/]+)/?(.*)$|^[a-zA-Z0-9](-*[a-zA-Z0-9])*` ** [CreationTime](#API_DescribeNotebookInstance_ResponseSyntax) ** A timestamp. Use this parameter to return the time when the notebook instance was created Type: Timestamp ** [DefaultCodeRepository](#API_DescribeNotebookInstance_ResponseSyntax) ** 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](https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) 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 SageMaker AI Notebook Instances](https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `https://([^/]+)/?(.*)$|^[a-zA-Z0-9](-*[a-zA-Z0-9])*` ** [DirectInternetAccess](#API_DescribeNotebookInstance_ResponseSyntax) ** Describes whether SageMaker AI 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 SageMaker AI training and endpoint services. For more information, see [Notebook Instances Are Internet-Enabled by Default](https://docs.aws.amazon.com/sagemaker/latest/dg/appendix-additional-considerations.html#appendix-notebook-and-internet-access). Type: String Valid Values: `Enabled | Disabled` ** [FailureReason](#API_DescribeNotebookInstance_ResponseSyntax) ** If status is `Failed`, the reason it failed. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. ** [InstanceMetadataServiceConfiguration](#API_DescribeNotebookInstance_ResponseSyntax) ** Information on the IMDS configuration of the notebook instance Type: [InstanceMetadataServiceConfiguration](API_InstanceMetadataServiceConfiguration.md) object ** [InstanceType](#API_DescribeNotebookInstance_ResponseSyntax) ** The type of ML compute instance running on the notebook instance. Type: String Valid Values: `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.m5d.large | ml.m5d.xlarge | ml.m5d.2xlarge | ml.m5d.4xlarge | ml.m5d.8xlarge | ml.m5d.12xlarge | ml.m5d.16xlarge | ml.m5d.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 | ml.p3dn.24xlarge | 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.8xlarge | ml.r5.12xlarge | ml.r5.16xlarge | ml.r5.24xlarge | ml.g5.xlarge | ml.g5.2xlarge | ml.g5.4xlarge | ml.g5.8xlarge | ml.g5.16xlarge | ml.g5.12xlarge | ml.g5.24xlarge | ml.g5.48xlarge | ml.inf1.xlarge | ml.inf1.2xlarge | ml.inf1.6xlarge | ml.inf1.24xlarge | ml.trn1.2xlarge | ml.trn1.32xlarge | ml.trn1n.32xlarge | ml.inf2.xlarge | ml.inf2.8xlarge | ml.inf2.24xlarge | ml.inf2.48xlarge | ml.p4d.24xlarge | ml.p4de.24xlarge | ml.p5.48xlarge | ml.p6-b200.48xlarge | ml.m6i.large | ml.m6i.xlarge | ml.m6i.2xlarge | ml.m6i.4xlarge | ml.m6i.8xlarge | ml.m6i.12xlarge | ml.m6i.16xlarge | ml.m6i.24xlarge | ml.m6i.32xlarge | ml.m7i.large | ml.m7i.xlarge | ml.m7i.2xlarge | ml.m7i.4xlarge | ml.m7i.8xlarge | ml.m7i.12xlarge | ml.m7i.16xlarge | ml.m7i.24xlarge | ml.m7i.48xlarge | ml.c6i.large | ml.c6i.xlarge | ml.c6i.2xlarge | ml.c6i.4xlarge | ml.c6i.8xlarge | ml.c6i.12xlarge | ml.c6i.16xlarge | ml.c6i.24xlarge | ml.c6i.32xlarge | ml.c7i.large | ml.c7i.xlarge | ml.c7i.2xlarge | ml.c7i.4xlarge | ml.c7i.8xlarge | ml.c7i.12xlarge | ml.c7i.16xlarge | ml.c7i.24xlarge | ml.c7i.48xlarge | ml.r6i.large | ml.r6i.xlarge | ml.r6i.2xlarge | ml.r6i.4xlarge | ml.r6i.8xlarge | ml.r6i.12xlarge | ml.r6i.16xlarge | ml.r6i.24xlarge | ml.r6i.32xlarge | ml.r7i.large | ml.r7i.xlarge | ml.r7i.2xlarge | ml.r7i.4xlarge | ml.r7i.8xlarge | ml.r7i.12xlarge | ml.r7i.16xlarge | ml.r7i.24xlarge | ml.r7i.48xlarge | ml.m6id.large | ml.m6id.xlarge | ml.m6id.2xlarge | ml.m6id.4xlarge | ml.m6id.8xlarge | ml.m6id.12xlarge | ml.m6id.16xlarge | ml.m6id.24xlarge | ml.m6id.32xlarge | ml.c6id.large | ml.c6id.xlarge | ml.c6id.2xlarge | ml.c6id.4xlarge | ml.c6id.8xlarge | ml.c6id.12xlarge | ml.c6id.16xlarge | ml.c6id.24xlarge | ml.c6id.32xlarge | ml.r6id.large | ml.r6id.xlarge | ml.r6id.2xlarge | ml.r6id.4xlarge | ml.r6id.8xlarge | ml.r6id.12xlarge | ml.r6id.16xlarge | ml.r6id.24xlarge | ml.r6id.32xlarge | ml.g6.xlarge | ml.g6.2xlarge | ml.g6.4xlarge | ml.g6.8xlarge | ml.g6.12xlarge | ml.g6.16xlarge | ml.g6.24xlarge | ml.g6.48xlarge` ** [IpAddressType](#API_DescribeNotebookInstance_ResponseSyntax) ** The IP address type configured for the notebook instance. Returns `ipv4` for IPv4-only connectivity or `dualstack` for both IPv4 and IPv6 connectivity. Type: String Valid Values: `ipv4 | dualstack` ** [KmsKeyId](#API_DescribeNotebookInstance_ResponseSyntax) ** The AWS KMS key ID SageMaker AI uses to encrypt data when storing it on the ML storage volume attached to the instance. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `[a-zA-Z0-9:/_-]*` ** [LastModifiedTime](#API_DescribeNotebookInstance_ResponseSyntax) ** A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified. Type: Timestamp ** [NetworkInterfaceId](#API_DescribeNotebookInstance_ResponseSyntax) ** The network interface IDs that SageMaker AI created at the time of creating the instance. Type: String ** [NotebookInstanceArn](#API_DescribeNotebookInstance_ResponseSyntax) ** The Amazon Resource Name (ARN) of the notebook instance. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. ** [NotebookInstanceLifecycleConfigName](#API_DescribeNotebookInstance_ResponseSyntax) ** 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](https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html) Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9])*` ** [NotebookInstanceName](#API_DescribeNotebookInstance_ResponseSyntax) ** The name of the SageMaker AI notebook instance. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9])*` ** [NotebookInstanceStatus](#API_DescribeNotebookInstance_ResponseSyntax) ** The status of the notebook instance. Type: String Valid Values: `Pending | InService | Stopping | Stopped | Failed | Deleting | Updating` ** [PlatformIdentifier](#API_DescribeNotebookInstance_ResponseSyntax) ** The platform identifier of the notebook instance runtime environment. Type: String Length Constraints: Minimum length of 0. Maximum length of 20. Pattern: `(notebook-al1-v1|notebook-al2-v1|notebook-al2-v2|notebook-al2-v3|notebook-al2023-v1)` ** [RoleArn](#API_DescribeNotebookInstance_ResponseSyntax) ** The Amazon Resource Name (ARN) of the IAM role associated with the instance. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` ** [RootAccess](#API_DescribeNotebookInstance_ResponseSyntax) ** 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. Type: String Valid Values: `Enabled | Disabled` ** [SecurityGroups](#API_DescribeNotebookInstance_ResponseSyntax) ** The IDs of the VPC security groups. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 5 items. Length Constraints: Minimum length of 0. Maximum length of 32. Pattern: `[-0-9a-zA-Z]+` ** [SubnetId](#API_DescribeNotebookInstance_ResponseSyntax) ** The ID of the VPC subnet. Type: String Length Constraints: Minimum length of 0. Maximum length of 32. Pattern: `[-0-9a-zA-Z]+` ** [Url](#API_DescribeNotebookInstance_ResponseSyntax) ** The URL that you use to connect to the Jupyter notebook that is running in your notebook instance. Type: String ** [VolumeSizeInGB](#API_DescribeNotebookInstance_ResponseSyntax) ** The size, in GB, of the ML storage volume attached to the notebook instance. Type: Integer Valid Range: Minimum value of 5. Maximum value of 16384. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeNotebookInstance) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeNotebookInstance) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeNotebookInstance) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeNotebookInstance) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeNotebookInstance) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeNotebookInstance) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeNotebookInstance) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeNotebookInstance) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeNotebookInstance) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeNotebookInstance) # DescribeNotebookInstanceLifecycleConfig 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](https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html). ## Request Syntax ``` { "NotebookInstanceLifecycleConfigName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [NotebookInstanceLifecycleConfigName](#API_DescribeNotebookInstanceLifecycleConfig_RequestSyntax) ** The name of the lifecycle configuration to describe. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9])*` Required: Yes ## Response Syntax ``` { "CreationTime": number, "LastModifiedTime": number, "NotebookInstanceLifecycleConfigArn": "string", "NotebookInstanceLifecycleConfigName": "string", "OnCreate": [ { "Content": "string" } ], "OnStart": [ { "Content": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreationTime](#API_DescribeNotebookInstanceLifecycleConfig_ResponseSyntax) ** A timestamp that tells when the lifecycle configuration was created. Type: Timestamp ** [LastModifiedTime](#API_DescribeNotebookInstanceLifecycleConfig_ResponseSyntax) ** A timestamp that tells when the lifecycle configuration was last modified. Type: Timestamp ** [NotebookInstanceLifecycleConfigArn](#API_DescribeNotebookInstanceLifecycleConfig_ResponseSyntax) ** The Amazon Resource Name (ARN) of the lifecycle configuration. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. ** [NotebookInstanceLifecycleConfigName](#API_DescribeNotebookInstanceLifecycleConfig_ResponseSyntax) ** The name of the lifecycle configuration. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9])*` ** [OnCreate](#API_DescribeNotebookInstanceLifecycleConfig_ResponseSyntax) ** The shell script that runs only once, when you create a notebook instance. Type: Array of [NotebookInstanceLifecycleHook](API_NotebookInstanceLifecycleHook.md) objects Array Members: Minimum number of 0 items. Maximum number of 1 item. ** [OnStart](#API_DescribeNotebookInstanceLifecycleConfig_ResponseSyntax) ** The shell script that runs every time you start a notebook instance, including when you create the notebook instance. Type: Array of [NotebookInstanceLifecycleHook](API_NotebookInstanceLifecycleHook.md) objects Array Members: Minimum number of 0 items. Maximum number of 1 item. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeNotebookInstanceLifecycleConfig) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeNotebookInstanceLifecycleConfig) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeNotebookInstanceLifecycleConfig) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeNotebookInstanceLifecycleConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeNotebookInstanceLifecycleConfig) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeNotebookInstanceLifecycleConfig) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeNotebookInstanceLifecycleConfig) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeNotebookInstanceLifecycleConfig) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeNotebookInstanceLifecycleConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeNotebookInstanceLifecycleConfig) # DescribeOptimizationJob Provides the properties of the specified optimization job. ## Request Syntax ``` { "OptimizationJobName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [OptimizationJobName](#API_DescribeOptimizationJob_RequestSyntax) ** The name that you assigned to the optimization job. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "CreationTime": number, "DeploymentInstanceType": "string", "FailureReason": "string", "LastModifiedTime": number, "MaxInstanceCount": number, "ModelSource": { "S3": { "ModelAccessConfig": { "AcceptEula": boolean }, "S3Uri": "string" }, "SageMakerModel": { "ModelName": "string" } }, "OptimizationConfigs": [ { ... } ], "OptimizationEndTime": number, "OptimizationEnvironment": { "string" : "string" }, "OptimizationJobArn": "string", "OptimizationJobName": "string", "OptimizationJobStatus": "string", "OptimizationOutput": { "RecommendedInferenceImage": "string" }, "OptimizationStartTime": number, "OutputConfig": { "KmsKeyId": "string", "S3OutputLocation": "string", "SageMakerModel": { "ModelName": "string" } }, "RoleArn": "string", "StoppingCondition": { "MaxPendingTimeInSeconds": number, "MaxRuntimeInSeconds": number, "MaxWaitTimeInSeconds": number }, "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreationTime](#API_DescribeOptimizationJob_ResponseSyntax) ** The time when you created the optimization job. Type: Timestamp ** [DeploymentInstanceType](#API_DescribeOptimizationJob_ResponseSyntax) ** The type of instance that hosts the optimized model that you create with the optimization job. Type: String Valid Values: `ml.p4d.24xlarge | ml.p4de.24xlarge | ml.p5.48xlarge | ml.p5e.48xlarge | ml.p5en.48xlarge | ml.g5.xlarge | ml.g5.2xlarge | ml.g5.4xlarge | ml.g5.8xlarge | ml.g5.12xlarge | ml.g5.16xlarge | ml.g5.24xlarge | ml.g5.48xlarge | ml.g6.xlarge | ml.g6.2xlarge | ml.g6.4xlarge | ml.g6.8xlarge | ml.g6.12xlarge | ml.g6.16xlarge | ml.g6.24xlarge | ml.g6.48xlarge | ml.g6e.xlarge | ml.g6e.2xlarge | ml.g6e.4xlarge | ml.g6e.8xlarge | ml.g6e.12xlarge | ml.g6e.16xlarge | ml.g6e.24xlarge | ml.g6e.48xlarge | ml.inf2.xlarge | ml.inf2.8xlarge | ml.inf2.24xlarge | ml.inf2.48xlarge | ml.trn1.2xlarge | ml.trn1.32xlarge | ml.trn1n.32xlarge` ** [FailureReason](#API_DescribeOptimizationJob_ResponseSyntax) ** If the optimization job status is `FAILED`, the reason for the failure. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. ** [LastModifiedTime](#API_DescribeOptimizationJob_ResponseSyntax) ** The time when the optimization job was last updated. Type: Timestamp ** [MaxInstanceCount](#API_DescribeOptimizationJob_ResponseSyntax) ** The maximum number of instances to use for the optimization job. Type: Integer Valid Range: Minimum value of 1. ** [ModelSource](#API_DescribeOptimizationJob_ResponseSyntax) ** The location of the source model to optimize with an optimization job. Type: [OptimizationJobModelSource](API_OptimizationJobModelSource.md) object ** [OptimizationConfigs](#API_DescribeOptimizationJob_ResponseSyntax) ** Settings for each of the optimization techniques that the job applies. Type: Array of [OptimizationConfig](API_OptimizationConfig.md) objects Array Members: Minimum number of 0 items. Maximum number of 10 items. ** [OptimizationEndTime](#API_DescribeOptimizationJob_ResponseSyntax) ** The time when the optimization job finished processing. Type: Timestamp ** [OptimizationEnvironment](#API_DescribeOptimizationJob_ResponseSyntax) ** The environment variables to set in the model container. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 25 items. Key Length Constraints: Minimum length of 0. Maximum length of 256. Key Pattern: `(?!\s*$).+` Value Length Constraints: Minimum length of 0. Maximum length of 256. ** [OptimizationJobArn](#API_DescribeOptimizationJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the optimization job. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:optimization-job/.*` ** [OptimizationJobName](#API_DescribeOptimizationJob_ResponseSyntax) ** The name that you assigned to the optimization job. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [OptimizationJobStatus](#API_DescribeOptimizationJob_ResponseSyntax) ** The current status of the optimization job. Type: String Valid Values: `INPROGRESS | COMPLETED | FAILED | STARTING | STOPPING | STOPPED` ** [OptimizationOutput](#API_DescribeOptimizationJob_ResponseSyntax) ** Output values produced by an optimization job. Type: [OptimizationOutput](API_OptimizationOutput.md) object ** [OptimizationStartTime](#API_DescribeOptimizationJob_ResponseSyntax) ** The time when the optimization job started. Type: Timestamp ** [OutputConfig](#API_DescribeOptimizationJob_ResponseSyntax) ** Details for where to store the optimized model that you create with the optimization job. Type: [OptimizationJobOutputConfig](API_OptimizationJobOutputConfig.md) object ** [RoleArn](#API_DescribeOptimizationJob_ResponseSyntax) ** The ARN of the IAM role that you assigned to the optimization job. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` ** [StoppingCondition](#API_DescribeOptimizationJob_ResponseSyntax) ** Specifies a limit to how long a job can run. When the job reaches the time limit, SageMaker ends the job. Use this API to cap costs. To stop a training job, 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 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. Type: [StoppingCondition](API_StoppingCondition.md) object ** [VpcConfig](#API_DescribeOptimizationJob_ResponseSyntax) ** A VPC in Amazon VPC that your optimized model has access to. Type: [OptimizationVpcConfig](API_OptimizationVpcConfig.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeOptimizationJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeOptimizationJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeOptimizationJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeOptimizationJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeOptimizationJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeOptimizationJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeOptimizationJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeOptimizationJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeOptimizationJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeOptimizationJob) # DescribePartnerApp Gets information about a SageMaker Partner AI App. ## Request Syntax ``` { "Arn": "string", "IncludeAvailableUpgrade": boolean } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Arn](#API_DescribePartnerApp_RequestSyntax) ** The ARN of the SageMaker Partner AI App to describe. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:partner-app\/app-[A-Z0-9]{12}` Required: Yes ** [IncludeAvailableUpgrade](#API_DescribePartnerApp_RequestSyntax) ** When set to `TRUE`, the response includes available upgrade information for the SageMaker Partner AI App. Default is `FALSE`. Type: Boolean Required: No ## Response Syntax ``` { "ApplicationConfig": { "AdminUsers": [ "string" ], "Arguments": { "string" : "string" }, "AssignedGroupPatterns": [ "string" ], "RoleGroupAssignments": [ { "GroupPatterns": [ "string" ], "RoleName": "string" } ] }, "Arn": "string", "AuthType": "string", "AvailableUpgrade": { "ReleaseNotes": [ "string" ], "Version": "string" }, "BaseUrl": "string", "CreationTime": number, "CurrentVersionEolDate": number, "EnableAutoMinorVersionUpgrade": boolean, "EnableIamSessionBasedIdentity": boolean, "Error": { "Code": "string", "Reason": "string" }, "ExecutionRoleArn": "string", "KmsKeyId": "string", "LastModifiedTime": number, "MaintenanceConfig": { "MaintenanceWindowStart": "string" }, "Name": "string", "Status": "string", "Tier": "string", "Type": "string", "Version": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ApplicationConfig](#API_DescribePartnerApp_ResponseSyntax) ** Configuration settings for the SageMaker Partner AI App. Type: [PartnerAppConfig](API_PartnerAppConfig.md) object ** [Arn](#API_DescribePartnerApp_ResponseSyntax) ** The ARN of the SageMaker Partner AI App that was described. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:partner-app\/app-[A-Z0-9]{12}` ** [AuthType](#API_DescribePartnerApp_ResponseSyntax) ** The authorization type that users use to access the SageMaker Partner AI App. Type: String Valid Values: `IAM` ** [AvailableUpgrade](#API_DescribePartnerApp_ResponseSyntax) ** A map of available minor version upgrades for the SageMaker Partner AI App. The key is the semantic version number, and the value is a list of release notes for that version. A null value indicates no upgrades are available. Type: [AvailableUpgrade](API_AvailableUpgrade.md) object ** [BaseUrl](#API_DescribePartnerApp_ResponseSyntax) ** The URL of the SageMaker Partner AI App that the Application SDK uses to support in-app calls for the user. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. ** [CreationTime](#API_DescribePartnerApp_ResponseSyntax) ** The time that the SageMaker Partner AI App was created. Type: Timestamp ** [CurrentVersionEolDate](#API_DescribePartnerApp_ResponseSyntax) ** The end-of-life date for the current version of the SageMaker Partner AI App. Type: Timestamp ** [EnableAutoMinorVersionUpgrade](#API_DescribePartnerApp_ResponseSyntax) ** Indicates whether the SageMaker Partner AI App is configured for automatic minor version upgrades during scheduled maintenance windows. Type: Boolean ** [EnableIamSessionBasedIdentity](#API_DescribePartnerApp_ResponseSyntax) ** When set to `TRUE`, the SageMaker Partner AI App sets the AWS IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user. Type: Boolean ** [Error](#API_DescribePartnerApp_ResponseSyntax) ** This is an error field object that contains the error code and the reason for an operation failure. Type: [ErrorInfo](API_ErrorInfo.md) object ** [ExecutionRoleArn](#API_DescribePartnerApp_ResponseSyntax) ** The ARN of the IAM role associated with the SageMaker Partner AI App. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` ** [KmsKeyId](#API_DescribePartnerApp_ResponseSyntax) ** The AWS KMS customer managed key used to encrypt the data at rest associated with SageMaker Partner AI Apps. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `[a-zA-Z0-9:/_-]*` ** [LastModifiedTime](#API_DescribePartnerApp_ResponseSyntax) ** The time that the SageMaker Partner AI App was last modified. Type: Timestamp ** [MaintenanceConfig](#API_DescribePartnerApp_ResponseSyntax) ** Maintenance configuration settings for the SageMaker Partner AI App. Type: [PartnerAppMaintenanceConfig](API_PartnerAppMaintenanceConfig.md) object ** [Name](#API_DescribePartnerApp_ResponseSyntax) ** The name of the SageMaker Partner AI App. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9]+` ** [Status](#API_DescribePartnerApp_ResponseSyntax) ** The status of the SageMaker Partner AI App. + Creating: SageMaker AI is creating the partner AI app. The partner AI app is not available during creation. + Updating: SageMaker AI is updating the partner AI app. The partner AI app is not available when updating. + Deleting: SageMaker AI is deleting the partner AI app. The partner AI app is not available during deletion. + Available: The partner AI app is provisioned and accessible. + Failed: The partner AI app is in a failed state and isn't available. SageMaker AI is investigating the issue. For further guidance, contact AWS Support. + UpdateFailed: The partner AI app couldn't be updated but is available. + Deleted: The partner AI app is permanently deleted and not available. Type: String Valid Values: `Creating | Updating | Deleting | Available | Failed | UpdateFailed | Deleted` ** [Tier](#API_DescribePartnerApp_ResponseSyntax) ** The instance type and size of the cluster attached to the SageMaker Partner AI App. Type: String Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: `(?!\s*$).+` ** [Type](#API_DescribePartnerApp_ResponseSyntax) ** The type of SageMaker Partner AI App. Must be one of the following: `lakera-guard`, `comet`, `deepchecks-llm-evaluation`, or `fiddler`. Type: String Valid Values: `lakera-guard | comet | deepchecks-llm-evaluation | fiddler` ** [Version](#API_DescribePartnerApp_ResponseSyntax) ** The version of the SageMaker Partner AI App. Type: String Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: `(?!\s*$).+` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribePartnerApp) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribePartnerApp) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribePartnerApp) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribePartnerApp) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribePartnerApp) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribePartnerApp) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribePartnerApp) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribePartnerApp) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribePartnerApp) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribePartnerApp) # DescribePipeline Describes the details of a pipeline. ## Request Syntax ``` { "PipelineName": "string", "PipelineVersionId": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [PipelineName](#API_DescribePipeline_RequestSyntax) ** The name or Amazon Resource Name (ARN) of the pipeline to describe. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:pipeline/.*)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,255})` Required: Yes ** [PipelineVersionId](#API_DescribePipeline_RequestSyntax) ** The ID of the pipeline version to describe. Type: Long Valid Range: Minimum value of 1. Required: No ## Response Syntax ``` { "CreatedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "LastModifiedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "LastRunTime": number, "ParallelismConfiguration": { "MaxParallelExecutionSteps": number }, "PipelineArn": "string", "PipelineDefinition": "string", "PipelineDescription": "string", "PipelineDisplayName": "string", "PipelineName": "string", "PipelineStatus": "string", "PipelineVersionDescription": "string", "PipelineVersionDisplayName": "string", "RoleArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreatedBy](#API_DescribePipeline_ResponseSyntax) ** Information about the user who created or modified a SageMaker resource. Type: [UserContext](API_UserContext.md) object ** [CreationTime](#API_DescribePipeline_ResponseSyntax) ** The time when the pipeline was created. Type: Timestamp ** [LastModifiedBy](#API_DescribePipeline_ResponseSyntax) ** Information about the user who created or modified a SageMaker resource. Type: [UserContext](API_UserContext.md) object ** [LastModifiedTime](#API_DescribePipeline_ResponseSyntax) ** The time when the pipeline was last modified. Type: Timestamp ** [LastRunTime](#API_DescribePipeline_ResponseSyntax) ** The time when the pipeline was last run. Type: Timestamp ** [ParallelismConfiguration](#API_DescribePipeline_ResponseSyntax) ** Lists the parallelism configuration applied to the pipeline. Type: [ParallelismConfiguration](API_ParallelismConfiguration.md) object ** [PipelineArn](#API_DescribePipeline_ResponseSyntax) ** The Amazon Resource Name (ARN) of the pipeline. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:pipeline/.*` ** [PipelineDefinition](#API_DescribePipeline_ResponseSyntax) ** The JSON pipeline definition. Type: String Length Constraints: Minimum length of 1. Maximum length of 1048576. Pattern: `.*(?:[ \r\n\t].*)*` ** [PipelineDescription](#API_DescribePipeline_ResponseSyntax) ** The description of the pipeline. Type: String Length Constraints: Minimum length of 0. Maximum length of 3072. Pattern: `.*` ** [PipelineDisplayName](#API_DescribePipeline_ResponseSyntax) ** The display name of the pipeline. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}` ** [PipelineName](#API_DescribePipeline_ResponseSyntax) ** The name of the pipeline. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}` ** [PipelineStatus](#API_DescribePipeline_ResponseSyntax) ** The status of the pipeline execution. Type: String Valid Values: `Active | Deleting` ** [PipelineVersionDescription](#API_DescribePipeline_ResponseSyntax) ** The description of the pipeline version. Type: String Length Constraints: Minimum length of 0. Maximum length of 3072. Pattern: `.*` ** [PipelineVersionDisplayName](#API_DescribePipeline_ResponseSyntax) ** The display name of the pipeline version. Type: String Length Constraints: Minimum length of 1. Maximum length of 82. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,81}` ** [RoleArn](#API_DescribePipeline_ResponseSyntax) ** The Amazon Resource Name (ARN) that the pipeline uses to execute. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribePipeline) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribePipeline) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribePipeline) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribePipeline) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribePipeline) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribePipeline) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribePipeline) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribePipeline) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribePipeline) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribePipeline) # DescribePipelineDefinitionForExecution Describes the details of an execution's pipeline definition. ## Request Syntax ``` { "PipelineExecutionArn": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [PipelineExecutionArn](#API_DescribePipelineDefinitionForExecution_RequestSyntax) ** The Amazon Resource Name (ARN) of the pipeline execution. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:pipeline\/.*\/execution\/.*` Required: Yes ## Response Syntax ``` { "CreationTime": number, "PipelineDefinition": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreationTime](#API_DescribePipelineDefinitionForExecution_ResponseSyntax) ** The time when the pipeline was created. Type: Timestamp ** [PipelineDefinition](#API_DescribePipelineDefinitionForExecution_ResponseSyntax) ** The JSON pipeline definition. Type: String Length Constraints: Minimum length of 1. Maximum length of 1048576. Pattern: `.*(?:[ \r\n\t].*)*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribePipelineDefinitionForExecution) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribePipelineDefinitionForExecution) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribePipelineDefinitionForExecution) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribePipelineDefinitionForExecution) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribePipelineDefinitionForExecution) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribePipelineDefinitionForExecution) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribePipelineDefinitionForExecution) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribePipelineDefinitionForExecution) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribePipelineDefinitionForExecution) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribePipelineDefinitionForExecution) # DescribePipelineExecution Describes the details of a pipeline execution. ## Request Syntax ``` { "PipelineExecutionArn": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [PipelineExecutionArn](#API_DescribePipelineExecution_RequestSyntax) ** The Amazon Resource Name (ARN) of the pipeline execution. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:pipeline\/.*\/execution\/.*` Required: Yes ## Response Syntax ``` { "CreatedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "FailureReason": "string", "LastModifiedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "MLflowConfig": { "MlflowExperimentName": "string", "MlflowResourceArn": "string" }, "ParallelismConfiguration": { "MaxParallelExecutionSteps": number }, "PipelineArn": "string", "PipelineExecutionArn": "string", "PipelineExecutionDescription": "string", "PipelineExecutionDisplayName": "string", "PipelineExecutionStatus": "string", "PipelineExperimentConfig": { "ExperimentName": "string", "TrialName": "string" }, "PipelineVersionId": number, "SelectiveExecutionConfig": { "SelectedSteps": [ { "StepName": "string" } ], "SourcePipelineExecutionArn": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreatedBy](#API_DescribePipelineExecution_ResponseSyntax) ** Information about the user who created or modified a SageMaker resource. Type: [UserContext](API_UserContext.md) object ** [CreationTime](#API_DescribePipelineExecution_ResponseSyntax) ** The time when the pipeline execution was created. Type: Timestamp ** [FailureReason](#API_DescribePipelineExecution_ResponseSyntax) ** If the execution failed, a message describing why. Type: String Length Constraints: Minimum length of 0. Maximum length of 1300. Pattern: `.*` ** [LastModifiedBy](#API_DescribePipelineExecution_ResponseSyntax) ** Information about the user who created or modified a SageMaker resource. Type: [UserContext](API_UserContext.md) object ** [LastModifiedTime](#API_DescribePipelineExecution_ResponseSyntax) ** The time when the pipeline execution was modified last. Type: Timestamp ** [MLflowConfig](#API_DescribePipelineExecution_ResponseSyntax) ** The MLflow configuration of the pipeline execution. Type: [MLflowConfiguration](API_MLflowConfiguration.md) object ** [ParallelismConfiguration](#API_DescribePipelineExecution_ResponseSyntax) ** The parallelism configuration applied to the pipeline. Type: [ParallelismConfiguration](API_ParallelismConfiguration.md) object ** [PipelineArn](#API_DescribePipelineExecution_ResponseSyntax) ** The Amazon Resource Name (ARN) of the pipeline. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:pipeline/.*` ** [PipelineExecutionArn](#API_DescribePipelineExecution_ResponseSyntax) ** The Amazon Resource Name (ARN) of the pipeline execution. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:pipeline\/.*\/execution\/.*` ** [PipelineExecutionDescription](#API_DescribePipelineExecution_ResponseSyntax) ** The description of the pipeline execution. Type: String Length Constraints: Minimum length of 0. Maximum length of 3072. Pattern: `.*` ** [PipelineExecutionDisplayName](#API_DescribePipelineExecution_ResponseSyntax) ** The display name of the pipeline execution. Type: String Length Constraints: Minimum length of 1. Maximum length of 82. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,81}` ** [PipelineExecutionStatus](#API_DescribePipelineExecution_ResponseSyntax) ** The status of the pipeline execution. Type: String Valid Values: `Executing | Stopping | Stopped | Failed | Succeeded` ** [PipelineExperimentConfig](#API_DescribePipelineExecution_ResponseSyntax) ** Specifies the names of the experiment and trial created by a pipeline. Type: [PipelineExperimentConfig](API_PipelineExperimentConfig.md) object ** [PipelineVersionId](#API_DescribePipelineExecution_ResponseSyntax) ** The ID of the pipeline version. Type: Long Valid Range: Minimum value of 1. ** [SelectiveExecutionConfig](#API_DescribePipelineExecution_ResponseSyntax) ** The selective execution configuration applied to the pipeline run. Type: [SelectiveExecutionConfig](API_SelectiveExecutionConfig.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribePipelineExecution) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribePipelineExecution) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribePipelineExecution) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribePipelineExecution) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribePipelineExecution) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribePipelineExecution) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribePipelineExecution) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribePipelineExecution) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribePipelineExecution) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribePipelineExecution) # DescribeProcessingJob Returns a description of a processing job. ## Request Syntax ``` { "ProcessingJobName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ProcessingJobName](#API_DescribeProcessingJob_RequestSyntax) ** The name of the processing job. The name must be unique within an AWS Region in the AWS account. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "AppSpecification": { "ContainerArguments": [ "string" ], "ContainerEntrypoint": [ "string" ], "ImageUri": "string" }, "AutoMLJobArn": "string", "CreationTime": number, "Environment": { "string" : "string" }, "ExitMessage": "string", "ExperimentConfig": { "ExperimentName": "string", "RunName": "string", "TrialComponentDisplayName": "string", "TrialName": "string" }, "FailureReason": "string", "LastModifiedTime": number, "MonitoringScheduleArn": "string", "NetworkConfig": { "EnableInterContainerTrafficEncryption": boolean, "EnableNetworkIsolation": boolean, "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } }, "ProcessingEndTime": number, "ProcessingInputs": [ { "AppManaged": boolean, "DatasetDefinition": { "AthenaDatasetDefinition": { "Catalog": "string", "Database": "string", "KmsKeyId": "string", "OutputCompression": "string", "OutputFormat": "string", "OutputS3Uri": "string", "QueryString": "string", "WorkGroup": "string" }, "DataDistributionType": "string", "InputMode": "string", "LocalPath": "string", "RedshiftDatasetDefinition": { "ClusterId": "string", "ClusterRoleArn": "string", "Database": "string", "DbUser": "string", "KmsKeyId": "string", "OutputCompression": "string", "OutputFormat": "string", "OutputS3Uri": "string", "QueryString": "string" } }, "InputName": "string", "S3Input": { "LocalPath": "string", "S3CompressionType": "string", "S3DataDistributionType": "string", "S3DataType": "string", "S3InputMode": "string", "S3Uri": "string" } } ], "ProcessingJobArn": "string", "ProcessingJobName": "string", "ProcessingJobStatus": "string", "ProcessingOutputConfig": { "KmsKeyId": "string", "Outputs": [ { "AppManaged": boolean, "FeatureStoreOutput": { "FeatureGroupName": "string" }, "OutputName": "string", "S3Output": { "LocalPath": "string", "S3UploadMode": "string", "S3Uri": "string" } } ] }, "ProcessingResources": { "ClusterConfig": { "InstanceCount": number, "InstanceType": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number } }, "ProcessingStartTime": number, "RoleArn": "string", "StoppingCondition": { "MaxRuntimeInSeconds": number }, "TrainingJobArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AppSpecification](#API_DescribeProcessingJob_ResponseSyntax) ** Configures the processing job to run a specified container image. Type: [AppSpecification](API_AppSpecification.md) object ** [AutoMLJobArn](#API_DescribeProcessingJob_ResponseSyntax) ** The ARN of an AutoML job associated with this processing job. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:automl-job/.*` ** [CreationTime](#API_DescribeProcessingJob_ResponseSyntax) ** The time at which the processing job was created. Type: Timestamp ** [Environment](#API_DescribeProcessingJob_ResponseSyntax) ** The environment variables set in the Docker container. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 100 items. Key Length Constraints: Minimum length of 0. Maximum length of 256. Key Pattern: `[a-zA-Z_][a-zA-Z0-9_]*` Value Length Constraints: Minimum length of 0. Maximum length of 256. Value Pattern: `[\S\s]*` ** [ExitMessage](#API_DescribeProcessingJob_ResponseSyntax) ** An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `[\S\s]*` ** [ExperimentConfig](#API_DescribeProcessingJob_ResponseSyntax) ** The configuration information used to create an experiment. Type: [ExperimentConfig](API_ExperimentConfig.md) object ** [FailureReason](#API_DescribeProcessingJob_ResponseSyntax) ** A string, up to one KB in size, that contains the reason a processing job failed, if it failed. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. ** [LastModifiedTime](#API_DescribeProcessingJob_ResponseSyntax) ** The time at which the processing job was last modified. Type: Timestamp ** [MonitoringScheduleArn](#API_DescribeProcessingJob_ResponseSyntax) ** The ARN of a monitoring schedule for an endpoint associated with this processing job. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `.*` ** [NetworkConfig](#API_DescribeProcessingJob_ResponseSyntax) ** Networking options for a processing job. Type: [NetworkConfig](API_NetworkConfig.md) object ** [ProcessingEndTime](#API_DescribeProcessingJob_ResponseSyntax) ** The time at which the processing job completed. Type: Timestamp ** [ProcessingInputs](#API_DescribeProcessingJob_ResponseSyntax) ** The inputs for a processing job. Type: Array of [ProcessingInput](API_ProcessingInput.md) objects Array Members: Minimum number of 0 items. Maximum number of 10 items. ** [ProcessingJobArn](#API_DescribeProcessingJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the processing job. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:processing-job/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [ProcessingJobName](#API_DescribeProcessingJob_ResponseSyntax) ** The name of the processing job. The name must be unique within an AWS Region in the AWS account. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [ProcessingJobStatus](#API_DescribeProcessingJob_ResponseSyntax) ** Provides the status of a processing job. Type: String Valid Values: `InProgress | Completed | Failed | Stopping | Stopped` ** [ProcessingOutputConfig](#API_DescribeProcessingJob_ResponseSyntax) ** Output configuration for the processing job. Type: [ProcessingOutputConfig](API_ProcessingOutputConfig.md) object ** [ProcessingResources](#API_DescribeProcessingJob_ResponseSyntax) ** 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. Type: [ProcessingResources](API_ProcessingResources.md) object ** [ProcessingStartTime](#API_DescribeProcessingJob_ResponseSyntax) ** The time at which the processing job started. Type: Timestamp ** [RoleArn](#API_DescribeProcessingJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` ** [StoppingCondition](#API_DescribeProcessingJob_ResponseSyntax) ** The time limit for how long the processing job is allowed to run. Type: [ProcessingStoppingCondition](API_ProcessingStoppingCondition.md) object ** [TrainingJobArn](#API_DescribeProcessingJob_ResponseSyntax) ** The ARN of a training job associated with this processing job. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:training-job/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeProcessingJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeProcessingJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeProcessingJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeProcessingJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeProcessingJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeProcessingJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeProcessingJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeProcessingJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeProcessingJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeProcessingJob) # DescribeProject Describes the details of a project. ## Request Syntax ``` { "ProjectName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ProjectName](#API_DescribeProject_RequestSyntax) ** The name of the project to describe. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}` Required: Yes ## Response Syntax ``` { "CreatedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "LastModifiedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "ProjectArn": "string", "ProjectDescription": "string", "ProjectId": "string", "ProjectName": "string", "ProjectStatus": "string", "ServiceCatalogProvisionedProductDetails": { "ProvisionedProductId": "string", "ProvisionedProductStatusMessage": "string" }, "ServiceCatalogProvisioningDetails": { "PathId": "string", "ProductId": "string", "ProvisioningArtifactId": "string", "ProvisioningParameters": [ { "Key": "string", "Value": "string" } ] }, "TemplateProviderDetails": [ { "CfnTemplateProviderDetail": { "Parameters": [ { "Key": "string", "Value": "string" } ], "RoleARN": "string", "StackDetail": { "Id": "string", "Name": "string", "StatusMessage": "string" }, "TemplateName": "string", "TemplateURL": "string" } } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreatedBy](#API_DescribeProject_ResponseSyntax) ** Information about the user who created or modified a SageMaker resource. Type: [UserContext](API_UserContext.md) object ** [CreationTime](#API_DescribeProject_ResponseSyntax) ** The time when the project was created. Type: Timestamp ** [LastModifiedBy](#API_DescribeProject_ResponseSyntax) ** Information about the user who created or modified a SageMaker resource. Type: [UserContext](API_UserContext.md) object ** [LastModifiedTime](#API_DescribeProject_ResponseSyntax) ** The timestamp when project was last modified. Type: Timestamp ** [ProjectArn](#API_DescribeProject_ResponseSyntax) ** The Amazon Resource Name (ARN) of the project. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:project/[\S]{1,2048}` ** [ProjectDescription](#API_DescribeProject_ResponseSyntax) ** The description of the project. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*` ** [ProjectId](#API_DescribeProject_ResponseSyntax) ** The ID of the project. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9])*` ** [ProjectName](#API_DescribeProject_ResponseSyntax) ** The name of the project. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}` ** [ProjectStatus](#API_DescribeProject_ResponseSyntax) ** The status of the project. Type: String Valid Values: `Pending | CreateInProgress | CreateCompleted | CreateFailed | DeleteInProgress | DeleteFailed | DeleteCompleted | UpdateInProgress | UpdateCompleted | UpdateFailed` ** [ServiceCatalogProvisionedProductDetails](#API_DescribeProject_ResponseSyntax) ** Information about a provisioned service catalog product. Type: [ServiceCatalogProvisionedProductDetails](API_ServiceCatalogProvisionedProductDetails.md) object ** [ServiceCatalogProvisioningDetails](#API_DescribeProject_ResponseSyntax) ** Information used to provision a service catalog product. For information, see [What is AWS Service Catalog](https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html). Type: [ServiceCatalogProvisioningDetails](API_ServiceCatalogProvisioningDetails.md) object ** [TemplateProviderDetails](#API_DescribeProject_ResponseSyntax) ** An array of template providers associated with the project. Type: Array of [TemplateProviderDetail](API_TemplateProviderDetail.md) objects Array Members: Fixed number of 1 item. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeProject) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeProject) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeProject) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeProject) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeProject) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeProject) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeProject) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeProject) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeProject) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeProject) # DescribeReservedCapacity Retrieves details about a reserved capacity. ## Request Syntax ``` { "ReservedCapacityArn": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ReservedCapacityArn](#API_DescribeReservedCapacity_RequestSyntax) ** ARN of the reserved capacity to describe. Type: String Length Constraints: Minimum length of 50. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:reserved-capacity/.*` Required: Yes ## Response Syntax ``` { "AvailabilityZone": "string", "AvailableInstanceCount": number, "DurationHours": number, "DurationMinutes": number, "EndTime": number, "InstanceType": "string", "InUseInstanceCount": number, "ReservedCapacityArn": "string", "ReservedCapacityType": "string", "StartTime": number, "Status": "string", "TotalInstanceCount": number, "UltraServerSummary": { "AvailableSpareInstanceCount": number, "InstanceType": "string", "UltraServerCount": number, "UltraServerType": "string", "UnhealthyInstanceCount": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AvailabilityZone](#API_DescribeReservedCapacity_ResponseSyntax) ** The Availability Zone where the reserved capacity is provisioned. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: `[a-z]+\-[0-9a-z\-]+` ** [AvailableInstanceCount](#API_DescribeReservedCapacity_ResponseSyntax) ** The number of instances currently available for use in this reserved capacity. Type: Integer Valid Range: Minimum value of 0. ** [DurationHours](#API_DescribeReservedCapacity_ResponseSyntax) ** The total duration of the reserved capacity in hours. Type: Long Valid Range: Minimum value of 0. Maximum value of 87600. ** [DurationMinutes](#API_DescribeReservedCapacity_ResponseSyntax) ** The number of minutes for the duration of the reserved capacity. For example, if a reserved capacity starts at 08:55 and ends at 11:30, the minutes field would be 35. Type: Long Valid Range: Minimum value of 0. Maximum value of 59. ** [EndTime](#API_DescribeReservedCapacity_ResponseSyntax) ** The timestamp when the reserved capacity expires. Type: Timestamp ** [InstanceType](#API_DescribeReservedCapacity_ResponseSyntax) ** The Amazon EC2 instance type used in the reserved capacity. Type: String Valid Values: `ml.p4d.24xlarge | ml.p5.48xlarge | ml.p5e.48xlarge | ml.p5en.48xlarge | ml.trn1.32xlarge | ml.trn2.48xlarge | ml.p6-b200.48xlarge | ml.p4de.24xlarge | ml.p6e-gb200.36xlarge | ml.p5.4xlarge | ml.p6-b300.48xlarge` ** [InUseInstanceCount](#API_DescribeReservedCapacity_ResponseSyntax) ** The number of instances currently in use from this reserved capacity. Type: Integer Valid Range: Minimum value of 0. ** [ReservedCapacityArn](#API_DescribeReservedCapacity_ResponseSyntax) ** ARN of the reserved capacity. Type: String Length Constraints: Minimum length of 50. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:reserved-capacity/.*` ** [ReservedCapacityType](#API_DescribeReservedCapacity_ResponseSyntax) ** The type of reserved capacity. Type: String Valid Values: `UltraServer | Instance` ** [StartTime](#API_DescribeReservedCapacity_ResponseSyntax) ** The timestamp when the reserved capacity becomes active. Type: Timestamp ** [Status](#API_DescribeReservedCapacity_ResponseSyntax) ** The current status of the reserved capacity. Type: String Valid Values: `Pending | Active | Scheduled | Expired | Failed` ** [TotalInstanceCount](#API_DescribeReservedCapacity_ResponseSyntax) ** The total number of instances allocated to this reserved capacity. Type: Integer Valid Range: Minimum value of 0. ** [UltraServerSummary](#API_DescribeReservedCapacity_ResponseSyntax) ** A summary of the UltraServer associated with this reserved capacity. Type: [UltraServerSummary](API_UltraServerSummary.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeReservedCapacity) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeReservedCapacity) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeReservedCapacity) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeReservedCapacity) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeReservedCapacity) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeReservedCapacity) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeReservedCapacity) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeReservedCapacity) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeReservedCapacity) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeReservedCapacity) # DescribeSpace Describes the space. ## Request Syntax ``` { "DomainId": "string", "SpaceName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DomainId](#API_DescribeSpace_RequestSyntax) ** The ID of the associated domain. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `d-(-*[a-z0-9]){1,61}` Required: Yes ** [SpaceName](#API_DescribeSpace_RequestSyntax) ** The name of the space. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "CreationTime": number, "DomainId": "string", "FailureReason": "string", "HomeEfsFileSystemUid": "string", "LastModifiedTime": number, "OwnershipSettings": { "OwnerUserProfileName": "string" }, "SpaceArn": "string", "SpaceDisplayName": "string", "SpaceName": "string", "SpaceSettings": { "AppType": "string", "CodeEditorAppSettings": { "AppLifecycleManagement": { "IdleSettings": { "IdleTimeoutInMinutes": number } }, "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" } }, "CustomFileSystems": [ { ... } ], "JupyterLabAppSettings": { "AppLifecycleManagement": { "IdleSettings": { "IdleTimeoutInMinutes": number } }, "CodeRepositories": [ { "RepositoryUrl": "string" } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" } }, "JupyterServerAppSettings": { "CodeRepositories": [ { "RepositoryUrl": "string" } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" }, "LifecycleConfigArns": [ "string" ] }, "KernelGatewayAppSettings": { "CustomImages": [ { "AppImageConfigName": "string", "ImageName": "string", "ImageVersionNumber": number } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" }, "LifecycleConfigArns": [ "string" ] }, "RemoteAccess": "string", "SpaceManagedResources": "string", "SpaceStorageSettings": { "EbsStorageSettings": { "EbsVolumeSizeInGb": number } } }, "SpaceSharingSettings": { "SharingType": "string" }, "Status": "string", "Url": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreationTime](#API_DescribeSpace_ResponseSyntax) ** The creation time. Type: Timestamp ** [DomainId](#API_DescribeSpace_ResponseSyntax) ** The ID of the associated domain. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `d-(-*[a-z0-9]){1,61}` ** [FailureReason](#API_DescribeSpace_ResponseSyntax) ** The failure reason. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. ** [HomeEfsFileSystemUid](#API_DescribeSpace_ResponseSyntax) ** The ID of the space's profile in the Amazon EFS volume. Type: String Length Constraints: Minimum length of 0. Maximum length of 10. Pattern: `\d+` ** [LastModifiedTime](#API_DescribeSpace_ResponseSyntax) ** The last modified time. Type: Timestamp ** [OwnershipSettings](#API_DescribeSpace_ResponseSyntax) ** The collection of ownership settings for a space. Type: [OwnershipSettings](API_OwnershipSettings.md) object ** [SpaceArn](#API_DescribeSpace_ResponseSyntax) ** The space's Amazon Resource Name (ARN). Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:space/.*` ** [SpaceDisplayName](#API_DescribeSpace_ResponseSyntax) ** The name of the space that appears in the Amazon SageMaker Studio UI. Type: String Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: `(?!\s*$).+` ** [SpaceName](#API_DescribeSpace_ResponseSyntax) ** The name of the space. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [SpaceSettings](#API_DescribeSpace_ResponseSyntax) ** A collection of space settings. Type: [SpaceSettings](API_SpaceSettings.md) object ** [SpaceSharingSettings](#API_DescribeSpace_ResponseSyntax) ** The collection of space sharing settings for a space. Type: [SpaceSharingSettings](API_SpaceSharingSettings.md) object ** [Status](#API_DescribeSpace_ResponseSyntax) ** The status. Type: String Valid Values: `Deleting | Failed | InService | Pending | Updating | Update_Failed | Delete_Failed` ** [Url](#API_DescribeSpace_ResponseSyntax) ** Returns the URL of the space. If the space is created with AWS IAM Identity Center (Successor to AWS Single Sign-On) authentication, users can navigate to the URL after appending the respective redirect parameter for the application type to be federated through AWS IAM Identity Center. The following application types are supported: + Studio Classic: `&redirect=JupyterServer` + JupyterLab: `&redirect=JupyterLab` + Code Editor, based on Code-OSS, Visual Studio Code - Open Source: `&redirect=CodeEditor` Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeSpace) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeSpace) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeSpace) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeSpace) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeSpace) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeSpace) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeSpace) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeSpace) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeSpace) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeSpace) # DescribeStudioLifecycleConfig Describes the Amazon SageMaker AI Studio Lifecycle Configuration. ## Request Syntax ``` { "StudioLifecycleConfigName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [StudioLifecycleConfigName](#API_DescribeStudioLifecycleConfig_RequestSyntax) ** The name of the Amazon SageMaker AI Studio Lifecycle Configuration to describe. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "CreationTime": number, "LastModifiedTime": number, "StudioLifecycleConfigAppType": "string", "StudioLifecycleConfigArn": "string", "StudioLifecycleConfigContent": "string", "StudioLifecycleConfigName": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreationTime](#API_DescribeStudioLifecycleConfig_ResponseSyntax) ** The creation time of the Amazon SageMaker AI Studio Lifecycle Configuration. Type: Timestamp ** [LastModifiedTime](#API_DescribeStudioLifecycleConfig_ResponseSyntax) ** This value is equivalent to CreationTime because Amazon SageMaker AI Studio Lifecycle Configurations are immutable. Type: Timestamp ** [StudioLifecycleConfigAppType](#API_DescribeStudioLifecycleConfig_ResponseSyntax) ** The App type that the Lifecycle Configuration is attached to. Type: String Valid Values: `JupyterServer | KernelGateway | CodeEditor | JupyterLab` ** [StudioLifecycleConfigArn](#API_DescribeStudioLifecycleConfig_ResponseSyntax) ** The ARN of the Lifecycle Configuration to describe. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:studio-lifecycle-config/.*|None)` ** [StudioLifecycleConfigContent](#API_DescribeStudioLifecycleConfig_ResponseSyntax) ** The content of your Amazon SageMaker AI Studio Lifecycle Configuration script. Type: String Length Constraints: Minimum length of 1. Maximum length of 16384. Pattern: `[\S\s]+` ** [StudioLifecycleConfigName](#API_DescribeStudioLifecycleConfig_ResponseSyntax) ** The name of the Amazon SageMaker AI Studio Lifecycle Configuration that is described. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeStudioLifecycleConfig) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeStudioLifecycleConfig) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeStudioLifecycleConfig) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeStudioLifecycleConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeStudioLifecycleConfig) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeStudioLifecycleConfig) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeStudioLifecycleConfig) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeStudioLifecycleConfig) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeStudioLifecycleConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeStudioLifecycleConfig) # DescribeSubscribedWorkteam Gets information about a work team provided by a vendor. It returns details about the subscription with a vendor in the AWS Marketplace. ## Request Syntax ``` { "WorkteamArn": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [WorkteamArn](#API_DescribeSubscribedWorkteam_RequestSyntax) ** The Amazon Resource Name (ARN) of the subscribed work team to describe. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:workteam/.*` Required: Yes ## Response Syntax ``` { "SubscribedWorkteam": { "ListingId": "string", "MarketplaceDescription": "string", "MarketplaceTitle": "string", "SellerName": "string", "WorkteamArn": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [SubscribedWorkteam](#API_DescribeSubscribedWorkteam_ResponseSyntax) ** A `Workteam` instance that contains information about the work team. Type: [SubscribedWorkteam](API_SubscribedWorkteam.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeSubscribedWorkteam) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeSubscribedWorkteam) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeSubscribedWorkteam) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeSubscribedWorkteam) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeSubscribedWorkteam) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeSubscribedWorkteam) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeSubscribedWorkteam) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeSubscribedWorkteam) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeSubscribedWorkteam) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeSubscribedWorkteam) # DescribeTrainingJob 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. ## Request Syntax ``` { "TrainingJobName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [TrainingJobName](#API_DescribeTrainingJob_RequestSyntax) ** The name of the training job. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "AlgorithmSpecification": { "AlgorithmName": "string", "ContainerArguments": [ "string" ], "ContainerEntrypoint": [ "string" ], "EnableSageMakerMetricsTimeSeries": boolean, "MetricDefinitions": [ { "Name": "string", "Regex": "string" } ], "TrainingImage": "string", "TrainingImageConfig": { "TrainingRepositoryAccessMode": "string", "TrainingRepositoryAuthConfig": { "TrainingRepositoryCredentialsProviderArn": "string" } }, "TrainingInputMode": "string" }, "AutoMLJobArn": "string", "BillableTimeInSeconds": number, "BillableTokenCount": number, "CheckpointConfig": { "LocalPath": "string", "S3Uri": "string" }, "CreationTime": number, "DebugHookConfig": { "CollectionConfigurations": [ { "CollectionName": "string", "CollectionParameters": { "string" : "string" } } ], "HookParameters": { "string" : "string" }, "LocalPath": "string", "S3OutputPath": "string" }, "DebugRuleConfigurations": [ { "InstanceType": "string", "LocalPath": "string", "RuleConfigurationName": "string", "RuleEvaluatorImage": "string", "RuleParameters": { "string" : "string" }, "S3OutputPath": "string", "VolumeSizeInGB": number } ], "DebugRuleEvaluationStatuses": [ { "LastModifiedTime": number, "RuleConfigurationName": "string", "RuleEvaluationJobArn": "string", "RuleEvaluationStatus": "string", "StatusDetails": "string" } ], "EnableInterContainerTrafficEncryption": boolean, "EnableManagedSpotTraining": boolean, "EnableNetworkIsolation": boolean, "Environment": { "string" : "string" }, "ExperimentConfig": { "ExperimentName": "string", "RunName": "string", "TrialComponentDisplayName": "string", "TrialName": "string" }, "FailureReason": "string", "FinalMetricDataList": [ { "MetricName": "string", "Timestamp": number, "Value": number } ], "HyperParameters": { "string" : "string" }, "InfraCheckConfig": { "EnableInfraCheck": boolean }, "InputDataConfig": [ { "ChannelName": "string", "CompressionType": "string", "ContentType": "string", "DataSource": { "FileSystemDataSource": { "DirectoryPath": "string", "FileSystemAccessMode": "string", "FileSystemId": "string", "FileSystemType": "string" }, "S3DataSource": { "AttributeNames": [ "string" ], "HubAccessConfig": { "HubContentArn": "string" }, "InstanceGroupNames": [ "string" ], "ModelAccessConfig": { "AcceptEula": boolean }, "S3DataDistributionType": "string", "S3DataType": "string", "S3Uri": "string" } }, "InputMode": "string", "RecordWrapperType": "string", "ShuffleConfig": { "Seed": number } } ], "LabelingJobArn": "string", "LastModifiedTime": number, "MlflowConfig": { "MlflowExperimentName": "string", "MlflowResourceArn": "string", "MlflowRunName": "string" }, "MlflowDetails": { "MlflowExperimentId": "string", "MlflowRunId": "string" }, "ModelArtifacts": { "S3ModelArtifacts": "string" }, "ModelPackageConfig": { "ModelPackageGroupArn": "string", "SourceModelPackageArn": "string" }, "OutputDataConfig": { "CompressionType": "string", "KmsKeyId": "string", "S3OutputPath": "string" }, "OutputModelPackageArn": "string", "ProfilerConfig": { "DisableProfiler": boolean, "ProfilingIntervalInMilliseconds": number, "ProfilingParameters": { "string" : "string" }, "S3OutputPath": "string" }, "ProfilerRuleConfigurations": [ { "InstanceType": "string", "LocalPath": "string", "RuleConfigurationName": "string", "RuleEvaluatorImage": "string", "RuleParameters": { "string" : "string" }, "S3OutputPath": "string", "VolumeSizeInGB": number } ], "ProfilerRuleEvaluationStatuses": [ { "LastModifiedTime": number, "RuleConfigurationName": "string", "RuleEvaluationJobArn": "string", "RuleEvaluationStatus": "string", "StatusDetails": "string" } ], "ProfilingStatus": "string", "ProgressInfo": { "CurrentEpoch": number, "CurrentStep": number, "MaxEpoch": number, "TotalStepCountPerEpoch": number }, "RemoteDebugConfig": { "EnableRemoteDebug": boolean }, "ResourceConfig": { "InstanceCount": number, "InstanceGroups": [ { "InstanceCount": number, "InstanceGroupName": "string", "InstanceType": "string" } ], "InstancePlacementConfig": { "EnableMultipleJobs": boolean, "PlacementSpecifications": [ { "InstanceCount": number, "UltraServerId": "string" } ] }, "InstanceType": "string", "KeepAlivePeriodInSeconds": number, "TrainingPlanArn": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number }, "RetryStrategy": { "MaximumRetryAttempts": number }, "RoleArn": "string", "SecondaryStatus": "string", "SecondaryStatusTransitions": [ { "EndTime": number, "StartTime": number, "Status": "string", "StatusMessage": "string" } ], "ServerlessJobConfig": { "AcceptEula": boolean, "BaseModelArn": "string", "CustomizationTechnique": "string", "EvaluationType": "string", "EvaluatorArn": "string", "JobType": "string", "Peft": "string" }, "StoppingCondition": { "MaxPendingTimeInSeconds": number, "MaxRuntimeInSeconds": number, "MaxWaitTimeInSeconds": number }, "TensorBoardOutputConfig": { "LocalPath": "string", "S3OutputPath": "string" }, "TrainingEndTime": number, "TrainingJobArn": "string", "TrainingJobName": "string", "TrainingJobStatus": "string", "TrainingStartTime": number, "TrainingTimeInSeconds": number, "TuningJobArn": "string", "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] }, "WarmPoolStatus": { "ResourceRetainedBillableTimeInSeconds": number, "ReusedByJob": "string", "Status": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AlgorithmSpecification](#API_DescribeTrainingJob_ResponseSyntax) ** Information about the algorithm used for training, and algorithm metadata. Type: [AlgorithmSpecification](API_AlgorithmSpecification.md) object ** [AutoMLJobArn](#API_DescribeTrainingJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of an AutoML job. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:automl-job/.*` ** [BillableTimeInSeconds](#API_DescribeTrainingJob_ResponseSyntax) ** 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 SageMaker bills 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%. Type: Integer Valid Range: Minimum value of 1. ** [BillableTokenCount](#API_DescribeTrainingJob_ResponseSyntax) ** The billable token count for eligible serverless training jobs. Type: Long Valid Range: Minimum value of 0. ** [CheckpointConfig](#API_DescribeTrainingJob_ResponseSyntax) ** Contains information about the output location for managed spot training checkpoint data. Type: [CheckpointConfig](API_CheckpointConfig.md) object ** [CreationTime](#API_DescribeTrainingJob_ResponseSyntax) ** A timestamp that indicates when the training job was created. Type: Timestamp ** [DebugHookConfig](#API_DescribeTrainingJob_ResponseSyntax) ** Configuration information for the Amazon SageMaker 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](https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html). Type: [DebugHookConfig](API_DebugHookConfig.md) object ** [DebugRuleConfigurations](#API_DescribeTrainingJob_ResponseSyntax) ** Configuration information for Amazon SageMaker Debugger rules for debugging output tensors. Type: Array of [DebugRuleConfiguration](API_DebugRuleConfiguration.md) objects Array Members: Minimum number of 0 items. Maximum number of 20 items. ** [DebugRuleEvaluationStatuses](#API_DescribeTrainingJob_ResponseSyntax) ** Evaluation status of Amazon SageMaker Debugger rules for debugging on a training job. Type: Array of [DebugRuleEvaluationStatus](API_DebugRuleEvaluationStatus.md) objects Array Members: Minimum number of 0 items. Maximum number of 20 items. ** [EnableInterContainerTrafficEncryption](#API_DescribeTrainingJob_ResponseSyntax) ** 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. Type: Boolean ** [EnableManagedSpotTraining](#API_DescribeTrainingJob_ResponseSyntax) ** A Boolean indicating whether managed spot training is enabled (`True`) or not (`False`). Type: Boolean ** [EnableNetworkIsolation](#API_DescribeTrainingJob_ResponseSyntax) ** 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, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access. Type: Boolean ** [Environment](#API_DescribeTrainingJob_ResponseSyntax) ** The environment variables to set in the Docker container. Do not include any security-sensitive information including account access IDs, secrets, or tokens in any environment fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request environment variable or plain text fields. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 100 items. Key Length Constraints: Minimum length of 0. Maximum length of 512. Key Pattern: `[a-zA-Z_][a-zA-Z0-9_]*` Value Length Constraints: Minimum length of 0. Maximum length of 512. Value Pattern: `[\S\s]*` ** [ExperimentConfig](#API_DescribeTrainingJob_ResponseSyntax) ** Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs: + [CreateProcessingJob](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html) + [CreateTrainingJob](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html) + [CreateTransformJob](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html) Type: [ExperimentConfig](API_ExperimentConfig.md) object ** [FailureReason](#API_DescribeTrainingJob_ResponseSyntax) ** If the training job failed, the reason it failed. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. ** [FinalMetricDataList](#API_DescribeTrainingJob_ResponseSyntax) ** A collection of `MetricData` objects that specify the names, values, and dates and times that the training algorithm emitted to Amazon CloudWatch. Type: Array of [MetricData](API_MetricData.md) objects Array Members: Minimum number of 0 items. Maximum number of 40 items. ** [HyperParameters](#API_DescribeTrainingJob_ResponseSyntax) ** Algorithm-specific parameters. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 100 items. Key Length Constraints: Minimum length of 0. Maximum length of 256. Key Pattern: `.*` Value Length Constraints: Minimum length of 0. Maximum length of 2500. Value Pattern: `.*` ** [InfraCheckConfig](#API_DescribeTrainingJob_ResponseSyntax) ** Contains information about the infrastructure health check configuration for the training job. Type: [InfraCheckConfig](API_InfraCheckConfig.md) object ** [InputDataConfig](#API_DescribeTrainingJob_ResponseSyntax) ** An array of `Channel` objects that describes each data input channel. Type: Array of [Channel](API_Channel.md) objects Array Members: Minimum number of 1 item. Maximum number of 20 items. ** [LabelingJobArn](#API_DescribeTrainingJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the SageMaker Ground Truth labeling job that created the transform or training job. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:labeling-job/.*` ** [LastModifiedTime](#API_DescribeTrainingJob_ResponseSyntax) ** A timestamp that indicates when the status of the training job was last modified. Type: Timestamp ** [MlflowConfig](#API_DescribeTrainingJob_ResponseSyntax) ** The MLflow configuration using SageMaker managed MLflow. Type: [MlflowConfig](API_MlflowConfig.md) object ** [MlflowDetails](#API_DescribeTrainingJob_ResponseSyntax) ** The MLflow details of this job. Type: [MlflowDetails](API_MlflowDetails.md) object ** [ModelArtifacts](#API_DescribeTrainingJob_ResponseSyntax) ** Information about the Amazon S3 location that is configured for storing model artifacts. Type: [ModelArtifacts](API_ModelArtifacts.md) object ** [ModelPackageConfig](#API_DescribeTrainingJob_ResponseSyntax) ** The configuration for the model package. Type: [ModelPackageConfig](API_ModelPackageConfig.md) object ** [OutputDataConfig](#API_DescribeTrainingJob_ResponseSyntax) ** The S3 path where model artifacts that you configured when creating the job are stored. SageMaker creates subfolders for model artifacts. Type: [OutputDataConfig](API_OutputDataConfig.md) object ** [OutputModelPackageArn](#API_DescribeTrainingJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the output model package containing model weights or checkpoints. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:model-package/[\S]{1,2048}` ** [ProfilerConfig](#API_DescribeTrainingJob_ResponseSyntax) ** Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths. Type: [ProfilerConfig](API_ProfilerConfig.md) object ** [ProfilerRuleConfigurations](#API_DescribeTrainingJob_ResponseSyntax) ** Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics. Type: Array of [ProfilerRuleConfiguration](API_ProfilerRuleConfiguration.md) objects Array Members: Minimum number of 0 items. Maximum number of 20 items. ** [ProfilerRuleEvaluationStatuses](#API_DescribeTrainingJob_ResponseSyntax) ** Evaluation status of Amazon SageMaker Debugger rules for profiling on a training job. Type: Array of [ProfilerRuleEvaluationStatus](API_ProfilerRuleEvaluationStatus.md) objects Array Members: Minimum number of 0 items. Maximum number of 20 items. ** [ProfilingStatus](#API_DescribeTrainingJob_ResponseSyntax) ** Profiling status of a training job. Type: String Valid Values: `Enabled | Disabled` ** [ProgressInfo](#API_DescribeTrainingJob_ResponseSyntax) ** The Serverless training job progress information. Type: [TrainingProgressInfo](API_TrainingProgressInfo.md) object ** [RemoteDebugConfig](#API_DescribeTrainingJob_ResponseSyntax) ** Configuration for remote debugging. To learn more about the remote debugging functionality of SageMaker, see [Access a training container through AWS Systems Manager (SSM) for remote debugging](https://docs.aws.amazon.com/sagemaker/latest/dg/train-remote-debugging.html). Type: [RemoteDebugConfig](API_RemoteDebugConfig.md) object ** [ResourceConfig](#API_DescribeTrainingJob_ResponseSyntax) ** Resources, including ML compute instances and ML storage volumes, that are configured for model training. Type: [ResourceConfig](API_ResourceConfig.md) object ** [RetryStrategy](#API_DescribeTrainingJob_ResponseSyntax) ** The number of times to retry the job when the job fails due to an `InternalServerError`. Type: [RetryStrategy](API_RetryStrategy.md) object ** [RoleArn](#API_DescribeTrainingJob_ResponseSyntax) ** The AWS Identity and Access Management (IAM) role configured for the training job. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` ** [SecondaryStatus](#API_DescribeTrainingJob_ResponseSyntax) ** 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](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_SecondaryStatusTransition.html). SageMaker provides primary statuses and secondary statuses that apply to each of them: InProgress + `Starting` - Starting the training job. + `Pending` - The training job is waiting for compute capacity or compute resource provision. + `Downloading` - An optional stage for algorithms that support `File` training input mode. It indicates that data is being downloaded to the ML storage volumes. + `Training` - Training is in progress. + `Interrupted` - The job stopped because the managed spot training instances were interrupted. + `Uploading` - Training is complete and the model artifacts are being uploaded to the S3 location. Completed + `Completed` - The training job has completed. Failed + `Failed` - The training job has failed. The reason for the failure is returned in the `FailureReason` field of `DescribeTrainingJobResponse`. Stopped + `MaxRuntimeExceeded` - The job stopped because it exceeded the maximum allowed runtime. + `MaxWaitTimeExceeded` - The job stopped because it exceeded the maximum allowed wait time. + `Stopped` - The training job has stopped. Stopping + `Stopping` - Stopping the training job. Valid values for `SecondaryStatus` are subject to change. We no longer support the following secondary statuses: + `LaunchingMLInstances` + `PreparingTraining` + `DownloadingTrainingImage` Type: String Valid Values: `Starting | LaunchingMLInstances | PreparingTrainingStack | Downloading | DownloadingTrainingImage | Training | Uploading | Stopping | Stopped | MaxRuntimeExceeded | Completed | Failed | Interrupted | MaxWaitTimeExceeded | Updating | Restarting | Pending` ** [SecondaryStatusTransitions](#API_DescribeTrainingJob_ResponseSyntax) ** A history of all of the secondary statuses that the training job has transitioned through. Type: Array of [SecondaryStatusTransition](API_SecondaryStatusTransition.md) objects ** [ServerlessJobConfig](#API_DescribeTrainingJob_ResponseSyntax) ** The configuration for serverless training jobs. Type: [ServerlessJobConfig](API_ServerlessJobConfig.md) object ** [StoppingCondition](#API_DescribeTrainingJob_ResponseSyntax) ** Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs. To stop a job, 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. Type: [StoppingCondition](API_StoppingCondition.md) object ** [TensorBoardOutputConfig](#API_DescribeTrainingJob_ResponseSyntax) ** Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data. Type: [TensorBoardOutputConfig](API_TensorBoardOutputConfig.md) object ** [TrainingEndTime](#API_DescribeTrainingJob_ResponseSyntax) ** 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 SageMaker detects a job failure. Type: Timestamp ** [TrainingJobArn](#API_DescribeTrainingJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the training job. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:training-job/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [TrainingJobName](#API_DescribeTrainingJob_ResponseSyntax) ** Name of the model training job. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [TrainingJobStatus](#API_DescribeTrainingJob_ResponseSyntax) ** The status of the training job. 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`. Type: String Valid Values: `InProgress | Completed | Failed | Stopping | Stopped | Deleting` ** [TrainingStartTime](#API_DescribeTrainingJob_ResponseSyntax) ** 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. Type: Timestamp ** [TrainingTimeInSeconds](#API_DescribeTrainingJob_ResponseSyntax) ** The training time in seconds. Type: Integer Valid Range: Minimum value of 1. ** [TuningJobArn](#API_DescribeTrainingJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:hyper-parameter-tuning-job/.*` ** [VpcConfig](#API_DescribeTrainingJob_ResponseSyntax) ** A [VpcConfig](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html) 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](https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html). Type: [VpcConfig](API_VpcConfig.md) object ** [WarmPoolStatus](#API_DescribeTrainingJob_ResponseSyntax) ** The status of the warm pool associated with the training job. Type: [WarmPoolStatus](API_WarmPoolStatus.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeTrainingJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeTrainingJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeTrainingJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeTrainingJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeTrainingJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeTrainingJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeTrainingJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeTrainingJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeTrainingJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeTrainingJob) # DescribeTrainingPlan Retrieves detailed information about a specific training plan. ## Request Syntax ``` { "TrainingPlanName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [TrainingPlanName](#API_DescribeTrainingPlan_RequestSyntax) ** The name of the training plan to describe. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}` Required: Yes ## Response Syntax ``` { "AvailableInstanceCount": number, "AvailableSpareInstanceCount": number, "CurrencyCode": "string", "DurationHours": number, "DurationMinutes": number, "EndTime": number, "InUseInstanceCount": number, "ReservedCapacitySummaries": [ { "AvailabilityZone": "string", "DurationHours": number, "DurationMinutes": number, "EndTime": number, "InstanceType": "string", "ReservedCapacityArn": "string", "ReservedCapacityType": "string", "StartTime": number, "Status": "string", "TotalInstanceCount": number, "UltraServerCount": number, "UltraServerType": "string" } ], "StartTime": number, "Status": "string", "StatusMessage": "string", "TargetResources": [ "string" ], "TotalInstanceCount": number, "TotalUltraServerCount": number, "TrainingPlanArn": "string", "TrainingPlanName": "string", "UnhealthyInstanceCount": number, "UpfrontFee": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AvailableInstanceCount](#API_DescribeTrainingPlan_ResponseSyntax) ** The number of instances currently available for use in this training plan. Type: Integer Valid Range: Minimum value of 0. ** [AvailableSpareInstanceCount](#API_DescribeTrainingPlan_ResponseSyntax) ** The number of available spare instances in the training plan. Type: Integer Valid Range: Minimum value of 0. ** [CurrencyCode](#API_DescribeTrainingPlan_ResponseSyntax) ** The currency code for the upfront fee (e.g., USD). Type: String ** [DurationHours](#API_DescribeTrainingPlan_ResponseSyntax) ** The number of whole hours in the total duration for this training plan. Type: Long Valid Range: Minimum value of 0. Maximum value of 87600. ** [DurationMinutes](#API_DescribeTrainingPlan_ResponseSyntax) ** The additional minutes beyond whole hours in the total duration for this training plan. Type: Long Valid Range: Minimum value of 0. Maximum value of 59. ** [EndTime](#API_DescribeTrainingPlan_ResponseSyntax) ** The end time of the training plan. Type: Timestamp ** [InUseInstanceCount](#API_DescribeTrainingPlan_ResponseSyntax) ** The number of instances currently in use from this training plan. Type: Integer Valid Range: Minimum value of 0. ** [ReservedCapacitySummaries](#API_DescribeTrainingPlan_ResponseSyntax) ** The list of Reserved Capacity providing the underlying compute resources of the plan. Type: Array of [ReservedCapacitySummary](API_ReservedCapacitySummary.md) objects Array Members: Minimum number of 0 items. Maximum number of 5 items. ** [StartTime](#API_DescribeTrainingPlan_ResponseSyntax) ** The start time of the training plan. Type: Timestamp ** [Status](#API_DescribeTrainingPlan_ResponseSyntax) ** The current status of the training plan (e.g., Pending, Active, Expired). To see the complete list of status values available for a training plan, refer to the `Status` attribute within the ` [TrainingPlanSummary](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingPlanSummary.html) ` object. Type: String Valid Values: `Pending | Active | Scheduled | Expired | Failed` ** [StatusMessage](#API_DescribeTrainingPlan_ResponseSyntax) ** A message providing additional information about the current status of the training plan. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. ** [TargetResources](#API_DescribeTrainingPlan_ResponseSyntax) ** The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod, SageMaker Endpoints) that can use this training plan. Training plans are specific to their target resource. + A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs. + A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group. + A training plan for SageMaker endpoints can be used exclusively to provide compute resources to SageMaker endpoints for model deployment. Type: Array of strings Array Members: Minimum number of 1 item. Valid Values: `training-job | hyperpod-cluster | endpoint` ** [TotalInstanceCount](#API_DescribeTrainingPlan_ResponseSyntax) ** The total number of instances reserved in this training plan. Type: Integer Valid Range: Minimum value of 0. ** [TotalUltraServerCount](#API_DescribeTrainingPlan_ResponseSyntax) ** The total number of UltraServers reserved to this training plan. Type: Integer Valid Range: Minimum value of 1. ** [TrainingPlanArn](#API_DescribeTrainingPlan_ResponseSyntax) ** The Amazon Resource Name (ARN); of the training plan. Type: String Length Constraints: Minimum length of 50. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:training-plan/.*` ** [TrainingPlanName](#API_DescribeTrainingPlan_ResponseSyntax) ** The name of the training plan. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}` ** [UnhealthyInstanceCount](#API_DescribeTrainingPlan_ResponseSyntax) ** The number of instances in the training plan that are currently in an unhealthy state. Type: Integer Valid Range: Minimum value of 0. ** [UpfrontFee](#API_DescribeTrainingPlan_ResponseSyntax) ** The upfront fee for the training plan. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeTrainingPlan) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeTrainingPlan) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeTrainingPlan) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeTrainingPlan) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeTrainingPlan) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeTrainingPlan) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeTrainingPlan) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeTrainingPlan) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeTrainingPlan) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeTrainingPlan) # DescribeTrainingPlanExtensionHistory Retrieves the extension history for a specified training plan. The response includes details about each extension, such as the offering ID, start and end dates, status, payment status, and cost information. ## Request Syntax ``` { "MaxResults": number, "NextToken": "string", "TrainingPlanArn": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [MaxResults](#API_DescribeTrainingPlanExtensionHistory_RequestSyntax) ** The maximum number of extensions to return in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_DescribeTrainingPlanExtensionHistory_RequestSyntax) ** A token to continue pagination if more results are available. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [TrainingPlanArn](#API_DescribeTrainingPlanExtensionHistory_RequestSyntax) ** The Amazon Resource Name (ARN); of the training plan to retrieve extension history for. Type: String Length Constraints: Minimum length of 50. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:training-plan/.*` Required: Yes ## Response Syntax ``` { "NextToken": "string", "TrainingPlanExtensions": [ { "AvailabilityZone": "string", "AvailabilityZoneId": "string", "CurrencyCode": "string", "DurationHours": number, "EndDate": number, "ExtendedAt": number, "PaymentStatus": "string", "StartDate": number, "Status": "string", "TrainingPlanExtensionOfferingId": "string", "UpfrontFee": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_DescribeTrainingPlanExtensionHistory_ResponseSyntax) ** A token to continue pagination if more results are available. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ** [TrainingPlanExtensions](#API_DescribeTrainingPlanExtensionHistory_ResponseSyntax) ** A list of extensions for the specified training plan. Type: Array of [TrainingPlanExtension](API_TrainingPlanExtension.md) objects Array Members: Minimum number of 0 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeTrainingPlanExtensionHistory) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeTrainingPlanExtensionHistory) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeTrainingPlanExtensionHistory) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeTrainingPlanExtensionHistory) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeTrainingPlanExtensionHistory) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeTrainingPlanExtensionHistory) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeTrainingPlanExtensionHistory) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeTrainingPlanExtensionHistory) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeTrainingPlanExtensionHistory) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeTrainingPlanExtensionHistory) # DescribeTransformJob Returns information about a transform job. ## Request Syntax ``` { "TransformJobName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [TransformJobName](#API_DescribeTransformJob_RequestSyntax) ** The name of the transform job that you want to view details of. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "AutoMLJobArn": "string", "BatchStrategy": "string", "CreationTime": number, "DataCaptureConfig": { "DestinationS3Uri": "string", "GenerateInferenceId": boolean, "KmsKeyId": "string" }, "DataProcessing": { "InputFilter": "string", "JoinSource": "string", "OutputFilter": "string" }, "Environment": { "string" : "string" }, "ExperimentConfig": { "ExperimentName": "string", "RunName": "string", "TrialComponentDisplayName": "string", "TrialName": "string" }, "FailureReason": "string", "LabelingJobArn": "string", "MaxConcurrentTransforms": number, "MaxPayloadInMB": number, "ModelClientConfig": { "InvocationsMaxRetries": number, "InvocationsTimeoutInSeconds": number }, "ModelName": "string", "TransformEndTime": number, "TransformInput": { "CompressionType": "string", "ContentType": "string", "DataSource": { "S3DataSource": { "S3DataType": "string", "S3Uri": "string" } }, "SplitType": "string" }, "TransformJobArn": "string", "TransformJobName": "string", "TransformJobStatus": "string", "TransformOutput": { "Accept": "string", "AssembleWith": "string", "KmsKeyId": "string", "S3OutputPath": "string" }, "TransformResources": { "InstanceCount": number, "InstanceType": "string", "TransformAmiVersion": "string", "VolumeKmsKeyId": "string" }, "TransformStartTime": number } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AutoMLJobArn](#API_DescribeTransformJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the AutoML transform job. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:automl-job/.*` ** [BatchStrategy](#API_DescribeTransformJob_ResponseSyntax) ** 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`. Type: String Valid Values: `MultiRecord | SingleRecord` ** [CreationTime](#API_DescribeTransformJob_ResponseSyntax) ** A timestamp that shows when the transform Job was created. Type: Timestamp ** [DataCaptureConfig](#API_DescribeTransformJob_ResponseSyntax) ** Configuration to control how SageMaker captures inference data. Type: [BatchDataCaptureConfig](API_BatchDataCaptureConfig.md) object ** [DataProcessing](#API_DescribeTransformJob_ResponseSyntax) ** 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](https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html). Type: [DataProcessing](API_DataProcessing.md) object ** [Environment](#API_DescribeTransformJob_ResponseSyntax) ** The environment variables to set in the Docker container. We support up to 16 key and values entries in the map. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 16 items. Key Length Constraints: Minimum length of 0. Maximum length of 1024. Key Pattern: `[a-zA-Z_][a-zA-Z0-9_]{0,1023}` Value Length Constraints: Minimum length of 0. Maximum length of 10240. Value Pattern: `[\S\s]*` ** [ExperimentConfig](#API_DescribeTransformJob_ResponseSyntax) ** Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs: + [CreateProcessingJob](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html) + [CreateTrainingJob](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html) + [CreateTransformJob](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html) Type: [ExperimentConfig](API_ExperimentConfig.md) object ** [FailureReason](#API_DescribeTransformJob_ResponseSyntax) ** 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](https://docs.aws.amazon.com/sagemaker/latest/dg/logging-cloudwatch.html). Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. ** [LabelingJobArn](#API_DescribeTransformJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:labeling-job/.*` ** [MaxConcurrentTransforms](#API_DescribeTransformJob_ResponseSyntax) ** The maximum number of parallel requests on each instance node that can be launched in a transform job. The default value is 1. Type: Integer Valid Range: Minimum value of 0. ** [MaxPayloadInMB](#API_DescribeTransformJob_ResponseSyntax) ** The maximum payload size, in MB, used in the transform job. Type: Integer Valid Range: Minimum value of 0. ** [ModelClientConfig](#API_DescribeTransformJob_ResponseSyntax) ** The timeout and maximum number of retries for processing a transform job invocation. Type: [ModelClientConfig](API_ModelClientConfig.md) object ** [ModelName](#API_DescribeTransformJob_ResponseSyntax) ** The name of the model used in the transform job. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9]([\-a-zA-Z0-9]*[a-zA-Z0-9])?` ** [TransformEndTime](#API_DescribeTransformJob_ResponseSyntax) ** 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`. Type: Timestamp ** [TransformInput](#API_DescribeTransformJob_ResponseSyntax) ** Describes the dataset to be transformed and the Amazon S3 location where it is stored. Type: [TransformInput](API_TransformInput.md) object ** [TransformJobArn](#API_DescribeTransformJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the transform job. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:transform-job/.*` ** [TransformJobName](#API_DescribeTransformJob_ResponseSyntax) ** The name of the transform job. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [TransformJobStatus](#API_DescribeTransformJob_ResponseSyntax) ** The status of the transform job. If the transform job failed, the reason is returned in the `FailureReason` field. Type: String Valid Values: `InProgress | Completed | Failed | Stopping | Stopped` ** [TransformOutput](#API_DescribeTransformJob_ResponseSyntax) ** Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job. Type: [TransformOutput](API_TransformOutput.md) object ** [TransformResources](#API_DescribeTransformJob_ResponseSyntax) ** Describes the resources, including ML instance types and ML instance count, to use for the transform job. Type: [TransformResources](API_TransformResources.md) object ** [TransformStartTime](#API_DescribeTransformJob_ResponseSyntax) ** Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of `TransformEndTime`. Type: Timestamp ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeTransformJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeTransformJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeTransformJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeTransformJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeTransformJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeTransformJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeTransformJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeTransformJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeTransformJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeTransformJob) # DescribeTrial Provides a list of a trial's properties. ## Request Syntax ``` { "TrialName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [TrialName](#API_DescribeTrial_RequestSyntax) ** The name of the trial to describe. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` Required: Yes ## Response Syntax ``` { "CreatedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "DisplayName": "string", "ExperimentName": "string", "LastModifiedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "MetadataProperties": { "CommitId": "string", "GeneratedBy": "string", "ProjectId": "string", "Repository": "string" }, "Source": { "SourceArn": "string", "SourceType": "string" }, "TrialArn": "string", "TrialName": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreatedBy](#API_DescribeTrial_ResponseSyntax) ** Who created the trial. Type: [UserContext](API_UserContext.md) object ** [CreationTime](#API_DescribeTrial_ResponseSyntax) ** When the trial was created. Type: Timestamp ** [DisplayName](#API_DescribeTrial_ResponseSyntax) ** The name of the trial as displayed. If `DisplayName` isn't specified, `TrialName` is displayed. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` ** [ExperimentName](#API_DescribeTrial_ResponseSyntax) ** The name of the experiment the trial is part of. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` ** [LastModifiedBy](#API_DescribeTrial_ResponseSyntax) ** Who last modified the trial. Type: [UserContext](API_UserContext.md) object ** [LastModifiedTime](#API_DescribeTrial_ResponseSyntax) ** When the trial was last modified. Type: Timestamp ** [MetadataProperties](#API_DescribeTrial_ResponseSyntax) ** Metadata properties of the tracking entity, trial, or trial component. Type: [MetadataProperties](API_MetadataProperties.md) object ** [Source](#API_DescribeTrial_ResponseSyntax) ** The Amazon Resource Name (ARN) of the source and, optionally, the job type. Type: [TrialSource](API_TrialSource.md) object ** [TrialArn](#API_DescribeTrial_ResponseSyntax) ** The Amazon Resource Name (ARN) of the trial. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:experiment-trial/.*` ** [TrialName](#API_DescribeTrial_ResponseSyntax) ** The name of the trial. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeTrial) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeTrial) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeTrial) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeTrial) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeTrial) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeTrial) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeTrial) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeTrial) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeTrial) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeTrial) # DescribeTrialComponent Provides a list of a trials component's properties. ## Request Syntax ``` { "TrialComponentName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [TrialComponentName](#API_DescribeTrialComponent_RequestSyntax) ** The name of the trial component to describe. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:(experiment|experiment-trial|experiment-trial-component|artifact|action|context)\/)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,119})` Required: Yes ## Response Syntax ``` { "CreatedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "DisplayName": "string", "EndTime": number, "InputArtifacts": { "string" : { "MediaType": "string", "Value": "string" } }, "LastModifiedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "LineageGroupArn": "string", "MetadataProperties": { "CommitId": "string", "GeneratedBy": "string", "ProjectId": "string", "Repository": "string" }, "Metrics": [ { "Avg": number, "Count": number, "Last": number, "Max": number, "MetricName": "string", "Min": number, "SourceArn": "string", "StdDev": number, "TimeStamp": number } ], "OutputArtifacts": { "string" : { "MediaType": "string", "Value": "string" } }, "Parameters": { "string" : { "NumberValue": number, "StringValue": "string" } }, "Source": { "SourceArn": "string", "SourceType": "string" }, "Sources": [ { "SourceArn": "string", "SourceType": "string" } ], "StartTime": number, "Status": { "Message": "string", "PrimaryStatus": "string" }, "TrialComponentArn": "string", "TrialComponentName": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreatedBy](#API_DescribeTrialComponent_ResponseSyntax) ** Who created the trial component. Type: [UserContext](API_UserContext.md) object ** [CreationTime](#API_DescribeTrialComponent_ResponseSyntax) ** When the component was created. Type: Timestamp ** [DisplayName](#API_DescribeTrialComponent_ResponseSyntax) ** The name of the component as displayed. If `DisplayName` isn't specified, `TrialComponentName` is displayed. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` ** [EndTime](#API_DescribeTrialComponent_ResponseSyntax) ** When the component ended. Type: Timestamp ** [InputArtifacts](#API_DescribeTrialComponent_ResponseSyntax) ** The input artifacts of the component. Type: String to [TrialComponentArtifact](API_TrialComponentArtifact.md) object map Map Entries: Minimum number of 0 items. Maximum number of 60 items. Key Length Constraints: Minimum length of 0. Maximum length of 128. Key Pattern: `.*` ** [LastModifiedBy](#API_DescribeTrialComponent_ResponseSyntax) ** Who last modified the component. Type: [UserContext](API_UserContext.md) object ** [LastModifiedTime](#API_DescribeTrialComponent_ResponseSyntax) ** When the component was last modified. Type: Timestamp ** [LineageGroupArn](#API_DescribeTrialComponent_ResponseSyntax) ** The Amazon Resource Name (ARN) of the lineage group. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:lineage-group/.*` ** [MetadataProperties](#API_DescribeTrialComponent_ResponseSyntax) ** Metadata properties of the tracking entity, trial, or trial component. Type: [MetadataProperties](API_MetadataProperties.md) object ** [Metrics](#API_DescribeTrialComponent_ResponseSyntax) ** The metrics for the component. Type: Array of [TrialComponentMetricSummary](API_TrialComponentMetricSummary.md) objects ** [OutputArtifacts](#API_DescribeTrialComponent_ResponseSyntax) ** The output artifacts of the component. Type: String to [TrialComponentArtifact](API_TrialComponentArtifact.md) object map Map Entries: Minimum number of 0 items. Maximum number of 60 items. Key Length Constraints: Minimum length of 0. Maximum length of 128. Key Pattern: `.*` ** [Parameters](#API_DescribeTrialComponent_ResponseSyntax) ** The hyperparameters of the component. Type: String to [TrialComponentParameterValue](API_TrialComponentParameterValue.md) object map Map Entries: Minimum number of 0 items. Maximum number of 300 items. Key Length Constraints: Minimum length of 0. Maximum length of 320. Key Pattern: `.*` ** [Source](#API_DescribeTrialComponent_ResponseSyntax) ** The Amazon Resource Name (ARN) of the source and, optionally, the job type. Type: [TrialComponentSource](API_TrialComponentSource.md) object ** [Sources](#API_DescribeTrialComponent_ResponseSyntax) ** A list of ARNs and, if applicable, job types for multiple sources of an experiment run. Type: Array of [TrialComponentSource](API_TrialComponentSource.md) objects ** [StartTime](#API_DescribeTrialComponent_ResponseSyntax) ** When the component started. Type: Timestamp ** [Status](#API_DescribeTrialComponent_ResponseSyntax) ** The status of the component. States include: + InProgress + Completed + Failed Type: [TrialComponentStatus](API_TrialComponentStatus.md) object ** [TrialComponentArn](#API_DescribeTrialComponent_ResponseSyntax) ** The Amazon Resource Name (ARN) of the trial component. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:experiment-trial-component/.*` ** [TrialComponentName](#API_DescribeTrialComponent_ResponseSyntax) ** The name of the trial component. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeTrialComponent) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeTrialComponent) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeTrialComponent) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeTrialComponent) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeTrialComponent) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeTrialComponent) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeTrialComponent) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeTrialComponent) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeTrialComponent) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeTrialComponent) # DescribeUserProfile Describes a user profile. For more information, see `CreateUserProfile`. ## Request Syntax ``` { "DomainId": "string", "UserProfileName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DomainId](#API_DescribeUserProfile_RequestSyntax) ** The domain ID. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `d-(-*[a-z0-9]){1,61}` Required: Yes ** [UserProfileName](#API_DescribeUserProfile_RequestSyntax) ** The user profile name. This value is not case sensitive. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "CreationTime": number, "DomainId": "string", "FailureReason": "string", "HomeEfsFileSystemUid": "string", "LastModifiedTime": number, "SingleSignOnUserIdentifier": "string", "SingleSignOnUserValue": "string", "Status": "string", "UserProfileArn": "string", "UserProfileName": "string", "UserSettings": { "AutoMountHomeEFS": "string", "CanvasAppSettings": { "DirectDeploySettings": { "Status": "string" }, "EmrServerlessSettings": { "ExecutionRoleArn": "string", "Status": "string" }, "GenerativeAiSettings": { "AmazonBedrockRoleArn": "string" }, "IdentityProviderOAuthSettings": [ { "DataSourceName": "string", "SecretArn": "string", "Status": "string" } ], "KendraSettings": { "Status": "string" }, "ModelRegisterSettings": { "CrossAccountModelRegisterRoleArn": "string", "Status": "string" }, "TimeSeriesForecastingSettings": { "AmazonForecastRoleArn": "string", "Status": "string" }, "WorkspaceSettings": { "S3ArtifactPath": "string", "S3KmsKeyId": "string" } }, "CodeEditorAppSettings": { "AppLifecycleManagement": { "IdleSettings": { "IdleTimeoutInMinutes": number, "LifecycleManagement": "string", "MaxIdleTimeoutInMinutes": number, "MinIdleTimeoutInMinutes": number } }, "BuiltInLifecycleConfigArn": "string", "CustomImages": [ { "AppImageConfigName": "string", "ImageName": "string", "ImageVersionNumber": number } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" }, "LifecycleConfigArns": [ "string" ] }, "CustomFileSystemConfigs": [ { ... } ], "CustomPosixUserConfig": { "Gid": number, "Uid": number }, "DefaultLandingUri": "string", "ExecutionRole": "string", "JupyterLabAppSettings": { "AppLifecycleManagement": { "IdleSettings": { "IdleTimeoutInMinutes": number, "LifecycleManagement": "string", "MaxIdleTimeoutInMinutes": number, "MinIdleTimeoutInMinutes": number } }, "BuiltInLifecycleConfigArn": "string", "CodeRepositories": [ { "RepositoryUrl": "string" } ], "CustomImages": [ { "AppImageConfigName": "string", "ImageName": "string", "ImageVersionNumber": number } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" }, "EmrSettings": { "AssumableRoleArns": [ "string" ], "ExecutionRoleArns": [ "string" ] }, "LifecycleConfigArns": [ "string" ] }, "JupyterServerAppSettings": { "CodeRepositories": [ { "RepositoryUrl": "string" } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" }, "LifecycleConfigArns": [ "string" ] }, "KernelGatewayAppSettings": { "CustomImages": [ { "AppImageConfigName": "string", "ImageName": "string", "ImageVersionNumber": number } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" }, "LifecycleConfigArns": [ "string" ] }, "RSessionAppSettings": { "CustomImages": [ { "AppImageConfigName": "string", "ImageName": "string", "ImageVersionNumber": number } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" } }, "RStudioServerProAppSettings": { "AccessStatus": "string", "UserGroup": "string" }, "SecurityGroups": [ "string" ], "SharingSettings": { "NotebookOutputOption": "string", "S3KmsKeyId": "string", "S3OutputPath": "string" }, "SpaceStorageSettings": { "DefaultEbsStorageSettings": { "DefaultEbsVolumeSizeInGb": number, "MaximumEbsVolumeSizeInGb": number } }, "StudioWebPortal": "string", "StudioWebPortalSettings": { "HiddenAppTypes": [ "string" ], "HiddenInstanceTypes": [ "string" ], "HiddenMlTools": [ "string" ], "HiddenSageMakerImageVersionAliases": [ { "SageMakerImageName": "string", "VersionAliases": [ "string" ] } ] }, "TensorBoardAppSettings": { "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" } } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreationTime](#API_DescribeUserProfile_ResponseSyntax) ** The creation time. Type: Timestamp ** [DomainId](#API_DescribeUserProfile_ResponseSyntax) ** The ID of the domain that contains the profile. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `d-(-*[a-z0-9]){1,61}` ** [FailureReason](#API_DescribeUserProfile_ResponseSyntax) ** The failure reason. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. ** [HomeEfsFileSystemUid](#API_DescribeUserProfile_ResponseSyntax) ** The ID of the user's profile in the Amazon Elastic File System volume. Type: String Length Constraints: Minimum length of 0. Maximum length of 10. Pattern: `\d+` ** [LastModifiedTime](#API_DescribeUserProfile_ResponseSyntax) ** The last modified time. Type: Timestamp ** [SingleSignOnUserIdentifier](#API_DescribeUserProfile_ResponseSyntax) ** The IAM Identity Center user identifier. Type: String Pattern: `UserName` ** [SingleSignOnUserValue](#API_DescribeUserProfile_ResponseSyntax) ** The IAM Identity Center user value. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. ** [Status](#API_DescribeUserProfile_ResponseSyntax) ** The status. Type: String Valid Values: `Deleting | Failed | InService | Pending | Updating | Update_Failed | Delete_Failed` ** [UserProfileArn](#API_DescribeUserProfile_ResponseSyntax) ** The user profile Amazon Resource Name (ARN). Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:user-profile/.*` ** [UserProfileName](#API_DescribeUserProfile_ResponseSyntax) ** The user profile name. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [UserSettings](#API_DescribeUserProfile_ResponseSyntax) ** A collection of settings. Type: [UserSettings](API_UserSettings.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeUserProfile) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeUserProfile) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeUserProfile) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeUserProfile) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeUserProfile) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeUserProfile) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeUserProfile) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeUserProfile) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeUserProfile) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeUserProfile) # DescribeWorkforce Lists private workforce information, including workforce name, Amazon Resource Name (ARN), and, if applicable, allowed IP address ranges ([CIDRs](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html)). Allowable IP address ranges are the IP addresses that workers can use to access tasks. **Important** This operation applies only to private workforces. ## Request Syntax ``` { "WorkforceName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [WorkforceName](#API_DescribeWorkforce_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9]([a-zA-Z0-9\-]){0,62}` Required: Yes ## Response Syntax ``` { "Workforce": { "CognitoConfig": { "ClientId": "string", "UserPool": "string" }, "CreateDate": number, "FailureReason": "string", "IpAddressType": "string", "LastUpdatedDate": number, "OidcConfig": { "AuthenticationRequestExtraParams": { "string" : "string" }, "AuthorizationEndpoint": "string", "ClientId": "string", "Issuer": "string", "JwksUri": "string", "LogoutEndpoint": "string", "Scope": "string", "TokenEndpoint": "string", "UserInfoEndpoint": "string" }, "SourceIpConfig": { "Cidrs": [ "string" ] }, "Status": "string", "SubDomain": "string", "WorkforceArn": "string", "WorkforceName": "string", "WorkforceVpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ], "VpcEndpointId": "string", "VpcId": "string" } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Workforce](#API_DescribeWorkforce_ResponseSyntax) ** 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](https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private.html). Type: [Workforce](API_Workforce.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeWorkforce) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeWorkforce) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeWorkforce) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeWorkforce) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeWorkforce) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeWorkforce) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeWorkforce) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeWorkforce) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeWorkforce) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeWorkforce) # DescribeWorkteam Gets information about a specific work team. You can see information such as the creation date, the last updated date, membership information, and the work team's Amazon Resource Name (ARN). ## Request Syntax ``` { "WorkteamName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [WorkteamName](#API_DescribeWorkteam_RequestSyntax) ** The name of the work team to return a description of. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "Workteam": { "CreateDate": number, "Description": "string", "LastUpdatedDate": number, "MemberDefinitions": [ { "CognitoMemberDefinition": { "ClientId": "string", "UserGroup": "string", "UserPool": "string" }, "OidcMemberDefinition": { "Groups": [ "string" ] } } ], "NotificationConfiguration": { "NotificationTopicArn": "string" }, "ProductListingIds": [ "string" ], "SubDomain": "string", "WorkerAccessConfiguration": { "S3Presign": { "IamPolicyConstraints": { "SourceIp": "string", "VpcSourceIp": "string" } } }, "WorkforceArn": "string", "WorkteamArn": "string", "WorkteamName": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Workteam](#API_DescribeWorkteam_ResponseSyntax) ** A `Workteam` instance that contains information about the work team. Type: [Workteam](API_Workteam.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DescribeWorkteam) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DescribeWorkteam) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DescribeWorkteam) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DescribeWorkteam) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DescribeWorkteam) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DescribeWorkteam) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DescribeWorkteam) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DescribeWorkteam) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DescribeWorkteam) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DescribeWorkteam) # DetachClusterNodeVolume Detaches your Amazon Elastic Block Store (Amazon EBS) volume from a node in your EKS orchestrated SageMaker HyperPod cluster. This API works with the Amazon Elastic Block Store (Amazon EBS) Container Storage Interface (CSI) driver to manage the lifecycle of persistent storage in your HyperPod EKS clusters. ## Request Syntax ``` { "ClusterArn": "string", "NodeId": "string", "VolumeId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClusterArn](#API_DetachClusterNodeVolume_RequestSyntax) ** The Amazon Resource Name (ARN) of your SageMaker HyperPod cluster containing the target node. Your cluster must use EKS as the orchestration and be in the `InService` state. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12}` Required: Yes ** [NodeId](#API_DetachClusterNodeVolume_RequestSyntax) ** The unique identifier of the cluster node from which you want to detach the volume. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `i-[a-f0-9]{8}(?:[a-f0-9]{9})?` Required: Yes ** [VolumeId](#API_DetachClusterNodeVolume_RequestSyntax) ** The unique identifier of your EBS volume that you want to detach. Your volume must be currently attached to the specified node. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `vol-[a-f0-9]{8}(?:[a-f0-9]{9})?` Required: Yes ## Response Syntax ``` { "AttachTime": number, "ClusterArn": "string", "DeviceName": "string", "NodeId": "string", "Status": "string", "VolumeId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AttachTime](#API_DetachClusterNodeVolume_ResponseSyntax) ** The original timestamp when your volume was initially attached to the node. Type: Timestamp ** [ClusterArn](#API_DetachClusterNodeVolume_ResponseSyntax) ** The Amazon Resource Name (ARN) of your SageMaker HyperPod cluster where the volume detachment operation was performed. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12}` ** [DeviceName](#API_DetachClusterNodeVolume_ResponseSyntax) ** The device name assigned to your attached volume on the target instance. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: `/dev/(xvd[a-z]|sd[b-z]|sd[f-p][1-6])` ** [NodeId](#API_DetachClusterNodeVolume_ResponseSyntax) ** The unique identifier of the cluster node from which your volume was detached. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `i-[a-f0-9]{8}(?:[a-f0-9]{9})?` ** [Status](#API_DetachClusterNodeVolume_ResponseSyntax) ** The current status of your volume detachment operation. Type: String Valid Values: `attaching | attached | detaching | detached | busy` ** [VolumeId](#API_DetachClusterNodeVolume_ResponseSyntax) ** The unique identifier of your EBS volume that was detached. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `vol-[a-f0-9]{8}(?:[a-f0-9]{9})?` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DetachClusterNodeVolume) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DetachClusterNodeVolume) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DetachClusterNodeVolume) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DetachClusterNodeVolume) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DetachClusterNodeVolume) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DetachClusterNodeVolume) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DetachClusterNodeVolume) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DetachClusterNodeVolume) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DetachClusterNodeVolume) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DetachClusterNodeVolume) # DisableSagemakerServicecatalogPortfolio Disables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects. ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DisableSagemakerServicecatalogPortfolio) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DisableSagemakerServicecatalogPortfolio) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DisableSagemakerServicecatalogPortfolio) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DisableSagemakerServicecatalogPortfolio) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DisableSagemakerServicecatalogPortfolio) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DisableSagemakerServicecatalogPortfolio) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DisableSagemakerServicecatalogPortfolio) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DisableSagemakerServicecatalogPortfolio) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DisableSagemakerServicecatalogPortfolio) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DisableSagemakerServicecatalogPortfolio) # DisassociateTrialComponent 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](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AssociateTrialComponent.html) API. To get a list of the trials a component is associated with, use the [Search](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) API. Specify `ExperimentTrialComponent` for the `Resource` parameter. The list appears in the response under `Results.TrialComponent.Parents`. ## Request Syntax ``` { "TrialComponentName": "string", "TrialName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [TrialComponentName](#API_DisassociateTrialComponent_RequestSyntax) ** The name of the component to disassociate from the trial. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` Required: Yes ** [TrialName](#API_DisassociateTrialComponent_RequestSyntax) ** The name of the trial to disassociate from. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` Required: Yes ## Response Syntax ``` { "TrialArn": "string", "TrialComponentArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [TrialArn](#API_DisassociateTrialComponent_ResponseSyntax) ** The Amazon Resource Name (ARN) of the trial. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:experiment-trial/.*` ** [TrialComponentArn](#API_DisassociateTrialComponent_ResponseSyntax) ** The Amazon Resource Name (ARN) of the trial component. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:experiment-trial-component/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/DisassociateTrialComponent) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/DisassociateTrialComponent) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/DisassociateTrialComponent) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/DisassociateTrialComponent) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/DisassociateTrialComponent) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/DisassociateTrialComponent) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/DisassociateTrialComponent) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/DisassociateTrialComponent) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/DisassociateTrialComponent) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/DisassociateTrialComponent) # EnableSagemakerServicecatalogPortfolio Enables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects. ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/EnableSagemakerServicecatalogPortfolio) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/EnableSagemakerServicecatalogPortfolio) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/EnableSagemakerServicecatalogPortfolio) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/EnableSagemakerServicecatalogPortfolio) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/EnableSagemakerServicecatalogPortfolio) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/EnableSagemakerServicecatalogPortfolio) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/EnableSagemakerServicecatalogPortfolio) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/EnableSagemakerServicecatalogPortfolio) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/EnableSagemakerServicecatalogPortfolio) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/EnableSagemakerServicecatalogPortfolio) # ExtendTrainingPlan Extends an existing training plan by purchasing an extension offering. This allows you to add additional compute capacity time to your training plan without creating a new plan or reconfiguring your workloads. To find available extension offerings, use the ` [SearchTrainingPlanOfferings](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_SearchTrainingPlanOfferings.html) ` API with the `TrainingPlanArn` parameter. To view the history of extensions for a training plan, use the ` [DescribeTrainingPlanExtensionHistory](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrainingPlanExtensionHistory.html) ` API. ## Request Syntax ``` { "TrainingPlanExtensionOfferingId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [TrainingPlanExtensionOfferingId](#API_ExtendTrainingPlan_RequestSyntax) ** The unique identifier of the extension offering to purchase. You can retrieve this ID from the `TrainingPlanExtensionOfferings` in the response of the `SearchTrainingPlanOfferings` API. Type: String Required: Yes ## Response Syntax ``` { "TrainingPlanExtensions": [ { "AvailabilityZone": "string", "AvailabilityZoneId": "string", "CurrencyCode": "string", "DurationHours": number, "EndDate": number, "ExtendedAt": number, "PaymentStatus": "string", "StartDate": number, "Status": "string", "TrainingPlanExtensionOfferingId": "string", "UpfrontFee": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [TrainingPlanExtensions](#API_ExtendTrainingPlan_ResponseSyntax) ** The list of extensions for the training plan, including the newly created extension. Type: Array of [TrainingPlanExtension](API_TrainingPlanExtension.md) objects Array Members: Minimum number of 0 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ExtendTrainingPlan) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ExtendTrainingPlan) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ExtendTrainingPlan) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ExtendTrainingPlan) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ExtendTrainingPlan) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ExtendTrainingPlan) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ExtendTrainingPlan) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ExtendTrainingPlan) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ExtendTrainingPlan) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ExtendTrainingPlan) # GetDeviceFleetReport Describes a fleet. ## Request Syntax ``` { "DeviceFleetName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DeviceFleetName](#API_GetDeviceFleetReport_RequestSyntax) ** The name of the fleet. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "AgentVersions": [ { "AgentCount": number, "Version": "string" } ], "Description": "string", "DeviceFleetArn": "string", "DeviceFleetName": "string", "DeviceStats": { "ConnectedDeviceCount": number, "RegisteredDeviceCount": number }, "ModelStats": [ { "ActiveDeviceCount": number, "ConnectedDeviceCount": number, "ModelName": "string", "ModelVersion": "string", "OfflineDeviceCount": number, "SamplingDeviceCount": number } ], "OutputConfig": { "KmsKeyId": "string", "PresetDeploymentConfig": "string", "PresetDeploymentType": "string", "S3OutputLocation": "string" }, "ReportGenerated": number } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AgentVersions](#API_GetDeviceFleetReport_ResponseSyntax) ** The versions of Edge Manager agent deployed on the fleet. Type: Array of [AgentVersion](API_AgentVersion.md) objects ** [Description](#API_GetDeviceFleetReport_ResponseSyntax) ** Description of the fleet. Type: String Length Constraints: Minimum length of 1. Maximum length of 800. Pattern: `[-a-zA-Z0-9_.,;:! ]*` ** [DeviceFleetArn](#API_GetDeviceFleetReport_ResponseSyntax) ** The Amazon Resource Name (ARN) of the device. Type: String Pattern: `arn:aws[a-z\-]*:iam::\d{12}:device-fleet/?[a-zA-Z_0-9+=,.@\-_/]+` ** [DeviceFleetName](#API_GetDeviceFleetReport_ResponseSyntax) ** The name of the fleet. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [DeviceStats](#API_GetDeviceFleetReport_ResponseSyntax) ** Status of devices. Type: [DeviceStats](API_DeviceStats.md) object ** [ModelStats](#API_GetDeviceFleetReport_ResponseSyntax) ** Status of model on device. Type: Array of [EdgeModelStat](API_EdgeModelStat.md) objects ** [OutputConfig](#API_GetDeviceFleetReport_ResponseSyntax) ** The output configuration for storing sample data collected by the fleet. Type: [EdgeOutputConfig](API_EdgeOutputConfig.md) object ** [ReportGenerated](#API_GetDeviceFleetReport_ResponseSyntax) ** Timestamp of when the report was generated. Type: Timestamp ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/GetDeviceFleetReport) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/GetDeviceFleetReport) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/GetDeviceFleetReport) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/GetDeviceFleetReport) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/GetDeviceFleetReport) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/GetDeviceFleetReport) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/GetDeviceFleetReport) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/GetDeviceFleetReport) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/GetDeviceFleetReport) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/GetDeviceFleetReport) # GetLineageGroupPolicy The resource policy for the lineage group. ## Request Syntax ``` { "LineageGroupName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [LineageGroupName](#API_GetLineageGroupPolicy_RequestSyntax) ** The name or Amazon Resource Name (ARN) of the lineage group. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:lineage-group\/)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,119})` Required: Yes ## Response Syntax ``` { "LineageGroupArn": "string", "ResourcePolicy": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [LineageGroupArn](#API_GetLineageGroupPolicy_ResponseSyntax) ** The Amazon Resource Name (ARN) of the lineage group. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:lineage-group/.*` ** [ResourcePolicy](#API_GetLineageGroupPolicy_ResponseSyntax) ** The resource policy that gives access to the lineage group in another account. Type: String Length Constraints: Minimum length of 0. Maximum length of 20480. Pattern: `.*(?:[ \r\n\t].*)*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/GetLineageGroupPolicy) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/GetLineageGroupPolicy) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/GetLineageGroupPolicy) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/GetLineageGroupPolicy) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/GetLineageGroupPolicy) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/GetLineageGroupPolicy) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/GetLineageGroupPolicy) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/GetLineageGroupPolicy) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/GetLineageGroupPolicy) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/GetLineageGroupPolicy) # GetModelPackageGroupPolicy Gets a resource policy that manages access for a model group. For information about resource policies, see [Identity-based policies and resource-based policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_identity-vs-resource.html) in the * AWS Identity and Access Management User Guide.*. ## Request Syntax ``` { "ModelPackageGroupName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ModelPackageGroupName](#API_GetModelPackageGroupPolicy_RequestSyntax) ** The name of the model group for which to get the resource policy. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "ResourcePolicy": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ResourcePolicy](#API_GetModelPackageGroupPolicy_ResponseSyntax) ** The resource policy for the model group. Type: String Length Constraints: Minimum length of 1. Maximum length of 20480. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/GetModelPackageGroupPolicy) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/GetModelPackageGroupPolicy) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/GetModelPackageGroupPolicy) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/GetModelPackageGroupPolicy) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/GetModelPackageGroupPolicy) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/GetModelPackageGroupPolicy) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/GetModelPackageGroupPolicy) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/GetModelPackageGroupPolicy) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/GetModelPackageGroupPolicy) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/GetModelPackageGroupPolicy) # GetSagemakerServicecatalogPortfolioStatus Gets the status of Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects. ## Response Syntax ``` { "Status": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Status](#API_GetSagemakerServicecatalogPortfolioStatus_ResponseSyntax) ** Whether Service Catalog is enabled or disabled in SageMaker. Type: String Valid Values: `Enabled | Disabled` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/GetSagemakerServicecatalogPortfolioStatus) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/GetSagemakerServicecatalogPortfolioStatus) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/GetSagemakerServicecatalogPortfolioStatus) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/GetSagemakerServicecatalogPortfolioStatus) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/GetSagemakerServicecatalogPortfolioStatus) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/GetSagemakerServicecatalogPortfolioStatus) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/GetSagemakerServicecatalogPortfolioStatus) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/GetSagemakerServicecatalogPortfolioStatus) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/GetSagemakerServicecatalogPortfolioStatus) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/GetSagemakerServicecatalogPortfolioStatus) # GetScalingConfigurationRecommendation Starts an Amazon SageMaker Inference Recommender autoscaling recommendation job. Returns recommendations for autoscaling policies that you can apply to your SageMaker endpoint. ## Request Syntax ``` { "EndpointName": "string", "InferenceRecommendationsJobName": "string", "RecommendationId": "string", "ScalingPolicyObjective": { "MaxInvocationsPerMinute": number, "MinInvocationsPerMinute": number }, "TargetCpuUtilizationPerCore": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [EndpointName](#API_GetScalingConfigurationRecommendation_RequestSyntax) ** The name of an endpoint benchmarked during a previously completed inference recommendation job. This name should come from one of the recommendations returned by the job specified in the `InferenceRecommendationsJobName` field. Specify either this field or the `RecommendationId` field. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: No ** [InferenceRecommendationsJobName](#API_GetScalingConfigurationRecommendation_RequestSyntax) ** The name of a previously completed Inference Recommender job. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}` Required: Yes ** [RecommendationId](#API_GetScalingConfigurationRecommendation_RequestSyntax) ** The recommendation ID of a previously completed inference recommendation. This ID should come from one of the recommendations returned by the job specified in the `InferenceRecommendationsJobName` field. Specify either this field or the `EndpointName` field. Type: String Required: No ** [ScalingPolicyObjective](#API_GetScalingConfigurationRecommendation_RequestSyntax) ** An object where you specify the anticipated traffic pattern for an endpoint. Type: [ScalingPolicyObjective](API_ScalingPolicyObjective.md) object Required: No ** [TargetCpuUtilizationPerCore](#API_GetScalingConfigurationRecommendation_RequestSyntax) ** The percentage of how much utilization you want an instance to use before autoscaling. The default value is 50%. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ## Response Syntax ``` { "DynamicScalingConfiguration": { "MaxCapacity": number, "MinCapacity": number, "ScaleInCooldown": number, "ScaleOutCooldown": number, "ScalingPolicies": [ { ... } ] }, "EndpointName": "string", "InferenceRecommendationsJobName": "string", "Metric": { "InvocationsPerInstance": number, "ModelLatency": number }, "RecommendationId": "string", "ScalingPolicyObjective": { "MaxInvocationsPerMinute": number, "MinInvocationsPerMinute": number }, "TargetCpuUtilizationPerCore": number } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DynamicScalingConfiguration](#API_GetScalingConfigurationRecommendation_ResponseSyntax) ** An object with the recommended values for you to specify when creating an autoscaling policy. Type: [DynamicScalingConfiguration](API_DynamicScalingConfiguration.md) object ** [EndpointName](#API_GetScalingConfigurationRecommendation_ResponseSyntax) ** The name of an endpoint benchmarked during a previously completed Inference Recommender job. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [InferenceRecommendationsJobName](#API_GetScalingConfigurationRecommendation_ResponseSyntax) ** The name of a previously completed Inference Recommender job. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}` ** [Metric](#API_GetScalingConfigurationRecommendation_ResponseSyntax) ** An object with a list of metrics that were benchmarked during the previously completed Inference Recommender job. Type: [ScalingPolicyMetric](API_ScalingPolicyMetric.md) object ** [RecommendationId](#API_GetScalingConfigurationRecommendation_ResponseSyntax) ** The recommendation ID of a previously completed inference recommendation. Type: String ** [ScalingPolicyObjective](#API_GetScalingConfigurationRecommendation_ResponseSyntax) ** An object representing the anticipated traffic pattern for an endpoint that you specified in the request. Type: [ScalingPolicyObjective](API_ScalingPolicyObjective.md) object ** [TargetCpuUtilizationPerCore](#API_GetScalingConfigurationRecommendation_ResponseSyntax) ** The percentage of how much utilization you want an instance to use before autoscaling, which you specified in the request. The default value is 50%. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/GetScalingConfigurationRecommendation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/GetScalingConfigurationRecommendation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/GetScalingConfigurationRecommendation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/GetScalingConfigurationRecommendation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/GetScalingConfigurationRecommendation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/GetScalingConfigurationRecommendation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/GetScalingConfigurationRecommendation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/GetScalingConfigurationRecommendation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/GetScalingConfigurationRecommendation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/GetScalingConfigurationRecommendation) # GetSearchSuggestions An auto-complete API for the search functionality in the SageMaker console. It returns suggestions of possible matches for the property name to use in `Search` queries. Provides suggestions for `HyperParameters`, `Tags`, and `Metrics`. ## Request Syntax ``` { "Resource": "string", "SuggestionQuery": { "PropertyNameQuery": { "PropertyNameHint": "string" } } } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Resource](#API_GetSearchSuggestions_RequestSyntax) ** The name of the SageMaker resource to search for. Type: String Valid Values: `TrainingJob | Experiment | ExperimentTrial | ExperimentTrialComponent | Endpoint | Model | ModelPackage | ModelPackageGroup | Pipeline | PipelineExecution | FeatureGroup | FeatureMetadata | Image | ImageVersion | Project | HyperParameterTuningJob | ModelCard | PipelineVersion` Required: Yes ** [SuggestionQuery](#API_GetSearchSuggestions_RequestSyntax) ** Limits the property names that are included in the response. Type: [SuggestionQuery](API_SuggestionQuery.md) object Required: No ## Response Syntax ``` { "PropertyNameSuggestions": [ { "PropertyName": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [PropertyNameSuggestions](#API_GetSearchSuggestions_ResponseSyntax) ** A list of property names for a `Resource` that match a `SuggestionQuery`. Type: Array of [PropertyNameSuggestion](API_PropertyNameSuggestion.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/GetSearchSuggestions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/GetSearchSuggestions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/GetSearchSuggestions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/GetSearchSuggestions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/GetSearchSuggestions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/GetSearchSuggestions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/GetSearchSuggestions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/GetSearchSuggestions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/GetSearchSuggestions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/GetSearchSuggestions) # ImportHubContent Import hub content. ## Request Syntax ``` { "DocumentSchemaVersion": "string", "HubContentDescription": "string", "HubContentDisplayName": "string", "HubContentDocument": "string", "HubContentMarkdown": "string", "HubContentName": "string", "HubContentSearchKeywords": [ "string" ], "HubContentType": "string", "HubContentVersion": "string", "HubName": "string", "SupportStatus": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DocumentSchemaVersion](#API_ImportHubContent_RequestSyntax) ** The version of the hub content schema to import. Type: String Length Constraints: Minimum length of 5. Maximum length of 14. Pattern: `\d{1,4}.\d{1,4}.\d{1,4}` Required: Yes ** [HubContentDescription](#API_ImportHubContent_RequestSyntax) ** A description of the hub content to import. Type: String Length Constraints: Minimum length of 0. Maximum length of 1023. Pattern: `.*` Required: No ** [HubContentDisplayName](#API_ImportHubContent_RequestSyntax) ** The display name of the hub content to import. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: `.*` Required: No ** [HubContentDocument](#API_ImportHubContent_RequestSyntax) ** The hub content document that describes information about the hub content such as type, associated containers, scripts, and more. Type: String Length Constraints: Minimum length of 0. Maximum length of 327680. Pattern: `.*` Required: Yes ** [HubContentMarkdown](#API_ImportHubContent_RequestSyntax) ** A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating. Type: String Length Constraints: Minimum length of 0. Maximum length of 170391. Required: No ** [HubContentName](#API_ImportHubContent_RequestSyntax) ** The name of the hub content to import. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [HubContentSearchKeywords](#API_ImportHubContent_RequestSyntax) ** The searchable keywords of the hub content. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 50 items. Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: `.*` Required: No ** [HubContentType](#API_ImportHubContent_RequestSyntax) ** The type of hub content to import. Type: String Valid Values: `Model | Notebook | ModelReference | DataSet | JsonDoc` Required: Yes ** [HubContentVersion](#API_ImportHubContent_RequestSyntax) ** The version of the hub content to import. Type: String Length Constraints: Minimum length of 5. Maximum length of 14. Pattern: `\d{1,4}.\d{1,4}.\d{1,4}` Required: No ** [HubName](#API_ImportHubContent_RequestSyntax) ** The name of the hub to import content into. Type: String Pattern: `(arn:[a-z0-9-\.]{1,63}:sagemaker:\w+(?:-\w+)+:(\d{12}|aws):hub\/)?[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [SupportStatus](#API_ImportHubContent_RequestSyntax) ** The status of the hub content resource. Type: String Valid Values: `Supported | Deprecated | Restricted` Required: No ** [Tags](#API_ImportHubContent_RequestSyntax) ** Any tags associated with the hub content. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No ## Response Syntax ``` { "HubArn": "string", "HubContentArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [HubArn](#API_ImportHubContent_ResponseSyntax) ** The ARN of the hub that the content was imported into. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: `.*` ** [HubContentArn](#API_ImportHubContent_ResponseSyntax) ** The ARN of the hub content that was imported. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ImportHubContent) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ImportHubContent) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ImportHubContent) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ImportHubContent) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ImportHubContent) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ImportHubContent) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ImportHubContent) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ImportHubContent) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ImportHubContent) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ImportHubContent) # ListActions Lists the actions in your account and their properties. ## Request Syntax ``` { "ActionType": "string", "CreatedAfter": number, "CreatedBefore": number, "MaxResults": number, "NextToken": "string", "SortBy": "string", "SortOrder": "string", "SourceUri": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ActionType](#API_ListActions_RequestSyntax) ** A filter that returns only actions of the specified type. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Required: No ** [CreatedAfter](#API_ListActions_RequestSyntax) ** A filter that returns only actions created on or after the specified time. Type: Timestamp Required: No ** [CreatedBefore](#API_ListActions_RequestSyntax) ** A filter that returns only actions created on or before the specified time. Type: Timestamp Required: No ** [MaxResults](#API_ListActions_RequestSyntax) ** The maximum number of actions to return in the response. The default value is 10. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListActions_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListActions_RequestSyntax) ** The property used to sort results. The default value is `CreationTime`. Type: String Valid Values: `Name | CreationTime` Required: No ** [SortOrder](#API_ListActions_RequestSyntax) ** The sort order. The default value is `Descending`. Type: String Valid Values: `Ascending | Descending` Required: No ** [SourceUri](#API_ListActions_RequestSyntax) ** A filter that returns only actions with the specified source URI. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `.*` Required: No ## Response Syntax ``` { "ActionSummaries": [ { "ActionArn": "string", "ActionName": "string", "ActionType": "string", "CreationTime": number, "LastModifiedTime": number, "Source": { "SourceId": "string", "SourceType": "string", "SourceUri": "string" }, "Status": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ActionSummaries](#API_ListActions_ResponseSyntax) ** A list of actions and their properties. Type: Array of [ActionSummary](API_ActionSummary.md) objects ** [NextToken](#API_ListActions_ResponseSyntax) ** A token for getting the next set of actions, if there are any. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListActions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListActions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListActions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListActions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListActions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListActions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListActions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListActions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListActions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListActions) # ListAlgorithms Lists the machine learning algorithms that have been created. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "MaxResults": number, "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListAlgorithms_RequestSyntax) ** A filter that returns only algorithms created after the specified time (timestamp). Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListAlgorithms_RequestSyntax) ** A filter that returns only algorithms created before the specified time (timestamp). Type: Timestamp Required: No ** [MaxResults](#API_ListAlgorithms_RequestSyntax) ** The maximum number of algorithms to return in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NameContains](#API_ListAlgorithms_RequestSyntax) ** A string in the algorithm name. This filter returns only algorithms whose name contains the specified string. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9\-]+` Required: No ** [NextToken](#API_ListAlgorithms_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListAlgorithms_RequestSyntax) ** The parameter by which to sort the results. The default is `CreationTime`. Type: String Valid Values: `Name | CreationTime` Required: No ** [SortOrder](#API_ListAlgorithms_RequestSyntax) ** The sort order for the results. The default is `Ascending`. Type: String Valid Values: `Ascending | Descending` Required: No ## Response Syntax ``` { "AlgorithmSummaryList": [ { "AlgorithmArn": "string", "AlgorithmDescription": "string", "AlgorithmName": "string", "AlgorithmStatus": "string", "CreationTime": number } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AlgorithmSummaryList](#API_ListAlgorithms_ResponseSyntax) ** >An array of `AlgorithmSummary` objects, each of which lists an algorithm. Type: Array of [AlgorithmSummary](API_AlgorithmSummary.md) objects ** [NextToken](#API_ListAlgorithms_ResponseSyntax) ** If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListAlgorithms) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListAlgorithms) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListAlgorithms) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListAlgorithms) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListAlgorithms) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListAlgorithms) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListAlgorithms) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListAlgorithms) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListAlgorithms) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListAlgorithms) # ListAliases Lists the aliases of a specified image or image version. ## Request Syntax ``` { "Alias": "string", "ImageName": "string", "MaxResults": number, "NextToken": "string", "Version": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Alias](#API_ListAliases_RequestSyntax) ** The alias of the image version. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `(?!^[.-])^([a-zA-Z0-9-_.]+)` Required: No ** [ImageName](#API_ListAliases_RequestSyntax) ** The name of the image. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}` Required: Yes ** [MaxResults](#API_ListAliases_RequestSyntax) ** The maximum number of aliases to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListAliases_RequestSyntax) ** If the previous call to `ListAliases` didn't return the full set of aliases, the call returns a token for retrieving the next set of aliases. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [Version](#API_ListAliases_RequestSyntax) ** The version of the image. If image version is not specified, the aliases of all versions of the image are listed. Type: Integer Valid Range: Minimum value of 0. Required: No ## Response Syntax ``` { "NextToken": "string", "SageMakerImageVersionAliases": [ "string" ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListAliases_ResponseSyntax) ** A token for getting the next set of aliases, if more aliases exist. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ** [SageMakerImageVersionAliases](#API_ListAliases_ResponseSyntax) ** A list of SageMaker AI image version aliases. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `(?!^[.-])^([a-zA-Z0-9-_.]+)` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListAliases) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListAliases) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListAliases) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListAliases) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListAliases) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListAliases) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListAliases) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListAliases) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListAliases) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListAliases) # ListAppImageConfigs 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. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "MaxResults": number, "ModifiedTimeAfter": number, "ModifiedTimeBefore": number, "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListAppImageConfigs_RequestSyntax) ** A filter that returns only AppImageConfigs created on or after the specified time. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListAppImageConfigs_RequestSyntax) ** A filter that returns only AppImageConfigs created on or before the specified time. Type: Timestamp Required: No ** [MaxResults](#API_ListAppImageConfigs_RequestSyntax) ** The total number of items to return in the response. If the total number of items available is more than the value specified, a `NextToken` is provided in the response. To resume pagination, provide the `NextToken` value in the as part of a subsequent call. The default value is 10. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [ModifiedTimeAfter](#API_ListAppImageConfigs_RequestSyntax) ** A filter that returns only AppImageConfigs modified on or after the specified time. Type: Timestamp Required: No ** [ModifiedTimeBefore](#API_ListAppImageConfigs_RequestSyntax) ** A filter that returns only AppImageConfigs modified on or before the specified time. Type: Timestamp Required: No ** [NameContains](#API_ListAppImageConfigs_RequestSyntax) ** A filter that returns only AppImageConfigs whose name contains the specified string. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: No ** [NextToken](#API_ListAppImageConfigs_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListAppImageConfigs_RequestSyntax) ** The property used to sort results. The default value is `CreationTime`. Type: String Valid Values: `CreationTime | LastModifiedTime | Name` Required: No ** [SortOrder](#API_ListAppImageConfigs_RequestSyntax) ** The sort order. The default value is `Descending`. Type: String Valid Values: `Ascending | Descending` Required: No ## Response Syntax ``` { "AppImageConfigs": [ { "AppImageConfigArn": "string", "AppImageConfigName": "string", "CodeEditorAppImageConfig": { "ContainerConfig": { "ContainerArguments": [ "string" ], "ContainerEntrypoint": [ "string" ], "ContainerEnvironmentVariables": { "string" : "string" } }, "FileSystemConfig": { "DefaultGid": number, "DefaultUid": number, "MountPath": "string" } }, "CreationTime": number, "JupyterLabAppImageConfig": { "ContainerConfig": { "ContainerArguments": [ "string" ], "ContainerEntrypoint": [ "string" ], "ContainerEnvironmentVariables": { "string" : "string" } }, "FileSystemConfig": { "DefaultGid": number, "DefaultUid": number, "MountPath": "string" } }, "KernelGatewayImageConfig": { "FileSystemConfig": { "DefaultGid": number, "DefaultUid": number, "MountPath": "string" }, "KernelSpecs": [ { "DisplayName": "string", "Name": "string" } ] }, "LastModifiedTime": number } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AppImageConfigs](#API_ListAppImageConfigs_ResponseSyntax) ** A list of AppImageConfigs and their properties. Type: Array of [AppImageConfigDetails](API_AppImageConfigDetails.md) objects ** [NextToken](#API_ListAppImageConfigs_ResponseSyntax) ** A token for getting the next set of AppImageConfigs, if there are any. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListAppImageConfigs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListAppImageConfigs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListAppImageConfigs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListAppImageConfigs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListAppImageConfigs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListAppImageConfigs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListAppImageConfigs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListAppImageConfigs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListAppImageConfigs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListAppImageConfigs) # ListApps Lists apps. ## Request Syntax ``` { "DomainIdEquals": "string", "MaxResults": number, "NextToken": "string", "SortBy": "string", "SortOrder": "string", "SpaceNameEquals": "string", "UserProfileNameEquals": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DomainIdEquals](#API_ListApps_RequestSyntax) ** A parameter to search for the domain ID. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `d-(-*[a-z0-9]){1,61}` Required: No ** [MaxResults](#API_ListApps_RequestSyntax) ** This parameter defines the maximum number of results that can be return in a single response. The `MaxResults` parameter is an upper bound, not a target. If there are more results available than the value specified, a `NextToken` is provided in the response. The `NextToken` indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for `MaxResults` is 10. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListApps_RequestSyntax) ** If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListApps_RequestSyntax) ** The parameter by which to sort the results. The default is CreationTime. Type: String Valid Values: `CreationTime` Required: No ** [SortOrder](#API_ListApps_RequestSyntax) ** The sort order for the results. The default is Ascending. Type: String Valid Values: `Ascending | Descending` Required: No ** [SpaceNameEquals](#API_ListApps_RequestSyntax) ** A parameter to search by space name. If `UserProfileNameEquals` is set, then this value cannot be set. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: No ** [UserProfileNameEquals](#API_ListApps_RequestSyntax) ** A parameter to search by user profile name. If `SpaceNameEquals` is set, then this value cannot be set. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: No ## Response Syntax ``` { "Apps": [ { "AppName": "string", "AppType": "string", "CreationTime": number, "DomainId": "string", "ResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" }, "SpaceName": "string", "Status": "string", "UserProfileName": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Apps](#API_ListApps_ResponseSyntax) ** The list of apps. Type: Array of [AppDetails](API_AppDetails.md) objects ** [NextToken](#API_ListApps_ResponseSyntax) ** If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListApps) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListApps) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListApps) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListApps) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListApps) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListApps) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListApps) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListApps) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListApps) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListApps) # ListArtifacts Lists the artifacts in your account and their properties. ## Request Syntax ``` { "ArtifactType": "string", "CreatedAfter": number, "CreatedBefore": number, "MaxResults": number, "NextToken": "string", "SortBy": "string", "SortOrder": "string", "SourceUri": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ArtifactType](#API_ListArtifacts_RequestSyntax) ** A filter that returns only artifacts of the specified type. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Required: No ** [CreatedAfter](#API_ListArtifacts_RequestSyntax) ** A filter that returns only artifacts created on or after the specified time. Type: Timestamp Required: No ** [CreatedBefore](#API_ListArtifacts_RequestSyntax) ** A filter that returns only artifacts created on or before the specified time. Type: Timestamp Required: No ** [MaxResults](#API_ListArtifacts_RequestSyntax) ** The maximum number of artifacts to return in the response. The default value is 10. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListArtifacts_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListArtifacts_RequestSyntax) ** The property used to sort results. The default value is `CreationTime`. Type: String Valid Values: `CreationTime` Required: No ** [SortOrder](#API_ListArtifacts_RequestSyntax) ** The sort order. The default value is `Descending`. Type: String Valid Values: `Ascending | Descending` Required: No ** [SourceUri](#API_ListArtifacts_RequestSyntax) ** A filter that returns only artifacts with the specified source URI. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `.*` Required: No ## Response Syntax ``` { "ArtifactSummaries": [ { "ArtifactArn": "string", "ArtifactName": "string", "ArtifactType": "string", "CreationTime": number, "LastModifiedTime": number, "Source": { "SourceTypes": [ { "SourceIdType": "string", "Value": "string" } ], "SourceUri": "string" } } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ArtifactSummaries](#API_ListArtifacts_ResponseSyntax) ** A list of artifacts and their properties. Type: Array of [ArtifactSummary](API_ArtifactSummary.md) objects ** [NextToken](#API_ListArtifacts_ResponseSyntax) ** A token for getting the next set of artifacts, if there are any. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListArtifacts) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListArtifacts) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListArtifacts) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListArtifacts) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListArtifacts) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListArtifacts) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListArtifacts) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListArtifacts) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListArtifacts) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListArtifacts) # ListAssociations Lists the associations in your account and their properties. ## Request Syntax ``` { "AssociationType": "string", "CreatedAfter": number, "CreatedBefore": number, "DestinationArn": "string", "DestinationType": "string", "MaxResults": number, "NextToken": "string", "SortBy": "string", "SortOrder": "string", "SourceArn": "string", "SourceType": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AssociationType](#API_ListAssociations_RequestSyntax) ** A filter that returns only associations of the specified type. Type: String Valid Values: `ContributedTo | AssociatedWith | DerivedFrom | Produced | SameAs` Required: No ** [CreatedAfter](#API_ListAssociations_RequestSyntax) ** A filter that returns only associations created on or after the specified time. Type: Timestamp Required: No ** [CreatedBefore](#API_ListAssociations_RequestSyntax) ** A filter that returns only associations created on or before the specified time. Type: Timestamp Required: No ** [DestinationArn](#API_ListAssociations_RequestSyntax) ** A filter that returns only associations with the specified destination Amazon Resource Name (ARN). Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:(experiment|experiment-trial-component|artifact|action|context)/.*` Required: No ** [DestinationType](#API_ListAssociations_RequestSyntax) ** A filter that returns only associations with the specified destination type. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Required: No ** [MaxResults](#API_ListAssociations_RequestSyntax) ** The maximum number of associations to return in the response. The default value is 10. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListAssociations_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListAssociations_RequestSyntax) ** The property used to sort results. The default value is `CreationTime`. Type: String Valid Values: `SourceArn | DestinationArn | SourceType | DestinationType | CreationTime` Required: No ** [SortOrder](#API_ListAssociations_RequestSyntax) ** The sort order. The default value is `Descending`. Type: String Valid Values: `Ascending | Descending` Required: No ** [SourceArn](#API_ListAssociations_RequestSyntax) ** A filter that returns only associations with the specified source ARN. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:(experiment|experiment-trial-component|artifact|action|context)/.*` Required: No ** [SourceType](#API_ListAssociations_RequestSyntax) ** A filter that returns only associations with the specified source type. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Required: No ## Response Syntax ``` { "AssociationSummaries": [ { "AssociationType": "string", "CreatedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "DestinationArn": "string", "DestinationName": "string", "DestinationType": "string", "SourceArn": "string", "SourceName": "string", "SourceType": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AssociationSummaries](#API_ListAssociations_ResponseSyntax) ** A list of associations and their properties. Type: Array of [AssociationSummary](API_AssociationSummary.md) objects ** [NextToken](#API_ListAssociations_ResponseSyntax) ** A token for getting the next set of associations, if there are any. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListAssociations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListAssociations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListAssociations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListAssociations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListAssociations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListAssociations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListAssociations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListAssociations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListAssociations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListAssociations) # ListAutoMLJobs Request a list of jobs. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "LastModifiedTimeAfter": number, "LastModifiedTimeBefore": number, "MaxResults": number, "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string", "StatusEquals": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListAutoMLJobs_RequestSyntax) ** Request a list of jobs, using a filter for time. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListAutoMLJobs_RequestSyntax) ** Request a list of jobs, using a filter for time. Type: Timestamp Required: No ** [LastModifiedTimeAfter](#API_ListAutoMLJobs_RequestSyntax) ** Request a list of jobs, using a filter for time. Type: Timestamp Required: No ** [LastModifiedTimeBefore](#API_ListAutoMLJobs_RequestSyntax) ** Request a list of jobs, using a filter for time. Type: Timestamp Required: No ** [MaxResults](#API_ListAutoMLJobs_RequestSyntax) ** Request a list of jobs up to a specified limit. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NameContains](#API_ListAutoMLJobs_RequestSyntax) ** Request a list of jobs, using a search filter for name. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9\-]+` Required: No ** [NextToken](#API_ListAutoMLJobs_RequestSyntax) ** If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListAutoMLJobs_RequestSyntax) ** The parameter by which to sort the results. The default is `Name`. Type: String Valid Values: `Name | CreationTime | Status` Required: No ** [SortOrder](#API_ListAutoMLJobs_RequestSyntax) ** The sort order for the results. The default is `Descending`. Type: String Valid Values: `Ascending | Descending` Required: No ** [StatusEquals](#API_ListAutoMLJobs_RequestSyntax) ** Request a list of jobs, using a filter for status. Type: String Valid Values: `Completed | InProgress | Failed | Stopped | Stopping` Required: No ## Response Syntax ``` { "AutoMLJobSummaries": [ { "AutoMLJobArn": "string", "AutoMLJobName": "string", "AutoMLJobSecondaryStatus": "string", "AutoMLJobStatus": "string", "CreationTime": number, "EndTime": number, "FailureReason": "string", "LastModifiedTime": number, "PartialFailureReasons": [ { "PartialFailureMessage": "string" } ] } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AutoMLJobSummaries](#API_ListAutoMLJobs_ResponseSyntax) ** Returns a summary list of jobs. Type: Array of [AutoMLJobSummary](API_AutoMLJobSummary.md) objects ** [NextToken](#API_ListAutoMLJobs_ResponseSyntax) ** If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListAutoMLJobs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListAutoMLJobs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListAutoMLJobs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListAutoMLJobs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListAutoMLJobs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListAutoMLJobs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListAutoMLJobs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListAutoMLJobs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListAutoMLJobs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListAutoMLJobs) # ListCandidatesForAutoMLJob List the candidates created for the job. ## Request Syntax ``` { "AutoMLJobName": "string", "CandidateNameEquals": "string", "MaxResults": number, "NextToken": "string", "SortBy": "string", "SortOrder": "string", "StatusEquals": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AutoMLJobName](#API_ListCandidatesForAutoMLJob_RequestSyntax) ** List the candidates created for the job by providing the job's name. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}` Required: Yes ** [CandidateNameEquals](#API_ListCandidatesForAutoMLJob_RequestSyntax) ** List the candidates for the job and filter by candidate name. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No ** [MaxResults](#API_ListCandidatesForAutoMLJob_RequestSyntax) ** List the job's candidates up to a specified limit. Type: Integer Valid Range: Minimum value of 1. Maximum value of 300. Required: No ** [NextToken](#API_ListCandidatesForAutoMLJob_RequestSyntax) ** If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListCandidatesForAutoMLJob_RequestSyntax) ** The parameter by which to sort the results. The default is `Descending`. Type: String Valid Values: `CreationTime | Status | FinalObjectiveMetricValue` Required: No ** [SortOrder](#API_ListCandidatesForAutoMLJob_RequestSyntax) ** The sort order for the results. The default is `Ascending`. Type: String Valid Values: `Ascending | Descending` Required: No ** [StatusEquals](#API_ListCandidatesForAutoMLJob_RequestSyntax) ** List the candidates for the job and filter by status. Type: String Valid Values: `Completed | InProgress | Failed | Stopped | Stopping` Required: No ## Response Syntax ``` { "Candidates": [ { "CandidateName": "string", "CandidateProperties": { "CandidateArtifactLocations": { "BacktestResults": "string", "Explainability": "string", "ModelInsights": "string" }, "CandidateMetrics": [ { "MetricName": "string", "Set": "string", "StandardMetricName": "string", "Value": number } ] }, "CandidateStatus": "string", "CandidateSteps": [ { "CandidateStepArn": "string", "CandidateStepName": "string", "CandidateStepType": "string" } ], "CreationTime": number, "EndTime": number, "FailureReason": "string", "FinalAutoMLJobObjectiveMetric": { "MetricName": "string", "StandardMetricName": "string", "Type": "string", "Value": number }, "InferenceContainerDefinitions": { "string" : [ { "Environment": { "string" : "string" }, "Image": "string", "ModelDataUrl": "string" } ] }, "InferenceContainers": [ { "Environment": { "string" : "string" }, "Image": "string", "ModelDataUrl": "string" } ], "LastModifiedTime": number, "ObjectiveStatus": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Candidates](#API_ListCandidatesForAutoMLJob_ResponseSyntax) ** Summaries about the `AutoMLCandidates`. Type: Array of [AutoMLCandidate](API_AutoMLCandidate.md) objects ** [NextToken](#API_ListCandidatesForAutoMLJob_ResponseSyntax) ** If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListCandidatesForAutoMLJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListCandidatesForAutoMLJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListCandidatesForAutoMLJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListCandidatesForAutoMLJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListCandidatesForAutoMLJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListCandidatesForAutoMLJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListCandidatesForAutoMLJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListCandidatesForAutoMLJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListCandidatesForAutoMLJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListCandidatesForAutoMLJob) # ListClusterEvents Retrieves a list of event summaries for a specified HyperPod cluster. The operation supports filtering, sorting, and pagination of results. This functionality is only supported when the `NodeProvisioningMode` is set to `Continuous`. ## Request Syntax ``` { "ClusterName": "string", "EventTimeAfter": number, "EventTimeBefore": number, "InstanceGroupName": "string", "MaxResults": number, "NextToken": "string", "NodeId": "string", "ResourceType": "string", "SortBy": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClusterName](#API_ListClusterEvents_RequestSyntax) ** The name or Amazon Resource Name (ARN) of the HyperPod cluster for which to list events. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})` Required: Yes ** [EventTimeAfter](#API_ListClusterEvents_RequestSyntax) ** The start of the time range for filtering events. Only events that occurred after this time are included in the results. Type: Timestamp Required: No ** [EventTimeBefore](#API_ListClusterEvents_RequestSyntax) ** The end of the time range for filtering events. Only events that occurred before this time are included in the results. Type: Timestamp Required: No ** [InstanceGroupName](#API_ListClusterEvents_RequestSyntax) ** The name of the instance group to filter events. If specified, only events related to this instance group are returned. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9])*` Required: No ** [MaxResults](#API_ListClusterEvents_RequestSyntax) ** The maximum number of events to return in the response. Valid range is 1 to 100. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListClusterEvents_RequestSyntax) ** A token to retrieve the next set of results. This token is obtained from the output of a previous `ListClusterEvents` call. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [NodeId](#API_ListClusterEvents_RequestSyntax) ** The EC2 instance ID to filter events. If specified, only events related to this instance are returned. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `i-[a-f0-9]{8}(?:[a-f0-9]{9})?` Required: No ** [ResourceType](#API_ListClusterEvents_RequestSyntax) ** The type of resource for which to filter events. Valid values are `Cluster`, `InstanceGroup`, or `Instance`. Type: String Valid Values: `Cluster | InstanceGroup | Instance` Required: No ** [SortBy](#API_ListClusterEvents_RequestSyntax) ** The field to use for sorting the event list. Currently, the only supported value is `EventTime`. Type: String Valid Values: `EventTime` Required: No ** [SortOrder](#API_ListClusterEvents_RequestSyntax) ** The order in which to sort the results. Valid values are `Ascending` or `Descending` (the default is `Descending`). Type: String Valid Values: `Ascending | Descending` Required: No ## Response Syntax ``` { "Events": [ { "ClusterArn": "string", "ClusterName": "string", "Description": "string", "EventId": "string", "EventTime": number, "InstanceGroupName": "string", "InstanceId": "string", "ResourceType": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Events](#API_ListClusterEvents_ResponseSyntax) ** A list of event summaries matching the specified criteria. Type: Array of [ClusterEventSummary](API_ClusterEventSummary.md) objects Array Members: Minimum number of 0 items. Maximum number of 100 items. ** [NextToken](#API_ListClusterEvents_ResponseSyntax) ** A token to retrieve the next set of results. Include this token in subsequent `ListClusterEvents` calls to fetch more events. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListClusterEvents) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListClusterEvents) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListClusterEvents) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListClusterEvents) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListClusterEvents) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListClusterEvents) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListClusterEvents) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListClusterEvents) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListClusterEvents) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListClusterEvents) # ListClusterNodes Retrieves the list of instances (also called *nodes* interchangeably) in a SageMaker HyperPod cluster. ## Request Syntax ``` { "ClusterName": "string", "CreationTimeAfter": number, "CreationTimeBefore": number, "IncludeNodeLogicalIds": boolean, "InstanceGroupNameContains": "string", "MaxResults": number, "NextToken": "string", "SortBy": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClusterName](#API_ListClusterNodes_RequestSyntax) ** The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the list of nodes. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})` Required: Yes ** [CreationTimeAfter](#API_ListClusterNodes_RequestSyntax) ** A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time. Timestamps are formatted according to the ISO 8601 standard. Acceptable formats include: + `YYYY-MM-DDThh:mm:ss.sssTZD` (UTC), for example, `2014-10-01T20:30:00.000Z` + `YYYY-MM-DDThh:mm:ss.sssTZD` (with offset), for example, `2014-10-01T12:30:00.000-08:00` + `YYYY-MM-DD`, for example, `2014-10-01` + Unix time in seconds, for example, `1412195400`. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC. For more information about the timestamp format, see [Timestamp](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp) in the * AWS Command Line Interface User Guide*. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListClusterNodes_RequestSyntax) ** A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable formats are the same as the timestamp formats for `CreationTimeAfter`. For more information about the timestamp format, see [Timestamp](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp) in the * AWS Command Line Interface User Guide*. Type: Timestamp Required: No ** [IncludeNodeLogicalIds](#API_ListClusterNodes_RequestSyntax) ** Specifies whether to include nodes that are still being provisioned in the response. When set to true, the response includes all nodes regardless of their provisioning status. When set to `False` (default), only nodes with assigned `InstanceIds` are returned. Type: Boolean Required: No ** [InstanceGroupNameContains](#API_ListClusterNodes_RequestSyntax) ** A filter that returns the instance groups whose name contain a specified string. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9])*` Required: No ** [MaxResults](#API_ListClusterNodes_RequestSyntax) ** The maximum number of nodes to return in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListClusterNodes_RequestSyntax) ** If the result of the previous `ListClusterNodes` request was truncated, the response includes a `NextToken`. To retrieve the next set of cluster nodes, use the token in the next request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListClusterNodes_RequestSyntax) ** The field by which to sort results. The default value is `CREATION_TIME`. Type: String Valid Values: `CREATION_TIME | NAME` Required: No ** [SortOrder](#API_ListClusterNodes_RequestSyntax) ** The sort order for results. The default value is `Ascending`. Type: String Valid Values: `Ascending | Descending` Required: No ## Response Syntax ``` { "ClusterNodeSummaries": [ { "InstanceGroupName": "string", "InstanceId": "string", "InstanceStatus": { "Message": "string", "Status": "string" }, "InstanceType": "string", "LastSoftwareUpdateTime": number, "LaunchTime": number, "NodeLogicalId": "string", "PrivateDnsHostname": "string", "UltraServerInfo": { "Id": "string", "Type": "string" } } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ClusterNodeSummaries](#API_ListClusterNodes_ResponseSyntax) ** The summaries of listed instances in a SageMaker HyperPod cluster Type: Array of [ClusterNodeSummary](API_ClusterNodeSummary.md) objects ** [NextToken](#API_ListClusterNodes_ResponseSyntax) ** The next token specified for listing instances in a SageMaker HyperPod cluster. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListClusterNodes) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListClusterNodes) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListClusterNodes) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListClusterNodes) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListClusterNodes) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListClusterNodes) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListClusterNodes) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListClusterNodes) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListClusterNodes) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListClusterNodes) # ListClusters Retrieves the list of SageMaker HyperPod clusters. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "MaxResults": number, "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string", "TrainingPlanArn": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListClusters_RequestSyntax) ** Set a start time for the time range during which you want to list SageMaker HyperPod clusters. Timestamps are formatted according to the ISO 8601 standard. Acceptable formats include: + `YYYY-MM-DDThh:mm:ss.sssTZD` (UTC), for example, `2014-10-01T20:30:00.000Z` + `YYYY-MM-DDThh:mm:ss.sssTZD` (with offset), for example, `2014-10-01T12:30:00.000-08:00` + `YYYY-MM-DD`, for example, `2014-10-01` + Unix time in seconds, for example, `1412195400`. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC. For more information about the timestamp format, see [Timestamp](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp) in the * AWS Command Line Interface User Guide*. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListClusters_RequestSyntax) ** Set an end time for the time range during which you want to list SageMaker HyperPod clusters. A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable formats are the same as the timestamp formats for `CreationTimeAfter`. For more information about the timestamp format, see [Timestamp](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp) in the * AWS Command Line Interface User Guide*. Type: Timestamp Required: No ** [MaxResults](#API_ListClusters_RequestSyntax) ** Specifies the maximum number of clusters to evaluate for the operation (not necessarily the number of matching items). After SageMaker processes the number of clusters up to `MaxResults`, it stops the operation and returns the matching clusters up to that point. If all the matching clusters are desired, SageMaker will go through all the clusters until `NextToken` is empty. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NameContains](#API_ListClusters_RequestSyntax) ** Set the maximum number of instances to print in the list. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9\-]+` Required: No ** [NextToken](#API_ListClusters_RequestSyntax) ** Set the next token to retrieve the list of SageMaker HyperPod clusters. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListClusters_RequestSyntax) ** The field by which to sort results. The default value is `CREATION_TIME`. Type: String Valid Values: `CREATION_TIME | NAME` Required: No ** [SortOrder](#API_ListClusters_RequestSyntax) ** The sort order for results. The default value is `Ascending`. Type: String Valid Values: `Ascending | Descending` Required: No ** [TrainingPlanArn](#API_ListClusters_RequestSyntax) ** The Amazon Resource Name (ARN); of the training plan to filter clusters by. For more information about reserving GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see ` [CreateTrainingPlan](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingPlan.html) `. Type: String Length Constraints: Minimum length of 50. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:training-plan/.*` Required: No ## Response Syntax ``` { "ClusterSummaries": [ { "ClusterArn": "string", "ClusterName": "string", "ClusterStatus": "string", "CreationTime": number, "TrainingPlanArns": [ "string" ] } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ClusterSummaries](#API_ListClusters_ResponseSyntax) ** The summaries of listed SageMaker HyperPod clusters. Type: Array of [ClusterSummary](API_ClusterSummary.md) objects ** [NextToken](#API_ListClusters_ResponseSyntax) ** If the result of the previous `ListClusters` request was truncated, the response includes a `NextToken`. To retrieve the next set of clusters, use the token in the next request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListClusters) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListClusters) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListClusters) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListClusters) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListClusters) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListClusters) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListClusters) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListClusters) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListClusters) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListClusters) # ListClusterSchedulerConfigs List the cluster policy configurations. ## Request Syntax ``` { "ClusterArn": "string", "CreatedAfter": number, "CreatedBefore": number, "MaxResults": number, "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string", "Status": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClusterArn](#API_ListClusterSchedulerConfigs_RequestSyntax) ** Filter for ARN of the cluster. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12}` Required: No ** [CreatedAfter](#API_ListClusterSchedulerConfigs_RequestSyntax) ** Filter for after this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see [EpochConverter](https://www.epochconverter.com/). Type: Timestamp Required: No ** [CreatedBefore](#API_ListClusterSchedulerConfigs_RequestSyntax) ** Filter for before this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see [EpochConverter](https://www.epochconverter.com/). Type: Timestamp Required: No ** [MaxResults](#API_ListClusterSchedulerConfigs_RequestSyntax) ** The maximum number of cluster policies to list. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NameContains](#API_ListClusterSchedulerConfigs_RequestSyntax) ** Filter for name containing this string. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: No ** [NextToken](#API_ListClusterSchedulerConfigs_RequestSyntax) ** If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListClusterSchedulerConfigs_RequestSyntax) ** Filter for sorting the list by a given value. For example, sort by name, creation time, or status. Type: String Valid Values: `Name | CreationTime | Status` Required: No ** [SortOrder](#API_ListClusterSchedulerConfigs_RequestSyntax) ** The order of the list. By default, listed in `Descending` order according to by `SortBy`. To change the list order, you can specify `SortOrder` to be `Ascending`. Type: String Valid Values: `Ascending | Descending` Required: No ** [Status](#API_ListClusterSchedulerConfigs_RequestSyntax) ** Filter for status. Type: String Valid Values: `Creating | CreateFailed | CreateRollbackFailed | Created | Updating | UpdateFailed | UpdateRollbackFailed | Updated | Deleting | DeleteFailed | DeleteRollbackFailed | Deleted` Required: No ## Response Syntax ``` { "ClusterSchedulerConfigSummaries": [ { "ClusterArn": "string", "ClusterSchedulerConfigArn": "string", "ClusterSchedulerConfigId": "string", "ClusterSchedulerConfigVersion": number, "CreationTime": number, "LastModifiedTime": number, "Name": "string", "Status": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ClusterSchedulerConfigSummaries](#API_ListClusterSchedulerConfigs_ResponseSyntax) ** Summaries of the cluster policies. Type: Array of [ClusterSchedulerConfigSummary](API_ClusterSchedulerConfigSummary.md) objects Array Members: Minimum number of 0 items. Maximum number of 100 items. ** [NextToken](#API_ListClusterSchedulerConfigs_ResponseSyntax) ** If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListClusterSchedulerConfigs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListClusterSchedulerConfigs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListClusterSchedulerConfigs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListClusterSchedulerConfigs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListClusterSchedulerConfigs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListClusterSchedulerConfigs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListClusterSchedulerConfigs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListClusterSchedulerConfigs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListClusterSchedulerConfigs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListClusterSchedulerConfigs) # ListCodeRepositories Gets a list of the Git repositories in your account. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "LastModifiedTimeAfter": number, "LastModifiedTimeBefore": number, "MaxResults": number, "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListCodeRepositories_RequestSyntax) ** A filter that returns only Git repositories that were created after the specified time. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListCodeRepositories_RequestSyntax) ** A filter that returns only Git repositories that were created before the specified time. Type: Timestamp Required: No ** [LastModifiedTimeAfter](#API_ListCodeRepositories_RequestSyntax) ** A filter that returns only Git repositories that were last modified after the specified time. Type: Timestamp Required: No ** [LastModifiedTimeBefore](#API_ListCodeRepositories_RequestSyntax) ** A filter that returns only Git repositories that were last modified before the specified time. Type: Timestamp Required: No ** [MaxResults](#API_ListCodeRepositories_RequestSyntax) ** The maximum number of Git repositories to return in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NameContains](#API_ListCodeRepositories_RequestSyntax) ** A string in the Git repositories name. This filter returns only repositories whose name contains the specified string. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9-]+` Required: No ** [NextToken](#API_ListCodeRepositories_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListCodeRepositories_RequestSyntax) ** The field to sort results by. The default is `Name`. Type: String Valid Values: `Name | CreationTime | LastModifiedTime` Required: No ** [SortOrder](#API_ListCodeRepositories_RequestSyntax) ** The sort order for results. The default is `Ascending`. Type: String Valid Values: `Ascending | Descending` Required: No ## Response Syntax ``` { "CodeRepositorySummaryList": [ { "CodeRepositoryArn": "string", "CodeRepositoryName": "string", "CreationTime": number, "GitConfig": { "Branch": "string", "RepositoryUrl": "string", "SecretArn": "string" }, "LastModifiedTime": number } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CodeRepositorySummaryList](#API_ListCodeRepositories_ResponseSyntax) ** 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. Type: Array of [CodeRepositorySummary](API_CodeRepositorySummary.md) objects ** [NextToken](#API_ListCodeRepositories_ResponseSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListCodeRepositories) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListCodeRepositories) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListCodeRepositories) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListCodeRepositories) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListCodeRepositories) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListCodeRepositories) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListCodeRepositories) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListCodeRepositories) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListCodeRepositories) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListCodeRepositories) # ListCompilationJobs Lists model compilation jobs that satisfy various filters. To create a model compilation job, use [CreateCompilationJob](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateCompilationJob.html). To get information about a particular model compilation job you have created, use [DescribeCompilationJob](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeCompilationJob.html). ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "LastModifiedTimeAfter": number, "LastModifiedTimeBefore": number, "MaxResults": number, "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string", "StatusEquals": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListCompilationJobs_RequestSyntax) ** A filter that returns the model compilation jobs that were created after a specified time. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListCompilationJobs_RequestSyntax) ** A filter that returns the model compilation jobs that were created before a specified time. Type: Timestamp Required: No ** [LastModifiedTimeAfter](#API_ListCompilationJobs_RequestSyntax) ** A filter that returns the model compilation jobs that were modified after a specified time. Type: Timestamp Required: No ** [LastModifiedTimeBefore](#API_ListCompilationJobs_RequestSyntax) ** A filter that returns the model compilation jobs that were modified before a specified time. Type: Timestamp Required: No ** [MaxResults](#API_ListCompilationJobs_RequestSyntax) ** The maximum number of model compilation jobs to return in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NameContains](#API_ListCompilationJobs_RequestSyntax) ** A filter that returns the model compilation jobs whose name contains a specified string. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9\-]+` Required: No ** [NextToken](#API_ListCompilationJobs_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListCompilationJobs_RequestSyntax) ** The field by which to sort results. The default is `CreationTime`. Type: String Valid Values: `Name | CreationTime | Status` Required: No ** [SortOrder](#API_ListCompilationJobs_RequestSyntax) ** The sort order for results. The default is `Ascending`. Type: String Valid Values: `Ascending | Descending` Required: No ** [StatusEquals](#API_ListCompilationJobs_RequestSyntax) ** A filter that retrieves model compilation jobs with a specific `CompilationJobStatus` status. Type: String Valid Values: `INPROGRESS | COMPLETED | FAILED | STARTING | STOPPING | STOPPED` Required: No ## Response Syntax ``` { "CompilationJobSummaries": [ { "CompilationEndTime": number, "CompilationJobArn": "string", "CompilationJobName": "string", "CompilationJobStatus": "string", "CompilationStartTime": number, "CompilationTargetDevice": "string", "CompilationTargetPlatformAccelerator": "string", "CompilationTargetPlatformArch": "string", "CompilationTargetPlatformOs": "string", "CreationTime": number, "LastModifiedTime": number } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CompilationJobSummaries](#API_ListCompilationJobs_ResponseSyntax) ** An array of [CompilationJobSummary](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CompilationJobSummary.html) objects, each describing a model compilation job. Type: Array of [CompilationJobSummary](API_CompilationJobSummary.md) objects ** [NextToken](#API_ListCompilationJobs_ResponseSyntax) ** If the response is truncated, Amazon SageMaker AI returns this `NextToken`. To retrieve the next set of model compilation jobs, use this token in the next request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListCompilationJobs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListCompilationJobs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListCompilationJobs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListCompilationJobs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListCompilationJobs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListCompilationJobs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListCompilationJobs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListCompilationJobs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListCompilationJobs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListCompilationJobs) # ListComputeQuotas List the resource allocation definitions. ## Request Syntax ``` { "ClusterArn": "string", "CreatedAfter": number, "CreatedBefore": number, "MaxResults": number, "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string", "Status": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClusterArn](#API_ListComputeQuotas_RequestSyntax) ** Filter for ARN of the cluster. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12}` Required: No ** [CreatedAfter](#API_ListComputeQuotas_RequestSyntax) ** Filter for after this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see [EpochConverter](https://www.epochconverter.com/). Type: Timestamp Required: No ** [CreatedBefore](#API_ListComputeQuotas_RequestSyntax) ** Filter for before this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see [EpochConverter](https://www.epochconverter.com/). Type: Timestamp Required: No ** [MaxResults](#API_ListComputeQuotas_RequestSyntax) ** The maximum number of compute allocation definitions to list. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NameContains](#API_ListComputeQuotas_RequestSyntax) ** Filter for name containing this string. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: No ** [NextToken](#API_ListComputeQuotas_RequestSyntax) ** If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListComputeQuotas_RequestSyntax) ** Filter for sorting the list by a given value. For example, sort by name, creation time, or status. Type: String Valid Values: `Name | CreationTime | Status | ClusterArn` Required: No ** [SortOrder](#API_ListComputeQuotas_RequestSyntax) ** The order of the list. By default, listed in `Descending` order according to by `SortBy`. To change the list order, you can specify `SortOrder` to be `Ascending`. Type: String Valid Values: `Ascending | Descending` Required: No ** [Status](#API_ListComputeQuotas_RequestSyntax) ** Filter for status. Type: String Valid Values: `Creating | CreateFailed | CreateRollbackFailed | Created | Updating | UpdateFailed | UpdateRollbackFailed | Updated | Deleting | DeleteFailed | DeleteRollbackFailed | Deleted` Required: No ## Response Syntax ``` { "ComputeQuotaSummaries": [ { "ActivationState": "string", "ClusterArn": "string", "ComputeQuotaArn": "string", "ComputeQuotaConfig": { "ComputeQuotaResources": [ { "AcceleratorPartition": { "Count": number, "Type": "string" }, "Accelerators": number, "Count": number, "InstanceType": "string", "MemoryInGiB": number, "VCpu": number } ], "PreemptTeamTasks": "string", "ResourceSharingConfig": { "AbsoluteBorrowLimits": [ { "AcceleratorPartition": { "Count": number, "Type": "string" }, "Accelerators": number, "Count": number, "InstanceType": "string", "MemoryInGiB": number, "VCpu": number } ], "BorrowLimit": number, "Strategy": "string" } }, "ComputeQuotaId": "string", "ComputeQuotaTarget": { "FairShareWeight": number, "TeamName": "string" }, "ComputeQuotaVersion": number, "CreationTime": number, "LastModifiedTime": number, "Name": "string", "Status": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ComputeQuotaSummaries](#API_ListComputeQuotas_ResponseSyntax) ** Summaries of the compute allocation definitions. Type: Array of [ComputeQuotaSummary](API_ComputeQuotaSummary.md) objects Array Members: Minimum number of 0 items. Maximum number of 100 items. ** [NextToken](#API_ListComputeQuotas_ResponseSyntax) ** If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListComputeQuotas) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListComputeQuotas) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListComputeQuotas) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListComputeQuotas) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListComputeQuotas) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListComputeQuotas) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListComputeQuotas) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListComputeQuotas) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListComputeQuotas) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListComputeQuotas) # ListContexts Lists the contexts in your account and their properties. ## Request Syntax ``` { "ContextType": "string", "CreatedAfter": number, "CreatedBefore": number, "MaxResults": number, "NextToken": "string", "SortBy": "string", "SortOrder": "string", "SourceUri": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ContextType](#API_ListContexts_RequestSyntax) ** A filter that returns only contexts of the specified type. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Required: No ** [CreatedAfter](#API_ListContexts_RequestSyntax) ** A filter that returns only contexts created on or after the specified time. Type: Timestamp Required: No ** [CreatedBefore](#API_ListContexts_RequestSyntax) ** A filter that returns only contexts created on or before the specified time. Type: Timestamp Required: No ** [MaxResults](#API_ListContexts_RequestSyntax) ** The maximum number of contexts to return in the response. The default value is 10. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListContexts_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListContexts_RequestSyntax) ** The property used to sort results. The default value is `CreationTime`. Type: String Valid Values: `Name | CreationTime` Required: No ** [SortOrder](#API_ListContexts_RequestSyntax) ** The sort order. The default value is `Descending`. Type: String Valid Values: `Ascending | Descending` Required: No ** [SourceUri](#API_ListContexts_RequestSyntax) ** A filter that returns only contexts with the specified source URI. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `.*` Required: No ## Response Syntax ``` { "ContextSummaries": [ { "ContextArn": "string", "ContextName": "string", "ContextType": "string", "CreationTime": number, "LastModifiedTime": number, "Source": { "SourceId": "string", "SourceType": "string", "SourceUri": "string" } } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ContextSummaries](#API_ListContexts_ResponseSyntax) ** A list of contexts and their properties. Type: Array of [ContextSummary](API_ContextSummary.md) objects ** [NextToken](#API_ListContexts_ResponseSyntax) ** A token for getting the next set of contexts, if there are any. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListContexts) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListContexts) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListContexts) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListContexts) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListContexts) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListContexts) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListContexts) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListContexts) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListContexts) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListContexts) # ListDataQualityJobDefinitions Lists the data quality job definitions in your account. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "EndpointName": "string", "MaxResults": number, "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListDataQualityJobDefinitions_RequestSyntax) ** A filter that returns only data quality monitoring job definitions created after the specified time. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListDataQualityJobDefinitions_RequestSyntax) ** A filter that returns only data quality monitoring job definitions created before the specified time. Type: Timestamp Required: No ** [EndpointName](#API_ListDataQualityJobDefinitions_RequestSyntax) ** A filter that lists the data quality job definitions associated with the specified endpoint. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: No ** [MaxResults](#API_ListDataQualityJobDefinitions_RequestSyntax) ** The maximum number of data quality monitoring job definitions to return in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NameContains](#API_ListDataQualityJobDefinitions_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9\-]+` Required: No ** [NextToken](#API_ListDataQualityJobDefinitions_RequestSyntax) ** 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.> Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListDataQualityJobDefinitions_RequestSyntax) ** The field to sort results by. The default is `CreationTime`. Type: String Valid Values: `Name | CreationTime` Required: No ** [SortOrder](#API_ListDataQualityJobDefinitions_RequestSyntax) ** Whether to sort the results in `Ascending` or `Descending` order. The default is `Descending`. Type: String Valid Values: `Ascending | Descending` Required: No ## Response Syntax ``` { "JobDefinitionSummaries": [ { "CreationTime": number, "EndpointName": "string", "MonitoringJobDefinitionArn": "string", "MonitoringJobDefinitionName": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [JobDefinitionSummaries](#API_ListDataQualityJobDefinitions_ResponseSyntax) ** A list of data quality monitoring job definitions. Type: Array of [MonitoringJobDefinitionSummary](API_MonitoringJobDefinitionSummary.md) objects ** [NextToken](#API_ListDataQualityJobDefinitions_ResponseSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListDataQualityJobDefinitions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListDataQualityJobDefinitions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListDataQualityJobDefinitions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListDataQualityJobDefinitions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListDataQualityJobDefinitions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListDataQualityJobDefinitions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListDataQualityJobDefinitions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListDataQualityJobDefinitions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListDataQualityJobDefinitions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListDataQualityJobDefinitions) # ListDeviceFleets Returns a list of devices in the fleet. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "LastModifiedTimeAfter": number, "LastModifiedTimeBefore": number, "MaxResults": number, "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListDeviceFleets_RequestSyntax) ** Filter fleets where packaging job was created after specified time. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListDeviceFleets_RequestSyntax) ** Filter fleets where the edge packaging job was created before specified time. Type: Timestamp Required: No ** [LastModifiedTimeAfter](#API_ListDeviceFleets_RequestSyntax) ** Select fleets where the job was updated after X Type: Timestamp Required: No ** [LastModifiedTimeBefore](#API_ListDeviceFleets_RequestSyntax) ** Select fleets where the job was updated before X Type: Timestamp Required: No ** [MaxResults](#API_ListDeviceFleets_RequestSyntax) ** The maximum number of results to select. Type: Integer Valid Range: Maximum value of 100. Required: No ** [NameContains](#API_ListDeviceFleets_RequestSyntax) ** Filter for fleets containing this name in their fleet device name. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9\-]+` Required: No ** [NextToken](#API_ListDeviceFleets_RequestSyntax) ** The response from the last list when returning a list large enough to need tokening. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListDeviceFleets_RequestSyntax) ** The column to sort by. Type: String Valid Values: `NAME | CREATION_TIME | LAST_MODIFIED_TIME` Required: No ** [SortOrder](#API_ListDeviceFleets_RequestSyntax) ** What direction to sort in. Type: String Valid Values: `Ascending | Descending` Required: No ## Response Syntax ``` { "DeviceFleetSummaries": [ { "CreationTime": number, "DeviceFleetArn": "string", "DeviceFleetName": "string", "LastModifiedTime": number } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DeviceFleetSummaries](#API_ListDeviceFleets_ResponseSyntax) ** Summary of the device fleet. Type: Array of [DeviceFleetSummary](API_DeviceFleetSummary.md) objects ** [NextToken](#API_ListDeviceFleets_ResponseSyntax) ** The response from the last list when returning a list large enough to need tokening. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListDeviceFleets) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListDeviceFleets) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListDeviceFleets) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListDeviceFleets) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListDeviceFleets) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListDeviceFleets) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListDeviceFleets) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListDeviceFleets) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListDeviceFleets) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListDeviceFleets) # ListDevices A list of devices. ## Request Syntax ``` { "DeviceFleetName": "string", "LatestHeartbeatAfter": number, "MaxResults": number, "ModelName": "string", "NextToken": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DeviceFleetName](#API_ListDevices_RequestSyntax) ** Filter for fleets containing this name in their device fleet name. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: No ** [LatestHeartbeatAfter](#API_ListDevices_RequestSyntax) ** Select fleets where the job was updated after X Type: Timestamp Required: No ** [MaxResults](#API_ListDevices_RequestSyntax) ** Maximum number of results to select. Type: Integer Valid Range: Maximum value of 100. Required: No ** [ModelName](#API_ListDevices_RequestSyntax) ** A filter that searches devices that contains this name in any of their models. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: No ** [NextToken](#API_ListDevices_RequestSyntax) ** The response from the last list when returning a list large enough to need tokening. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ## Response Syntax ``` { "DeviceSummaries": [ { "AgentVersion": "string", "Description": "string", "DeviceArn": "string", "DeviceFleetName": "string", "DeviceName": "string", "IotThingName": "string", "LatestHeartbeat": number, "Models": [ { "ModelName": "string", "ModelVersion": "string" } ], "RegistrationTime": number } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DeviceSummaries](#API_ListDevices_ResponseSyntax) ** Summary of devices. Type: Array of [DeviceSummary](API_DeviceSummary.md) objects ** [NextToken](#API_ListDevices_ResponseSyntax) ** The response from the last list when returning a list large enough to need tokening. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListDevices) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListDevices) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListDevices) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListDevices) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListDevices) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListDevices) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListDevices) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListDevices) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListDevices) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListDevices) # ListDomains Lists the domains. ## Request Syntax ``` { "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [MaxResults](#API_ListDomains_RequestSyntax) ** This parameter defines the maximum number of results that can be return in a single response. The `MaxResults` parameter is an upper bound, not a target. If there are more results available than the value specified, a `NextToken` is provided in the response. The `NextToken` indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for `MaxResults` is 10. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListDomains_RequestSyntax) ** If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ## Response Syntax ``` { "Domains": [ { "CreationTime": number, "DomainArn": "string", "DomainId": "string", "DomainName": "string", "LastModifiedTime": number, "Status": "string", "Url": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Domains](#API_ListDomains_ResponseSyntax) ** The list of domains. Type: Array of [DomainDetails](API_DomainDetails.md) objects ** [NextToken](#API_ListDomains_ResponseSyntax) ** If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListDomains) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListDomains) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListDomains) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListDomains) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListDomains) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListDomains) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListDomains) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListDomains) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListDomains) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListDomains) # ListEdgeDeploymentPlans Lists all edge deployment plans. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "DeviceFleetNameContains": "string", "LastModifiedTimeAfter": number, "LastModifiedTimeBefore": number, "MaxResults": number, "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListEdgeDeploymentPlans_RequestSyntax) ** Selects edge deployment plans created after this time. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListEdgeDeploymentPlans_RequestSyntax) ** Selects edge deployment plans created before this time. Type: Timestamp Required: No ** [DeviceFleetNameContains](#API_ListEdgeDeploymentPlans_RequestSyntax) ** Selects edge deployment plans with a device fleet name containing this name. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9\-]+` Required: No ** [LastModifiedTimeAfter](#API_ListEdgeDeploymentPlans_RequestSyntax) ** Selects edge deployment plans that were last updated after this time. Type: Timestamp Required: No ** [LastModifiedTimeBefore](#API_ListEdgeDeploymentPlans_RequestSyntax) ** Selects edge deployment plans that were last updated before this time. Type: Timestamp Required: No ** [MaxResults](#API_ListEdgeDeploymentPlans_RequestSyntax) ** The maximum number of results to select (50 by default). Type: Integer Valid Range: Maximum value of 100. Required: No ** [NameContains](#API_ListEdgeDeploymentPlans_RequestSyntax) ** Selects edge deployment plans with names containing this name. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9\-]+` Required: No ** [NextToken](#API_ListEdgeDeploymentPlans_RequestSyntax) ** The response from the last list when returning a list large enough to need tokening. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListEdgeDeploymentPlans_RequestSyntax) ** The column by which to sort the edge deployment plans. Can be one of `NAME`, `DEVICEFLEETNAME`, `CREATIONTIME`, `LASTMODIFIEDTIME`. Type: String Valid Values: `NAME | DEVICE_FLEET_NAME | CREATION_TIME | LAST_MODIFIED_TIME` Required: No ** [SortOrder](#API_ListEdgeDeploymentPlans_RequestSyntax) ** The direction of the sorting (ascending or descending). Type: String Valid Values: `Ascending | Descending` Required: No ## Response Syntax ``` { "EdgeDeploymentPlanSummaries": [ { "CreationTime": number, "DeviceFleetName": "string", "EdgeDeploymentFailed": number, "EdgeDeploymentPending": number, "EdgeDeploymentPlanArn": "string", "EdgeDeploymentPlanName": "string", "EdgeDeploymentSuccess": number, "LastModifiedTime": number } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [EdgeDeploymentPlanSummaries](#API_ListEdgeDeploymentPlans_ResponseSyntax) ** List of summaries of edge deployment plans. Type: Array of [EdgeDeploymentPlanSummary](API_EdgeDeploymentPlanSummary.md) objects ** [NextToken](#API_ListEdgeDeploymentPlans_ResponseSyntax) ** The token to use when calling the next page of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListEdgeDeploymentPlans) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListEdgeDeploymentPlans) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListEdgeDeploymentPlans) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListEdgeDeploymentPlans) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListEdgeDeploymentPlans) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListEdgeDeploymentPlans) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListEdgeDeploymentPlans) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListEdgeDeploymentPlans) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListEdgeDeploymentPlans) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListEdgeDeploymentPlans) # ListEdgePackagingJobs Returns a list of edge packaging jobs. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "LastModifiedTimeAfter": number, "LastModifiedTimeBefore": number, "MaxResults": number, "ModelNameContains": "string", "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string", "StatusEquals": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListEdgePackagingJobs_RequestSyntax) ** Select jobs where the job was created after specified time. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListEdgePackagingJobs_RequestSyntax) ** Select jobs where the job was created before specified time. Type: Timestamp Required: No ** [LastModifiedTimeAfter](#API_ListEdgePackagingJobs_RequestSyntax) ** Select jobs where the job was updated after specified time. Type: Timestamp Required: No ** [LastModifiedTimeBefore](#API_ListEdgePackagingJobs_RequestSyntax) ** Select jobs where the job was updated before specified time. Type: Timestamp Required: No ** [MaxResults](#API_ListEdgePackagingJobs_RequestSyntax) ** Maximum number of results to select. Type: Integer Valid Range: Maximum value of 100. Required: No ** [ModelNameContains](#API_ListEdgePackagingJobs_RequestSyntax) ** Filter for jobs where the model name contains this string. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9\-]+` Required: No ** [NameContains](#API_ListEdgePackagingJobs_RequestSyntax) ** Filter for jobs containing this name in their packaging job name. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9\-]+` Required: No ** [NextToken](#API_ListEdgePackagingJobs_RequestSyntax) ** The response from the last list when returning a list large enough to need tokening. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListEdgePackagingJobs_RequestSyntax) ** Use to specify what column to sort by. Type: String Valid Values: `NAME | MODEL_NAME | CREATION_TIME | LAST_MODIFIED_TIME | STATUS` Required: No ** [SortOrder](#API_ListEdgePackagingJobs_RequestSyntax) ** What direction to sort by. Type: String Valid Values: `Ascending | Descending` Required: No ** [StatusEquals](#API_ListEdgePackagingJobs_RequestSyntax) ** The job status to filter for. Type: String Valid Values: `STARTING | INPROGRESS | COMPLETED | FAILED | STOPPING | STOPPED` Required: No ## Response Syntax ``` { "EdgePackagingJobSummaries": [ { "CompilationJobName": "string", "CreationTime": number, "EdgePackagingJobArn": "string", "EdgePackagingJobName": "string", "EdgePackagingJobStatus": "string", "LastModifiedTime": number, "ModelName": "string", "ModelVersion": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [EdgePackagingJobSummaries](#API_ListEdgePackagingJobs_ResponseSyntax) ** Summaries of edge packaging jobs. Type: Array of [EdgePackagingJobSummary](API_EdgePackagingJobSummary.md) objects ** [NextToken](#API_ListEdgePackagingJobs_ResponseSyntax) ** Token to use when calling the next page of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListEdgePackagingJobs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListEdgePackagingJobs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListEdgePackagingJobs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListEdgePackagingJobs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListEdgePackagingJobs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListEdgePackagingJobs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListEdgePackagingJobs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListEdgePackagingJobs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListEdgePackagingJobs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListEdgePackagingJobs) # ListEndpointConfigs Lists endpoint configurations. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "MaxResults": number, "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListEndpointConfigs_RequestSyntax) ** A filter that returns only endpoint configurations with a creation time greater than or equal to the specified time (timestamp). Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListEndpointConfigs_RequestSyntax) ** A filter that returns only endpoint configurations created before the specified time (timestamp). Type: Timestamp Required: No ** [MaxResults](#API_ListEndpointConfigs_RequestSyntax) ** The maximum number of training jobs to return in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NameContains](#API_ListEndpointConfigs_RequestSyntax) ** A string in the endpoint configuration name. This filter returns only endpoint configurations whose name contains the specified string. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9-]+` Required: No ** [NextToken](#API_ListEndpointConfigs_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListEndpointConfigs_RequestSyntax) ** The field to sort results by. The default is `CreationTime`. Type: String Valid Values: `Name | CreationTime` Required: No ** [SortOrder](#API_ListEndpointConfigs_RequestSyntax) ** The sort order for results. The default is `Descending`. Type: String Valid Values: `Ascending | Descending` Required: No ## Response Syntax ``` { "EndpointConfigs": [ { "CreationTime": number, "EndpointConfigArn": "string", "EndpointConfigName": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [EndpointConfigs](#API_ListEndpointConfigs_ResponseSyntax) ** An array of endpoint configurations. Type: Array of [EndpointConfigSummary](API_EndpointConfigSummary.md) objects ** [NextToken](#API_ListEndpointConfigs_ResponseSyntax) ** If the response is truncated, SageMaker returns this token. To retrieve the next set of endpoint configurations, use it in the subsequent request Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListEndpointConfigs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListEndpointConfigs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListEndpointConfigs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListEndpointConfigs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListEndpointConfigs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListEndpointConfigs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListEndpointConfigs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListEndpointConfigs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListEndpointConfigs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListEndpointConfigs) # ListEndpoints Lists endpoints. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "LastModifiedTimeAfter": number, "LastModifiedTimeBefore": number, "MaxResults": number, "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string", "StatusEquals": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListEndpoints_RequestSyntax) ** A filter that returns only endpoints with a creation time greater than or equal to the specified time (timestamp). Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListEndpoints_RequestSyntax) ** A filter that returns only endpoints that were created before the specified time (timestamp). Type: Timestamp Required: No ** [LastModifiedTimeAfter](#API_ListEndpoints_RequestSyntax) ** A filter that returns only endpoints that were modified after the specified timestamp. Type: Timestamp Required: No ** [LastModifiedTimeBefore](#API_ListEndpoints_RequestSyntax) ** A filter that returns only endpoints that were modified before the specified timestamp. Type: Timestamp Required: No ** [MaxResults](#API_ListEndpoints_RequestSyntax) ** The maximum number of endpoints to return in the response. This value defaults to 10. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NameContains](#API_ListEndpoints_RequestSyntax) ** A string in endpoint names. This filter returns only endpoints whose name contains the specified string. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9-]+` Required: No ** [NextToken](#API_ListEndpoints_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListEndpoints_RequestSyntax) ** Sorts the list of results. The default is `CreationTime`. Type: String Valid Values: `Name | CreationTime | Status` Required: No ** [SortOrder](#API_ListEndpoints_RequestSyntax) ** The sort order for results. The default is `Descending`. Type: String Valid Values: `Ascending | Descending` Required: No ** [StatusEquals](#API_ListEndpoints_RequestSyntax) ** A filter that returns only endpoints with the specified status. Type: String Valid Values: `OutOfService | Creating | Updating | SystemUpdating | RollingBack | InService | Deleting | Failed | UpdateRollbackFailed` Required: No ## Response Syntax ``` { "Endpoints": [ { "CreationTime": number, "EndpointArn": "string", "EndpointName": "string", "EndpointStatus": "string", "LastModifiedTime": number } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Endpoints](#API_ListEndpoints_ResponseSyntax) ** An array or endpoint objects. Type: Array of [EndpointSummary](API_EndpointSummary.md) objects ** [NextToken](#API_ListEndpoints_ResponseSyntax) ** If the response is truncated, SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListEndpoints) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListEndpoints) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListEndpoints) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListEndpoints) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListEndpoints) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListEndpoints) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListEndpoints) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListEndpoints) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListEndpoints) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListEndpoints) # ListExperiments 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. ## Request Syntax ``` { "CreatedAfter": number, "CreatedBefore": number, "MaxResults": number, "NextToken": "string", "SortBy": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreatedAfter](#API_ListExperiments_RequestSyntax) ** A filter that returns only experiments created after the specified time. Type: Timestamp Required: No ** [CreatedBefore](#API_ListExperiments_RequestSyntax) ** A filter that returns only experiments created before the specified time. Type: Timestamp Required: No ** [MaxResults](#API_ListExperiments_RequestSyntax) ** The maximum number of experiments to return in the response. The default value is 10. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListExperiments_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListExperiments_RequestSyntax) ** The property used to sort results. The default value is `CreationTime`. Type: String Valid Values: `Name | CreationTime` Required: No ** [SortOrder](#API_ListExperiments_RequestSyntax) ** The sort order. The default value is `Descending`. Type: String Valid Values: `Ascending | Descending` Required: No ## Response Syntax ``` { "ExperimentSummaries": [ { "CreationTime": number, "DisplayName": "string", "ExperimentArn": "string", "ExperimentName": "string", "ExperimentSource": { "SourceArn": "string", "SourceType": "string" }, "LastModifiedTime": number } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ExperimentSummaries](#API_ListExperiments_ResponseSyntax) ** A list of the summaries of your experiments. Type: Array of [ExperimentSummary](API_ExperimentSummary.md) objects ** [NextToken](#API_ListExperiments_ResponseSyntax) ** A token for getting the next set of experiments, if there are any. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListExperiments) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListExperiments) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListExperiments) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListExperiments) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListExperiments) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListExperiments) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListExperiments) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListExperiments) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListExperiments) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListExperiments) # ListFeatureGroups List `FeatureGroup`s based on given filter and order. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "FeatureGroupStatusEquals": "string", "MaxResults": number, "NameContains": "string", "NextToken": "string", "OfflineStoreStatusEquals": "string", "SortBy": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListFeatureGroups_RequestSyntax) ** Use this parameter to search for `FeatureGroups`s created after a specific date and time. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListFeatureGroups_RequestSyntax) ** Use this parameter to search for `FeatureGroups`s created before a specific date and time. Type: Timestamp Required: No ** [FeatureGroupStatusEquals](#API_ListFeatureGroups_RequestSyntax) ** A `FeatureGroup` status. Filters by `FeatureGroup` status. Type: String Valid Values: `Creating | Created | CreateFailed | Deleting | DeleteFailed` Required: No ** [MaxResults](#API_ListFeatureGroups_RequestSyntax) ** The maximum number of results returned by `ListFeatureGroups`. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NameContains](#API_ListFeatureGroups_RequestSyntax) ** A string that partially matches one or more `FeatureGroup`s names. Filters `FeatureGroup`s by name. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No ** [NextToken](#API_ListFeatureGroups_RequestSyntax) ** A token to resume pagination of `ListFeatureGroups` results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [OfflineStoreStatusEquals](#API_ListFeatureGroups_RequestSyntax) ** An `OfflineStore` status. Filters by `OfflineStore` status. Type: String Valid Values: `Active | Blocked | Disabled` Required: No ** [SortBy](#API_ListFeatureGroups_RequestSyntax) ** The value on which the feature group list is sorted. Type: String Valid Values: `Name | FeatureGroupStatus | OfflineStoreStatus | CreationTime` Required: No ** [SortOrder](#API_ListFeatureGroups_RequestSyntax) ** The order in which feature groups are listed. Type: String Valid Values: `Ascending | Descending` Required: No ## Response Syntax ``` { "FeatureGroupSummaries": [ { "CreationTime": number, "FeatureGroupArn": "string", "FeatureGroupName": "string", "FeatureGroupStatus": "string", "OfflineStoreStatus": { "BlockedReason": "string", "Status": "string" } } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [FeatureGroupSummaries](#API_ListFeatureGroups_ResponseSyntax) ** A summary of feature groups. Type: Array of [FeatureGroupSummary](API_FeatureGroupSummary.md) objects ** [NextToken](#API_ListFeatureGroups_ResponseSyntax) ** A token to resume pagination of `ListFeatureGroups` results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListFeatureGroups) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListFeatureGroups) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListFeatureGroups) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListFeatureGroups) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListFeatureGroups) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListFeatureGroups) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListFeatureGroups) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListFeatureGroups) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListFeatureGroups) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListFeatureGroups) # ListFlowDefinitions Returns information about the flow definitions in your account. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "MaxResults": number, "NextToken": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListFlowDefinitions_RequestSyntax) ** A filter that returns only flow definitions with a creation time greater than or equal to the specified timestamp. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListFlowDefinitions_RequestSyntax) ** A filter that returns only flow definitions that were created before the specified timestamp. Type: Timestamp Required: No ** [MaxResults](#API_ListFlowDefinitions_RequestSyntax) ** 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. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListFlowDefinitions_RequestSyntax) ** A token to resume pagination. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortOrder](#API_ListFlowDefinitions_RequestSyntax) ** An optional value that specifies whether you want the results sorted in `Ascending` or `Descending` order. Type: String Valid Values: `Ascending | Descending` Required: No ## Response Syntax ``` { "FlowDefinitionSummaries": [ { "CreationTime": number, "FailureReason": "string", "FlowDefinitionArn": "string", "FlowDefinitionName": "string", "FlowDefinitionStatus": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [FlowDefinitionSummaries](#API_ListFlowDefinitions_ResponseSyntax) ** An array of objects describing the flow definitions. Type: Array of [FlowDefinitionSummary](API_FlowDefinitionSummary.md) objects ** [NextToken](#API_ListFlowDefinitions_ResponseSyntax) ** A token to resume pagination. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListFlowDefinitions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListFlowDefinitions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListFlowDefinitions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListFlowDefinitions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListFlowDefinitions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListFlowDefinitions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListFlowDefinitions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListFlowDefinitions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListFlowDefinitions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListFlowDefinitions) # ListHubContents List the contents of a hub. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "HubContentType": "string", "HubName": "string", "MaxResults": number, "MaxSchemaVersion": "string", "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListHubContents_RequestSyntax) ** Only list hub content that was created after the time specified. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListHubContents_RequestSyntax) ** Only list hub content that was created before the time specified. Type: Timestamp Required: No ** [HubContentType](#API_ListHubContents_RequestSyntax) ** The type of hub content to list. Type: String Valid Values: `Model | Notebook | ModelReference | DataSet | JsonDoc` Required: Yes ** [HubName](#API_ListHubContents_RequestSyntax) ** The name of the hub to list the contents of. Type: String Pattern: `(arn:[a-z0-9-\.]{1,63}:sagemaker:\w+(?:-\w+)+:(\d{12}|aws):hub\/)?[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [MaxResults](#API_ListHubContents_RequestSyntax) ** The maximum amount of hub content to list. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [MaxSchemaVersion](#API_ListHubContents_RequestSyntax) ** The upper bound of the hub content schema verion. Type: String Length Constraints: Minimum length of 5. Maximum length of 14. Pattern: `\d{1,4}.\d{1,4}.\d{1,4}` Required: No ** [NameContains](#API_ListHubContents_RequestSyntax) ** Only list hub content if the name contains the specified string. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9\-]+` Required: No ** [NextToken](#API_ListHubContents_RequestSyntax) ** If the response to a previous `ListHubContents` request was truncated, the response includes a `NextToken`. To retrieve the next set of hub content, use the token in the next request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListHubContents_RequestSyntax) ** Sort hub content versions by either name or creation time. Type: String Valid Values: `HubContentName | CreationTime | HubContentStatus` Required: No ** [SortOrder](#API_ListHubContents_RequestSyntax) ** Sort hubs by ascending or descending order. Type: String Valid Values: `Ascending | Descending` Required: No ## Response Syntax ``` { "HubContentSummaries": [ { "CreationTime": number, "DocumentSchemaVersion": "string", "HubContentArn": "string", "HubContentDescription": "string", "HubContentDisplayName": "string", "HubContentName": "string", "HubContentSearchKeywords": [ "string" ], "HubContentStatus": "string", "HubContentType": "string", "HubContentVersion": "string", "OriginalCreationTime": number, "SageMakerPublicHubContentArn": "string", "SupportStatus": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [HubContentSummaries](#API_ListHubContents_ResponseSyntax) ** The summaries of the listed hub content. Type: Array of [HubContentInfo](API_HubContentInfo.md) objects ** [NextToken](#API_ListHubContents_ResponseSyntax) ** If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content, use it in the subsequent request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListHubContents) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListHubContents) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListHubContents) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListHubContents) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListHubContents) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListHubContents) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListHubContents) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListHubContents) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListHubContents) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListHubContents) # ListHubContentVersions List hub content versions. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "HubContentName": "string", "HubContentType": "string", "HubName": "string", "MaxResults": number, "MaxSchemaVersion": "string", "MinVersion": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListHubContentVersions_RequestSyntax) ** Only list hub content versions that were created after the time specified. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListHubContentVersions_RequestSyntax) ** Only list hub content versions that were created before the time specified. Type: Timestamp Required: No ** [HubContentName](#API_ListHubContentVersions_RequestSyntax) ** The name of the hub content. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [HubContentType](#API_ListHubContentVersions_RequestSyntax) ** The type of hub content to list versions of. Type: String Valid Values: `Model | Notebook | ModelReference | DataSet | JsonDoc` Required: Yes ** [HubName](#API_ListHubContentVersions_RequestSyntax) ** The name of the hub to list the content versions of. Type: String Pattern: `(arn:[a-z0-9-\.]{1,63}:sagemaker:\w+(?:-\w+)+:(\d{12}|aws):hub\/)?[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [MaxResults](#API_ListHubContentVersions_RequestSyntax) ** The maximum number of hub content versions to list. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [MaxSchemaVersion](#API_ListHubContentVersions_RequestSyntax) ** The upper bound of the hub content schema version. Type: String Length Constraints: Minimum length of 5. Maximum length of 14. Pattern: `\d{1,4}.\d{1,4}.\d{1,4}` Required: No ** [MinVersion](#API_ListHubContentVersions_RequestSyntax) ** The lower bound of the hub content versions to list. Type: String Length Constraints: Minimum length of 5. Maximum length of 14. Pattern: `\d{1,4}.\d{1,4}.\d{1,4}` Required: No ** [NextToken](#API_ListHubContentVersions_RequestSyntax) ** If the response to a previous `ListHubContentVersions` request was truncated, the response includes a `NextToken`. To retrieve the next set of hub content versions, use the token in the next request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListHubContentVersions_RequestSyntax) ** Sort hub content versions by either name or creation time. Type: String Valid Values: `HubContentName | CreationTime | HubContentStatus` Required: No ** [SortOrder](#API_ListHubContentVersions_RequestSyntax) ** Sort hub content versions by ascending or descending order. Type: String Valid Values: `Ascending | Descending` Required: No ## Response Syntax ``` { "HubContentSummaries": [ { "CreationTime": number, "DocumentSchemaVersion": "string", "HubContentArn": "string", "HubContentDescription": "string", "HubContentDisplayName": "string", "HubContentName": "string", "HubContentSearchKeywords": [ "string" ], "HubContentStatus": "string", "HubContentType": "string", "HubContentVersion": "string", "OriginalCreationTime": number, "SageMakerPublicHubContentArn": "string", "SupportStatus": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [HubContentSummaries](#API_ListHubContentVersions_ResponseSyntax) ** The summaries of the listed hub content versions. Type: Array of [HubContentInfo](API_HubContentInfo.md) objects ** [NextToken](#API_ListHubContentVersions_ResponseSyntax) ** If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content versions, use it in the subsequent request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListHubContentVersions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListHubContentVersions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListHubContentVersions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListHubContentVersions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListHubContentVersions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListHubContentVersions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListHubContentVersions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListHubContentVersions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListHubContentVersions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListHubContentVersions) # ListHubs List all existing hubs. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "LastModifiedTimeAfter": number, "LastModifiedTimeBefore": number, "MaxResults": number, "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListHubs_RequestSyntax) ** Only list hubs that were created after the time specified. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListHubs_RequestSyntax) ** Only list hubs that were created before the time specified. Type: Timestamp Required: No ** [LastModifiedTimeAfter](#API_ListHubs_RequestSyntax) ** Only list hubs that were last modified after the time specified. Type: Timestamp Required: No ** [LastModifiedTimeBefore](#API_ListHubs_RequestSyntax) ** Only list hubs that were last modified before the time specified. Type: Timestamp Required: No ** [MaxResults](#API_ListHubs_RequestSyntax) ** The maximum number of hubs to list. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NameContains](#API_ListHubs_RequestSyntax) ** Only list hubs with names that contain the specified string. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9\-]+` Required: No ** [NextToken](#API_ListHubs_RequestSyntax) ** If the response to a previous `ListHubs` request was truncated, the response includes a `NextToken`. To retrieve the next set of hubs, use the token in the next request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListHubs_RequestSyntax) ** Sort hubs by either name or creation time. Type: String Valid Values: `HubName | CreationTime | HubStatus | AccountIdOwner` Required: No ** [SortOrder](#API_ListHubs_RequestSyntax) ** Sort hubs by ascending or descending order. Type: String Valid Values: `Ascending | Descending` Required: No ## Response Syntax ``` { "HubSummaries": [ { "CreationTime": number, "HubArn": "string", "HubDescription": "string", "HubDisplayName": "string", "HubName": "string", "HubSearchKeywords": [ "string" ], "HubStatus": "string", "LastModifiedTime": number } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [HubSummaries](#API_ListHubs_ResponseSyntax) ** The summaries of the listed hubs. Type: Array of [HubInfo](API_HubInfo.md) objects ** [NextToken](#API_ListHubs_ResponseSyntax) ** If the response is truncated, SageMaker returns this token. To retrieve the next set of hubs, use it in the subsequent request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListHubs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListHubs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListHubs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListHubs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListHubs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListHubs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListHubs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListHubs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListHubs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListHubs) # ListHumanTaskUis Returns information about the human task user interfaces in your account. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "MaxResults": number, "NextToken": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListHumanTaskUis_RequestSyntax) ** A filter that returns only human task user interfaces with a creation time greater than or equal to the specified timestamp. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListHumanTaskUis_RequestSyntax) ** A filter that returns only human task user interfaces that were created before the specified timestamp. Type: Timestamp Required: No ** [MaxResults](#API_ListHumanTaskUis_RequestSyntax) ** 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. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListHumanTaskUis_RequestSyntax) ** A token to resume pagination. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortOrder](#API_ListHumanTaskUis_RequestSyntax) ** An optional value that specifies whether you want the results sorted in `Ascending` or `Descending` order. Type: String Valid Values: `Ascending | Descending` Required: No ## Response Syntax ``` { "HumanTaskUiSummaries": [ { "CreationTime": number, "HumanTaskUiArn": "string", "HumanTaskUiName": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [HumanTaskUiSummaries](#API_ListHumanTaskUis_ResponseSyntax) ** An array of objects describing the human task user interfaces. Type: Array of [HumanTaskUiSummary](API_HumanTaskUiSummary.md) objects ** [NextToken](#API_ListHumanTaskUis_ResponseSyntax) ** A token to resume pagination. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListHumanTaskUis) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListHumanTaskUis) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListHumanTaskUis) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListHumanTaskUis) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListHumanTaskUis) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListHumanTaskUis) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListHumanTaskUis) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListHumanTaskUis) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListHumanTaskUis) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListHumanTaskUis) # ListHyperParameterTuningJobs Gets a list of [HyperParameterTuningJobSummary](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobSummary.html) objects that describe the hyperparameter tuning jobs launched in your account. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "LastModifiedTimeAfter": number, "LastModifiedTimeBefore": number, "MaxResults": number, "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string", "StatusEquals": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListHyperParameterTuningJobs_RequestSyntax) ** A filter that returns only tuning jobs that were created after the specified time. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListHyperParameterTuningJobs_RequestSyntax) ** A filter that returns only tuning jobs that were created before the specified time. Type: Timestamp Required: No ** [LastModifiedTimeAfter](#API_ListHyperParameterTuningJobs_RequestSyntax) ** A filter that returns only tuning jobs that were modified after the specified time. Type: Timestamp Required: No ** [LastModifiedTimeBefore](#API_ListHyperParameterTuningJobs_RequestSyntax) ** A filter that returns only tuning jobs that were modified before the specified time. Type: Timestamp Required: No ** [MaxResults](#API_ListHyperParameterTuningJobs_RequestSyntax) ** The maximum number of tuning jobs to return. The default value is 10. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NameContains](#API_ListHyperParameterTuningJobs_RequestSyntax) ** A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9\-]+` Required: No ** [NextToken](#API_ListHyperParameterTuningJobs_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListHyperParameterTuningJobs_RequestSyntax) ** The field to sort results by. The default is `Name`. Type: String Valid Values: `Name | Status | CreationTime` Required: No ** [SortOrder](#API_ListHyperParameterTuningJobs_RequestSyntax) ** The sort order for results. The default is `Ascending`. Type: String Valid Values: `Ascending | Descending` Required: No ** [StatusEquals](#API_ListHyperParameterTuningJobs_RequestSyntax) ** A filter that returns only tuning jobs with the specified status. Type: String Valid Values: `Completed | InProgress | Failed | Stopped | Stopping | Deleting | DeleteFailed` Required: No ## Response Syntax ``` { "HyperParameterTuningJobSummaries": [ { "CreationTime": number, "HyperParameterTuningEndTime": number, "HyperParameterTuningJobArn": "string", "HyperParameterTuningJobName": "string", "HyperParameterTuningJobStatus": "string", "LastModifiedTime": number, "ObjectiveStatusCounters": { "Failed": number, "Pending": number, "Succeeded": number }, "ResourceLimits": { "MaxNumberOfTrainingJobs": number, "MaxParallelTrainingJobs": number, "MaxRuntimeInSeconds": number }, "Strategy": "string", "TrainingJobStatusCounters": { "Completed": number, "InProgress": number, "NonRetryableError": number, "RetryableError": number, "Stopped": number } } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [HyperParameterTuningJobSummaries](#API_ListHyperParameterTuningJobs_ResponseSyntax) ** A list of [HyperParameterTuningJobSummary](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobSummary.html) objects that describe the tuning jobs that the `ListHyperParameterTuningJobs` request returned. Type: Array of [HyperParameterTuningJobSummary](API_HyperParameterTuningJobSummary.md) objects ** [NextToken](#API_ListHyperParameterTuningJobs_ResponseSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListHyperParameterTuningJobs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListHyperParameterTuningJobs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListHyperParameterTuningJobs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListHyperParameterTuningJobs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListHyperParameterTuningJobs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListHyperParameterTuningJobs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListHyperParameterTuningJobs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListHyperParameterTuningJobs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListHyperParameterTuningJobs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListHyperParameterTuningJobs) # ListImages 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. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "LastModifiedTimeAfter": number, "LastModifiedTimeBefore": number, "MaxResults": number, "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListImages_RequestSyntax) ** A filter that returns only images created on or after the specified time. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListImages_RequestSyntax) ** A filter that returns only images created on or before the specified time. Type: Timestamp Required: No ** [LastModifiedTimeAfter](#API_ListImages_RequestSyntax) ** A filter that returns only images modified on or after the specified time. Type: Timestamp Required: No ** [LastModifiedTimeBefore](#API_ListImages_RequestSyntax) ** A filter that returns only images modified on or before the specified time. Type: Timestamp Required: No ** [MaxResults](#API_ListImages_RequestSyntax) ** The maximum number of images to return in the response. The default value is 10. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NameContains](#API_ListImages_RequestSyntax) ** A filter that returns only images whose name contains the specified string. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9\-.]+` Required: No ** [NextToken](#API_ListImages_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListImages_RequestSyntax) ** The property used to sort results. The default value is `CREATION_TIME`. Type: String Valid Values: `CREATION_TIME | LAST_MODIFIED_TIME | IMAGE_NAME` Required: No ** [SortOrder](#API_ListImages_RequestSyntax) ** The sort order. The default value is `DESCENDING`. Type: String Valid Values: `ASCENDING | DESCENDING` Required: No ## Response Syntax ``` { "Images": [ { "CreationTime": number, "Description": "string", "DisplayName": "string", "FailureReason": "string", "ImageArn": "string", "ImageName": "string", "ImageStatus": "string", "LastModifiedTime": number } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Images](#API_ListImages_ResponseSyntax) ** A list of images and their properties. Type: Array of [Image](API_Image.md) objects ** [NextToken](#API_ListImages_ResponseSyntax) ** A token for getting the next set of images, if there are any. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListImages) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListImages) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListImages) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListImages) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListImages) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListImages) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListImages) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListImages) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListImages) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListImages) # ListImageVersions Lists the versions of a specified image and their properties. The list can be filtered by creation time or modified time. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "ImageName": "string", "LastModifiedTimeAfter": number, "LastModifiedTimeBefore": number, "MaxResults": number, "NextToken": "string", "SortBy": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListImageVersions_RequestSyntax) ** A filter that returns only versions created on or after the specified time. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListImageVersions_RequestSyntax) ** A filter that returns only versions created on or before the specified time. Type: Timestamp Required: No ** [ImageName](#API_ListImageVersions_RequestSyntax) ** The name of the image to list the versions of. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}` Required: Yes ** [LastModifiedTimeAfter](#API_ListImageVersions_RequestSyntax) ** A filter that returns only versions modified on or after the specified time. Type: Timestamp Required: No ** [LastModifiedTimeBefore](#API_ListImageVersions_RequestSyntax) ** A filter that returns only versions modified on or before the specified time. Type: Timestamp Required: No ** [MaxResults](#API_ListImageVersions_RequestSyntax) ** The maximum number of versions to return in the response. The default value is 10. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListImageVersions_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListImageVersions_RequestSyntax) ** The property used to sort results. The default value is `CREATION_TIME`. Type: String Valid Values: `CREATION_TIME | LAST_MODIFIED_TIME | VERSION` Required: No ** [SortOrder](#API_ListImageVersions_RequestSyntax) ** The sort order. The default value is `DESCENDING`. Type: String Valid Values: `ASCENDING | DESCENDING` Required: No ## Response Syntax ``` { "ImageVersions": [ { "CreationTime": number, "FailureReason": "string", "ImageArn": "string", "ImageVersionArn": "string", "ImageVersionStatus": "string", "LastModifiedTime": number, "Version": number } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ImageVersions](#API_ListImageVersions_ResponseSyntax) ** A list of versions and their properties. Type: Array of [ImageVersion](API_ImageVersion.md) objects ** [NextToken](#API_ListImageVersions_ResponseSyntax) ** A token for getting the next set of versions, if there are any. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListImageVersions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListImageVersions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListImageVersions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListImageVersions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListImageVersions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListImageVersions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListImageVersions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListImageVersions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListImageVersions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListImageVersions) # ListInferenceComponents Lists the inference components in your account and their properties. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "EndpointNameEquals": "string", "LastModifiedTimeAfter": number, "LastModifiedTimeBefore": number, "MaxResults": number, "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string", "StatusEquals": "string", "VariantNameEquals": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListInferenceComponents_RequestSyntax) ** Filters the results to only those inference components that were created after the specified time. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListInferenceComponents_RequestSyntax) ** Filters the results to only those inference components that were created before the specified time. Type: Timestamp Required: No ** [EndpointNameEquals](#API_ListInferenceComponents_RequestSyntax) ** An endpoint name to filter the listed inference components. The response includes only those inference components that are hosted at the specified endpoint. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: No ** [LastModifiedTimeAfter](#API_ListInferenceComponents_RequestSyntax) ** Filters the results to only those inference components that were updated after the specified time. Type: Timestamp Required: No ** [LastModifiedTimeBefore](#API_ListInferenceComponents_RequestSyntax) ** Filters the results to only those inference components that were updated before the specified time. Type: Timestamp Required: No ** [MaxResults](#API_ListInferenceComponents_RequestSyntax) ** The maximum number of inference components to return in the response. This value defaults to 10. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NameContains](#API_ListInferenceComponents_RequestSyntax) ** Filters the results to only those inference components with a name that contains the specified string. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9-]+` Required: No ** [NextToken](#API_ListInferenceComponents_RequestSyntax) ** A token that you use to get the next set of results following a truncated response. If the response to the previous request was truncated, that response provides the value for this token. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListInferenceComponents_RequestSyntax) ** The field by which to sort the inference components in the response. The default is `CreationTime`. Type: String Valid Values: `Name | CreationTime | Status` Required: No ** [SortOrder](#API_ListInferenceComponents_RequestSyntax) ** The sort order for results. The default is `Descending`. Type: String Valid Values: `Ascending | Descending` Required: No ** [StatusEquals](#API_ListInferenceComponents_RequestSyntax) ** Filters the results to only those inference components with the specified status. Type: String Valid Values: `InService | Creating | Updating | Failed | Deleting` Required: No ** [VariantNameEquals](#API_ListInferenceComponents_RequestSyntax) ** A production variant name to filter the listed inference components. The response includes only those inference components that are hosted at the specified variant. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: No ## Response Syntax ``` { "InferenceComponents": [ { "CreationTime": number, "EndpointArn": "string", "EndpointName": "string", "InferenceComponentArn": "string", "InferenceComponentName": "string", "InferenceComponentStatus": "string", "LastModifiedTime": number, "VariantName": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [InferenceComponents](#API_ListInferenceComponents_ResponseSyntax) ** A list of inference components and their properties that matches any of the filters you specified in the request. Type: Array of [InferenceComponentSummary](API_InferenceComponentSummary.md) objects ** [NextToken](#API_ListInferenceComponents_ResponseSyntax) ** The token to use in a subsequent request to get the next set of results following a truncated response. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListInferenceComponents) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListInferenceComponents) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListInferenceComponents) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListInferenceComponents) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListInferenceComponents) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListInferenceComponents) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListInferenceComponents) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListInferenceComponents) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListInferenceComponents) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListInferenceComponents) # ListInferenceExperiments Returns the list of all inference experiments. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "LastModifiedTimeAfter": number, "LastModifiedTimeBefore": number, "MaxResults": number, "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string", "StatusEquals": "string", "Type": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListInferenceExperiments_RequestSyntax) ** Selects inference experiments which were created after this timestamp. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListInferenceExperiments_RequestSyntax) ** Selects inference experiments which were created before this timestamp. Type: Timestamp Required: No ** [LastModifiedTimeAfter](#API_ListInferenceExperiments_RequestSyntax) ** Selects inference experiments which were last modified after this timestamp. Type: Timestamp Required: No ** [LastModifiedTimeBefore](#API_ListInferenceExperiments_RequestSyntax) ** Selects inference experiments which were last modified before this timestamp. Type: Timestamp Required: No ** [MaxResults](#API_ListInferenceExperiments_RequestSyntax) ** The maximum number of results to select. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NameContains](#API_ListInferenceExperiments_RequestSyntax) ** Selects inference experiments whose names contain this name. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9\-]+` Required: No ** [NextToken](#API_ListInferenceExperiments_RequestSyntax) ** The response from the last list when returning a list large enough to need tokening. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListInferenceExperiments_RequestSyntax) ** The column by which to sort the listed inference experiments. Type: String Valid Values: `Name | CreationTime | Status` Required: No ** [SortOrder](#API_ListInferenceExperiments_RequestSyntax) ** The direction of sorting (ascending or descending). Type: String Valid Values: `Ascending | Descending` Required: No ** [StatusEquals](#API_ListInferenceExperiments_RequestSyntax) ** Selects inference experiments which are in this status. For the possible statuses, see [DescribeInferenceExperiment](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeInferenceExperiment.html). Type: String Valid Values: `Creating | Created | Updating | Running | Starting | Stopping | Completed | Cancelled` Required: No ** [Type](#API_ListInferenceExperiments_RequestSyntax) ** Selects inference experiments of this type. For the possible types of inference experiments, see [CreateInferenceExperiment](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateInferenceExperiment.html). Type: String Valid Values: `ShadowMode` Required: No ## Response Syntax ``` { "InferenceExperiments": [ { "CompletionTime": number, "CreationTime": number, "Description": "string", "LastModifiedTime": number, "Name": "string", "RoleArn": "string", "Schedule": { "EndTime": number, "StartTime": number }, "Status": "string", "StatusReason": "string", "Type": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [InferenceExperiments](#API_ListInferenceExperiments_ResponseSyntax) ** List of inference experiments. Type: Array of [InferenceExperimentSummary](API_InferenceExperimentSummary.md) objects ** [NextToken](#API_ListInferenceExperiments_ResponseSyntax) ** The token to use when calling the next page of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListInferenceExperiments) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListInferenceExperiments) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListInferenceExperiments) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListInferenceExperiments) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListInferenceExperiments) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListInferenceExperiments) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListInferenceExperiments) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListInferenceExperiments) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListInferenceExperiments) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListInferenceExperiments) # ListInferenceRecommendationsJobs Lists recommendation jobs that satisfy various filters. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "LastModifiedTimeAfter": number, "LastModifiedTimeBefore": number, "MaxResults": number, "ModelNameEquals": "string", "ModelPackageVersionArnEquals": "string", "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string", "StatusEquals": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListInferenceRecommendationsJobs_RequestSyntax) ** A filter that returns only jobs created after the specified time (timestamp). Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListInferenceRecommendationsJobs_RequestSyntax) ** A filter that returns only jobs created before the specified time (timestamp). Type: Timestamp Required: No ** [LastModifiedTimeAfter](#API_ListInferenceRecommendationsJobs_RequestSyntax) ** A filter that returns only jobs that were last modified after the specified time (timestamp). Type: Timestamp Required: No ** [LastModifiedTimeBefore](#API_ListInferenceRecommendationsJobs_RequestSyntax) ** A filter that returns only jobs that were last modified before the specified time (timestamp). Type: Timestamp Required: No ** [MaxResults](#API_ListInferenceRecommendationsJobs_RequestSyntax) ** The maximum number of recommendations to return in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [ModelNameEquals](#API_ListInferenceRecommendationsJobs_RequestSyntax) ** A filter that returns only jobs that were created for this model. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9]([\-a-zA-Z0-9]*[a-zA-Z0-9])?` Required: No ** [ModelPackageVersionArnEquals](#API_ListInferenceRecommendationsJobs_RequestSyntax) ** A filter that returns only jobs that were created for this versioned model package. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:model-package/[\S]{1,2048}` Required: No ** [NameContains](#API_ListInferenceRecommendationsJobs_RequestSyntax) ** A string in the job name. This filter returns only recommendations whose name contains the specified string. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9\-]+` Required: No ** [NextToken](#API_ListInferenceRecommendationsJobs_RequestSyntax) ** If the response to a previous `ListInferenceRecommendationsJobsRequest` request was truncated, the response includes a `NextToken`. To retrieve the next set of recommendations, use the token in the next request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListInferenceRecommendationsJobs_RequestSyntax) ** The parameter by which to sort the results. Type: String Valid Values: `Name | CreationTime | Status` Required: No ** [SortOrder](#API_ListInferenceRecommendationsJobs_RequestSyntax) ** The sort order for the results. Type: String Valid Values: `Ascending | Descending` Required: No ** [StatusEquals](#API_ListInferenceRecommendationsJobs_RequestSyntax) ** A filter that retrieves only inference recommendations jobs with a specific status. Type: String Valid Values: `PENDING | IN_PROGRESS | COMPLETED | FAILED | STOPPING | STOPPED | DELETING | DELETED` Required: No ## Response Syntax ``` { "InferenceRecommendationsJobs": [ { "CompletionTime": number, "CreationTime": number, "FailureReason": "string", "JobArn": "string", "JobDescription": "string", "JobName": "string", "JobType": "string", "LastModifiedTime": number, "ModelName": "string", "ModelPackageVersionArn": "string", "RoleArn": "string", "SamplePayloadUrl": "string", "Status": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [InferenceRecommendationsJobs](#API_ListInferenceRecommendationsJobs_ResponseSyntax) ** The recommendations created from the Amazon SageMaker Inference Recommender job. Type: Array of [InferenceRecommendationsJob](API_InferenceRecommendationsJob.md) objects ** [NextToken](#API_ListInferenceRecommendationsJobs_ResponseSyntax) ** A token for getting the next set of recommendations, if there are any. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListInferenceRecommendationsJobs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListInferenceRecommendationsJobs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListInferenceRecommendationsJobs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListInferenceRecommendationsJobs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListInferenceRecommendationsJobs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListInferenceRecommendationsJobs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListInferenceRecommendationsJobs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListInferenceRecommendationsJobs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListInferenceRecommendationsJobs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListInferenceRecommendationsJobs) # ListInferenceRecommendationsJobSteps Returns a list of the subtasks for an Inference Recommender job. The supported subtasks are benchmarks, which evaluate the performance of your model on different instance types. ## Request Syntax ``` { "JobName": "string", "MaxResults": number, "NextToken": "string", "Status": "string", "StepType": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [JobName](#API_ListInferenceRecommendationsJobSteps_RequestSyntax) ** The name for the Inference Recommender job. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}` Required: Yes ** [MaxResults](#API_ListInferenceRecommendationsJobSteps_RequestSyntax) ** The maximum number of results to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListInferenceRecommendationsJobSteps_RequestSyntax) ** A token that you can specify to return more results from the list. Specify this field if you have a token that was returned from a previous request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [Status](#API_ListInferenceRecommendationsJobSteps_RequestSyntax) ** A filter to return benchmarks of a specified status. If this field is left empty, then all benchmarks are returned. Type: String Valid Values: `PENDING | IN_PROGRESS | COMPLETED | FAILED | STOPPING | STOPPED | DELETING | DELETED` Required: No ** [StepType](#API_ListInferenceRecommendationsJobSteps_RequestSyntax) ** A filter to return details about the specified type of subtask. `BENCHMARK`: Evaluate the performance of your model on different instance types. Type: String Valid Values: `BENCHMARK` Required: No ## Response Syntax ``` { "NextToken": "string", "Steps": [ { "InferenceBenchmark": { "EndpointConfiguration": { "EndpointName": "string", "InitialInstanceCount": number, "InstanceType": "string", "ServerlessConfig": { "MaxConcurrency": number, "MemorySizeInMB": number, "ProvisionedConcurrency": number }, "VariantName": "string" }, "EndpointMetrics": { "MaxInvocations": number, "ModelLatency": number }, "FailureReason": "string", "InvocationEndTime": number, "InvocationStartTime": number, "Metrics": { "CostPerHour": number, "CostPerInference": number, "CpuUtilization": number, "MaxInvocations": number, "MemoryUtilization": number, "ModelLatency": number, "ModelSetupTime": number }, "ModelConfiguration": { "CompilationJobName": "string", "EnvironmentParameters": [ { "Key": "string", "Value": "string", "ValueType": "string" } ], "InferenceSpecificationName": "string" } }, "JobName": "string", "Status": "string", "StepType": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListInferenceRecommendationsJobSteps_ResponseSyntax) ** A token that you can specify in your next request to return more results from the list. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ** [Steps](#API_ListInferenceRecommendationsJobSteps_ResponseSyntax) ** A list of all subtask details in Inference Recommender. Type: Array of [InferenceRecommendationsJobStep](API_InferenceRecommendationsJobStep.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListInferenceRecommendationsJobSteps) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListInferenceRecommendationsJobSteps) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListInferenceRecommendationsJobSteps) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListInferenceRecommendationsJobSteps) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListInferenceRecommendationsJobSteps) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListInferenceRecommendationsJobSteps) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListInferenceRecommendationsJobSteps) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListInferenceRecommendationsJobSteps) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListInferenceRecommendationsJobSteps) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListInferenceRecommendationsJobSteps) # ListLabelingJobs Gets a list of labeling jobs. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "LastModifiedTimeAfter": number, "LastModifiedTimeBefore": number, "MaxResults": number, "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string", "StatusEquals": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListLabelingJobs_RequestSyntax) ** A filter that returns only labeling jobs created after the specified time (timestamp). Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListLabelingJobs_RequestSyntax) ** A filter that returns only labeling jobs created before the specified time (timestamp). Type: Timestamp Required: No ** [LastModifiedTimeAfter](#API_ListLabelingJobs_RequestSyntax) ** A filter that returns only labeling jobs modified after the specified time (timestamp). Type: Timestamp Required: No ** [LastModifiedTimeBefore](#API_ListLabelingJobs_RequestSyntax) ** A filter that returns only labeling jobs modified before the specified time (timestamp). Type: Timestamp Required: No ** [MaxResults](#API_ListLabelingJobs_RequestSyntax) ** The maximum number of labeling jobs to return in each page of the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NameContains](#API_ListLabelingJobs_RequestSyntax) ** A string in the labeling job name. This filter returns only labeling jobs whose name contains the specified string. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9\-]+` Required: No ** [NextToken](#API_ListLabelingJobs_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListLabelingJobs_RequestSyntax) ** The field to sort results by. The default is `CreationTime`. Type: String Valid Values: `Name | CreationTime | Status` Required: No ** [SortOrder](#API_ListLabelingJobs_RequestSyntax) ** The sort order for results. The default is `Ascending`. Type: String Valid Values: `Ascending | Descending` Required: No ** [StatusEquals](#API_ListLabelingJobs_RequestSyntax) ** A filter that retrieves only labeling jobs with a specific status. Type: String Valid Values: `Initializing | InProgress | Completed | Failed | Stopping | Stopped` Required: No ## Response Syntax ``` { "LabelingJobSummaryList": [ { "AnnotationConsolidationLambdaArn": "string", "CreationTime": number, "FailureReason": "string", "InputConfig": { "DataAttributes": { "ContentClassifiers": [ "string" ] }, "DataSource": { "S3DataSource": { "ManifestS3Uri": "string" }, "SnsDataSource": { "SnsTopicArn": "string" } } }, "LabelCounters": { "FailedNonRetryableError": number, "HumanLabeled": number, "MachineLabeled": number, "TotalLabeled": number, "Unlabeled": number }, "LabelingJobArn": "string", "LabelingJobName": "string", "LabelingJobOutput": { "FinalActiveLearningModelArn": "string", "OutputDatasetS3Uri": "string" }, "LabelingJobStatus": "string", "LastModifiedTime": number, "PreHumanTaskLambdaArn": "string", "WorkteamArn": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [LabelingJobSummaryList](#API_ListLabelingJobs_ResponseSyntax) ** An array of `LabelingJobSummary` objects, each describing a labeling job. Type: Array of [LabelingJobSummary](API_LabelingJobSummary.md) objects ** [NextToken](#API_ListLabelingJobs_ResponseSyntax) ** If the response is truncated, SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListLabelingJobs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListLabelingJobs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListLabelingJobs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListLabelingJobs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListLabelingJobs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListLabelingJobs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListLabelingJobs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListLabelingJobs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListLabelingJobs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListLabelingJobs) # ListLabelingJobsForWorkteam Gets a list of labeling jobs assigned to a specified work team. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "JobReferenceCodeContains": "string", "MaxResults": number, "NextToken": "string", "SortBy": "string", "SortOrder": "string", "WorkteamArn": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListLabelingJobsForWorkteam_RequestSyntax) ** A filter that returns only labeling jobs created after the specified time (timestamp). Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListLabelingJobsForWorkteam_RequestSyntax) ** A filter that returns only labeling jobs created before the specified time (timestamp). Type: Timestamp Required: No ** [JobReferenceCodeContains](#API_ListLabelingJobsForWorkteam_RequestSyntax) ** A filter the limits jobs to only the ones whose job reference code contains the specified string. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `.+` Required: No ** [MaxResults](#API_ListLabelingJobsForWorkteam_RequestSyntax) ** The maximum number of labeling jobs to return in each page of the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListLabelingJobsForWorkteam_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListLabelingJobsForWorkteam_RequestSyntax) ** The field to sort results by. The default is `CreationTime`. Type: String Valid Values: `CreationTime` Required: No ** [SortOrder](#API_ListLabelingJobsForWorkteam_RequestSyntax) ** The sort order for results. The default is `Ascending`. Type: String Valid Values: `Ascending | Descending` Required: No ** [WorkteamArn](#API_ListLabelingJobsForWorkteam_RequestSyntax) ** The Amazon Resource Name (ARN) of the work team for which you want to see labeling jobs for. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:workteam/.*` Required: Yes ## Response Syntax ``` { "LabelingJobSummaryList": [ { "CreationTime": number, "JobReferenceCode": "string", "LabelCounters": { "HumanLabeled": number, "PendingHuman": number, "Total": number }, "LabelingJobName": "string", "NumberOfHumanWorkersPerDataObject": number, "WorkRequesterAccountId": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [LabelingJobSummaryList](#API_ListLabelingJobsForWorkteam_ResponseSyntax) ** An array of `LabelingJobSummary` objects, each describing a labeling job. Type: Array of [LabelingJobForWorkteamSummary](API_LabelingJobForWorkteamSummary.md) objects ** [NextToken](#API_ListLabelingJobsForWorkteam_ResponseSyntax) ** If the response is truncated, SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListLabelingJobsForWorkteam) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListLabelingJobsForWorkteam) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListLabelingJobsForWorkteam) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListLabelingJobsForWorkteam) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListLabelingJobsForWorkteam) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListLabelingJobsForWorkteam) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListLabelingJobsForWorkteam) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListLabelingJobsForWorkteam) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListLabelingJobsForWorkteam) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListLabelingJobsForWorkteam) # ListLineageGroups A list of lineage groups shared with your AWS account. For more information, see [ Cross-Account Lineage Tracking ](https://docs.aws.amazon.com/sagemaker/latest/dg/xaccount-lineage-tracking.html) in the *Amazon SageMaker Developer Guide*. ## Request Syntax ``` { "CreatedAfter": number, "CreatedBefore": number, "MaxResults": number, "NextToken": "string", "SortBy": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreatedAfter](#API_ListLineageGroups_RequestSyntax) ** A timestamp to filter against lineage groups created after a certain point in time. Type: Timestamp Required: No ** [CreatedBefore](#API_ListLineageGroups_RequestSyntax) ** A timestamp to filter against lineage groups created before a certain point in time. Type: Timestamp Required: No ** [MaxResults](#API_ListLineageGroups_RequestSyntax) ** The maximum number of endpoints to return in the response. This value defaults to 10. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListLineageGroups_RequestSyntax) ** If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListLineageGroups_RequestSyntax) ** The parameter by which to sort the results. The default is `CreationTime`. Type: String Valid Values: `Name | CreationTime` Required: No ** [SortOrder](#API_ListLineageGroups_RequestSyntax) ** The sort order for the results. The default is `Ascending`. Type: String Valid Values: `Ascending | Descending` Required: No ## Response Syntax ``` { "LineageGroupSummaries": [ { "CreationTime": number, "DisplayName": "string", "LastModifiedTime": number, "LineageGroupArn": "string", "LineageGroupName": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [LineageGroupSummaries](#API_ListLineageGroups_ResponseSyntax) ** A list of lineage groups and their properties. Type: Array of [LineageGroupSummary](API_LineageGroupSummary.md) objects ** [NextToken](#API_ListLineageGroups_ResponseSyntax) ** If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListLineageGroups) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListLineageGroups) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListLineageGroups) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListLineageGroups) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListLineageGroups) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListLineageGroups) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListLineageGroups) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListLineageGroups) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListLineageGroups) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListLineageGroups) # ListMlflowApps Lists all MLflow Apps ## Request Syntax ``` { "AccountDefaultStatus": "string", "CreatedAfter": number, "CreatedBefore": number, "DefaultForDomainId": "string", "MaxResults": number, "MlflowVersion": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string", "Status": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AccountDefaultStatus](#API_ListMlflowApps_RequestSyntax) ** Filter for MLflow Apps with the specified `AccountDefaultStatus`. Type: String Valid Values: `ENABLED | DISABLED` Required: No ** [CreatedAfter](#API_ListMlflowApps_RequestSyntax) ** Use the `CreatedAfter` filter to only list MLflow Apps created after a specific date and time. Listed MLflow Apps are shown with a date and time such as `"2024-03-16T01:46:56+00:00"`. The `CreatedAfter` parameter takes in a Unix timestamp. Type: Timestamp Required: No ** [CreatedBefore](#API_ListMlflowApps_RequestSyntax) ** Use the `CreatedBefore` filter to only list MLflow Apps created before a specific date and time. Listed MLflow Apps are shown with a date and time such as `"2024-03-16T01:46:56+00:00"`. The `CreatedAfter` parameter takes in a Unix timestamp. Type: Timestamp Required: No ** [DefaultForDomainId](#API_ListMlflowApps_RequestSyntax) ** Filter for MLflow Apps with the specified default SageMaker Domain ID. Type: String Required: No ** [MaxResults](#API_ListMlflowApps_RequestSyntax) ** The maximum number of MLflow Apps to list. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [MlflowVersion](#API_ListMlflowApps_RequestSyntax) ** Filter for Mlflow Apps with the specified version. Type: String Length Constraints: Minimum length of 0. Maximum length of 16. Pattern: `[0-9]*.[0-9]*.[0-9]*` Required: No ** [NextToken](#API_ListMlflowApps_RequestSyntax) ** If the previous response was truncated, use this token in your next request to receive the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListMlflowApps_RequestSyntax) ** Filter for MLflow Apps sorting by name, creation time, or creation status. Type: String Valid Values: `Name | CreationTime | Status` Required: No ** [SortOrder](#API_ListMlflowApps_RequestSyntax) ** Change the order of the listed MLflow Apps. By default, MLflow Apps are listed in `Descending` order by creation time. To change the list order, specify `SortOrder` to be `Ascending`. Type: String Valid Values: `Ascending | Descending` Required: No ** [Status](#API_ListMlflowApps_RequestSyntax) ** Filter for Mlflow apps with a specific creation status. Type: String Valid Values: `Creating | Created | CreateFailed | Updating | Updated | UpdateFailed | Deleting | DeleteFailed | Deleted` Required: No ## Response Syntax ``` { "NextToken": "string", "Summaries": [ { "Arn": "string", "CreationTime": number, "LastModifiedTime": number, "MlflowVersion": "string", "Name": "string", "Status": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListMlflowApps_ResponseSyntax) ** If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ** [Summaries](#API_ListMlflowApps_ResponseSyntax) ** A list of MLflow Apps according to chosen filters. Type: Array of [MlflowAppSummary](API_MlflowAppSummary.md) objects Array Members: Minimum number of 0 items. Maximum number of 100 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListMlflowApps) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListMlflowApps) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListMlflowApps) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListMlflowApps) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListMlflowApps) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListMlflowApps) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListMlflowApps) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListMlflowApps) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListMlflowApps) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListMlflowApps) # ListMlflowTrackingServers Lists all MLflow Tracking Servers. ## Request Syntax ``` { "CreatedAfter": number, "CreatedBefore": number, "MaxResults": number, "MlflowVersion": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string", "TrackingServerStatus": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreatedAfter](#API_ListMlflowTrackingServers_RequestSyntax) ** Use the `CreatedAfter` filter to only list tracking servers created after a specific date and time. Listed tracking servers are shown with a date and time such as `"2024-03-16T01:46:56+00:00"`. The `CreatedAfter` parameter takes in a Unix timestamp. To convert a date and time into a Unix timestamp, see [EpochConverter](https://www.epochconverter.com/). Type: Timestamp Required: No ** [CreatedBefore](#API_ListMlflowTrackingServers_RequestSyntax) ** Use the `CreatedBefore` filter to only list tracking servers created before a specific date and time. Listed tracking servers are shown with a date and time such as `"2024-03-16T01:46:56+00:00"`. The `CreatedBefore` parameter takes in a Unix timestamp. To convert a date and time into a Unix timestamp, see [EpochConverter](https://www.epochconverter.com/). Type: Timestamp Required: No ** [MaxResults](#API_ListMlflowTrackingServers_RequestSyntax) ** The maximum number of tracking servers to list. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [MlflowVersion](#API_ListMlflowTrackingServers_RequestSyntax) ** Filter for tracking servers using the specified MLflow version. Type: String Length Constraints: Minimum length of 0. Maximum length of 16. Pattern: `[0-9]*.[0-9]*.[0-9]*` Required: No ** [NextToken](#API_ListMlflowTrackingServers_RequestSyntax) ** If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListMlflowTrackingServers_RequestSyntax) ** Filter for trackings servers sorting by name, creation time, or creation status. Type: String Valid Values: `Name | CreationTime | Status` Required: No ** [SortOrder](#API_ListMlflowTrackingServers_RequestSyntax) ** Change the order of the listed tracking servers. By default, tracking servers are listed in `Descending` order by creation time. To change the list order, you can specify `SortOrder` to be `Ascending`. Type: String Valid Values: `Ascending | Descending` Required: No ** [TrackingServerStatus](#API_ListMlflowTrackingServers_RequestSyntax) ** Filter for tracking servers with a specified creation status. Type: String Valid Values: `Creating | Created | CreateFailed | Updating | Updated | UpdateFailed | Deleting | DeleteFailed | Stopping | Stopped | StopFailed | Starting | Started | StartFailed | MaintenanceInProgress | MaintenanceComplete | MaintenanceFailed` Required: No ## Response Syntax ``` { "NextToken": "string", "TrackingServerSummaries": [ { "CreationTime": number, "IsActive": "string", "LastModifiedTime": number, "MlflowVersion": "string", "TrackingServerArn": "string", "TrackingServerName": "string", "TrackingServerStatus": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListMlflowTrackingServers_ResponseSyntax) ** If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ** [TrackingServerSummaries](#API_ListMlflowTrackingServers_ResponseSyntax) ** A list of tracking servers according to chosen filters. Type: Array of [TrackingServerSummary](API_TrackingServerSummary.md) objects Array Members: Minimum number of 0 items. Maximum number of 100 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListMlflowTrackingServers) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListMlflowTrackingServers) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListMlflowTrackingServers) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListMlflowTrackingServers) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListMlflowTrackingServers) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListMlflowTrackingServers) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListMlflowTrackingServers) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListMlflowTrackingServers) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListMlflowTrackingServers) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListMlflowTrackingServers) # ListModelBiasJobDefinitions Lists model bias jobs definitions that satisfy various filters. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "EndpointName": "string", "MaxResults": number, "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListModelBiasJobDefinitions_RequestSyntax) ** A filter that returns only model bias jobs created after a specified time. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListModelBiasJobDefinitions_RequestSyntax) ** A filter that returns only model bias jobs created before a specified time. Type: Timestamp Required: No ** [EndpointName](#API_ListModelBiasJobDefinitions_RequestSyntax) ** Name of the endpoint to monitor for model bias. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: No ** [MaxResults](#API_ListModelBiasJobDefinitions_RequestSyntax) ** The maximum number of model bias jobs to return in the response. The default value is 10. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NameContains](#API_ListModelBiasJobDefinitions_RequestSyntax) ** Filter for model bias jobs whose name contains a specified string. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9\-]+` Required: No ** [NextToken](#API_ListModelBiasJobDefinitions_RequestSyntax) ** The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListModelBiasJobDefinitions_RequestSyntax) ** Whether to sort results by the `Name` or `CreationTime` field. The default is `CreationTime`. Type: String Valid Values: `Name | CreationTime` Required: No ** [SortOrder](#API_ListModelBiasJobDefinitions_RequestSyntax) ** Whether to sort the results in `Ascending` or `Descending` order. The default is `Descending`. Type: String Valid Values: `Ascending | Descending` Required: No ## Response Syntax ``` { "JobDefinitionSummaries": [ { "CreationTime": number, "EndpointName": "string", "MonitoringJobDefinitionArn": "string", "MonitoringJobDefinitionName": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [JobDefinitionSummaries](#API_ListModelBiasJobDefinitions_ResponseSyntax) ** A JSON array in which each element is a summary for a model bias jobs. Type: Array of [MonitoringJobDefinitionSummary](API_MonitoringJobDefinitionSummary.md) objects ** [NextToken](#API_ListModelBiasJobDefinitions_ResponseSyntax) ** The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListModelBiasJobDefinitions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListModelBiasJobDefinitions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListModelBiasJobDefinitions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListModelBiasJobDefinitions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListModelBiasJobDefinitions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListModelBiasJobDefinitions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListModelBiasJobDefinitions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListModelBiasJobDefinitions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListModelBiasJobDefinitions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListModelBiasJobDefinitions) # ListModelCardExportJobs List the export jobs for the Amazon SageMaker Model Card. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "MaxResults": number, "ModelCardExportJobNameContains": "string", "ModelCardName": "string", "ModelCardVersion": number, "NextToken": "string", "SortBy": "string", "SortOrder": "string", "StatusEquals": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListModelCardExportJobs_RequestSyntax) ** Only list model card export jobs that were created after the time specified. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListModelCardExportJobs_RequestSyntax) ** Only list model card export jobs that were created before the time specified. Type: Timestamp Required: No ** [MaxResults](#API_ListModelCardExportJobs_RequestSyntax) ** The maximum number of model card export jobs to list. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [ModelCardExportJobNameContains](#API_ListModelCardExportJobs_RequestSyntax) ** Only list model card export jobs with names that contain the specified string. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: No ** [ModelCardName](#API_ListModelCardExportJobs_RequestSyntax) ** List export jobs for the model card with the specified name. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [ModelCardVersion](#API_ListModelCardExportJobs_RequestSyntax) ** List export jobs for the model card with the specified version. Type: Integer Required: No ** [NextToken](#API_ListModelCardExportJobs_RequestSyntax) ** If the response to a previous `ListModelCardExportJobs` request was truncated, the response includes a `NextToken`. To retrieve the next set of model card export jobs, use the token in the next request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListModelCardExportJobs_RequestSyntax) ** Sort model card export jobs by either name or creation time. Sorts by creation time by default. Type: String Valid Values: `Name | CreationTime | Status` Required: No ** [SortOrder](#API_ListModelCardExportJobs_RequestSyntax) ** Sort model card export jobs by ascending or descending order. Type: String Valid Values: `Ascending | Descending` Required: No ** [StatusEquals](#API_ListModelCardExportJobs_RequestSyntax) ** Only list model card export jobs with the specified status. Type: String Valid Values: `InProgress | Completed | Failed` Required: No ## Response Syntax ``` { "ModelCardExportJobSummaries": [ { "CreatedAt": number, "LastModifiedAt": number, "ModelCardExportJobArn": "string", "ModelCardExportJobName": "string", "ModelCardName": "string", "ModelCardVersion": number, "Status": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ModelCardExportJobSummaries](#API_ListModelCardExportJobs_ResponseSyntax) ** The summaries of the listed model card export jobs. Type: Array of [ModelCardExportJobSummary](API_ModelCardExportJobSummary.md) objects ** [NextToken](#API_ListModelCardExportJobs_ResponseSyntax) ** If the response is truncated, SageMaker returns this token. To retrieve the next set of model card export jobs, use it in the subsequent request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListModelCardExportJobs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListModelCardExportJobs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListModelCardExportJobs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListModelCardExportJobs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListModelCardExportJobs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListModelCardExportJobs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListModelCardExportJobs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListModelCardExportJobs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListModelCardExportJobs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListModelCardExportJobs) # ListModelCards List existing model cards. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "MaxResults": number, "ModelCardStatus": "string", "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListModelCards_RequestSyntax) ** Only list model cards that were created after the time specified. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListModelCards_RequestSyntax) ** Only list model cards that were created before the time specified. Type: Timestamp Required: No ** [MaxResults](#API_ListModelCards_RequestSyntax) ** The maximum number of model cards to list. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [ModelCardStatus](#API_ListModelCards_RequestSyntax) ** Only list model cards with the specified approval status. Type: String Valid Values: `Draft | PendingReview | Approved | Archived` Required: No ** [NameContains](#API_ListModelCards_RequestSyntax) ** Only list model cards with names that contain the specified string. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: No ** [NextToken](#API_ListModelCards_RequestSyntax) ** If the response to a previous `ListModelCards` request was truncated, the response includes a `NextToken`. To retrieve the next set of model cards, use the token in the next request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListModelCards_RequestSyntax) ** Sort model cards by either name or creation time. Sorts by creation time by default. Type: String Valid Values: `Name | CreationTime` Required: No ** [SortOrder](#API_ListModelCards_RequestSyntax) ** Sort model cards by ascending or descending order. Type: String Valid Values: `Ascending | Descending` Required: No ## Response Syntax ``` { "ModelCardSummaries": [ { "CreationTime": number, "LastModifiedTime": number, "ModelCardArn": "string", "ModelCardName": "string", "ModelCardStatus": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ModelCardSummaries](#API_ListModelCards_ResponseSyntax) ** The summaries of the listed model cards. Type: Array of [ModelCardSummary](API_ModelCardSummary.md) objects ** [NextToken](#API_ListModelCards_ResponseSyntax) ** If the response is truncated, SageMaker returns this token. To retrieve the next set of model cards, use it in the subsequent request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListModelCards) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListModelCards) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListModelCards) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListModelCards) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListModelCards) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListModelCards) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListModelCards) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListModelCards) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListModelCards) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListModelCards) # ListModelCardVersions List existing versions of an Amazon SageMaker Model Card. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "MaxResults": number, "ModelCardName": "string", "ModelCardStatus": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListModelCardVersions_RequestSyntax) ** Only list model card versions that were created after the time specified. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListModelCardVersions_RequestSyntax) ** Only list model card versions that were created before the time specified. Type: Timestamp Required: No ** [MaxResults](#API_ListModelCardVersions_RequestSyntax) ** The maximum number of model card versions to list. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [ModelCardName](#API_ListModelCardVersions_RequestSyntax) ** List model card versions for the model card with the specified name or Amazon Resource Name (ARN). Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:model-card/.*)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})` Required: Yes ** [ModelCardStatus](#API_ListModelCardVersions_RequestSyntax) ** Only list model card versions with the specified approval status. Type: String Valid Values: `Draft | PendingReview | Approved | Archived` Required: No ** [NextToken](#API_ListModelCardVersions_RequestSyntax) ** If the response to a previous `ListModelCardVersions` request was truncated, the response includes a `NextToken`. To retrieve the next set of model card versions, use the token in the next request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListModelCardVersions_RequestSyntax) ** Sort listed model card versions by version. Sorts by version by default. Type: String Valid Values: `Version` Required: No ** [SortOrder](#API_ListModelCardVersions_RequestSyntax) ** Sort model card versions by ascending or descending order. Type: String Valid Values: `Ascending | Descending` Required: No ## Response Syntax ``` { "ModelCardVersionSummaryList": [ { "CreationTime": number, "LastModifiedTime": number, "ModelCardArn": "string", "ModelCardName": "string", "ModelCardStatus": "string", "ModelCardVersion": number } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ModelCardVersionSummaryList](#API_ListModelCardVersions_ResponseSyntax) ** The summaries of the listed versions of the model card. Type: Array of [ModelCardVersionSummary](API_ModelCardVersionSummary.md) objects ** [NextToken](#API_ListModelCardVersions_ResponseSyntax) ** If the response is truncated, SageMaker returns this token. To retrieve the next set of model card versions, use it in the subsequent request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListModelCardVersions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListModelCardVersions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListModelCardVersions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListModelCardVersions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListModelCardVersions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListModelCardVersions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListModelCardVersions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListModelCardVersions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListModelCardVersions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListModelCardVersions) # ListModelExplainabilityJobDefinitions Lists model explainability job definitions that satisfy various filters. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "EndpointName": "string", "MaxResults": number, "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListModelExplainabilityJobDefinitions_RequestSyntax) ** A filter that returns only model explainability jobs created after a specified time. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListModelExplainabilityJobDefinitions_RequestSyntax) ** A filter that returns only model explainability jobs created before a specified time. Type: Timestamp Required: No ** [EndpointName](#API_ListModelExplainabilityJobDefinitions_RequestSyntax) ** Name of the endpoint to monitor for model explainability. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: No ** [MaxResults](#API_ListModelExplainabilityJobDefinitions_RequestSyntax) ** The maximum number of jobs to return in the response. The default value is 10. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NameContains](#API_ListModelExplainabilityJobDefinitions_RequestSyntax) ** Filter for model explainability jobs whose name contains a specified string. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9\-]+` Required: No ** [NextToken](#API_ListModelExplainabilityJobDefinitions_RequestSyntax) ** The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListModelExplainabilityJobDefinitions_RequestSyntax) ** Whether to sort results by the `Name` or `CreationTime` field. The default is `CreationTime`. Type: String Valid Values: `Name | CreationTime` Required: No ** [SortOrder](#API_ListModelExplainabilityJobDefinitions_RequestSyntax) ** Whether to sort the results in `Ascending` or `Descending` order. The default is `Descending`. Type: String Valid Values: `Ascending | Descending` Required: No ## Response Syntax ``` { "JobDefinitionSummaries": [ { "CreationTime": number, "EndpointName": "string", "MonitoringJobDefinitionArn": "string", "MonitoringJobDefinitionName": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [JobDefinitionSummaries](#API_ListModelExplainabilityJobDefinitions_ResponseSyntax) ** A JSON array in which each element is a summary for a explainability bias jobs. Type: Array of [MonitoringJobDefinitionSummary](API_MonitoringJobDefinitionSummary.md) objects ** [NextToken](#API_ListModelExplainabilityJobDefinitions_ResponseSyntax) ** The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListModelExplainabilityJobDefinitions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListModelExplainabilityJobDefinitions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListModelExplainabilityJobDefinitions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListModelExplainabilityJobDefinitions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListModelExplainabilityJobDefinitions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListModelExplainabilityJobDefinitions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListModelExplainabilityJobDefinitions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListModelExplainabilityJobDefinitions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListModelExplainabilityJobDefinitions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListModelExplainabilityJobDefinitions) # ListModelMetadata Lists the domain, framework, task, and model name of standard machine learning models found in common model zoos. ## Request Syntax ``` { "MaxResults": number, "NextToken": "string", "SearchExpression": { "Filters": [ { "Name": "string", "Value": "string" } ] } } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [MaxResults](#API_ListModelMetadata_RequestSyntax) ** The maximum number of models to return in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListModelMetadata_RequestSyntax) ** If the response to a previous `ListModelMetadataResponse` request was truncated, the response includes a NextToken. To retrieve the next set of model metadata, use the token in the next request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SearchExpression](#API_ListModelMetadata_RequestSyntax) ** One or more filters 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. Specify the Framework, FrameworkVersion, Domain or Task to filter supported. Filter names and values are case-sensitive. Type: [ModelMetadataSearchExpression](API_ModelMetadataSearchExpression.md) object Required: No ## Response Syntax ``` { "ModelMetadataSummaries": [ { "Domain": "string", "Framework": "string", "FrameworkVersion": "string", "Model": "string", "Task": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ModelMetadataSummaries](#API_ListModelMetadata_ResponseSyntax) ** A structure that holds model metadata. Type: Array of [ModelMetadataSummary](API_ModelMetadataSummary.md) objects ** [NextToken](#API_ListModelMetadata_ResponseSyntax) ** A token for getting the next set of recommendations, if there are any. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListModelMetadata) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListModelMetadata) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListModelMetadata) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListModelMetadata) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListModelMetadata) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListModelMetadata) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListModelMetadata) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListModelMetadata) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListModelMetadata) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListModelMetadata) # ListModelPackageGroups Gets a list of the model groups in your AWS account. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "CrossAccountFilterOption": "string", "MaxResults": number, "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListModelPackageGroups_RequestSyntax) ** A filter that returns only model groups created after the specified time. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListModelPackageGroups_RequestSyntax) ** A filter that returns only model groups created before the specified time. Type: Timestamp Required: No ** [CrossAccountFilterOption](#API_ListModelPackageGroups_RequestSyntax) ** A filter that returns either model groups shared with you or model groups in your own account. When the value is `CrossAccount`, the results show the resources made discoverable to you from other accounts. When the value is `SameAccount` or `null`, the results show resources from your account. The default is `SameAccount`. Type: String Valid Values: `SameAccount | CrossAccount` Required: No ** [MaxResults](#API_ListModelPackageGroups_RequestSyntax) ** The maximum number of results to return in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NameContains](#API_ListModelPackageGroups_RequestSyntax) ** A string in the model group name. This filter returns only model groups whose name contains the specified string. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9\-]+` Required: No ** [NextToken](#API_ListModelPackageGroups_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListModelPackageGroups_RequestSyntax) ** The field to sort results by. The default is `CreationTime`. Type: String Valid Values: `Name | CreationTime` Required: No ** [SortOrder](#API_ListModelPackageGroups_RequestSyntax) ** The sort order for results. The default is `Ascending`. Type: String Valid Values: `Ascending | Descending` Required: No ## Response Syntax ``` { "ModelPackageGroupSummaryList": [ { "CreationTime": number, "ModelPackageGroupArn": "string", "ModelPackageGroupDescription": "string", "ModelPackageGroupName": "string", "ModelPackageGroupStatus": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ModelPackageGroupSummaryList](#API_ListModelPackageGroups_ResponseSyntax) ** A list of summaries of the model groups in your AWS account. Type: Array of [ModelPackageGroupSummary](API_ModelPackageGroupSummary.md) objects ** [NextToken](#API_ListModelPackageGroups_ResponseSyntax) ** If the response is truncated, SageMaker returns this token. To retrieve the next set of model groups, use it in the subsequent request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListModelPackageGroups) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListModelPackageGroups) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListModelPackageGroups) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListModelPackageGroups) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListModelPackageGroups) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListModelPackageGroups) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListModelPackageGroups) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListModelPackageGroups) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListModelPackageGroups) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListModelPackageGroups) # ListModelPackages Lists the model packages that have been created. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "MaxResults": number, "ModelApprovalStatus": "string", "ModelPackageGroupName": "string", "ModelPackageType": "string", "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListModelPackages_RequestSyntax) ** A filter that returns only model packages created after the specified time (timestamp). Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListModelPackages_RequestSyntax) ** A filter that returns only model packages created before the specified time (timestamp). Type: Timestamp Required: No ** [MaxResults](#API_ListModelPackages_RequestSyntax) ** The maximum number of model packages to return in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [ModelApprovalStatus](#API_ListModelPackages_RequestSyntax) ** A filter that returns only the model packages with the specified approval status. Type: String Valid Values: `Approved | Rejected | PendingManualApproval` Required: No ** [ModelPackageGroupName](#API_ListModelPackages_RequestSyntax) ** A filter that returns only model versions that belong to the specified model group. Type: String Length Constraints: Minimum length of 1. Maximum length of 170. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:[a-z\-]*\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(? A filter that returns only the model packages of the specified type. This can be one of the following values. + `UNVERSIONED` - List only unversioined models. This is the default value if no `ModelPackageType` is specified. + `VERSIONED` - List only versioned models. + `BOTH` - List both versioned and unversioned models. Type: String Valid Values: `Versioned | Unversioned | Both` Required: No ** [NameContains](#API_ListModelPackages_RequestSyntax) ** A string in the model package name. This filter returns only model packages whose name contains the specified string. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9\-]+` Required: No ** [NextToken](#API_ListModelPackages_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListModelPackages_RequestSyntax) ** The parameter by which to sort the results. The default is `CreationTime`. Type: String Valid Values: `Name | CreationTime` Required: No ** [SortOrder](#API_ListModelPackages_RequestSyntax) ** The sort order for the results. The default is `Ascending`. Type: String Valid Values: `Ascending | Descending` Required: No ## Response Syntax ``` { "ModelPackageSummaryList": [ { "CreationTime": number, "ModelApprovalStatus": "string", "ModelLifeCycle": { "Stage": "string", "StageDescription": "string", "StageStatus": "string" }, "ModelPackageArn": "string", "ModelPackageDescription": "string", "ModelPackageGroupName": "string", "ModelPackageName": "string", "ModelPackageRegistrationType": "string", "ModelPackageStatus": "string", "ModelPackageVersion": number } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ModelPackageSummaryList](#API_ListModelPackages_ResponseSyntax) ** An array of `ModelPackageSummary` objects, each of which lists a model package. Type: Array of [ModelPackageSummary](API_ModelPackageSummary.md) objects ** [NextToken](#API_ListModelPackages_ResponseSyntax) ** If the response is truncated, SageMaker returns this token. To retrieve the next set of model packages, use it in the subsequent request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListModelPackages) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListModelPackages) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListModelPackages) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListModelPackages) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListModelPackages) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListModelPackages) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListModelPackages) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListModelPackages) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListModelPackages) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListModelPackages) # ListModelQualityJobDefinitions Gets a list of model quality monitoring job definitions in your account. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "EndpointName": "string", "MaxResults": number, "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListModelQualityJobDefinitions_RequestSyntax) ** A filter that returns only model quality monitoring job definitions created after the specified time. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListModelQualityJobDefinitions_RequestSyntax) ** A filter that returns only model quality monitoring job definitions created before the specified time. Type: Timestamp Required: No ** [EndpointName](#API_ListModelQualityJobDefinitions_RequestSyntax) ** A filter that returns only model quality monitoring job definitions that are associated with the specified endpoint. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: No ** [MaxResults](#API_ListModelQualityJobDefinitions_RequestSyntax) ** The maximum number of results to return in a call to `ListModelQualityJobDefinitions`. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NameContains](#API_ListModelQualityJobDefinitions_RequestSyntax) ** A string in the transform job name. This filter returns only model quality monitoring job definitions whose name contains the specified string. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9\-]+` Required: No ** [NextToken](#API_ListModelQualityJobDefinitions_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListModelQualityJobDefinitions_RequestSyntax) ** The field to sort results by. The default is `CreationTime`. Type: String Valid Values: `Name | CreationTime` Required: No ** [SortOrder](#API_ListModelQualityJobDefinitions_RequestSyntax) ** Whether to sort the results in `Ascending` or `Descending` order. The default is `Descending`. Type: String Valid Values: `Ascending | Descending` Required: No ## Response Syntax ``` { "JobDefinitionSummaries": [ { "CreationTime": number, "EndpointName": "string", "MonitoringJobDefinitionArn": "string", "MonitoringJobDefinitionName": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [JobDefinitionSummaries](#API_ListModelQualityJobDefinitions_ResponseSyntax) ** A list of summaries of model quality monitoring job definitions. Type: Array of [MonitoringJobDefinitionSummary](API_MonitoringJobDefinitionSummary.md) objects ** [NextToken](#API_ListModelQualityJobDefinitions_ResponseSyntax) ** If the response is truncated, Amazon SageMaker AI returns this token. To retrieve the next set of model quality monitoring job definitions, use it in the next request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListModelQualityJobDefinitions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListModelQualityJobDefinitions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListModelQualityJobDefinitions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListModelQualityJobDefinitions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListModelQualityJobDefinitions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListModelQualityJobDefinitions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListModelQualityJobDefinitions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListModelQualityJobDefinitions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListModelQualityJobDefinitions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListModelQualityJobDefinitions) # ListModels Lists models created with the `CreateModel` API. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "MaxResults": number, "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListModels_RequestSyntax) ** A filter that returns only models with a creation time greater than or equal to the specified time (timestamp). Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListModels_RequestSyntax) ** A filter that returns only models created before the specified time (timestamp). Type: Timestamp Required: No ** [MaxResults](#API_ListModels_RequestSyntax) ** The maximum number of models to return in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NameContains](#API_ListModels_RequestSyntax) ** A string in the model name. This filter returns only models whose name contains the specified string. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9-]+` Required: No ** [NextToken](#API_ListModels_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListModels_RequestSyntax) ** Sorts the list of results. The default is `CreationTime`. Type: String Valid Values: `Name | CreationTime` Required: No ** [SortOrder](#API_ListModels_RequestSyntax) ** The sort order for results. The default is `Descending`. Type: String Valid Values: `Ascending | Descending` Required: No ## Response Syntax ``` { "Models": [ { "CreationTime": number, "ModelArn": "string", "ModelName": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Models](#API_ListModels_ResponseSyntax) ** An array of `ModelSummary` objects, each of which lists a model. Type: Array of [ModelSummary](API_ModelSummary.md) objects ** [NextToken](#API_ListModels_ResponseSyntax) ** If the response is truncated, SageMaker returns this token. To retrieve the next set of models, use it in the subsequent request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListModels) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListModels) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListModels) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListModels) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListModels) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListModels) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListModels) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListModels) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListModels) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListModels) # ListMonitoringAlertHistory Gets a list of past alerts in a model monitoring schedule. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "MaxResults": number, "MonitoringAlertName": "string", "MonitoringScheduleName": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string", "StatusEquals": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListMonitoringAlertHistory_RequestSyntax) ** A filter that returns only alerts created on or after the specified time. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListMonitoringAlertHistory_RequestSyntax) ** A filter that returns only alerts created on or before the specified time. Type: Timestamp Required: No ** [MaxResults](#API_ListMonitoringAlertHistory_RequestSyntax) ** The maximum number of results to display. The default is 100. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [MonitoringAlertName](#API_ListMonitoringAlertHistory_RequestSyntax) ** The name of a monitoring alert. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: No ** [MonitoringScheduleName](#API_ListMonitoringAlertHistory_RequestSyntax) ** The name of a monitoring schedule. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: No ** [NextToken](#API_ListMonitoringAlertHistory_RequestSyntax) ** If the result of the previous `ListMonitoringAlertHistory` request was truncated, the response includes a `NextToken`. To retrieve the next set of alerts in the history, use the token in the next request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListMonitoringAlertHistory_RequestSyntax) ** The field used to sort results. The default is `CreationTime`. Type: String Valid Values: `CreationTime | Status` Required: No ** [SortOrder](#API_ListMonitoringAlertHistory_RequestSyntax) ** The sort order, whether `Ascending` or `Descending`, of the alert history. The default is `Descending`. Type: String Valid Values: `Ascending | Descending` Required: No ** [StatusEquals](#API_ListMonitoringAlertHistory_RequestSyntax) ** A filter that retrieves only alerts with a specific status. Type: String Valid Values: `InAlert | OK` Required: No ## Response Syntax ``` { "MonitoringAlertHistory": [ { "AlertStatus": "string", "CreationTime": number, "MonitoringAlertName": "string", "MonitoringScheduleName": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [MonitoringAlertHistory](#API_ListMonitoringAlertHistory_ResponseSyntax) ** An alert history for a model monitoring schedule. Type: Array of [MonitoringAlertHistorySummary](API_MonitoringAlertHistorySummary.md) objects ** [NextToken](#API_ListMonitoringAlertHistory_ResponseSyntax) ** If the response is truncated, SageMaker returns this token. To retrieve the next set of alerts, use it in the subsequent request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListMonitoringAlertHistory) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListMonitoringAlertHistory) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListMonitoringAlertHistory) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListMonitoringAlertHistory) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListMonitoringAlertHistory) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListMonitoringAlertHistory) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListMonitoringAlertHistory) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListMonitoringAlertHistory) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListMonitoringAlertHistory) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListMonitoringAlertHistory) # ListMonitoringAlerts Gets the alerts for a single monitoring schedule. ## Request Syntax ``` { "MaxResults": number, "MonitoringScheduleName": "string", "NextToken": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [MaxResults](#API_ListMonitoringAlerts_RequestSyntax) ** The maximum number of results to display. The default is 100. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [MonitoringScheduleName](#API_ListMonitoringAlerts_RequestSyntax) ** The name of a monitoring schedule. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [NextToken](#API_ListMonitoringAlerts_RequestSyntax) ** If the result of the previous `ListMonitoringAlerts` request was truncated, the response includes a `NextToken`. To retrieve the next set of alerts in the history, use the token in the next request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ## Response Syntax ``` { "MonitoringAlertSummaries": [ { "Actions": { "ModelDashboardIndicator": { "Enabled": boolean } }, "AlertStatus": "string", "CreationTime": number, "DatapointsToAlert": number, "EvaluationPeriod": number, "LastModifiedTime": number, "MonitoringAlertName": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [MonitoringAlertSummaries](#API_ListMonitoringAlerts_ResponseSyntax) ** A JSON array where each element is a summary for a monitoring alert. Type: Array of [MonitoringAlertSummary](API_MonitoringAlertSummary.md) objects Array Members: Minimum number of 1 item. Maximum number of 100 items. ** [NextToken](#API_ListMonitoringAlerts_ResponseSyntax) ** If the response is truncated, SageMaker returns this token. To retrieve the next set of alerts, use it in the subsequent request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListMonitoringAlerts) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListMonitoringAlerts) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListMonitoringAlerts) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListMonitoringAlerts) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListMonitoringAlerts) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListMonitoringAlerts) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListMonitoringAlerts) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListMonitoringAlerts) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListMonitoringAlerts) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListMonitoringAlerts) # ListMonitoringExecutions Returns list of all monitoring job executions. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "EndpointName": "string", "LastModifiedTimeAfter": number, "LastModifiedTimeBefore": number, "MaxResults": number, "MonitoringJobDefinitionName": "string", "MonitoringScheduleName": "string", "MonitoringTypeEquals": "string", "NextToken": "string", "ScheduledTimeAfter": number, "ScheduledTimeBefore": number, "SortBy": "string", "SortOrder": "string", "StatusEquals": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListMonitoringExecutions_RequestSyntax) ** A filter that returns only jobs created after a specified time. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListMonitoringExecutions_RequestSyntax) ** A filter that returns only jobs created before a specified time. Type: Timestamp Required: No ** [EndpointName](#API_ListMonitoringExecutions_RequestSyntax) ** Name of a specific endpoint to fetch jobs for. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: No ** [LastModifiedTimeAfter](#API_ListMonitoringExecutions_RequestSyntax) ** A filter that returns only jobs modified before a specified time. Type: Timestamp Required: No ** [LastModifiedTimeBefore](#API_ListMonitoringExecutions_RequestSyntax) ** A filter that returns only jobs modified after a specified time. Type: Timestamp Required: No ** [MaxResults](#API_ListMonitoringExecutions_RequestSyntax) ** The maximum number of jobs to return in the response. The default value is 10. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [MonitoringJobDefinitionName](#API_ListMonitoringExecutions_RequestSyntax) ** Gets a list of the monitoring job runs of the specified monitoring job definitions. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: No ** [MonitoringScheduleName](#API_ListMonitoringExecutions_RequestSyntax) ** Name of a specific schedule to fetch jobs for. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: No ** [MonitoringTypeEquals](#API_ListMonitoringExecutions_RequestSyntax) ** A filter that returns only the monitoring job runs of the specified monitoring type. Type: String Valid Values: `DataQuality | ModelQuality | ModelBias | ModelExplainability` Required: No ** [NextToken](#API_ListMonitoringExecutions_RequestSyntax) ** The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [ScheduledTimeAfter](#API_ListMonitoringExecutions_RequestSyntax) ** Filter for jobs scheduled after a specified time. Type: Timestamp Required: No ** [ScheduledTimeBefore](#API_ListMonitoringExecutions_RequestSyntax) ** Filter for jobs scheduled before a specified time. Type: Timestamp Required: No ** [SortBy](#API_ListMonitoringExecutions_RequestSyntax) ** Whether to sort the results by the `Status`, `CreationTime`, or `ScheduledTime` field. The default is `CreationTime`. Type: String Valid Values: `CreationTime | ScheduledTime | Status` Required: No ** [SortOrder](#API_ListMonitoringExecutions_RequestSyntax) ** Whether to sort the results in `Ascending` or `Descending` order. The default is `Descending`. Type: String Valid Values: `Ascending | Descending` Required: No ** [StatusEquals](#API_ListMonitoringExecutions_RequestSyntax) ** A filter that retrieves only jobs with a specific status. Type: String Valid Values: `Pending | Completed | CompletedWithViolations | InProgress | Failed | Stopping | Stopped` Required: No ## Response Syntax ``` { "MonitoringExecutionSummaries": [ { "CreationTime": number, "EndpointName": "string", "FailureReason": "string", "LastModifiedTime": number, "MonitoringExecutionStatus": "string", "MonitoringJobDefinitionName": "string", "MonitoringScheduleName": "string", "MonitoringType": "string", "ProcessingJobArn": "string", "ScheduledTime": number } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [MonitoringExecutionSummaries](#API_ListMonitoringExecutions_ResponseSyntax) ** A JSON array in which each element is a summary for a monitoring execution. Type: Array of [MonitoringExecutionSummary](API_MonitoringExecutionSummary.md) objects ** [NextToken](#API_ListMonitoringExecutions_ResponseSyntax) ** The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListMonitoringExecutions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListMonitoringExecutions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListMonitoringExecutions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListMonitoringExecutions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListMonitoringExecutions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListMonitoringExecutions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListMonitoringExecutions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListMonitoringExecutions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListMonitoringExecutions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListMonitoringExecutions) # ListMonitoringSchedules Returns list of all monitoring schedules. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "EndpointName": "string", "LastModifiedTimeAfter": number, "LastModifiedTimeBefore": number, "MaxResults": number, "MonitoringJobDefinitionName": "string", "MonitoringTypeEquals": "string", "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string", "StatusEquals": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListMonitoringSchedules_RequestSyntax) ** A filter that returns only monitoring schedules created after a specified time. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListMonitoringSchedules_RequestSyntax) ** A filter that returns only monitoring schedules created before a specified time. Type: Timestamp Required: No ** [EndpointName](#API_ListMonitoringSchedules_RequestSyntax) ** Name of a specific endpoint to fetch schedules for. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: No ** [LastModifiedTimeAfter](#API_ListMonitoringSchedules_RequestSyntax) ** A filter that returns only monitoring schedules modified after a specified time. Type: Timestamp Required: No ** [LastModifiedTimeBefore](#API_ListMonitoringSchedules_RequestSyntax) ** A filter that returns only monitoring schedules modified before a specified time. Type: Timestamp Required: No ** [MaxResults](#API_ListMonitoringSchedules_RequestSyntax) ** The maximum number of jobs to return in the response. The default value is 10. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [MonitoringJobDefinitionName](#API_ListMonitoringSchedules_RequestSyntax) ** Gets a list of the monitoring schedules for the specified monitoring job definition. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: No ** [MonitoringTypeEquals](#API_ListMonitoringSchedules_RequestSyntax) ** A filter that returns only the monitoring schedules for the specified monitoring type. Type: String Valid Values: `DataQuality | ModelQuality | ModelBias | ModelExplainability` Required: No ** [NameContains](#API_ListMonitoringSchedules_RequestSyntax) ** Filter for monitoring schedules whose name contains a specified string. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9\-]+` Required: No ** [NextToken](#API_ListMonitoringSchedules_RequestSyntax) ** The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListMonitoringSchedules_RequestSyntax) ** Whether to sort the results by the `Status`, `CreationTime`, or `ScheduledTime` field. The default is `CreationTime`. Type: String Valid Values: `Name | CreationTime | Status` Required: No ** [SortOrder](#API_ListMonitoringSchedules_RequestSyntax) ** Whether to sort the results in `Ascending` or `Descending` order. The default is `Descending`. Type: String Valid Values: `Ascending | Descending` Required: No ** [StatusEquals](#API_ListMonitoringSchedules_RequestSyntax) ** A filter that returns only monitoring schedules modified before a specified time. Type: String Valid Values: `Pending | Failed | Scheduled | Stopped` Required: No ## Response Syntax ``` { "MonitoringScheduleSummaries": [ { "CreationTime": number, "EndpointName": "string", "LastModifiedTime": number, "MonitoringJobDefinitionName": "string", "MonitoringScheduleArn": "string", "MonitoringScheduleName": "string", "MonitoringScheduleStatus": "string", "MonitoringType": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [MonitoringScheduleSummaries](#API_ListMonitoringSchedules_ResponseSyntax) ** A JSON array in which each element is a summary for a monitoring schedule. Type: Array of [MonitoringScheduleSummary](API_MonitoringScheduleSummary.md) objects ** [NextToken](#API_ListMonitoringSchedules_ResponseSyntax) ** The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListMonitoringSchedules) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListMonitoringSchedules) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListMonitoringSchedules) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListMonitoringSchedules) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListMonitoringSchedules) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListMonitoringSchedules) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListMonitoringSchedules) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListMonitoringSchedules) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListMonitoringSchedules) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListMonitoringSchedules) # ListNotebookInstanceLifecycleConfigs Lists notebook instance lifestyle configurations created with the [CreateNotebookInstanceLifecycleConfig](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateNotebookInstanceLifecycleConfig.html) API. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "LastModifiedTimeAfter": number, "LastModifiedTimeBefore": number, "MaxResults": number, "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListNotebookInstanceLifecycleConfigs_RequestSyntax) ** A filter that returns only lifecycle configurations that were created after the specified time (timestamp). Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListNotebookInstanceLifecycleConfigs_RequestSyntax) ** A filter that returns only lifecycle configurations that were created before the specified time (timestamp). Type: Timestamp Required: No ** [LastModifiedTimeAfter](#API_ListNotebookInstanceLifecycleConfigs_RequestSyntax) ** A filter that returns only lifecycle configurations that were modified after the specified time (timestamp). Type: Timestamp Required: No ** [LastModifiedTimeBefore](#API_ListNotebookInstanceLifecycleConfigs_RequestSyntax) ** A filter that returns only lifecycle configurations that were modified before the specified time (timestamp). Type: Timestamp Required: No ** [MaxResults](#API_ListNotebookInstanceLifecycleConfigs_RequestSyntax) ** The maximum number of lifecycle configurations to return in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NameContains](#API_ListNotebookInstanceLifecycleConfigs_RequestSyntax) ** A string in the lifecycle configuration name. This filter returns only lifecycle configurations whose name contains the specified string. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9-]+` Required: No ** [NextToken](#API_ListNotebookInstanceLifecycleConfigs_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListNotebookInstanceLifecycleConfigs_RequestSyntax) ** Sorts the list of results. The default is `CreationTime`. Type: String Valid Values: `Name | CreationTime | LastModifiedTime` Required: No ** [SortOrder](#API_ListNotebookInstanceLifecycleConfigs_RequestSyntax) ** The sort order for results. Type: String Valid Values: `Ascending | Descending` Required: No ## Response Syntax ``` { "NextToken": "string", "NotebookInstanceLifecycleConfigs": [ { "CreationTime": number, "LastModifiedTime": number, "NotebookInstanceLifecycleConfigArn": "string", "NotebookInstanceLifecycleConfigName": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListNotebookInstanceLifecycleConfigs_ResponseSyntax) ** If the response is truncated, SageMaker AI returns this token. To get the next set of lifecycle configurations, use it in the next request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ** [NotebookInstanceLifecycleConfigs](#API_ListNotebookInstanceLifecycleConfigs_ResponseSyntax) ** An array of `NotebookInstanceLifecycleConfiguration` objects, each listing a lifecycle configuration. Type: Array of [NotebookInstanceLifecycleConfigSummary](API_NotebookInstanceLifecycleConfigSummary.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListNotebookInstanceLifecycleConfigs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListNotebookInstanceLifecycleConfigs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListNotebookInstanceLifecycleConfigs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListNotebookInstanceLifecycleConfigs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListNotebookInstanceLifecycleConfigs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListNotebookInstanceLifecycleConfigs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListNotebookInstanceLifecycleConfigs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListNotebookInstanceLifecycleConfigs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListNotebookInstanceLifecycleConfigs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListNotebookInstanceLifecycleConfigs) # ListNotebookInstances Returns a list of the SageMaker AI notebook instances in the requester's account in an AWS Region. ## Request Syntax ``` { "AdditionalCodeRepositoryEquals": "string", "CreationTimeAfter": number, "CreationTimeBefore": number, "DefaultCodeRepositoryContains": "string", "LastModifiedTimeAfter": number, "LastModifiedTimeBefore": number, "MaxResults": number, "NameContains": "string", "NextToken": "string", "NotebookInstanceLifecycleConfigNameContains": "string", "SortBy": "string", "SortOrder": "string", "StatusEquals": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AdditionalCodeRepositoryEquals](#API_ListNotebookInstances_RequestSyntax) ** A filter that returns only notebook instances with associated with the specified git repository. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `https://([^/]+)/?(.*)$|^[a-zA-Z0-9](-*[a-zA-Z0-9])*` Required: No ** [CreationTimeAfter](#API_ListNotebookInstances_RequestSyntax) ** A filter that returns only notebook instances that were created after the specified time (timestamp). Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListNotebookInstances_RequestSyntax) ** A filter that returns only notebook instances that were created before the specified time (timestamp). Type: Timestamp Required: No ** [DefaultCodeRepositoryContains](#API_ListNotebookInstances_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `[a-zA-Z0-9-]+` Required: No ** [LastModifiedTimeAfter](#API_ListNotebookInstances_RequestSyntax) ** A filter that returns only notebook instances that were modified after the specified time (timestamp). Type: Timestamp Required: No ** [LastModifiedTimeBefore](#API_ListNotebookInstances_RequestSyntax) ** A filter that returns only notebook instances that were modified before the specified time (timestamp). Type: Timestamp Required: No ** [MaxResults](#API_ListNotebookInstances_RequestSyntax) ** The maximum number of notebook instances to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NameContains](#API_ListNotebookInstances_RequestSyntax) ** A string in the notebook instances' name. This filter returns only notebook instances whose name contains the specified string. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9-]+` Required: No ** [NextToken](#API_ListNotebookInstances_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [NotebookInstanceLifecycleConfigNameContains](#API_ListNotebookInstances_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9])*` Required: No ** [SortBy](#API_ListNotebookInstances_RequestSyntax) ** The field to sort results by. The default is `Name`. Type: String Valid Values: `Name | CreationTime | Status` Required: No ** [SortOrder](#API_ListNotebookInstances_RequestSyntax) ** The sort order for results. Type: String Valid Values: `Ascending | Descending` Required: No ** [StatusEquals](#API_ListNotebookInstances_RequestSyntax) ** A filter that returns only notebook instances with the specified status. Type: String Valid Values: `Pending | InService | Stopping | Stopped | Failed | Deleting | Updating` Required: No ## Response Syntax ``` { "NextToken": "string", "NotebookInstances": [ { "AdditionalCodeRepositories": [ "string" ], "CreationTime": number, "DefaultCodeRepository": "string", "InstanceType": "string", "LastModifiedTime": number, "NotebookInstanceArn": "string", "NotebookInstanceLifecycleConfigName": "string", "NotebookInstanceName": "string", "NotebookInstanceStatus": "string", "Url": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListNotebookInstances_ResponseSyntax) ** If the response to the previous `ListNotebookInstances` request was truncated, SageMaker AI returns this token. To retrieve the next set of notebook instances, use the token in the next request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ** [NotebookInstances](#API_ListNotebookInstances_ResponseSyntax) ** An array of `NotebookInstanceSummary` objects, one for each notebook instance. Type: Array of [NotebookInstanceSummary](API_NotebookInstanceSummary.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListNotebookInstances) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListNotebookInstances) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListNotebookInstances) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListNotebookInstances) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListNotebookInstances) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListNotebookInstances) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListNotebookInstances) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListNotebookInstances) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListNotebookInstances) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListNotebookInstances) # ListOptimizationJobs Lists the optimization jobs in your account and their properties. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "LastModifiedTimeAfter": number, "LastModifiedTimeBefore": number, "MaxResults": number, "NameContains": "string", "NextToken": "string", "OptimizationContains": "string", "SortBy": "string", "SortOrder": "string", "StatusEquals": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListOptimizationJobs_RequestSyntax) ** Filters the results to only those optimization jobs that were created after the specified time. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListOptimizationJobs_RequestSyntax) ** Filters the results to only those optimization jobs that were created before the specified time. Type: Timestamp Required: No ** [LastModifiedTimeAfter](#API_ListOptimizationJobs_RequestSyntax) ** Filters the results to only those optimization jobs that were updated after the specified time. Type: Timestamp Required: No ** [LastModifiedTimeBefore](#API_ListOptimizationJobs_RequestSyntax) ** Filters the results to only those optimization jobs that were updated before the specified time. Type: Timestamp Required: No ** [MaxResults](#API_ListOptimizationJobs_RequestSyntax) ** The maximum number of optimization jobs to return in the response. The default is 50. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NameContains](#API_ListOptimizationJobs_RequestSyntax) ** Filters the results to only those optimization jobs with a name that contains the specified string. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9\-]+` Required: No ** [NextToken](#API_ListOptimizationJobs_RequestSyntax) ** A token that you use to get the next set of results following a truncated response. If the response to the previous request was truncated, that response provides the value for this token. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [OptimizationContains](#API_ListOptimizationJobs_RequestSyntax) ** Filters the results to only those optimization jobs that apply the specified optimization techniques. You can specify either `Quantization` or `Compilation`. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9\-]+` Required: No ** [SortBy](#API_ListOptimizationJobs_RequestSyntax) ** The field by which to sort the optimization jobs in the response. The default is `CreationTime` Type: String Valid Values: `Name | CreationTime | Status` Required: No ** [SortOrder](#API_ListOptimizationJobs_RequestSyntax) ** The sort order for results. The default is `Ascending` Type: String Valid Values: `Ascending | Descending` Required: No ** [StatusEquals](#API_ListOptimizationJobs_RequestSyntax) ** Filters the results to only those optimization jobs with the specified status. Type: String Valid Values: `INPROGRESS | COMPLETED | FAILED | STARTING | STOPPING | STOPPED` Required: No ## Response Syntax ``` { "NextToken": "string", "OptimizationJobSummaries": [ { "CreationTime": number, "DeploymentInstanceType": "string", "LastModifiedTime": number, "MaxInstanceCount": number, "OptimizationEndTime": number, "OptimizationJobArn": "string", "OptimizationJobName": "string", "OptimizationJobStatus": "string", "OptimizationStartTime": number, "OptimizationTypes": [ "string" ] } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListOptimizationJobs_ResponseSyntax) ** The token to use in a subsequent request to get the next set of results following a truncated response. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ** [OptimizationJobSummaries](#API_ListOptimizationJobs_ResponseSyntax) ** A list of optimization jobs and their properties that matches any of the filters you specified in the request. Type: Array of [OptimizationJobSummary](API_OptimizationJobSummary.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListOptimizationJobs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListOptimizationJobs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListOptimizationJobs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListOptimizationJobs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListOptimizationJobs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListOptimizationJobs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListOptimizationJobs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListOptimizationJobs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListOptimizationJobs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListOptimizationJobs) # ListPartnerApps Lists all of the SageMaker Partner AI Apps in an account. ## Request Syntax ``` { "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [MaxResults](#API_ListPartnerApps_RequestSyntax) ** This parameter defines the maximum number of results that can be returned in a single response. The `MaxResults` parameter is an upper bound, not a target. If there are more results available than the value specified, a `NextToken` is provided in the response. The `NextToken` indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for `MaxResults` is 10. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListPartnerApps_RequestSyntax) ** If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ## Response Syntax ``` { "NextToken": "string", "Summaries": [ { "Arn": "string", "CreationTime": number, "Name": "string", "Status": "string", "Type": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListPartnerApps_ResponseSyntax) ** If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ** [Summaries](#API_ListPartnerApps_ResponseSyntax) ** The information related to each of the SageMaker Partner AI Apps in an account. Type: Array of [PartnerAppSummary](API_PartnerAppSummary.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListPartnerApps) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListPartnerApps) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListPartnerApps) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListPartnerApps) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListPartnerApps) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListPartnerApps) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListPartnerApps) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListPartnerApps) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListPartnerApps) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListPartnerApps) # ListPipelineExecutions Gets a list of the pipeline executions. ## Request Syntax ``` { "CreatedAfter": number, "CreatedBefore": number, "MaxResults": number, "NextToken": "string", "PipelineName": "string", "SortBy": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreatedAfter](#API_ListPipelineExecutions_RequestSyntax) ** A filter that returns the pipeline executions that were created after a specified time. Type: Timestamp Required: No ** [CreatedBefore](#API_ListPipelineExecutions_RequestSyntax) ** A filter that returns the pipeline executions that were created before a specified time. Type: Timestamp Required: No ** [MaxResults](#API_ListPipelineExecutions_RequestSyntax) ** The maximum number of pipeline executions to return in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListPipelineExecutions_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [PipelineName](#API_ListPipelineExecutions_RequestSyntax) ** The name or Amazon Resource Name (ARN) of the pipeline. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:pipeline/.*)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,255})` Required: Yes ** [SortBy](#API_ListPipelineExecutions_RequestSyntax) ** The field by which to sort results. The default is `CreatedTime`. Type: String Valid Values: `CreationTime | PipelineExecutionArn` Required: No ** [SortOrder](#API_ListPipelineExecutions_RequestSyntax) ** The sort order for results. Type: String Valid Values: `Ascending | Descending` Required: No ## Response Syntax ``` { "NextToken": "string", "PipelineExecutionSummaries": [ { "PipelineExecutionArn": "string", "PipelineExecutionDescription": "string", "PipelineExecutionDisplayName": "string", "PipelineExecutionFailureReason": "string", "PipelineExecutionStatus": "string", "StartTime": number } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListPipelineExecutions_ResponseSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ** [PipelineExecutionSummaries](#API_ListPipelineExecutions_ResponseSyntax) ** 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. Type: Array of [PipelineExecutionSummary](API_PipelineExecutionSummary.md) objects Array Members: Minimum number of 0 items. Maximum number of 100 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListPipelineExecutions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListPipelineExecutions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListPipelineExecutions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListPipelineExecutions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListPipelineExecutions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListPipelineExecutions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListPipelineExecutions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListPipelineExecutions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListPipelineExecutions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListPipelineExecutions) # ListPipelineExecutionSteps Gets a list of `PipeLineExecutionStep` objects. ## Request Syntax ``` { "MaxResults": number, "NextToken": "string", "PipelineExecutionArn": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [MaxResults](#API_ListPipelineExecutionSteps_RequestSyntax) ** The maximum number of pipeline execution steps to return in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListPipelineExecutionSteps_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [PipelineExecutionArn](#API_ListPipelineExecutionSteps_RequestSyntax) ** The Amazon Resource Name (ARN) of the pipeline execution. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:pipeline\/.*\/execution\/.*` Required: No ** [SortOrder](#API_ListPipelineExecutionSteps_RequestSyntax) ** The field by which to sort results. The default is `CreatedTime`. Type: String Valid Values: `Ascending | Descending` Required: No ## Response Syntax ``` { "NextToken": "string", "PipelineExecutionSteps": [ { "AttemptCount": number, "CacheHitResult": { "SourcePipelineExecutionArn": "string" }, "EndTime": number, "FailureReason": "string", "Metadata": { "AutoMLJob": { "Arn": "string" }, "BedrockCustomModel": { "Arn": "string" }, "BedrockCustomModelDeployment": { "Arn": "string" }, "BedrockModelImport": { "Arn": "string" }, "BedrockProvisionedModelThroughput": { "Arn": "string" }, "Callback": { "CallbackToken": "string", "OutputParameters": [ { "Name": "string", "Value": "string" } ], "SqsQueueUrl": "string" }, "ClarifyCheck": { "BaselineUsedForDriftCheckConstraints": "string", "CalculatedBaselineConstraints": "string", "CheckJobArn": "string", "CheckType": "string", "ModelPackageGroupName": "string", "RegisterNewBaseline": boolean, "SkipCheck": boolean, "ViolationReport": "string" }, "Condition": { "Outcome": "string" }, "EMR": { "ClusterId": "string", "LogFilePath": "string", "StepId": "string", "StepName": "string" }, "Endpoint": { "Arn": "string" }, "EndpointConfig": { "Arn": "string" }, "Fail": { "ErrorMessage": "string" }, "InferenceComponent": { "Arn": "string" }, "Lambda": { "Arn": "string", "OutputParameters": [ { "Name": "string", "Value": "string" } ] }, "Lineage": { "ActionArns": { "string" : "string" }, "ArtifactArns": { "string" : "string" }, "Associations": [ { "DestinationArn": "string", "SourceArn": "string" } ], "ContextArns": { "string" : "string" } }, "Model": { "Arn": "string" }, "ProcessingJob": { "Arn": "string" }, "QualityCheck": { "BaselineUsedForDriftCheckConstraints": "string", "BaselineUsedForDriftCheckStatistics": "string", "CalculatedBaselineConstraints": "string", "CalculatedBaselineStatistics": "string", "CheckJobArn": "string", "CheckType": "string", "ModelPackageGroupName": "string", "RegisterNewBaseline": boolean, "SkipCheck": boolean, "ViolationReport": "string" }, "RegisterModel": { "Arn": "string" }, "TrainingJob": { "Arn": "string" }, "TransformJob": { "Arn": "string" }, "TuningJob": { "Arn": "string" } }, "SelectiveExecutionResult": { "SourcePipelineExecutionArn": "string" }, "StartTime": number, "StepDescription": "string", "StepDisplayName": "string", "StepName": "string", "StepStatus": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListPipelineExecutionSteps_ResponseSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ** [PipelineExecutionSteps](#API_ListPipelineExecutionSteps_ResponseSyntax) ** 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. Type: Array of [PipelineExecutionStep](API_PipelineExecutionStep.md) objects Array Members: Minimum number of 0 items. Maximum number of 100 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListPipelineExecutionSteps) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListPipelineExecutionSteps) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListPipelineExecutionSteps) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListPipelineExecutionSteps) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListPipelineExecutionSteps) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListPipelineExecutionSteps) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListPipelineExecutionSteps) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListPipelineExecutionSteps) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListPipelineExecutionSteps) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListPipelineExecutionSteps) # ListPipelineParametersForExecution Gets a list of parameters for a pipeline execution. ## Request Syntax ``` { "MaxResults": number, "NextToken": "string", "PipelineExecutionArn": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [MaxResults](#API_ListPipelineParametersForExecution_RequestSyntax) ** The maximum number of parameters to return in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListPipelineParametersForExecution_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [PipelineExecutionArn](#API_ListPipelineParametersForExecution_RequestSyntax) ** The Amazon Resource Name (ARN) of the pipeline execution. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:pipeline\/.*\/execution\/.*` Required: Yes ## Response Syntax ``` { "NextToken": "string", "PipelineParameters": [ { "Name": "string", "Value": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListPipelineParametersForExecution_ResponseSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ** [PipelineParameters](#API_ListPipelineParametersForExecution_ResponseSyntax) ** Contains a list of pipeline parameters. This list can be empty. Type: Array of [Parameter](API_Parameter.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListPipelineParametersForExecution) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListPipelineParametersForExecution) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListPipelineParametersForExecution) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListPipelineParametersForExecution) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListPipelineParametersForExecution) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListPipelineParametersForExecution) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListPipelineParametersForExecution) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListPipelineParametersForExecution) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListPipelineParametersForExecution) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListPipelineParametersForExecution) # ListPipelines Gets a list of pipelines. ## Request Syntax ``` { "CreatedAfter": number, "CreatedBefore": number, "MaxResults": number, "NextToken": "string", "PipelineNamePrefix": "string", "SortBy": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreatedAfter](#API_ListPipelines_RequestSyntax) ** A filter that returns the pipelines that were created after a specified time. Type: Timestamp Required: No ** [CreatedBefore](#API_ListPipelines_RequestSyntax) ** A filter that returns the pipelines that were created before a specified time. Type: Timestamp Required: No ** [MaxResults](#API_ListPipelines_RequestSyntax) ** The maximum number of pipelines to return in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListPipelines_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [PipelineNamePrefix](#API_ListPipelines_RequestSyntax) ** The prefix of the pipeline name. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}` Required: No ** [SortBy](#API_ListPipelines_RequestSyntax) ** The field by which to sort results. The default is `CreatedTime`. Type: String Valid Values: `Name | CreationTime` Required: No ** [SortOrder](#API_ListPipelines_RequestSyntax) ** The sort order for results. Type: String Valid Values: `Ascending | Descending` Required: No ## Response Syntax ``` { "NextToken": "string", "PipelineSummaries": [ { "CreationTime": number, "LastExecutionTime": number, "LastModifiedTime": number, "PipelineArn": "string", "PipelineDescription": "string", "PipelineDisplayName": "string", "PipelineName": "string", "RoleArn": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListPipelines_ResponseSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ** [PipelineSummaries](#API_ListPipelines_ResponseSyntax) ** 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. Type: Array of [PipelineSummary](API_PipelineSummary.md) objects Array Members: Minimum number of 0 items. Maximum number of 100 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListPipelines) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListPipelines) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListPipelines) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListPipelines) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListPipelines) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListPipelines) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListPipelines) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListPipelines) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListPipelines) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListPipelines) # ListPipelineVersions Gets a list of all versions of the pipeline. ## Request Syntax ``` { "CreatedAfter": number, "CreatedBefore": number, "MaxResults": number, "NextToken": "string", "PipelineName": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreatedAfter](#API_ListPipelineVersions_RequestSyntax) ** A filter that returns the pipeline versions that were created after a specified time. Type: Timestamp Required: No ** [CreatedBefore](#API_ListPipelineVersions_RequestSyntax) ** A filter that returns the pipeline versions that were created before a specified time. Type: Timestamp Required: No ** [MaxResults](#API_ListPipelineVersions_RequestSyntax) ** The maximum number of pipeline versions to return in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListPipelineVersions_RequestSyntax) ** If the result of the previous `ListPipelineVersions` request was truncated, the response includes a `NextToken`. To retrieve the next set of pipeline versions, use this token in your next request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [PipelineName](#API_ListPipelineVersions_RequestSyntax) ** The Amazon Resource Name (ARN) of the pipeline. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:pipeline/.*)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,255})` Required: Yes ** [SortOrder](#API_ListPipelineVersions_RequestSyntax) ** The sort order for the results. Type: String Valid Values: `Ascending | Descending` Required: No ## Response Syntax ``` { "NextToken": "string", "PipelineVersionSummaries": [ { "CreationTime": number, "LastExecutionPipelineExecutionArn": "string", "PipelineArn": "string", "PipelineVersionDescription": "string", "PipelineVersionDisplayName": "string", "PipelineVersionId": number } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListPipelineVersions_ResponseSyntax) ** If the result of the previous `ListPipelineVersions` request was truncated, the response includes a `NextToken`. To retrieve the next set of pipeline versions, use this token in your next request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ** [PipelineVersionSummaries](#API_ListPipelineVersions_ResponseSyntax) ** Contains a sorted list of pipeline version summary objects matching the specified filters. Each version summary includes the pipeline version ID, the creation date, and the last pipeline execution created from that version. This list can be empty. Type: Array of [PipelineVersionSummary](API_PipelineVersionSummary.md) objects Array Members: Minimum number of 0 items. Maximum number of 100 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListPipelineVersions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListPipelineVersions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListPipelineVersions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListPipelineVersions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListPipelineVersions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListPipelineVersions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListPipelineVersions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListPipelineVersions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListPipelineVersions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListPipelineVersions) # ListProcessingJobs Lists processing jobs that satisfy various filters. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "LastModifiedTimeAfter": number, "LastModifiedTimeBefore": number, "MaxResults": number, "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string", "StatusEquals": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListProcessingJobs_RequestSyntax) ** A filter that returns only processing jobs created after the specified time. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListProcessingJobs_RequestSyntax) ** A filter that returns only processing jobs created after the specified time. Type: Timestamp Required: No ** [LastModifiedTimeAfter](#API_ListProcessingJobs_RequestSyntax) ** A filter that returns only processing jobs modified after the specified time. Type: Timestamp Required: No ** [LastModifiedTimeBefore](#API_ListProcessingJobs_RequestSyntax) ** A filter that returns only processing jobs modified before the specified time. Type: Timestamp Required: No ** [MaxResults](#API_ListProcessingJobs_RequestSyntax) ** The maximum number of processing jobs to return in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NameContains](#API_ListProcessingJobs_RequestSyntax) ** A string in the processing job name. This filter returns only processing jobs whose name contains the specified string. Type: String Required: No ** [NextToken](#API_ListProcessingJobs_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListProcessingJobs_RequestSyntax) ** The field to sort results by. The default is `CreationTime`. Type: String Valid Values: `Name | CreationTime | Status` Required: No ** [SortOrder](#API_ListProcessingJobs_RequestSyntax) ** The sort order for results. The default is `Ascending`. Type: String Valid Values: `Ascending | Descending` Required: No ** [StatusEquals](#API_ListProcessingJobs_RequestSyntax) ** A filter that retrieves only processing jobs with a specific status. Type: String Valid Values: `InProgress | Completed | Failed | Stopping | Stopped` Required: No ## Response Syntax ``` { "NextToken": "string", "ProcessingJobSummaries": [ { "CreationTime": number, "ExitMessage": "string", "FailureReason": "string", "LastModifiedTime": number, "ProcessingEndTime": number, "ProcessingJobArn": "string", "ProcessingJobName": "string", "ProcessingJobStatus": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListProcessingJobs_ResponseSyntax) ** If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of processing jobs, use it in the subsequent request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ** [ProcessingJobSummaries](#API_ListProcessingJobs_ResponseSyntax) ** An array of `ProcessingJobSummary` objects, each listing a processing job. Type: Array of [ProcessingJobSummary](API_ProcessingJobSummary.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListProcessingJobs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListProcessingJobs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListProcessingJobs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListProcessingJobs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListProcessingJobs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListProcessingJobs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListProcessingJobs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListProcessingJobs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListProcessingJobs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListProcessingJobs) # ListProjects Gets a list of the projects in an AWS account. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "MaxResults": number, "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListProjects_RequestSyntax) ** A filter that returns the projects that were created after a specified time. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListProjects_RequestSyntax) ** A filter that returns the projects that were created before a specified time. Type: Timestamp Required: No ** [MaxResults](#API_ListProjects_RequestSyntax) ** The maximum number of projects to return in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NameContains](#API_ListProjects_RequestSyntax) ** A filter that returns the projects whose name contains a specified string. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}` Required: No ** [NextToken](#API_ListProjects_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListProjects_RequestSyntax) ** The field by which to sort results. The default is `CreationTime`. Type: String Valid Values: `Name | CreationTime` Required: No ** [SortOrder](#API_ListProjects_RequestSyntax) ** The sort order for results. The default is `Ascending`. Type: String Valid Values: `Ascending | Descending` Required: No ## Response Syntax ``` { "NextToken": "string", "ProjectSummaryList": [ { "CreationTime": number, "ProjectArn": "string", "ProjectDescription": "string", "ProjectId": "string", "ProjectName": "string", "ProjectStatus": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListProjects_ResponseSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ** [ProjectSummaryList](#API_ListProjects_ResponseSyntax) ** A list of summaries of projects. Type: Array of [ProjectSummary](API_ProjectSummary.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListProjects) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListProjects) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListProjects) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListProjects) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListProjects) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListProjects) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListProjects) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListProjects) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListProjects) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListProjects) # ListResourceCatalogs Lists Amazon SageMaker Catalogs based on given filters and orders. The maximum number of `ResourceCatalog`s viewable is 1000. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "MaxResults": number, "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListResourceCatalogs_RequestSyntax) ** Use this parameter to search for `ResourceCatalog`s created after a specific date and time. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListResourceCatalogs_RequestSyntax) ** Use this parameter to search for `ResourceCatalog`s created before a specific date and time. Type: Timestamp Required: No ** [MaxResults](#API_ListResourceCatalogs_RequestSyntax) ** The maximum number of results returned by `ListResourceCatalogs`. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NameContains](#API_ListResourceCatalogs_RequestSyntax) ** A string that partially matches one or more `ResourceCatalog`s names. Filters `ResourceCatalog` by name. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No ** [NextToken](#API_ListResourceCatalogs_RequestSyntax) ** A token to resume pagination of `ListResourceCatalogs` results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListResourceCatalogs_RequestSyntax) ** The value on which the resource catalog list is sorted. Type: String Valid Values: `CreationTime` Required: No ** [SortOrder](#API_ListResourceCatalogs_RequestSyntax) ** The order in which the resource catalogs are listed. Type: String Valid Values: `Ascending | Descending` Required: No ## Response Syntax ``` { "NextToken": "string", "ResourceCatalogs": [ { "CreationTime": number, "Description": "string", "ResourceCatalogArn": "string", "ResourceCatalogName": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListResourceCatalogs_ResponseSyntax) ** A token to resume pagination of `ListResourceCatalogs` results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ** [ResourceCatalogs](#API_ListResourceCatalogs_ResponseSyntax) ** A list of the requested `ResourceCatalog`s. Type: Array of [ResourceCatalog](API_ResourceCatalog.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListResourceCatalogs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListResourceCatalogs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListResourceCatalogs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListResourceCatalogs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListResourceCatalogs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListResourceCatalogs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListResourceCatalogs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListResourceCatalogs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListResourceCatalogs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListResourceCatalogs) # ListSpaces Lists spaces. ## Request Syntax ``` { "DomainIdEquals": "string", "MaxResults": number, "NextToken": "string", "SortBy": "string", "SortOrder": "string", "SpaceNameContains": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DomainIdEquals](#API_ListSpaces_RequestSyntax) ** A parameter to search for the domain ID. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `d-(-*[a-z0-9]){1,61}` Required: No ** [MaxResults](#API_ListSpaces_RequestSyntax) ** This parameter defines the maximum number of results that can be return in a single response. The `MaxResults` parameter is an upper bound, not a target. If there are more results available than the value specified, a `NextToken` is provided in the response. The `NextToken` indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for `MaxResults` is 10. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListSpaces_RequestSyntax) ** If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListSpaces_RequestSyntax) ** The parameter by which to sort the results. The default is `CreationTime`. Type: String Valid Values: `CreationTime | LastModifiedTime` Required: No ** [SortOrder](#API_ListSpaces_RequestSyntax) ** The sort order for the results. The default is `Ascending`. Type: String Valid Values: `Ascending | Descending` Required: No ** [SpaceNameContains](#API_ListSpaces_RequestSyntax) ** A parameter by which to filter the results. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: No ## Response Syntax ``` { "NextToken": "string", "Spaces": [ { "CreationTime": number, "DomainId": "string", "LastModifiedTime": number, "OwnershipSettingsSummary": { "OwnerUserProfileName": "string" }, "SpaceDisplayName": "string", "SpaceName": "string", "SpaceSettingsSummary": { "AppType": "string", "RemoteAccess": "string", "SpaceStorageSettings": { "EbsStorageSettings": { "EbsVolumeSizeInGb": number } } }, "SpaceSharingSettingsSummary": { "SharingType": "string" }, "Status": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListSpaces_ResponseSyntax) ** If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ** [Spaces](#API_ListSpaces_ResponseSyntax) ** The list of spaces. Type: Array of [SpaceDetails](API_SpaceDetails.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListSpaces) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListSpaces) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListSpaces) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListSpaces) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListSpaces) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListSpaces) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListSpaces) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListSpaces) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListSpaces) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListSpaces) # ListStageDevices Lists devices allocated to the stage, containing detailed device information and deployment status. ## Request Syntax ``` { "EdgeDeploymentPlanName": "string", "ExcludeDevicesDeployedInOtherStage": boolean, "MaxResults": number, "NextToken": "string", "StageName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [EdgeDeploymentPlanName](#API_ListStageDevices_RequestSyntax) ** The name of the edge deployment plan. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [ExcludeDevicesDeployedInOtherStage](#API_ListStageDevices_RequestSyntax) ** Toggle for excluding devices deployed in other stages. Type: Boolean Required: No ** [MaxResults](#API_ListStageDevices_RequestSyntax) ** The maximum number of requests to select. Type: Integer Valid Range: Maximum value of 100. Required: No ** [NextToken](#API_ListStageDevices_RequestSyntax) ** The response from the last list when returning a list large enough to neeed tokening. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [StageName](#API_ListStageDevices_RequestSyntax) ** The name of the stage in the deployment. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "DeviceDeploymentSummaries": [ { "DeployedStageName": "string", "DeploymentStartTime": number, "Description": "string", "DeviceArn": "string", "DeviceDeploymentStatus": "string", "DeviceDeploymentStatusMessage": "string", "DeviceFleetName": "string", "DeviceName": "string", "EdgeDeploymentPlanArn": "string", "EdgeDeploymentPlanName": "string", "StageName": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DeviceDeploymentSummaries](#API_ListStageDevices_ResponseSyntax) ** List of summaries of devices allocated to the stage. Type: Array of [DeviceDeploymentSummary](API_DeviceDeploymentSummary.md) objects ** [NextToken](#API_ListStageDevices_ResponseSyntax) ** The token to use when calling the next page of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListStageDevices) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListStageDevices) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListStageDevices) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListStageDevices) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListStageDevices) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListStageDevices) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListStageDevices) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListStageDevices) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListStageDevices) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListStageDevices) # ListStudioLifecycleConfigs Lists the Amazon SageMaker AI Studio Lifecycle Configurations in your AWS Account. ## Request Syntax ``` { "AppTypeEquals": "string", "CreationTimeAfter": number, "CreationTimeBefore": number, "MaxResults": number, "ModifiedTimeAfter": number, "ModifiedTimeBefore": number, "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AppTypeEquals](#API_ListStudioLifecycleConfigs_RequestSyntax) ** A parameter to search for the App Type to which the Lifecycle Configuration is attached. Type: String Valid Values: `JupyterServer | KernelGateway | CodeEditor | JupyterLab` Required: No ** [CreationTimeAfter](#API_ListStudioLifecycleConfigs_RequestSyntax) ** A filter that returns only Lifecycle Configurations created on or after the specified time. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListStudioLifecycleConfigs_RequestSyntax) ** A filter that returns only Lifecycle Configurations created on or before the specified time. Type: Timestamp Required: No ** [MaxResults](#API_ListStudioLifecycleConfigs_RequestSyntax) ** The total number of items to return in the response. If the total number of items available is more than the value specified, a `NextToken` is provided in the response. To resume pagination, provide the `NextToken` value in the as part of a subsequent call. The default value is 10. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [ModifiedTimeAfter](#API_ListStudioLifecycleConfigs_RequestSyntax) ** A filter that returns only Lifecycle Configurations modified after the specified time. Type: Timestamp Required: No ** [ModifiedTimeBefore](#API_ListStudioLifecycleConfigs_RequestSyntax) ** A filter that returns only Lifecycle Configurations modified before the specified time. Type: Timestamp Required: No ** [NameContains](#API_ListStudioLifecycleConfigs_RequestSyntax) ** A string in the Lifecycle Configuration name. This filter returns only Lifecycle Configurations whose name contains the specified string. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: No ** [NextToken](#API_ListStudioLifecycleConfigs_RequestSyntax) ** If the previous call to ListStudioLifecycleConfigs didn't return the full set of Lifecycle Configurations, the call returns a token for getting the next set of Lifecycle Configurations. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListStudioLifecycleConfigs_RequestSyntax) ** The property used to sort results. The default value is CreationTime. Type: String Valid Values: `CreationTime | LastModifiedTime | Name` Required: No ** [SortOrder](#API_ListStudioLifecycleConfigs_RequestSyntax) ** The sort order. The default value is Descending. Type: String Valid Values: `Ascending | Descending` Required: No ## Response Syntax ``` { "NextToken": "string", "StudioLifecycleConfigs": [ { "CreationTime": number, "LastModifiedTime": number, "StudioLifecycleConfigAppType": "string", "StudioLifecycleConfigArn": "string", "StudioLifecycleConfigName": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListStudioLifecycleConfigs_ResponseSyntax) ** If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ** [StudioLifecycleConfigs](#API_ListStudioLifecycleConfigs_ResponseSyntax) ** A list of Lifecycle Configurations and their properties. Type: Array of [StudioLifecycleConfigDetails](API_StudioLifecycleConfigDetails.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListStudioLifecycleConfigs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListStudioLifecycleConfigs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListStudioLifecycleConfigs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListStudioLifecycleConfigs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListStudioLifecycleConfigs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListStudioLifecycleConfigs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListStudioLifecycleConfigs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListStudioLifecycleConfigs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListStudioLifecycleConfigs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListStudioLifecycleConfigs) # ListSubscribedWorkteams 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. ## Request Syntax ``` { "MaxResults": number, "NameContains": "string", "NextToken": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [MaxResults](#API_ListSubscribedWorkteams_RequestSyntax) ** The maximum number of work teams to return in each page of the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NameContains](#API_ListSubscribedWorkteams_RequestSyntax) ** A string in the work team name. This filter returns only work teams whose name contains the specified string. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: No ** [NextToken](#API_ListSubscribedWorkteams_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ## Response Syntax ``` { "NextToken": "string", "SubscribedWorkteams": [ { "ListingId": "string", "MarketplaceDescription": "string", "MarketplaceTitle": "string", "SellerName": "string", "WorkteamArn": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListSubscribedWorkteams_ResponseSyntax) ** If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ** [SubscribedWorkteams](#API_ListSubscribedWorkteams_ResponseSyntax) ** An array of `Workteam` objects, each describing a work team. Type: Array of [SubscribedWorkteam](API_SubscribedWorkteam.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListSubscribedWorkteams) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListSubscribedWorkteams) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListSubscribedWorkteams) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListSubscribedWorkteams) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListSubscribedWorkteams) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListSubscribedWorkteams) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListSubscribedWorkteams) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListSubscribedWorkteams) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListSubscribedWorkteams) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListSubscribedWorkteams) # ListTags Returns the tags for the specified SageMaker resource. ## Request Syntax ``` { "MaxResults": number, "NextToken": "string", "ResourceArn": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [MaxResults](#API_ListTags_RequestSyntax) ** Maximum number of tags to return. Type: Integer Valid Range: Minimum value of 50. Required: No ** [NextToken](#API_ListTags_RequestSyntax) ** If the response to the previous `ListTags` request is truncated, SageMaker returns this token. To retrieve the next set of tags, use it in the subsequent request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [ResourceArn](#API_ListTags_RequestSyntax) ** The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z-]*:sagemaker:[a-z0-9-]*:[0-9]{12}:.+` Required: Yes ## Response Syntax ``` { "NextToken": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListTags_ResponseSyntax) ** If response is truncated, SageMaker includes a token in the response. You can use this token in your subsequent request to fetch next set of tokens. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ** [Tags](#API_ListTags_ResponseSyntax) ** An array of `Tag` objects, each with a tag key and a value. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListTags) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListTags) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListTags) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListTags) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListTags) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListTags) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListTags) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListTags) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListTags) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListTags) # ListTrainingJobs Lists training jobs. **Note** 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 ... }` First, 100 trainings jobs with any status, including those other than `InProgress`, are selected (sorted according to the creation time, from the most current to the oldest). Next, those with a status of `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` ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "LastModifiedTimeAfter": number, "LastModifiedTimeBefore": number, "MaxResults": number, "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string", "StatusEquals": "string", "TrainingPlanArnEquals": "string", "WarmPoolStatusEquals": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListTrainingJobs_RequestSyntax) ** A filter that returns only training jobs created after the specified time (timestamp). Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListTrainingJobs_RequestSyntax) ** A filter that returns only training jobs created before the specified time (timestamp). Type: Timestamp Required: No ** [LastModifiedTimeAfter](#API_ListTrainingJobs_RequestSyntax) ** A filter that returns only training jobs modified after the specified time (timestamp). Type: Timestamp Required: No ** [LastModifiedTimeBefore](#API_ListTrainingJobs_RequestSyntax) ** A filter that returns only training jobs modified before the specified time (timestamp). Type: Timestamp Required: No ** [MaxResults](#API_ListTrainingJobs_RequestSyntax) ** The maximum number of training jobs to return in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NameContains](#API_ListTrainingJobs_RequestSyntax) ** A string in the training job name. This filter returns only training jobs whose name contains the specified string. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9\-]+` Required: No ** [NextToken](#API_ListTrainingJobs_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListTrainingJobs_RequestSyntax) ** The field to sort results by. The default is `CreationTime`. Type: String Valid Values: `Name | CreationTime | Status` Required: No ** [SortOrder](#API_ListTrainingJobs_RequestSyntax) ** The sort order for results. The default is `Ascending`. Type: String Valid Values: `Ascending | Descending` Required: No ** [StatusEquals](#API_ListTrainingJobs_RequestSyntax) ** A filter that retrieves only training jobs with a specific status. Type: String Valid Values: `InProgress | Completed | Failed | Stopping | Stopped | Deleting` Required: No ** [TrainingPlanArnEquals](#API_ListTrainingJobs_RequestSyntax) ** The Amazon Resource Name (ARN); of the training plan to filter training jobs by. For more information about reserving GPU capacity for your SageMaker training jobs using Amazon SageMaker Training Plan, see ` [CreateTrainingPlan](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingPlan.html) `. Type: String Length Constraints: Minimum length of 50. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:training-plan/.*` Required: No ** [WarmPoolStatusEquals](#API_ListTrainingJobs_RequestSyntax) ** A filter that retrieves only training jobs with a specific warm pool status. Type: String Valid Values: `Available | Terminated | Reused | InUse` Required: No ## Response Syntax ``` { "NextToken": "string", "TrainingJobSummaries": [ { "CreationTime": number, "LastModifiedTime": number, "SecondaryStatus": "string", "TrainingEndTime": number, "TrainingJobArn": "string", "TrainingJobName": "string", "TrainingJobStatus": "string", "TrainingPlanArn": "string", "WarmPoolStatus": { "ResourceRetainedBillableTimeInSeconds": number, "ReusedByJob": "string", "Status": "string" } } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListTrainingJobs_ResponseSyntax) ** If the response is truncated, SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ** [TrainingJobSummaries](#API_ListTrainingJobs_ResponseSyntax) ** An array of `TrainingJobSummary` objects, each listing a training job. Type: Array of [TrainingJobSummary](API_TrainingJobSummary.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListTrainingJobs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListTrainingJobs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListTrainingJobs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListTrainingJobs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListTrainingJobs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListTrainingJobs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListTrainingJobs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListTrainingJobs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListTrainingJobs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListTrainingJobs) # ListTrainingJobsForHyperParameterTuningJob Gets a list of [TrainingJobSummary](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html) objects that describe the training jobs that a hyperparameter tuning job launched. ## Request Syntax ``` { "HyperParameterTuningJobName": "string", "MaxResults": number, "NextToken": "string", "SortBy": "string", "SortOrder": "string", "StatusEquals": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [HyperParameterTuningJobName](#API_ListTrainingJobsForHyperParameterTuningJob_RequestSyntax) ** The name of the tuning job whose training jobs you want to list. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}` Required: Yes ** [MaxResults](#API_ListTrainingJobsForHyperParameterTuningJob_RequestSyntax) ** The maximum number of training jobs to return. The default value is 10. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListTrainingJobsForHyperParameterTuningJob_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListTrainingJobsForHyperParameterTuningJob_RequestSyntax) ** 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. Type: String Valid Values: `Name | CreationTime | Status | FinalObjectiveMetricValue` Required: No ** [SortOrder](#API_ListTrainingJobsForHyperParameterTuningJob_RequestSyntax) ** The sort order for results. The default is `Ascending`. Type: String Valid Values: `Ascending | Descending` Required: No ** [StatusEquals](#API_ListTrainingJobsForHyperParameterTuningJob_RequestSyntax) ** A filter that returns only training jobs with the specified status. Type: String Valid Values: `InProgress | Completed | Failed | Stopping | Stopped | Deleting` Required: No ## Response Syntax ``` { "NextToken": "string", "TrainingJobSummaries": [ { "CreationTime": number, "FailureReason": "string", "FinalHyperParameterTuningJobObjectiveMetric": { "MetricName": "string", "Type": "string", "Value": number }, "ObjectiveStatus": "string", "TrainingEndTime": number, "TrainingJobArn": "string", "TrainingJobDefinitionName": "string", "TrainingJobName": "string", "TrainingJobStatus": "string", "TrainingStartTime": number, "TunedHyperParameters": { "string" : "string" }, "TuningJobName": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListTrainingJobsForHyperParameterTuningJob_ResponseSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ** [TrainingJobSummaries](#API_ListTrainingJobsForHyperParameterTuningJob_ResponseSyntax) ** A list of [TrainingJobSummary](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html) objects that describe the training jobs that the `ListTrainingJobsForHyperParameterTuningJob` request returned. Type: Array of [HyperParameterTrainingJobSummary](API_HyperParameterTrainingJobSummary.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListTrainingJobsForHyperParameterTuningJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListTrainingJobsForHyperParameterTuningJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListTrainingJobsForHyperParameterTuningJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListTrainingJobsForHyperParameterTuningJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListTrainingJobsForHyperParameterTuningJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListTrainingJobsForHyperParameterTuningJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListTrainingJobsForHyperParameterTuningJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListTrainingJobsForHyperParameterTuningJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListTrainingJobsForHyperParameterTuningJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListTrainingJobsForHyperParameterTuningJob) # ListTrainingPlans Retrieves a list of training plans for the current account. ## Request Syntax ``` { "Filters": [ { "Name": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string", "SortBy": "string", "SortOrder": "string", "StartTimeAfter": number, "StartTimeBefore": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Filters](#API_ListTrainingPlans_RequestSyntax) ** Additional filters to apply to the list of training plans. Type: Array of [TrainingPlanFilter](API_TrainingPlanFilter.md) objects Array Members: Minimum number of 1 item. Maximum number of 5 items. Required: No ** [MaxResults](#API_ListTrainingPlans_RequestSyntax) ** The maximum number of results to return in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListTrainingPlans_RequestSyntax) ** A token to continue pagination if more results are available. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListTrainingPlans_RequestSyntax) ** The training plan field to sort the results by (e.g., StartTime, Status). Type: String Valid Values: `TrainingPlanName | StartTime | Status` Required: No ** [SortOrder](#API_ListTrainingPlans_RequestSyntax) ** The order to sort the results (Ascending or Descending). Type: String Valid Values: `Ascending | Descending` Required: No ** [StartTimeAfter](#API_ListTrainingPlans_RequestSyntax) ** Filter to list only training plans with an actual start time after this date. Type: Timestamp Required: No ** [StartTimeBefore](#API_ListTrainingPlans_RequestSyntax) ** Filter to list only training plans with an actual start time before this date. Type: Timestamp Required: No ## Response Syntax ``` { "NextToken": "string", "TrainingPlanSummaries": [ { "AvailableInstanceCount": number, "CurrencyCode": "string", "DurationHours": number, "DurationMinutes": number, "EndTime": number, "InUseInstanceCount": number, "ReservedCapacitySummaries": [ { "AvailabilityZone": "string", "DurationHours": number, "DurationMinutes": number, "EndTime": number, "InstanceType": "string", "ReservedCapacityArn": "string", "ReservedCapacityType": "string", "StartTime": number, "Status": "string", "TotalInstanceCount": number, "UltraServerCount": number, "UltraServerType": "string" } ], "StartTime": number, "Status": "string", "StatusMessage": "string", "TargetResources": [ "string" ], "TotalInstanceCount": number, "TotalUltraServerCount": number, "TrainingPlanArn": "string", "TrainingPlanName": "string", "UpfrontFee": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListTrainingPlans_ResponseSyntax) ** A token to continue pagination if more results are available. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ** [TrainingPlanSummaries](#API_ListTrainingPlans_ResponseSyntax) ** A list of summary information for the training plans. Type: Array of [TrainingPlanSummary](API_TrainingPlanSummary.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListTrainingPlans) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListTrainingPlans) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListTrainingPlans) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListTrainingPlans) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListTrainingPlans) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListTrainingPlans) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListTrainingPlans) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListTrainingPlans) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListTrainingPlans) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListTrainingPlans) # ListTransformJobs Lists transform jobs. ## Request Syntax ``` { "CreationTimeAfter": number, "CreationTimeBefore": number, "LastModifiedTimeAfter": number, "LastModifiedTimeBefore": number, "MaxResults": number, "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string", "StatusEquals": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreationTimeAfter](#API_ListTransformJobs_RequestSyntax) ** A filter that returns only transform jobs created after the specified time. Type: Timestamp Required: No ** [CreationTimeBefore](#API_ListTransformJobs_RequestSyntax) ** A filter that returns only transform jobs created before the specified time. Type: Timestamp Required: No ** [LastModifiedTimeAfter](#API_ListTransformJobs_RequestSyntax) ** A filter that returns only transform jobs modified after the specified time. Type: Timestamp Required: No ** [LastModifiedTimeBefore](#API_ListTransformJobs_RequestSyntax) ** A filter that returns only transform jobs modified before the specified time. Type: Timestamp Required: No ** [MaxResults](#API_ListTransformJobs_RequestSyntax) ** The maximum number of transform jobs to return in the response. The default value is `10`. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NameContains](#API_ListTransformJobs_RequestSyntax) ** A string in the transform job name. This filter returns only transform jobs whose name contains the specified string. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9\-]+` Required: No ** [NextToken](#API_ListTransformJobs_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListTransformJobs_RequestSyntax) ** The field to sort results by. The default is `CreationTime`. Type: String Valid Values: `Name | CreationTime | Status` Required: No ** [SortOrder](#API_ListTransformJobs_RequestSyntax) ** The sort order for results. The default is `Descending`. Type: String Valid Values: `Ascending | Descending` Required: No ** [StatusEquals](#API_ListTransformJobs_RequestSyntax) ** A filter that retrieves only transform jobs with a specific status. Type: String Valid Values: `InProgress | Completed | Failed | Stopping | Stopped` Required: No ## Response Syntax ``` { "NextToken": "string", "TransformJobSummaries": [ { "CreationTime": number, "FailureReason": "string", "LastModifiedTime": number, "TransformEndTime": number, "TransformJobArn": "string", "TransformJobName": "string", "TransformJobStatus": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListTransformJobs_ResponseSyntax) ** If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of transform jobs, use it in the next request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ** [TransformJobSummaries](#API_ListTransformJobs_ResponseSyntax) ** An array of `TransformJobSummary` objects. Type: Array of [TransformJobSummary](API_TransformJobSummary.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListTransformJobs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListTransformJobs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListTransformJobs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListTransformJobs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListTransformJobs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListTransformJobs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListTransformJobs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListTransformJobs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListTransformJobs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListTransformJobs) # ListTrialComponents 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` ## Request Syntax ``` { "CreatedAfter": number, "CreatedBefore": number, "ExperimentName": "string", "MaxResults": number, "NextToken": "string", "SortBy": "string", "SortOrder": "string", "SourceArn": "string", "TrialName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreatedAfter](#API_ListTrialComponents_RequestSyntax) ** A filter that returns only components created after the specified time. Type: Timestamp Required: No ** [CreatedBefore](#API_ListTrialComponents_RequestSyntax) ** A filter that returns only components created before the specified time. Type: Timestamp Required: No ** [ExperimentName](#API_ListTrialComponents_RequestSyntax) ** 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`. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` Required: No ** [MaxResults](#API_ListTrialComponents_RequestSyntax) ** The maximum number of components to return in the response. The default value is 10. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListTrialComponents_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListTrialComponents_RequestSyntax) ** The property used to sort results. The default value is `CreationTime`. Type: String Valid Values: `Name | CreationTime` Required: No ** [SortOrder](#API_ListTrialComponents_RequestSyntax) ** The sort order. The default value is `Descending`. Type: String Valid Values: `Ascending | Descending` Required: No ** [SourceArn](#API_ListTrialComponents_RequestSyntax) ** 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`. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Required: No ** [TrialName](#API_ListTrialComponents_RequestSyntax) ** 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`. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` Required: No ## Response Syntax ``` { "NextToken": "string", "TrialComponentSummaries": [ { "CreatedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "DisplayName": "string", "EndTime": number, "LastModifiedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "StartTime": number, "Status": { "Message": "string", "PrimaryStatus": "string" }, "TrialComponentArn": "string", "TrialComponentName": "string", "TrialComponentSource": { "SourceArn": "string", "SourceType": "string" } } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListTrialComponents_ResponseSyntax) ** A token for getting the next set of components, if there are any. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ** [TrialComponentSummaries](#API_ListTrialComponents_ResponseSyntax) ** A list of the summaries of your trial components. Type: Array of [TrialComponentSummary](API_TrialComponentSummary.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListTrialComponents) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListTrialComponents) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListTrialComponents) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListTrialComponents) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListTrialComponents) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListTrialComponents) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListTrialComponents) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListTrialComponents) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListTrialComponents) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListTrialComponents) # ListTrials 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. ## Request Syntax ``` { "CreatedAfter": number, "CreatedBefore": number, "ExperimentName": "string", "MaxResults": number, "NextToken": "string", "SortBy": "string", "SortOrder": "string", "TrialComponentName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CreatedAfter](#API_ListTrials_RequestSyntax) ** A filter that returns only trials created after the specified time. Type: Timestamp Required: No ** [CreatedBefore](#API_ListTrials_RequestSyntax) ** A filter that returns only trials created before the specified time. Type: Timestamp Required: No ** [ExperimentName](#API_ListTrials_RequestSyntax) ** A filter that returns only trials that are part of the specified experiment. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` Required: No ** [MaxResults](#API_ListTrials_RequestSyntax) ** The maximum number of trials to return in the response. The default value is 10. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListTrials_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListTrials_RequestSyntax) ** The property used to sort results. The default value is `CreationTime`. Type: String Valid Values: `Name | CreationTime` Required: No ** [SortOrder](#API_ListTrials_RequestSyntax) ** The sort order. The default value is `Descending`. Type: String Valid Values: `Ascending | Descending` Required: No ** [TrialComponentName](#API_ListTrials_RequestSyntax) ** A filter that returns only trials that are associated with the specified trial component. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` Required: No ## Response Syntax ``` { "NextToken": "string", "TrialSummaries": [ { "CreationTime": number, "DisplayName": "string", "LastModifiedTime": number, "TrialArn": "string", "TrialName": "string", "TrialSource": { "SourceArn": "string", "SourceType": "string" } } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListTrials_ResponseSyntax) ** A token for getting the next set of trials, if there are any. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ** [TrialSummaries](#API_ListTrials_ResponseSyntax) ** A list of the summaries of your trials. Type: Array of [TrialSummary](API_TrialSummary.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListTrials) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListTrials) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListTrials) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListTrials) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListTrials) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListTrials) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListTrials) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListTrials) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListTrials) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListTrials) # ListUltraServersByReservedCapacity Lists all UltraServers that are part of a specified reserved capacity. ## Request Syntax ``` { "MaxResults": number, "NextToken": "string", "ReservedCapacityArn": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [MaxResults](#API_ListUltraServersByReservedCapacity_RequestSyntax) ** The maximum number of UltraServers to return in the response. The default value is 10. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListUltraServersByReservedCapacity_RequestSyntax) ** If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [ReservedCapacityArn](#API_ListUltraServersByReservedCapacity_RequestSyntax) ** The ARN of the reserved capacity to list UltraServers for. Type: String Length Constraints: Minimum length of 50. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:reserved-capacity/.*` Required: Yes ## Response Syntax ``` { "NextToken": "string", "UltraServers": [ { "AvailabilityZone": "string", "AvailableInstanceCount": number, "AvailableSpareInstanceCount": number, "ConfiguredSpareInstanceCount": number, "HealthStatus": "string", "InstanceType": "string", "InUseInstanceCount": number, "TotalInstanceCount": number, "UltraServerId": "string", "UltraServerType": "string", "UnhealthyInstanceCount": number } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListUltraServersByReservedCapacity_ResponseSyntax) ** If the response is truncated, SageMaker returns this token. Use it in the next request to retrieve the next set of UltraServers. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ** [UltraServers](#API_ListUltraServersByReservedCapacity_ResponseSyntax) ** A list of UltraServers that are part of the specified reserved capacity. Type: Array of [UltraServer](API_UltraServer.md) objects Array Members: Minimum number of 0 items. Maximum number of 100 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListUltraServersByReservedCapacity) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListUltraServersByReservedCapacity) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListUltraServersByReservedCapacity) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListUltraServersByReservedCapacity) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListUltraServersByReservedCapacity) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListUltraServersByReservedCapacity) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListUltraServersByReservedCapacity) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListUltraServersByReservedCapacity) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListUltraServersByReservedCapacity) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListUltraServersByReservedCapacity) # ListUserProfiles Lists user profiles. ## Request Syntax ``` { "DomainIdEquals": "string", "MaxResults": number, "NextToken": "string", "SortBy": "string", "SortOrder": "string", "UserProfileNameContains": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DomainIdEquals](#API_ListUserProfiles_RequestSyntax) ** A parameter by which to filter the results. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `d-(-*[a-z0-9]){1,61}` Required: No ** [MaxResults](#API_ListUserProfiles_RequestSyntax) ** This parameter defines the maximum number of results that can be return in a single response. The `MaxResults` parameter is an upper bound, not a target. If there are more results available than the value specified, a `NextToken` is provided in the response. The `NextToken` indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for `MaxResults` is 10. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListUserProfiles_RequestSyntax) ** If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListUserProfiles_RequestSyntax) ** The parameter by which to sort the results. The default is CreationTime. Type: String Valid Values: `CreationTime | LastModifiedTime` Required: No ** [SortOrder](#API_ListUserProfiles_RequestSyntax) ** The sort order for the results. The default is Ascending. Type: String Valid Values: `Ascending | Descending` Required: No ** [UserProfileNameContains](#API_ListUserProfiles_RequestSyntax) ** A parameter by which to filter the results. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: No ## Response Syntax ``` { "NextToken": "string", "UserProfiles": [ { "CreationTime": number, "DomainId": "string", "LastModifiedTime": number, "Status": "string", "UserProfileName": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListUserProfiles_ResponseSyntax) ** If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ** [UserProfiles](#API_ListUserProfiles_ResponseSyntax) ** The list of user profiles. Type: Array of [UserProfileDetails](API_UserProfileDetails.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListUserProfiles) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListUserProfiles) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListUserProfiles) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListUserProfiles) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListUserProfiles) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListUserProfiles) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListUserProfiles) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListUserProfiles) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListUserProfiles) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListUserProfiles) # ListWorkforces 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. ## Request Syntax ``` { "MaxResults": number, "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [MaxResults](#API_ListWorkforces_RequestSyntax) ** The maximum number of workforces returned in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NameContains](#API_ListWorkforces_RequestSyntax) ** A filter you can use to search for workforces using part of the workforce name. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9]([a-zA-Z0-9\-]){0,62}` Required: No ** [NextToken](#API_ListWorkforces_RequestSyntax) ** A token to resume pagination. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListWorkforces_RequestSyntax) ** Sort workforces using the workforce name or creation date. Type: String Valid Values: `Name | CreateDate` Required: No ** [SortOrder](#API_ListWorkforces_RequestSyntax) ** Sort workforces in ascending or descending order. Type: String Valid Values: `Ascending | Descending` Required: No ## Response Syntax ``` { "NextToken": "string", "Workforces": [ { "CognitoConfig": { "ClientId": "string", "UserPool": "string" }, "CreateDate": number, "FailureReason": "string", "IpAddressType": "string", "LastUpdatedDate": number, "OidcConfig": { "AuthenticationRequestExtraParams": { "string" : "string" }, "AuthorizationEndpoint": "string", "ClientId": "string", "Issuer": "string", "JwksUri": "string", "LogoutEndpoint": "string", "Scope": "string", "TokenEndpoint": "string", "UserInfoEndpoint": "string" }, "SourceIpConfig": { "Cidrs": [ "string" ] }, "Status": "string", "SubDomain": "string", "WorkforceArn": "string", "WorkforceName": "string", "WorkforceVpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ], "VpcEndpointId": "string", "VpcId": "string" } } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListWorkforces_ResponseSyntax) ** A token to resume pagination. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ** [Workforces](#API_ListWorkforces_ResponseSyntax) ** A list containing information about your workforce. Type: Array of [Workforce](API_Workforce.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListWorkforces) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListWorkforces) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListWorkforces) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListWorkforces) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListWorkforces) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListWorkforces) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListWorkforces) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListWorkforces) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListWorkforces) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListWorkforces) # ListWorkteams 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. ## Request Syntax ``` { "MaxResults": number, "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [MaxResults](#API_ListWorkteams_RequestSyntax) ** The maximum number of work teams to return in each page of the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NameContains](#API_ListWorkteams_RequestSyntax) ** A string in the work team's name. This filter returns only work teams whose name contains the specified string. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: No ** [NextToken](#API_ListWorkteams_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [SortBy](#API_ListWorkteams_RequestSyntax) ** The field to sort results by. The default is `CreationTime`. Type: String Valid Values: `Name | CreateDate` Required: No ** [SortOrder](#API_ListWorkteams_RequestSyntax) ** The sort order for results. The default is `Ascending`. Type: String Valid Values: `Ascending | Descending` Required: No ## Response Syntax ``` { "NextToken": "string", "Workteams": [ { "CreateDate": number, "Description": "string", "LastUpdatedDate": number, "MemberDefinitions": [ { "CognitoMemberDefinition": { "ClientId": "string", "UserGroup": "string", "UserPool": "string" }, "OidcMemberDefinition": { "Groups": [ "string" ] } } ], "NotificationConfiguration": { "NotificationTopicArn": "string" }, "ProductListingIds": [ "string" ], "SubDomain": "string", "WorkerAccessConfiguration": { "S3Presign": { "IamPolicyConstraints": { "SourceIp": "string", "VpcSourceIp": "string" } } }, "WorkforceArn": "string", "WorkteamArn": "string", "WorkteamName": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListWorkteams_ResponseSyntax) ** If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ** [Workteams](#API_ListWorkteams_ResponseSyntax) ** An array of `Workteam` objects, each describing a work team. Type: Array of [Workteam](API_Workteam.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListWorkteams) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListWorkteams) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListWorkteams) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListWorkteams) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListWorkteams) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListWorkteams) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListWorkteams) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListWorkteams) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListWorkteams) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListWorkteams) # PutModelPackageGroupPolicy Adds a resouce policy to control access to a model group. For information about resoure policies, see [Identity-based policies and resource-based policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_identity-vs-resource.html) in the * AWS Identity and Access Management User Guide.*. ## Request Syntax ``` { "ModelPackageGroupName": "string", "ResourcePolicy": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ModelPackageGroupName](#API_PutModelPackageGroupPolicy_RequestSyntax) ** The name of the model group to add a resource policy to. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [ResourcePolicy](#API_PutModelPackageGroupPolicy_RequestSyntax) ** The resource policy for the model group. Type: String Length Constraints: Minimum length of 1. Maximum length of 20480. Pattern: `.*` Required: Yes ## Response Syntax ``` { "ModelPackageGroupArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ModelPackageGroupArn](#API_PutModelPackageGroupPolicy_ResponseSyntax) ** The Amazon Resource Name (ARN) of the model package group. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:model-package-group/[\S]{1,2048}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/PutModelPackageGroupPolicy) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/PutModelPackageGroupPolicy) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/PutModelPackageGroupPolicy) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/PutModelPackageGroupPolicy) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/PutModelPackageGroupPolicy) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/PutModelPackageGroupPolicy) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/PutModelPackageGroupPolicy) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/PutModelPackageGroupPolicy) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/PutModelPackageGroupPolicy) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/PutModelPackageGroupPolicy) # QueryLineage Use this action to inspect your lineage and discover relationships between entities. For more information, see [ Querying Lineage Entities](https://docs.aws.amazon.com/sagemaker/latest/dg/querying-lineage-entities.html) in the *Amazon SageMaker Developer Guide*. ## Request Syntax ``` { "Direction": "string", "Filters": { "CreatedAfter": number, "CreatedBefore": number, "LineageTypes": [ "string" ], "ModifiedAfter": number, "ModifiedBefore": number, "Properties": { "string" : "string" }, "Types": [ "string" ] }, "IncludeEdges": boolean, "MaxDepth": number, "MaxResults": number, "NextToken": "string", "StartArns": [ "string" ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Direction](#API_QueryLineage_RequestSyntax) ** Associations between lineage entities have a direction. This parameter determines the direction from the StartArn(s) that the query traverses. Type: String Valid Values: `Both | Ascendants | Descendants` Required: No ** [Filters](#API_QueryLineage_RequestSyntax) ** A set of filtering parameters that allow you to specify which entities should be returned. + Properties - Key-value pairs to match on the lineage entities' properties. + LineageTypes - A set of lineage entity types to match on. For example: `TrialComponent`, `Artifact`, or `Context`. + CreatedBefore - Filter entities created before this date. + ModifiedBefore - Filter entities modified before this date. + ModifiedAfter - Filter entities modified after this date. Type: [QueryFilters](API_QueryFilters.md) object Required: No ** [IncludeEdges](#API_QueryLineage_RequestSyntax) ** Setting this value to `True` retrieves not only the entities of interest but also the [Associations](https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking-entities.html) and lineage entities on the path. Set to `False` to only return lineage entities that match your query. Type: Boolean Required: No ** [MaxDepth](#API_QueryLineage_RequestSyntax) ** The maximum depth in lineage relationships from the `StartArns` that are traversed. Depth is a measure of the number of `Associations` from the `StartArn` entity to the matched results. Type: Integer Valid Range: Maximum value of 10. Required: No ** [MaxResults](#API_QueryLineage_RequestSyntax) ** Limits the number of vertices in the results. Use the `NextToken` in a response to to retrieve the next page of results. Type: Integer Valid Range: Maximum value of 50. Required: No ** [NextToken](#API_QueryLineage_RequestSyntax) ** Limits the number of vertices in the request. Use the `NextToken` in a response to to retrieve the next page of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Required: No ** [StartArns](#API_QueryLineage_RequestSyntax) ** A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 1 item. Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:(experiment|experiment-trial-component|artifact|action|context)/.*` Required: No ## Response Syntax ``` { "Edges": [ { "AssociationType": "string", "DestinationArn": "string", "SourceArn": "string" } ], "NextToken": "string", "Vertices": [ { "Arn": "string", "LineageType": "string", "Type": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Edges](#API_QueryLineage_ResponseSyntax) ** A list of edges that connect vertices in the response. Type: Array of [Edge](API_Edge.md) objects ** [NextToken](#API_QueryLineage_ResponseSyntax) ** Limits the number of vertices in the response. Use the `NextToken` in a response to to retrieve the next page of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. ** [Vertices](#API_QueryLineage_ResponseSyntax) ** A list of vertices connected to the start entity(ies) in the lineage graph. Type: Array of [Vertex](API_Vertex.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/QueryLineage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/QueryLineage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/QueryLineage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/QueryLineage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/QueryLineage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/QueryLineage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/QueryLineage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/QueryLineage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/QueryLineage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/QueryLineage) # RegisterDevices Register devices. ## Request Syntax ``` { "DeviceFleetName": "string", "Devices": [ { "Description": "string", "DeviceName": "string", "IotThingName": "string" } ], "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DeviceFleetName](#API_RegisterDevices_RequestSyntax) ** The name of the fleet. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [Devices](#API_RegisterDevices_RequestSyntax) ** A list of devices to register with SageMaker Edge Manager. Type: Array of [Device](API_Device.md) objects Required: Yes ** [Tags](#API_RegisterDevices_RequestSyntax) ** The tags associated with devices. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/RegisterDevices) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/RegisterDevices) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/RegisterDevices) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/RegisterDevices) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/RegisterDevices) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/RegisterDevices) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/RegisterDevices) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/RegisterDevices) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/RegisterDevices) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/RegisterDevices) # RenderUiTemplate Renders the UI template so that you can preview the worker's experience. ## Request Syntax ``` { "HumanTaskUiArn": "string", "RoleArn": "string", "Task": { "Input": "string" }, "UiTemplate": { "Content": "string" } } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [HumanTaskUiArn](#API_RenderUiTemplate_RequestSyntax) ** 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](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UiConfig.html). Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]+:[0-9]{12}:human-task-ui/.*` Required: No ** [RoleArn](#API_RenderUiTemplate_RequestSyntax) ** The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` Required: Yes ** [Task](#API_RenderUiTemplate_RequestSyntax) ** A `RenderableTask` object containing a representative task to render. Type: [RenderableTask](API_RenderableTask.md) object Required: Yes ** [UiTemplate](#API_RenderUiTemplate_RequestSyntax) ** A `Template` object containing the worker UI template to render. Type: [UiTemplate](API_UiTemplate.md) object Required: No ## Response Syntax ``` { "Errors": [ { "Code": "string", "Message": "string" } ], "RenderedContent": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Errors](#API_RenderUiTemplate_ResponseSyntax) ** 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. Type: Array of [RenderingError](API_RenderingError.md) objects ** [RenderedContent](#API_RenderUiTemplate_ResponseSyntax) ** A Liquid template that renders the HTML for the worker UI. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/RenderUiTemplate) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/RenderUiTemplate) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/RenderUiTemplate) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/RenderUiTemplate) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/RenderUiTemplate) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/RenderUiTemplate) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/RenderUiTemplate) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/RenderUiTemplate) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/RenderUiTemplate) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/RenderUiTemplate) # RetryPipelineExecution Retry the execution of the pipeline. ## Request Syntax ``` { "ClientRequestToken": "string", "ParallelismConfiguration": { "MaxParallelExecutionSteps": number }, "PipelineExecutionArn": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClientRequestToken](#API_RetryPipelineExecution_RequestSyntax) ** A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once. Type: String Length Constraints: Minimum length of 32. Maximum length of 128. Required: Yes ** [ParallelismConfiguration](#API_RetryPipelineExecution_RequestSyntax) ** This configuration, if specified, overrides the parallelism configuration of the parent pipeline. Type: [ParallelismConfiguration](API_ParallelismConfiguration.md) object Required: No ** [PipelineExecutionArn](#API_RetryPipelineExecution_RequestSyntax) ** The Amazon Resource Name (ARN) of the pipeline execution. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:pipeline\/.*\/execution\/.*` Required: Yes ## Response Syntax ``` { "PipelineExecutionArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [PipelineExecutionArn](#API_RetryPipelineExecution_ResponseSyntax) ** The Amazon Resource Name (ARN) of the pipeline execution. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:pipeline\/.*\/execution\/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/RetryPipelineExecution) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/RetryPipelineExecution) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/RetryPipelineExecution) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/RetryPipelineExecution) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/RetryPipelineExecution) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/RetryPipelineExecution) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/RetryPipelineExecution) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/RetryPipelineExecution) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/RetryPipelineExecution) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/RetryPipelineExecution) # Search Finds SageMaker resources that match a search query. Matching resources are returned as a list of `SearchRecord` objects in the response. You can sort the search results by any resource property in a ascending or descending order. You can query against the following value types: numeric, text, Boolean, and timestamp. **Note** The Search API may provide access to otherwise restricted data. See [Amazon SageMaker API Permissions: Actions, Permissions, and Resources Reference](https://docs.aws.amazon.com/sagemaker/latest/dg/api-permissions-reference.html) for more information. ## Request Syntax ``` { "CrossAccountFilterOption": "string", "MaxResults": number, "NextToken": "string", "Resource": "string", "SearchExpression": { "Filters": [ { "Name": "string", "Operator": "string", "Value": "string" } ], "NestedFilters": [ { "Filters": [ { "Name": "string", "Operator": "string", "Value": "string" } ], "NestedPropertyName": "string" } ], "Operator": "string", "SubExpressions": [ "SearchExpression" ] }, "SortBy": "string", "SortOrder": "string", "VisibilityConditions": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CrossAccountFilterOption](#API_Search_RequestSyntax) ** A cross account filter option. When the value is `"CrossAccount"` the search results will only include resources made discoverable to you from other accounts. When the value is `"SameAccount"` or `null` the search results will only include resources from your account. Default is `null`. For more information on searching for resources made discoverable to your account, see [ Search discoverable resources](https://docs.aws.amazon.com/sagemaker/latest/dg/feature-store-cross-account-discoverability-use.html) in the SageMaker Developer Guide. The maximum number of `ResourceCatalog`s viewable is 1000. Type: String Valid Values: `SameAccount | CrossAccount` Required: No ** [MaxResults](#API_Search_RequestSyntax) ** The maximum number of results to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_Search_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` Required: No ** [Resource](#API_Search_RequestSyntax) ** The name of the SageMaker resource to search for. Type: String Valid Values: `TrainingJob | Experiment | ExperimentTrial | ExperimentTrialComponent | Endpoint | Model | ModelPackage | ModelPackageGroup | Pipeline | PipelineExecution | FeatureGroup | FeatureMetadata | Image | ImageVersion | Project | HyperParameterTuningJob | ModelCard | PipelineVersion` Required: Yes ** [SearchExpression](#API_Search_RequestSyntax) ** 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. Type: [SearchExpression](API_SearchExpression.md) object Required: No ** [SortBy](#API_Search_RequestSyntax) ** The name of the resource property used to sort the `SearchResults`. The default is `LastModifiedTime`. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `.+` Required: No ** [SortOrder](#API_Search_RequestSyntax) ** How `SearchResults` are ordered. Valid values are `Ascending` or `Descending`. The default is `Descending`. Type: String Valid Values: `Ascending | Descending` Required: No ** [VisibilityConditions](#API_Search_RequestSyntax) ** Limits the results of your search request to the resources that you can access. Type: Array of [VisibilityConditions](API_VisibilityConditions.md) objects Array Members: Minimum number of 1 item. Maximum number of 5 items. Required: No ## Response Syntax ``` { "NextToken": "string", "Results": [ { "Endpoint": { "CreationTime": number, "DataCaptureConfig": { "CaptureStatus": "string", "CurrentSamplingPercentage": number, "DestinationS3Uri": "string", "EnableCapture": boolean, "KmsKeyId": "string" }, "EndpointArn": "string", "EndpointConfigName": "string", "EndpointName": "string", "EndpointStatus": "string", "FailureReason": "string", "LastModifiedTime": number, "MonitoringSchedules": [ { "CreationTime": number, "EndpointName": "string", "FailureReason": "string", "LastModifiedTime": number, "LastMonitoringExecutionSummary": { "CreationTime": number, "EndpointName": "string", "FailureReason": "string", "LastModifiedTime": number, "MonitoringExecutionStatus": "string", "MonitoringJobDefinitionName": "string", "MonitoringScheduleName": "string", "MonitoringType": "string", "ProcessingJobArn": "string", "ScheduledTime": number }, "MonitoringScheduleArn": "string", "MonitoringScheduleConfig": { "MonitoringJobDefinition": { "BaselineConfig": { "BaseliningJobName": "string", "ConstraintsResource": { "S3Uri": "string" }, "StatisticsResource": { "S3Uri": "string" } }, "Environment": { "string" : "string" }, "MonitoringAppSpecification": { "ContainerArguments": [ "string" ], "ContainerEntrypoint": [ "string" ], "ImageUri": "string", "PostAnalyticsProcessorSourceUri": "string", "RecordPreprocessorSourceUri": "string" }, "MonitoringInputs": [ { "BatchTransformInput": { "DataCapturedDestinationS3Uri": "string", "DatasetFormat": { "Csv": { "Header": boolean }, "Json": { "Line": boolean }, "Parquet": { } }, "EndTimeOffset": "string", "ExcludeFeaturesAttribute": "string", "FeaturesAttribute": "string", "InferenceAttribute": "string", "LocalPath": "string", "ProbabilityAttribute": "string", "ProbabilityThresholdAttribute": number, "S3DataDistributionType": "string", "S3InputMode": "string", "StartTimeOffset": "string" }, "EndpointInput": { "EndpointName": "string", "EndTimeOffset": "string", "ExcludeFeaturesAttribute": "string", "FeaturesAttribute": "string", "InferenceAttribute": "string", "LocalPath": "string", "ProbabilityAttribute": "string", "ProbabilityThresholdAttribute": number, "S3DataDistributionType": "string", "S3InputMode": "string", "StartTimeOffset": "string" } } ], "MonitoringOutputConfig": { "KmsKeyId": "string", "MonitoringOutputs": [ { "S3Output": { "LocalPath": "string", "S3UploadMode": "string", "S3Uri": "string" } } ] }, "MonitoringResources": { "ClusterConfig": { "InstanceCount": number, "InstanceType": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number } }, "NetworkConfig": { "EnableInterContainerTrafficEncryption": boolean, "EnableNetworkIsolation": boolean, "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } }, "RoleArn": "string", "StoppingCondition": { "MaxRuntimeInSeconds": number } }, "MonitoringJobDefinitionName": "string", "MonitoringType": "string", "ScheduleConfig": { "DataAnalysisEndTime": "string", "DataAnalysisStartTime": "string", "ScheduleExpression": "string" } }, "MonitoringScheduleName": "string", "MonitoringScheduleStatus": "string", "MonitoringType": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ], "ProductionVariants": [ { "CapacityReservationConfig": { "AvailableInstanceCount": number, "CapacityReservationPreference": "string", "Ec2CapacityReservations": [ { "AvailableInstanceCount": number, "Ec2CapacityReservationId": "string", "TotalInstanceCount": number, "UsedByCurrentEndpoint": number } ], "MlReservationArn": "string", "TotalInstanceCount": number, "UsedByCurrentEndpoint": number }, "CurrentInstanceCount": number, "CurrentServerlessConfig": { "MaxConcurrency": number, "MemorySizeInMB": number, "ProvisionedConcurrency": number }, "CurrentWeight": number, "DeployedImages": [ { "ResolutionTime": number, "ResolvedImage": "string", "SpecifiedImage": "string" } ], "DesiredInstanceCount": number, "DesiredServerlessConfig": { "MaxConcurrency": number, "MemorySizeInMB": number, "ProvisionedConcurrency": number }, "DesiredWeight": number, "ManagedInstanceScaling": { "MaxInstanceCount": number, "MinInstanceCount": number, "ScaleInPolicy": { "CooldownInMinutes": number, "MaximumStepSize": number, "Strategy": "string" }, "Status": "string" }, "RoutingConfig": { "RoutingStrategy": "string" }, "VariantName": "string", "VariantStatus": [ { "StartTime": number, "Status": "string", "StatusMessage": "string" } ] } ], "ShadowProductionVariants": [ { "CapacityReservationConfig": { "AvailableInstanceCount": number, "CapacityReservationPreference": "string", "Ec2CapacityReservations": [ { "AvailableInstanceCount": number, "Ec2CapacityReservationId": "string", "TotalInstanceCount": number, "UsedByCurrentEndpoint": number } ], "MlReservationArn": "string", "TotalInstanceCount": number, "UsedByCurrentEndpoint": number }, "CurrentInstanceCount": number, "CurrentServerlessConfig": { "MaxConcurrency": number, "MemorySizeInMB": number, "ProvisionedConcurrency": number }, "CurrentWeight": number, "DeployedImages": [ { "ResolutionTime": number, "ResolvedImage": "string", "SpecifiedImage": "string" } ], "DesiredInstanceCount": number, "DesiredServerlessConfig": { "MaxConcurrency": number, "MemorySizeInMB": number, "ProvisionedConcurrency": number }, "DesiredWeight": number, "ManagedInstanceScaling": { "MaxInstanceCount": number, "MinInstanceCount": number, "ScaleInPolicy": { "CooldownInMinutes": number, "MaximumStepSize": number, "Strategy": "string" }, "Status": "string" }, "RoutingConfig": { "RoutingStrategy": "string" }, "VariantName": "string", "VariantStatus": [ { "StartTime": number, "Status": "string", "StatusMessage": "string" } ] } ], "Tags": [ { "Key": "string", "Value": "string" } ] }, "Experiment": { "CreatedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "Description": "string", "DisplayName": "string", "ExperimentArn": "string", "ExperimentName": "string", "LastModifiedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "Source": { "SourceArn": "string", "SourceType": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ] }, "FeatureGroup": { "CreationTime": number, "Description": "string", "EventTimeFeatureName": "string", "FailureReason": "string", "FeatureDefinitions": [ { "CollectionConfig": { ... }, "CollectionType": "string", "FeatureName": "string", "FeatureType": "string" } ], "FeatureGroupArn": "string", "FeatureGroupName": "string", "FeatureGroupStatus": "string", "LastModifiedTime": number, "LastUpdateStatus": { "FailureReason": "string", "Status": "string" }, "OfflineStoreConfig": { "DataCatalogConfig": { "Catalog": "string", "Database": "string", "TableName": "string" }, "DisableGlueTableCreation": boolean, "S3StorageConfig": { "KmsKeyId": "string", "ResolvedOutputS3Uri": "string", "S3Uri": "string" }, "TableFormat": "string" }, "OfflineStoreStatus": { "BlockedReason": "string", "Status": "string" }, "OnlineStoreConfig": { "EnableOnlineStore": boolean, "SecurityConfig": { "KmsKeyId": "string" }, "StorageType": "string", "TtlDuration": { "Unit": "string", "Value": number } }, "RecordIdentifierFeatureName": "string", "RoleArn": "string", "Tags": [ { "Key": "string", "Value": "string" } ] }, "FeatureMetadata": { "CreationTime": number, "Description": "string", "FeatureGroupArn": "string", "FeatureGroupName": "string", "FeatureName": "string", "FeatureType": "string", "LastModifiedTime": number, "Parameters": [ { "Key": "string", "Value": "string" } ] }, "HyperParameterTuningJob": { "BestTrainingJob": { "CreationTime": number, "FailureReason": "string", "FinalHyperParameterTuningJobObjectiveMetric": { "MetricName": "string", "Type": "string", "Value": number }, "ObjectiveStatus": "string", "TrainingEndTime": number, "TrainingJobArn": "string", "TrainingJobDefinitionName": "string", "TrainingJobName": "string", "TrainingJobStatus": "string", "TrainingStartTime": number, "TunedHyperParameters": { "string" : "string" }, "TuningJobName": "string" }, "ConsumedResources": { "RuntimeInSeconds": number }, "CreationTime": number, "FailureReason": "string", "HyperParameterTuningEndTime": number, "HyperParameterTuningJobArn": "string", "HyperParameterTuningJobConfig": { "HyperParameterTuningJobObjective": { "MetricName": "string", "Type": "string" }, "ParameterRanges": { "AutoParameters": [ { "Name": "string", "ValueHint": "string" } ], "CategoricalParameterRanges": [ { "Name": "string", "Values": [ "string" ] } ], "ContinuousParameterRanges": [ { "MaxValue": "string", "MinValue": "string", "Name": "string", "ScalingType": "string" } ], "IntegerParameterRanges": [ { "MaxValue": "string", "MinValue": "string", "Name": "string", "ScalingType": "string" } ] }, "RandomSeed": number, "ResourceLimits": { "MaxNumberOfTrainingJobs": number, "MaxParallelTrainingJobs": number, "MaxRuntimeInSeconds": number }, "Strategy": "string", "StrategyConfig": { "HyperbandStrategyConfig": { "MaxResource": number, "MinResource": number } }, "TrainingJobEarlyStoppingType": "string", "TuningJobCompletionCriteria": { "BestObjectiveNotImproving": { "MaxNumberOfTrainingJobsNotImproving": number }, "ConvergenceDetected": { "CompleteOnConvergence": "string" }, "TargetObjectiveMetricValue": number } }, "HyperParameterTuningJobName": "string", "HyperParameterTuningJobStatus": "string", "LastModifiedTime": number, "ObjectiveStatusCounters": { "Failed": number, "Pending": number, "Succeeded": number }, "OverallBestTrainingJob": { "CreationTime": number, "FailureReason": "string", "FinalHyperParameterTuningJobObjectiveMetric": { "MetricName": "string", "Type": "string", "Value": number }, "ObjectiveStatus": "string", "TrainingEndTime": number, "TrainingJobArn": "string", "TrainingJobDefinitionName": "string", "TrainingJobName": "string", "TrainingJobStatus": "string", "TrainingStartTime": number, "TunedHyperParameters": { "string" : "string" }, "TuningJobName": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ], "TrainingJobDefinition": { "AlgorithmSpecification": { "AlgorithmName": "string", "MetricDefinitions": [ { "Name": "string", "Regex": "string" } ], "TrainingImage": "string", "TrainingInputMode": "string" }, "CheckpointConfig": { "LocalPath": "string", "S3Uri": "string" }, "DefinitionName": "string", "EnableInterContainerTrafficEncryption": boolean, "EnableManagedSpotTraining": boolean, "EnableNetworkIsolation": boolean, "Environment": { "string" : "string" }, "HyperParameterRanges": { "AutoParameters": [ { "Name": "string", "ValueHint": "string" } ], "CategoricalParameterRanges": [ { "Name": "string", "Values": [ "string" ] } ], "ContinuousParameterRanges": [ { "MaxValue": "string", "MinValue": "string", "Name": "string", "ScalingType": "string" } ], "IntegerParameterRanges": [ { "MaxValue": "string", "MinValue": "string", "Name": "string", "ScalingType": "string" } ] }, "HyperParameterTuningResourceConfig": { "AllocationStrategy": "string", "InstanceConfigs": [ { "InstanceCount": number, "InstanceType": "string", "VolumeSizeInGB": number } ], "InstanceCount": number, "InstanceType": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number }, "InputDataConfig": [ { "ChannelName": "string", "CompressionType": "string", "ContentType": "string", "DataSource": { "FileSystemDataSource": { "DirectoryPath": "string", "FileSystemAccessMode": "string", "FileSystemId": "string", "FileSystemType": "string" }, "S3DataSource": { "AttributeNames": [ "string" ], "HubAccessConfig": { "HubContentArn": "string" }, "InstanceGroupNames": [ "string" ], "ModelAccessConfig": { "AcceptEula": boolean }, "S3DataDistributionType": "string", "S3DataType": "string", "S3Uri": "string" } }, "InputMode": "string", "RecordWrapperType": "string", "ShuffleConfig": { "Seed": number } } ], "OutputDataConfig": { "CompressionType": "string", "KmsKeyId": "string", "S3OutputPath": "string" }, "ResourceConfig": { "InstanceCount": number, "InstanceGroups": [ { "InstanceCount": number, "InstanceGroupName": "string", "InstanceType": "string" } ], "InstancePlacementConfig": { "EnableMultipleJobs": boolean, "PlacementSpecifications": [ { "InstanceCount": number, "UltraServerId": "string" } ] }, "InstanceType": "string", "KeepAlivePeriodInSeconds": number, "TrainingPlanArn": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number }, "RetryStrategy": { "MaximumRetryAttempts": number }, "RoleArn": "string", "StaticHyperParameters": { "string" : "string" }, "StoppingCondition": { "MaxPendingTimeInSeconds": number, "MaxRuntimeInSeconds": number, "MaxWaitTimeInSeconds": number }, "TuningObjective": { "MetricName": "string", "Type": "string" }, "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } }, "TrainingJobDefinitions": [ { "AlgorithmSpecification": { "AlgorithmName": "string", "MetricDefinitions": [ { "Name": "string", "Regex": "string" } ], "TrainingImage": "string", "TrainingInputMode": "string" }, "CheckpointConfig": { "LocalPath": "string", "S3Uri": "string" }, "DefinitionName": "string", "EnableInterContainerTrafficEncryption": boolean, "EnableManagedSpotTraining": boolean, "EnableNetworkIsolation": boolean, "Environment": { "string" : "string" }, "HyperParameterRanges": { "AutoParameters": [ { "Name": "string", "ValueHint": "string" } ], "CategoricalParameterRanges": [ { "Name": "string", "Values": [ "string" ] } ], "ContinuousParameterRanges": [ { "MaxValue": "string", "MinValue": "string", "Name": "string", "ScalingType": "string" } ], "IntegerParameterRanges": [ { "MaxValue": "string", "MinValue": "string", "Name": "string", "ScalingType": "string" } ] }, "HyperParameterTuningResourceConfig": { "AllocationStrategy": "string", "InstanceConfigs": [ { "InstanceCount": number, "InstanceType": "string", "VolumeSizeInGB": number } ], "InstanceCount": number, "InstanceType": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number }, "InputDataConfig": [ { "ChannelName": "string", "CompressionType": "string", "ContentType": "string", "DataSource": { "FileSystemDataSource": { "DirectoryPath": "string", "FileSystemAccessMode": "string", "FileSystemId": "string", "FileSystemType": "string" }, "S3DataSource": { "AttributeNames": [ "string" ], "HubAccessConfig": { "HubContentArn": "string" }, "InstanceGroupNames": [ "string" ], "ModelAccessConfig": { "AcceptEula": boolean }, "S3DataDistributionType": "string", "S3DataType": "string", "S3Uri": "string" } }, "InputMode": "string", "RecordWrapperType": "string", "ShuffleConfig": { "Seed": number } } ], "OutputDataConfig": { "CompressionType": "string", "KmsKeyId": "string", "S3OutputPath": "string" }, "ResourceConfig": { "InstanceCount": number, "InstanceGroups": [ { "InstanceCount": number, "InstanceGroupName": "string", "InstanceType": "string" } ], "InstancePlacementConfig": { "EnableMultipleJobs": boolean, "PlacementSpecifications": [ { "InstanceCount": number, "UltraServerId": "string" } ] }, "InstanceType": "string", "KeepAlivePeriodInSeconds": number, "TrainingPlanArn": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number }, "RetryStrategy": { "MaximumRetryAttempts": number }, "RoleArn": "string", "StaticHyperParameters": { "string" : "string" }, "StoppingCondition": { "MaxPendingTimeInSeconds": number, "MaxRuntimeInSeconds": number, "MaxWaitTimeInSeconds": number }, "TuningObjective": { "MetricName": "string", "Type": "string" }, "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } } ], "TrainingJobStatusCounters": { "Completed": number, "InProgress": number, "NonRetryableError": number, "RetryableError": number, "Stopped": number }, "TuningJobCompletionDetails": { "ConvergenceDetectedTime": number, "NumberOfTrainingJobsObjectiveNotImproving": number }, "WarmStartConfig": { "ParentHyperParameterTuningJobs": [ { "HyperParameterTuningJobName": "string" } ], "WarmStartType": "string" } }, "Model": { "Endpoints": [ { "CreationTime": number, "EndpointArn": "string", "EndpointName": "string", "EndpointStatus": "string", "LastModifiedTime": number } ], "LastBatchTransformJob": { "AutoMLJobArn": "string", "BatchStrategy": "string", "CreationTime": number, "DataCaptureConfig": { "DestinationS3Uri": "string", "GenerateInferenceId": boolean, "KmsKeyId": "string" }, "DataProcessing": { "InputFilter": "string", "JoinSource": "string", "OutputFilter": "string" }, "Environment": { "string" : "string" }, "ExperimentConfig": { "ExperimentName": "string", "RunName": "string", "TrialComponentDisplayName": "string", "TrialName": "string" }, "FailureReason": "string", "LabelingJobArn": "string", "MaxConcurrentTransforms": number, "MaxPayloadInMB": number, "ModelClientConfig": { "InvocationsMaxRetries": number, "InvocationsTimeoutInSeconds": number }, "ModelName": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TransformEndTime": number, "TransformInput": { "CompressionType": "string", "ContentType": "string", "DataSource": { "S3DataSource": { "S3DataType": "string", "S3Uri": "string" } }, "SplitType": "string" }, "TransformJobArn": "string", "TransformJobName": "string", "TransformJobStatus": "string", "TransformOutput": { "Accept": "string", "AssembleWith": "string", "KmsKeyId": "string", "S3OutputPath": "string" }, "TransformResources": { "InstanceCount": number, "InstanceType": "string", "TransformAmiVersion": "string", "VolumeKmsKeyId": "string" }, "TransformStartTime": number }, "Model": { "Containers": [ { "AdditionalModelDataSources": [ { "ChannelName": "string", "S3DataSource": { "CompressionType": "string", "ETag": "string", "HubAccessConfig": { "HubContentArn": "string" }, "ManifestEtag": "string", "ManifestS3Uri": "string", "ModelAccessConfig": { "AcceptEula": boolean }, "S3DataType": "string", "S3Uri": "string" } } ], "ContainerHostname": "string", "Environment": { "string" : "string" }, "Image": "string", "ImageConfig": { "RepositoryAccessMode": "string", "RepositoryAuthConfig": { "RepositoryCredentialsProviderArn": "string" } }, "InferenceSpecificationName": "string", "Mode": "string", "ModelDataSource": { "S3DataSource": { "CompressionType": "string", "ETag": "string", "HubAccessConfig": { "HubContentArn": "string" }, "ManifestEtag": "string", "ManifestS3Uri": "string", "ModelAccessConfig": { "AcceptEula": boolean }, "S3DataType": "string", "S3Uri": "string" } }, "ModelDataUrl": "string", "ModelPackageName": "string", "MultiModelConfig": { "ModelCacheSetting": "string" } } ], "CreationTime": number, "DeploymentRecommendation": { "RealTimeInferenceRecommendations": [ { "Environment": { "string" : "string" }, "InstanceType": "string", "RecommendationId": "string" } ], "RecommendationStatus": "string" }, "EnableNetworkIsolation": boolean, "ExecutionRoleArn": "string", "InferenceExecutionConfig": { "Mode": "string" }, "ModelArn": "string", "ModelName": "string", "PrimaryContainer": { "AdditionalModelDataSources": [ { "ChannelName": "string", "S3DataSource": { "CompressionType": "string", "ETag": "string", "HubAccessConfig": { "HubContentArn": "string" }, "ManifestEtag": "string", "ManifestS3Uri": "string", "ModelAccessConfig": { "AcceptEula": boolean }, "S3DataType": "string", "S3Uri": "string" } } ], "ContainerHostname": "string", "Environment": { "string" : "string" }, "Image": "string", "ImageConfig": { "RepositoryAccessMode": "string", "RepositoryAuthConfig": { "RepositoryCredentialsProviderArn": "string" } }, "InferenceSpecificationName": "string", "Mode": "string", "ModelDataSource": { "S3DataSource": { "CompressionType": "string", "ETag": "string", "HubAccessConfig": { "HubContentArn": "string" }, "ManifestEtag": "string", "ManifestS3Uri": "string", "ModelAccessConfig": { "AcceptEula": boolean }, "S3DataType": "string", "S3Uri": "string" } }, "ModelDataUrl": "string", "ModelPackageName": "string", "MultiModelConfig": { "ModelCacheSetting": "string" } }, "Tags": [ { "Key": "string", "Value": "string" } ], "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } }, "ModelCard": { "CreatedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "LastModifiedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "ModelCardArn": "string", "ModelCardName": "string", "ModelCardStatus": "string", "ModelCardVersion": number, "ModelId": "string", "RiskRating": "string", "SecurityConfig": { "KmsKeyId": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ] }, "MonitoringSchedules": [ { "BatchTransformInput": { "DataCapturedDestinationS3Uri": "string", "DatasetFormat": { "Csv": { "Header": boolean }, "Json": { "Line": boolean }, "Parquet": { } }, "EndTimeOffset": "string", "ExcludeFeaturesAttribute": "string", "FeaturesAttribute": "string", "InferenceAttribute": "string", "LocalPath": "string", "ProbabilityAttribute": "string", "ProbabilityThresholdAttribute": number, "S3DataDistributionType": "string", "S3InputMode": "string", "StartTimeOffset": "string" }, "CreationTime": number, "EndpointName": "string", "FailureReason": "string", "LastModifiedTime": number, "LastMonitoringExecutionSummary": { "CreationTime": number, "EndpointName": "string", "FailureReason": "string", "LastModifiedTime": number, "MonitoringExecutionStatus": "string", "MonitoringJobDefinitionName": "string", "MonitoringScheduleName": "string", "MonitoringType": "string", "ProcessingJobArn": "string", "ScheduledTime": number }, "MonitoringAlertSummaries": [ { "Actions": { "ModelDashboardIndicator": { "Enabled": boolean } }, "AlertStatus": "string", "CreationTime": number, "DatapointsToAlert": number, "EvaluationPeriod": number, "LastModifiedTime": number, "MonitoringAlertName": "string" } ], "MonitoringScheduleArn": "string", "MonitoringScheduleConfig": { "MonitoringJobDefinition": { "BaselineConfig": { "BaseliningJobName": "string", "ConstraintsResource": { "S3Uri": "string" }, "StatisticsResource": { "S3Uri": "string" } }, "Environment": { "string" : "string" }, "MonitoringAppSpecification": { "ContainerArguments": [ "string" ], "ContainerEntrypoint": [ "string" ], "ImageUri": "string", "PostAnalyticsProcessorSourceUri": "string", "RecordPreprocessorSourceUri": "string" }, "MonitoringInputs": [ { "BatchTransformInput": { "DataCapturedDestinationS3Uri": "string", "DatasetFormat": { "Csv": { "Header": boolean }, "Json": { "Line": boolean }, "Parquet": { } }, "EndTimeOffset": "string", "ExcludeFeaturesAttribute": "string", "FeaturesAttribute": "string", "InferenceAttribute": "string", "LocalPath": "string", "ProbabilityAttribute": "string", "ProbabilityThresholdAttribute": number, "S3DataDistributionType": "string", "S3InputMode": "string", "StartTimeOffset": "string" }, "EndpointInput": { "EndpointName": "string", "EndTimeOffset": "string", "ExcludeFeaturesAttribute": "string", "FeaturesAttribute": "string", "InferenceAttribute": "string", "LocalPath": "string", "ProbabilityAttribute": "string", "ProbabilityThresholdAttribute": number, "S3DataDistributionType": "string", "S3InputMode": "string", "StartTimeOffset": "string" } } ], "MonitoringOutputConfig": { "KmsKeyId": "string", "MonitoringOutputs": [ { "S3Output": { "LocalPath": "string", "S3UploadMode": "string", "S3Uri": "string" } } ] }, "MonitoringResources": { "ClusterConfig": { "InstanceCount": number, "InstanceType": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number } }, "NetworkConfig": { "EnableInterContainerTrafficEncryption": boolean, "EnableNetworkIsolation": boolean, "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } }, "RoleArn": "string", "StoppingCondition": { "MaxRuntimeInSeconds": number } }, "MonitoringJobDefinitionName": "string", "MonitoringType": "string", "ScheduleConfig": { "DataAnalysisEndTime": "string", "DataAnalysisStartTime": "string", "ScheduleExpression": "string" } }, "MonitoringScheduleName": "string", "MonitoringScheduleStatus": "string", "MonitoringType": "string" } ] }, "ModelCard": { "Content": "string", "CreatedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "LastModifiedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "ModelCardArn": "string", "ModelCardName": "string", "ModelCardStatus": "string", "ModelCardVersion": number, "ModelId": "string", "ModelPackageGroupName": "string", "RiskRating": "string", "SecurityConfig": { "KmsKeyId": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ] }, "ModelPackage": { "AdditionalInferenceSpecifications": [ { "Containers": [ { "AdditionalS3DataSource": { "CompressionType": "string", "ETag": "string", "S3DataType": "string", "S3Uri": "string" }, "BaseModel": { "HubContentName": "string", "HubContentVersion": "string", "RecipeName": "string" }, "ContainerHostname": "string", "Environment": { "string" : "string" }, "Framework": "string", "FrameworkVersion": "string", "Image": "string", "ImageDigest": "string", "IsCheckpoint": boolean, "ModelDataETag": "string", "ModelDataSource": { "S3DataSource": { "CompressionType": "string", "ETag": "string", "HubAccessConfig": { "HubContentArn": "string" }, "ManifestEtag": "string", "ManifestS3Uri": "string", "ModelAccessConfig": { "AcceptEula": boolean }, "S3DataType": "string", "S3Uri": "string" } }, "ModelDataUrl": "string", "ModelInput": { "DataInputConfig": "string" }, "NearestModelName": "string", "ProductId": "string" } ], "Description": "string", "Name": "string", "SupportedContentTypes": [ "string" ], "SupportedRealtimeInferenceInstanceTypes": [ "string" ], "SupportedResponseMIMETypes": [ "string" ], "SupportedTransformInstanceTypes": [ "string" ] } ], "ApprovalDescription": "string", "CertifyForMarketplace": boolean, "CreatedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "CustomerMetadataProperties": { "string" : "string" }, "Domain": "string", "DriftCheckBaselines": { "Bias": { "ConfigFile": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" }, "PostTrainingConstraints": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" }, "PreTrainingConstraints": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" } }, "Explainability": { "ConfigFile": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" }, "Constraints": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" } }, "ModelDataQuality": { "Constraints": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" }, "Statistics": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" } }, "ModelQuality": { "Constraints": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" }, "Statistics": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" } } }, "InferenceSpecification": { "Containers": [ { "AdditionalS3DataSource": { "CompressionType": "string", "ETag": "string", "S3DataType": "string", "S3Uri": "string" }, "BaseModel": { "HubContentName": "string", "HubContentVersion": "string", "RecipeName": "string" }, "ContainerHostname": "string", "Environment": { "string" : "string" }, "Framework": "string", "FrameworkVersion": "string", "Image": "string", "ImageDigest": "string", "IsCheckpoint": boolean, "ModelDataETag": "string", "ModelDataSource": { "S3DataSource": { "CompressionType": "string", "ETag": "string", "HubAccessConfig": { "HubContentArn": "string" }, "ManifestEtag": "string", "ManifestS3Uri": "string", "ModelAccessConfig": { "AcceptEula": boolean }, "S3DataType": "string", "S3Uri": "string" } }, "ModelDataUrl": "string", "ModelInput": { "DataInputConfig": "string" }, "NearestModelName": "string", "ProductId": "string" } ], "SupportedContentTypes": [ "string" ], "SupportedRealtimeInferenceInstanceTypes": [ "string" ], "SupportedResponseMIMETypes": [ "string" ], "SupportedTransformInstanceTypes": [ "string" ] }, "LastModifiedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "MetadataProperties": { "CommitId": "string", "GeneratedBy": "string", "ProjectId": "string", "Repository": "string" }, "ModelApprovalStatus": "string", "ModelCard": { "ModelCardContent": "string", "ModelCardStatus": "string" }, "ModelLifeCycle": { "Stage": "string", "StageDescription": "string", "StageStatus": "string" }, "ModelMetrics": { "Bias": { "PostTrainingReport": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" }, "PreTrainingReport": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" }, "Report": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" } }, "Explainability": { "Report": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" } }, "ModelDataQuality": { "Constraints": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" }, "Statistics": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" } }, "ModelQuality": { "Constraints": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" }, "Statistics": { "ContentDigest": "string", "ContentType": "string", "S3Uri": "string" } } }, "ModelPackageArn": "string", "ModelPackageDescription": "string", "ModelPackageGroupName": "string", "ModelPackageName": "string", "ModelPackageRegistrationType": "string", "ModelPackageStatus": "string", "ModelPackageStatusDetails": { "ImageScanStatuses": [ { "FailureReason": "string", "Name": "string", "Status": "string" } ], "ValidationStatuses": [ { "FailureReason": "string", "Name": "string", "Status": "string" } ] }, "ModelPackageVersion": number, "SamplePayloadUrl": "string", "SecurityConfig": { "KmsKeyId": "string" }, "SkipModelValidation": "string", "SourceAlgorithmSpecification": { "SourceAlgorithms": [ { "AlgorithmName": "string", "ModelDataETag": "string", "ModelDataSource": { "S3DataSource": { "CompressionType": "string", "ETag": "string", "HubAccessConfig": { "HubContentArn": "string" }, "ManifestEtag": "string", "ManifestS3Uri": "string", "ModelAccessConfig": { "AcceptEula": boolean }, "S3DataType": "string", "S3Uri": "string" } }, "ModelDataUrl": "string" } ] }, "SourceUri": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "Task": "string", "ValidationSpecification": { "ValidationProfiles": [ { "ProfileName": "string", "TransformJobDefinition": { "BatchStrategy": "string", "Environment": { "string" : "string" }, "MaxConcurrentTransforms": number, "MaxPayloadInMB": number, "TransformInput": { "CompressionType": "string", "ContentType": "string", "DataSource": { "S3DataSource": { "S3DataType": "string", "S3Uri": "string" } }, "SplitType": "string" }, "TransformOutput": { "Accept": "string", "AssembleWith": "string", "KmsKeyId": "string", "S3OutputPath": "string" }, "TransformResources": { "InstanceCount": number, "InstanceType": "string", "TransformAmiVersion": "string", "VolumeKmsKeyId": "string" } } } ], "ValidationRole": "string" } }, "ModelPackageGroup": { "CreatedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "ModelPackageGroupArn": "string", "ModelPackageGroupDescription": "string", "ModelPackageGroupName": "string", "ModelPackageGroupStatus": "string", "Tags": [ { "Key": "string", "Value": "string" } ] }, "Pipeline": { "CreatedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "LastModifiedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "LastRunTime": number, "ParallelismConfiguration": { "MaxParallelExecutionSteps": number }, "PipelineArn": "string", "PipelineDescription": "string", "PipelineDisplayName": "string", "PipelineName": "string", "PipelineStatus": "string", "RoleArn": "string", "Tags": [ { "Key": "string", "Value": "string" } ] }, "PipelineExecution": { "CreatedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "FailureReason": "string", "LastModifiedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "ParallelismConfiguration": { "MaxParallelExecutionSteps": number }, "PipelineArn": "string", "PipelineExecutionArn": "string", "PipelineExecutionDescription": "string", "PipelineExecutionDisplayName": "string", "PipelineExecutionStatus": "string", "PipelineExperimentConfig": { "ExperimentName": "string", "TrialName": "string" }, "PipelineParameters": [ { "Name": "string", "Value": "string" } ], "PipelineVersionDisplayName": "string", "PipelineVersionId": number, "SelectiveExecutionConfig": { "SelectedSteps": [ { "StepName": "string" } ], "SourcePipelineExecutionArn": "string" } }, "PipelineVersion": { "CreatedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "LastExecutedPipelineExecutionArn": "string", "LastExecutedPipelineExecutionDisplayName": "string", "LastExecutedPipelineExecutionStatus": "string", "LastModifiedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "PipelineArn": "string", "PipelineVersionDescription": "string", "PipelineVersionDisplayName": "string", "PipelineVersionId": number }, "Project": { "CreatedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "LastModifiedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "ProjectArn": "string", "ProjectDescription": "string", "ProjectId": "string", "ProjectName": "string", "ProjectStatus": "string", "ServiceCatalogProvisionedProductDetails": { "ProvisionedProductId": "string", "ProvisionedProductStatusMessage": "string" }, "ServiceCatalogProvisioningDetails": { "PathId": "string", "ProductId": "string", "ProvisioningArtifactId": "string", "ProvisioningParameters": [ { "Key": "string", "Value": "string" } ] }, "Tags": [ { "Key": "string", "Value": "string" } ], "TemplateProviderDetails": [ { "CfnTemplateProviderDetail": { "Parameters": [ { "Key": "string", "Value": "string" } ], "RoleARN": "string", "StackDetail": { "Id": "string", "Name": "string", "StatusMessage": "string" }, "TemplateName": "string", "TemplateURL": "string" } } ] }, "TrainingJob": { "AlgorithmSpecification": { "AlgorithmName": "string", "ContainerArguments": [ "string" ], "ContainerEntrypoint": [ "string" ], "EnableSageMakerMetricsTimeSeries": boolean, "MetricDefinitions": [ { "Name": "string", "Regex": "string" } ], "TrainingImage": "string", "TrainingImageConfig": { "TrainingRepositoryAccessMode": "string", "TrainingRepositoryAuthConfig": { "TrainingRepositoryCredentialsProviderArn": "string" } }, "TrainingInputMode": "string" }, "AutoMLJobArn": "string", "BillableTimeInSeconds": number, "CheckpointConfig": { "LocalPath": "string", "S3Uri": "string" }, "CreationTime": number, "DebugHookConfig": { "CollectionConfigurations": [ { "CollectionName": "string", "CollectionParameters": { "string" : "string" } } ], "HookParameters": { "string" : "string" }, "LocalPath": "string", "S3OutputPath": "string" }, "DebugRuleConfigurations": [ { "InstanceType": "string", "LocalPath": "string", "RuleConfigurationName": "string", "RuleEvaluatorImage": "string", "RuleParameters": { "string" : "string" }, "S3OutputPath": "string", "VolumeSizeInGB": number } ], "DebugRuleEvaluationStatuses": [ { "LastModifiedTime": number, "RuleConfigurationName": "string", "RuleEvaluationJobArn": "string", "RuleEvaluationStatus": "string", "StatusDetails": "string" } ], "EnableInterContainerTrafficEncryption": boolean, "EnableManagedSpotTraining": boolean, "EnableNetworkIsolation": boolean, "Environment": { "string" : "string" }, "ExperimentConfig": { "ExperimentName": "string", "RunName": "string", "TrialComponentDisplayName": "string", "TrialName": "string" }, "FailureReason": "string", "FinalMetricDataList": [ { "MetricName": "string", "Timestamp": number, "Value": number } ], "HyperParameters": { "string" : "string" }, "InputDataConfig": [ { "ChannelName": "string", "CompressionType": "string", "ContentType": "string", "DataSource": { "FileSystemDataSource": { "DirectoryPath": "string", "FileSystemAccessMode": "string", "FileSystemId": "string", "FileSystemType": "string" }, "S3DataSource": { "AttributeNames": [ "string" ], "HubAccessConfig": { "HubContentArn": "string" }, "InstanceGroupNames": [ "string" ], "ModelAccessConfig": { "AcceptEula": boolean }, "S3DataDistributionType": "string", "S3DataType": "string", "S3Uri": "string" } }, "InputMode": "string", "RecordWrapperType": "string", "ShuffleConfig": { "Seed": number } } ], "LabelingJobArn": "string", "LastModifiedTime": number, "ModelArtifacts": { "S3ModelArtifacts": "string" }, "ModelPackageConfig": { "ModelPackageGroupArn": "string", "SourceModelPackageArn": "string" }, "OutputDataConfig": { "CompressionType": "string", "KmsKeyId": "string", "S3OutputPath": "string" }, "OutputModelPackageArn": "string", "ProfilerConfig": { "DisableProfiler": boolean, "ProfilingIntervalInMilliseconds": number, "ProfilingParameters": { "string" : "string" }, "S3OutputPath": "string" }, "ResourceConfig": { "InstanceCount": number, "InstanceGroups": [ { "InstanceCount": number, "InstanceGroupName": "string", "InstanceType": "string" } ], "InstancePlacementConfig": { "EnableMultipleJobs": boolean, "PlacementSpecifications": [ { "InstanceCount": number, "UltraServerId": "string" } ] }, "InstanceType": "string", "KeepAlivePeriodInSeconds": number, "TrainingPlanArn": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number }, "RetryStrategy": { "MaximumRetryAttempts": number }, "RoleArn": "string", "SecondaryStatus": "string", "SecondaryStatusTransitions": [ { "EndTime": number, "StartTime": number, "Status": "string", "StatusMessage": "string" } ], "StoppingCondition": { "MaxPendingTimeInSeconds": number, "MaxRuntimeInSeconds": number, "MaxWaitTimeInSeconds": number }, "Tags": [ { "Key": "string", "Value": "string" } ], "TensorBoardOutputConfig": { "LocalPath": "string", "S3OutputPath": "string" }, "TrainingEndTime": number, "TrainingJobArn": "string", "TrainingJobName": "string", "TrainingJobStatus": "string", "TrainingStartTime": number, "TrainingTimeInSeconds": number, "TuningJobArn": "string", "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } }, "Trial": { "CreatedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "DisplayName": "string", "ExperimentName": "string", "LastModifiedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "MetadataProperties": { "CommitId": "string", "GeneratedBy": "string", "ProjectId": "string", "Repository": "string" }, "Source": { "SourceArn": "string", "SourceType": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ], "TrialArn": "string", "TrialComponentSummaries": [ { "CreatedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "TrialComponentArn": "string", "TrialComponentName": "string", "TrialComponentSource": { "SourceArn": "string", "SourceType": "string" } } ], "TrialName": "string" }, "TrialComponent": { "CreatedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "DisplayName": "string", "EndTime": number, "InputArtifacts": { "string" : { "MediaType": "string", "Value": "string" } }, "LastModifiedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "LineageGroupArn": "string", "MetadataProperties": { "CommitId": "string", "GeneratedBy": "string", "ProjectId": "string", "Repository": "string" }, "Metrics": [ { "Avg": number, "Count": number, "Last": number, "Max": number, "MetricName": "string", "Min": number, "SourceArn": "string", "StdDev": number, "TimeStamp": number } ], "OutputArtifacts": { "string" : { "MediaType": "string", "Value": "string" } }, "Parameters": { "string" : { "NumberValue": number, "StringValue": "string" } }, "Parents": [ { "ExperimentName": "string", "TrialName": "string" } ], "RunName": "string", "Source": { "SourceArn": "string", "SourceType": "string" }, "SourceDetail": { "ProcessingJob": { "AppSpecification": { "ContainerArguments": [ "string" ], "ContainerEntrypoint": [ "string" ], "ImageUri": "string" }, "AutoMLJobArn": "string", "CreationTime": number, "Environment": { "string" : "string" }, "ExitMessage": "string", "ExperimentConfig": { "ExperimentName": "string", "RunName": "string", "TrialComponentDisplayName": "string", "TrialName": "string" }, "FailureReason": "string", "LastModifiedTime": number, "MonitoringScheduleArn": "string", "NetworkConfig": { "EnableInterContainerTrafficEncryption": boolean, "EnableNetworkIsolation": boolean, "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } }, "ProcessingEndTime": number, "ProcessingInputs": [ { "AppManaged": boolean, "DatasetDefinition": { "AthenaDatasetDefinition": { "Catalog": "string", "Database": "string", "KmsKeyId": "string", "OutputCompression": "string", "OutputFormat": "string", "OutputS3Uri": "string", "QueryString": "string", "WorkGroup": "string" }, "DataDistributionType": "string", "InputMode": "string", "LocalPath": "string", "RedshiftDatasetDefinition": { "ClusterId": "string", "ClusterRoleArn": "string", "Database": "string", "DbUser": "string", "KmsKeyId": "string", "OutputCompression": "string", "OutputFormat": "string", "OutputS3Uri": "string", "QueryString": "string" } }, "InputName": "string", "S3Input": { "LocalPath": "string", "S3CompressionType": "string", "S3DataDistributionType": "string", "S3DataType": "string", "S3InputMode": "string", "S3Uri": "string" } } ], "ProcessingJobArn": "string", "ProcessingJobName": "string", "ProcessingJobStatus": "string", "ProcessingOutputConfig": { "KmsKeyId": "string", "Outputs": [ { "AppManaged": boolean, "FeatureStoreOutput": { "FeatureGroupName": "string" }, "OutputName": "string", "S3Output": { "LocalPath": "string", "S3UploadMode": "string", "S3Uri": "string" } } ] }, "ProcessingResources": { "ClusterConfig": { "InstanceCount": number, "InstanceType": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number } }, "ProcessingStartTime": number, "RoleArn": "string", "StoppingCondition": { "MaxRuntimeInSeconds": number }, "Tags": [ { "Key": "string", "Value": "string" } ], "TrainingJobArn": "string" }, "SourceArn": "string", "TrainingJob": { "AlgorithmSpecification": { "AlgorithmName": "string", "ContainerArguments": [ "string" ], "ContainerEntrypoint": [ "string" ], "EnableSageMakerMetricsTimeSeries": boolean, "MetricDefinitions": [ { "Name": "string", "Regex": "string" } ], "TrainingImage": "string", "TrainingImageConfig": { "TrainingRepositoryAccessMode": "string", "TrainingRepositoryAuthConfig": { "TrainingRepositoryCredentialsProviderArn": "string" } }, "TrainingInputMode": "string" }, "AutoMLJobArn": "string", "BillableTimeInSeconds": number, "CheckpointConfig": { "LocalPath": "string", "S3Uri": "string" }, "CreationTime": number, "DebugHookConfig": { "CollectionConfigurations": [ { "CollectionName": "string", "CollectionParameters": { "string" : "string" } } ], "HookParameters": { "string" : "string" }, "LocalPath": "string", "S3OutputPath": "string" }, "DebugRuleConfigurations": [ { "InstanceType": "string", "LocalPath": "string", "RuleConfigurationName": "string", "RuleEvaluatorImage": "string", "RuleParameters": { "string" : "string" }, "S3OutputPath": "string", "VolumeSizeInGB": number } ], "DebugRuleEvaluationStatuses": [ { "LastModifiedTime": number, "RuleConfigurationName": "string", "RuleEvaluationJobArn": "string", "RuleEvaluationStatus": "string", "StatusDetails": "string" } ], "EnableInterContainerTrafficEncryption": boolean, "EnableManagedSpotTraining": boolean, "EnableNetworkIsolation": boolean, "Environment": { "string" : "string" }, "ExperimentConfig": { "ExperimentName": "string", "RunName": "string", "TrialComponentDisplayName": "string", "TrialName": "string" }, "FailureReason": "string", "FinalMetricDataList": [ { "MetricName": "string", "Timestamp": number, "Value": number } ], "HyperParameters": { "string" : "string" }, "InputDataConfig": [ { "ChannelName": "string", "CompressionType": "string", "ContentType": "string", "DataSource": { "FileSystemDataSource": { "DirectoryPath": "string", "FileSystemAccessMode": "string", "FileSystemId": "string", "FileSystemType": "string" }, "S3DataSource": { "AttributeNames": [ "string" ], "HubAccessConfig": { "HubContentArn": "string" }, "InstanceGroupNames": [ "string" ], "ModelAccessConfig": { "AcceptEula": boolean }, "S3DataDistributionType": "string", "S3DataType": "string", "S3Uri": "string" } }, "InputMode": "string", "RecordWrapperType": "string", "ShuffleConfig": { "Seed": number } } ], "LabelingJobArn": "string", "LastModifiedTime": number, "ModelArtifacts": { "S3ModelArtifacts": "string" }, "ModelPackageConfig": { "ModelPackageGroupArn": "string", "SourceModelPackageArn": "string" }, "OutputDataConfig": { "CompressionType": "string", "KmsKeyId": "string", "S3OutputPath": "string" }, "OutputModelPackageArn": "string", "ProfilerConfig": { "DisableProfiler": boolean, "ProfilingIntervalInMilliseconds": number, "ProfilingParameters": { "string" : "string" }, "S3OutputPath": "string" }, "ResourceConfig": { "InstanceCount": number, "InstanceGroups": [ { "InstanceCount": number, "InstanceGroupName": "string", "InstanceType": "string" } ], "InstancePlacementConfig": { "EnableMultipleJobs": boolean, "PlacementSpecifications": [ { "InstanceCount": number, "UltraServerId": "string" } ] }, "InstanceType": "string", "KeepAlivePeriodInSeconds": number, "TrainingPlanArn": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number }, "RetryStrategy": { "MaximumRetryAttempts": number }, "RoleArn": "string", "SecondaryStatus": "string", "SecondaryStatusTransitions": [ { "EndTime": number, "StartTime": number, "Status": "string", "StatusMessage": "string" } ], "StoppingCondition": { "MaxPendingTimeInSeconds": number, "MaxRuntimeInSeconds": number, "MaxWaitTimeInSeconds": number }, "Tags": [ { "Key": "string", "Value": "string" } ], "TensorBoardOutputConfig": { "LocalPath": "string", "S3OutputPath": "string" }, "TrainingEndTime": number, "TrainingJobArn": "string", "TrainingJobName": "string", "TrainingJobStatus": "string", "TrainingStartTime": number, "TrainingTimeInSeconds": number, "TuningJobArn": "string", "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } }, "TransformJob": { "AutoMLJobArn": "string", "BatchStrategy": "string", "CreationTime": number, "DataCaptureConfig": { "DestinationS3Uri": "string", "GenerateInferenceId": boolean, "KmsKeyId": "string" }, "DataProcessing": { "InputFilter": "string", "JoinSource": "string", "OutputFilter": "string" }, "Environment": { "string" : "string" }, "ExperimentConfig": { "ExperimentName": "string", "RunName": "string", "TrialComponentDisplayName": "string", "TrialName": "string" }, "FailureReason": "string", "LabelingJobArn": "string", "MaxConcurrentTransforms": number, "MaxPayloadInMB": number, "ModelClientConfig": { "InvocationsMaxRetries": number, "InvocationsTimeoutInSeconds": number }, "ModelName": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TransformEndTime": number, "TransformInput": { "CompressionType": "string", "ContentType": "string", "DataSource": { "S3DataSource": { "S3DataType": "string", "S3Uri": "string" } }, "SplitType": "string" }, "TransformJobArn": "string", "TransformJobName": "string", "TransformJobStatus": "string", "TransformOutput": { "Accept": "string", "AssembleWith": "string", "KmsKeyId": "string", "S3OutputPath": "string" }, "TransformResources": { "InstanceCount": number, "InstanceType": "string", "TransformAmiVersion": "string", "VolumeKmsKeyId": "string" }, "TransformStartTime": number } }, "StartTime": number, "Status": { "Message": "string", "PrimaryStatus": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ], "TrialComponentArn": "string", "TrialComponentName": "string" } } ], "TotalHits": { "Relation": "string", "Value": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_Search_ResponseSyntax) ** 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Pattern: `.*` ** [Results](#API_Search_ResponseSyntax) ** A list of `SearchRecord` objects. Type: Array of [SearchRecord](API_SearchRecord.md) objects ** [TotalHits](#API_Search_ResponseSyntax) ** The total number of matching results. Type: [TotalHits](API_TotalHits.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/Search) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/Search) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/Search) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/Search) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/Search) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/Search) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/Search) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/Search) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/Search) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/Search) # SearchTrainingPlanOfferings Searches for available training plan offerings based on specified criteria. + Users search for available plan offerings based on their requirements (e.g., instance type, count, start time, duration). + And then, they create a plan that best matches their needs using the ID of the plan offering they want to use. For more information about how to reserve GPU capacity for your SageMaker training jobs or SageMaker HyperPod clusters using Amazon SageMaker Training Plan , see ` [CreateTrainingPlan](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingPlan.html) `. ## Request Syntax ``` { "DurationHours": number, "EndTimeBefore": number, "InstanceCount": number, "InstanceType": "string", "StartTimeAfter": number, "TargetResources": [ "string" ], "TrainingPlanArn": "string", "UltraServerCount": number, "UltraServerType": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DurationHours](#API_SearchTrainingPlanOfferings_RequestSyntax) ** The desired duration in hours for the training plan offerings. Type: Long Valid Range: Minimum value of 1. Maximum value of 87600. Required: No ** [EndTimeBefore](#API_SearchTrainingPlanOfferings_RequestSyntax) ** A filter to search for reserved capacity offerings with an end time before a specified date. Type: Timestamp Required: No ** [InstanceCount](#API_SearchTrainingPlanOfferings_RequestSyntax) ** The number of instances you want to reserve in the training plan offerings. This allows you to specify the quantity of compute resources needed for your SageMaker training jobs or SageMaker HyperPod clusters, helping you find reserved capacity offerings that match your requirements. Type: Integer Valid Range: Minimum value of 0. Maximum value of 256. Required: No ** [InstanceType](#API_SearchTrainingPlanOfferings_RequestSyntax) ** The type of instance you want to search for in the available training plan offerings. This field allows you to filter the search results based on the specific compute resources you require for your SageMaker training jobs or SageMaker HyperPod clusters. When searching for training plan offerings, specifying the instance type helps you find Reserved Instances that match your computational needs. Type: String Valid Values: `ml.p4d.24xlarge | ml.p5.48xlarge | ml.p5e.48xlarge | ml.p5en.48xlarge | ml.trn1.32xlarge | ml.trn2.48xlarge | ml.p6-b200.48xlarge | ml.p4de.24xlarge | ml.p6e-gb200.36xlarge | ml.p5.4xlarge | ml.p6-b300.48xlarge` Required: No ** [StartTimeAfter](#API_SearchTrainingPlanOfferings_RequestSyntax) ** A filter to search for training plan offerings with a start time after a specified date. Type: Timestamp Required: No ** [TargetResources](#API_SearchTrainingPlanOfferings_RequestSyntax) ** The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod, SageMaker Endpoints) to search for in the offerings. Training plans are specific to their target resource. + A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs. + A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group. + A training plan for SageMaker endpoints can be used exclusively to provide compute resources to SageMaker endpoints for model deployment. Type: Array of strings Array Members: Minimum number of 1 item. Valid Values: `training-job | hyperpod-cluster | endpoint` Required: No ** [TrainingPlanArn](#API_SearchTrainingPlanOfferings_RequestSyntax) ** The Amazon Resource Name (ARN); of an existing training plan to search for extension offerings. When specified, the API returns extension offerings that can be used to extend the specified training plan. Type: String Required: No ** [UltraServerCount](#API_SearchTrainingPlanOfferings_RequestSyntax) ** The number of UltraServers to search for. Type: Integer Valid Range: Minimum value of 1. Required: No ** [UltraServerType](#API_SearchTrainingPlanOfferings_RequestSyntax) ** The type of UltraServer to search for, such as ml.u-p6e-gb200x72. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `ml.[a-z0-9\-.]+` Required: No ## Response Syntax ``` { "TrainingPlanExtensionOfferings": [ { "AvailabilityZone": "string", "CurrencyCode": "string", "DurationHours": number, "EndDate": number, "StartDate": number, "TrainingPlanExtensionOfferingId": "string", "UpfrontFee": "string" } ], "TrainingPlanOfferings": [ { "CurrencyCode": "string", "DurationHours": number, "DurationMinutes": number, "RequestedEndTimeBefore": number, "RequestedStartTimeAfter": number, "ReservedCapacityOfferings": [ { "AvailabilityZone": "string", "DurationHours": number, "DurationMinutes": number, "EndTime": number, "ExtensionEndTime": number, "ExtensionStartTime": number, "InstanceCount": number, "InstanceType": "string", "ReservedCapacityType": "string", "StartTime": number, "UltraServerCount": number, "UltraServerType": "string" } ], "TargetResources": [ "string" ], "TrainingPlanOfferingId": "string", "UpfrontFee": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [TrainingPlanExtensionOfferings](#API_SearchTrainingPlanOfferings_ResponseSyntax) ** A list of extension offerings available for the specified training plan. These offerings can be used with the ` [ExtendTrainingPlan](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ExtendTrainingPlan.html) ` API to extend an existing training plan. Type: Array of [TrainingPlanExtensionOffering](API_TrainingPlanExtensionOffering.md) objects Array Members: Minimum number of 0 items. ** [TrainingPlanOfferings](#API_SearchTrainingPlanOfferings_ResponseSyntax) ** A list of training plan offerings that match the search criteria. Type: Array of [TrainingPlanOffering](API_TrainingPlanOffering.md) objects Array Members: Minimum number of 0 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/SearchTrainingPlanOfferings) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/SearchTrainingPlanOfferings) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/SearchTrainingPlanOfferings) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/SearchTrainingPlanOfferings) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/SearchTrainingPlanOfferings) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/SearchTrainingPlanOfferings) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/SearchTrainingPlanOfferings) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/SearchTrainingPlanOfferings) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/SearchTrainingPlanOfferings) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/SearchTrainingPlanOfferings) # SendPipelineExecutionStepFailure Notifies the pipeline that the execution of a callback step failed, along with a message describing why. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS). ## Request Syntax ``` { "CallbackToken": "string", "ClientRequestToken": "string", "FailureReason": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CallbackToken](#API_SendPipelineExecutionStepFailure_RequestSyntax) ** The pipeline generated token from the Amazon SQS queue. Type: String Length Constraints: Fixed length of 10. Pattern: `[a-zA-Z0-9]+` Required: Yes ** [ClientRequestToken](#API_SendPipelineExecutionStepFailure_RequestSyntax) ** A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time. Type: String Length Constraints: Minimum length of 32. Maximum length of 128. Required: No ** [FailureReason](#API_SendPipelineExecutionStepFailure_RequestSyntax) ** A message describing why the step failed. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Required: No ## Response Syntax ``` { "PipelineExecutionArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [PipelineExecutionArn](#API_SendPipelineExecutionStepFailure_ResponseSyntax) ** The Amazon Resource Name (ARN) of the pipeline execution. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:pipeline\/.*\/execution\/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/SendPipelineExecutionStepFailure) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/SendPipelineExecutionStepFailure) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/SendPipelineExecutionStepFailure) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/SendPipelineExecutionStepFailure) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/SendPipelineExecutionStepFailure) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/SendPipelineExecutionStepFailure) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/SendPipelineExecutionStepFailure) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/SendPipelineExecutionStepFailure) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/SendPipelineExecutionStepFailure) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/SendPipelineExecutionStepFailure) # SendPipelineExecutionStepSuccess Notifies the pipeline that the execution of a callback step succeeded and provides a list of the step's output parameters. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS). ## Request Syntax ``` { "CallbackToken": "string", "ClientRequestToken": "string", "OutputParameters": [ { "Name": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CallbackToken](#API_SendPipelineExecutionStepSuccess_RequestSyntax) ** The pipeline generated token from the Amazon SQS queue. Type: String Length Constraints: Fixed length of 10. Pattern: `[a-zA-Z0-9]+` Required: Yes ** [ClientRequestToken](#API_SendPipelineExecutionStepSuccess_RequestSyntax) ** A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time. Type: String Length Constraints: Minimum length of 32. Maximum length of 128. Required: No ** [OutputParameters](#API_SendPipelineExecutionStepSuccess_RequestSyntax) ** A list of the output parameters of the callback step. Type: Array of [OutputParameter](API_OutputParameter.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No ## Response Syntax ``` { "PipelineExecutionArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [PipelineExecutionArn](#API_SendPipelineExecutionStepSuccess_ResponseSyntax) ** The Amazon Resource Name (ARN) of the pipeline execution. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:pipeline\/.*\/execution\/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/SendPipelineExecutionStepSuccess) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/SendPipelineExecutionStepSuccess) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/SendPipelineExecutionStepSuccess) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/SendPipelineExecutionStepSuccess) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/SendPipelineExecutionStepSuccess) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/SendPipelineExecutionStepSuccess) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/SendPipelineExecutionStepSuccess) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/SendPipelineExecutionStepSuccess) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/SendPipelineExecutionStepSuccess) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/SendPipelineExecutionStepSuccess) # StartEdgeDeploymentStage Starts a stage in an edge deployment plan. ## Request Syntax ``` { "EdgeDeploymentPlanName": "string", "StageName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [EdgeDeploymentPlanName](#API_StartEdgeDeploymentStage_RequestSyntax) ** The name of the edge deployment plan to start. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [StageName](#API_StartEdgeDeploymentStage_RequestSyntax) ** The name of the stage to start. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/StartEdgeDeploymentStage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/StartEdgeDeploymentStage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/StartEdgeDeploymentStage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/StartEdgeDeploymentStage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/StartEdgeDeploymentStage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/StartEdgeDeploymentStage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/StartEdgeDeploymentStage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/StartEdgeDeploymentStage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/StartEdgeDeploymentStage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/StartEdgeDeploymentStage) # StartInferenceExperiment Starts an inference experiment. ## Request Syntax ``` { "Name": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Name](#API_StartInferenceExperiment_RequestSyntax) ** The name of the inference experiment to start. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` Required: Yes ## Response Syntax ``` { "InferenceExperimentArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [InferenceExperimentArn](#API_StartInferenceExperiment_ResponseSyntax) ** The ARN of the started inference experiment to start. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:inference-experiment/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/StartInferenceExperiment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/StartInferenceExperiment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/StartInferenceExperiment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/StartInferenceExperiment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/StartInferenceExperiment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/StartInferenceExperiment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/StartInferenceExperiment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/StartInferenceExperiment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/StartInferenceExperiment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/StartInferenceExperiment) # StartMlflowTrackingServer Programmatically start an MLflow Tracking Server. ## Request Syntax ``` { "TrackingServerName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [TrackingServerName](#API_StartMlflowTrackingServer_RequestSyntax) ** The name of the tracking server to start. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}` Required: Yes ## Response Syntax ``` { "TrackingServerArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [TrackingServerArn](#API_StartMlflowTrackingServer_ResponseSyntax) ** The ARN of the started tracking server. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:mlflow-tracking-server/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/StartMlflowTrackingServer) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/StartMlflowTrackingServer) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/StartMlflowTrackingServer) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/StartMlflowTrackingServer) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/StartMlflowTrackingServer) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/StartMlflowTrackingServer) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/StartMlflowTrackingServer) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/StartMlflowTrackingServer) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/StartMlflowTrackingServer) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/StartMlflowTrackingServer) # StartMonitoringSchedule Starts a previously stopped monitoring schedule. **Note** By default, when you successfully create a new schedule, the status of a monitoring schedule is `scheduled`. ## Request Syntax ``` { "MonitoringScheduleName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [MonitoringScheduleName](#API_StartMonitoringSchedule_RequestSyntax) ** The name of the schedule to start. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/StartMonitoringSchedule) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/StartMonitoringSchedule) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/StartMonitoringSchedule) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/StartMonitoringSchedule) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/StartMonitoringSchedule) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/StartMonitoringSchedule) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/StartMonitoringSchedule) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/StartMonitoringSchedule) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/StartMonitoringSchedule) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/StartMonitoringSchedule) # StartNotebookInstance Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume. After configuring the notebook instance, SageMaker AI sets the notebook instance status to `InService`. A notebook instance's status must be `InService` before you can connect to your Jupyter notebook. ## Request Syntax ``` { "NotebookInstanceName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [NotebookInstanceName](#API_StartNotebookInstance_RequestSyntax) ** The name of the notebook instance to start. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9])*` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/StartNotebookInstance) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/StartNotebookInstance) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/StartNotebookInstance) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/StartNotebookInstance) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/StartNotebookInstance) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/StartNotebookInstance) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/StartNotebookInstance) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/StartNotebookInstance) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/StartNotebookInstance) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/StartNotebookInstance) # StartPipelineExecution Starts a pipeline execution. ## Request Syntax ``` { "ClientRequestToken": "string", "MlflowExperimentName": "string", "ParallelismConfiguration": { "MaxParallelExecutionSteps": number }, "PipelineExecutionDescription": "string", "PipelineExecutionDisplayName": "string", "PipelineName": "string", "PipelineParameters": [ { "Name": "string", "Value": "string" } ], "PipelineVersionId": number, "SelectiveExecutionConfig": { "SelectedSteps": [ { "StepName": "string" } ], "SourcePipelineExecutionArn": "string" } } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClientRequestToken](#API_StartPipelineExecution_RequestSyntax) ** A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once. Type: String Length Constraints: Minimum length of 32. Maximum length of 128. Required: Yes ** [MlflowExperimentName](#API_StartPipelineExecution_RequestSyntax) ** The MLflow experiment name of the pipeline execution. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `.*` Required: No ** [ParallelismConfiguration](#API_StartPipelineExecution_RequestSyntax) ** This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run. Type: [ParallelismConfiguration](API_ParallelismConfiguration.md) object Required: No ** [PipelineExecutionDescription](#API_StartPipelineExecution_RequestSyntax) ** The description of the pipeline execution. Type: String Length Constraints: Minimum length of 0. Maximum length of 3072. Pattern: `.*` Required: No ** [PipelineExecutionDisplayName](#API_StartPipelineExecution_RequestSyntax) ** The display name of the pipeline execution. Type: String Length Constraints: Minimum length of 1. Maximum length of 82. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,81}` Required: No ** [PipelineName](#API_StartPipelineExecution_RequestSyntax) ** The name or Amazon Resource Name (ARN) of the pipeline. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:pipeline/.*)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,255})` Required: Yes ** [PipelineParameters](#API_StartPipelineExecution_RequestSyntax) ** Contains a list of pipeline parameters. This list can be empty. Type: Array of [Parameter](API_Parameter.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ** [PipelineVersionId](#API_StartPipelineExecution_RequestSyntax) ** The ID of the pipeline version to start execution from. Type: Long Valid Range: Minimum value of 1. Required: No ** [SelectiveExecutionConfig](#API_StartPipelineExecution_RequestSyntax) ** The selective execution configuration applied to the pipeline run. Type: [SelectiveExecutionConfig](API_SelectiveExecutionConfig.md) object Required: No ## Response Syntax ``` { "PipelineExecutionArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [PipelineExecutionArn](#API_StartPipelineExecution_ResponseSyntax) ** The Amazon Resource Name (ARN) of the pipeline execution. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:pipeline\/.*\/execution\/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/StartPipelineExecution) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/StartPipelineExecution) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/StartPipelineExecution) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/StartPipelineExecution) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/StartPipelineExecution) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/StartPipelineExecution) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/StartPipelineExecution) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/StartPipelineExecution) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/StartPipelineExecution) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/StartPipelineExecution) # StartSession Initiates a remote connection session between a local integrated development environments (IDEs) and a remote SageMaker space. ## Request Syntax ``` { "ResourceIdentifier": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ResourceIdentifier](#API_StartSession_RequestSyntax) ** The Amazon Resource Name (ARN) of the resource to which the remote connection will be established. For example, this identifies the specific ARN space application you want to connect to from your local IDE. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:.*\/.*` Required: Yes ## Response Syntax ``` { "SessionId": "string", "StreamUrl": "string", "TokenValue": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [SessionId](#API_StartSession_ResponseSyntax) ** A unique identifier for the established remote connection session. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. ** [StreamUrl](#API_StartSession_ResponseSyntax) ** A WebSocket URL used to establish a SSH connection between the local IDE and remote SageMaker space. Type: String ** [TokenValue](#API_StartSession_ResponseSyntax) ** An encrypted token value containing session and caller information. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/StartSession) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/StartSession) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/StartSession) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/StartSession) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/StartSession) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/StartSession) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/StartSession) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/StartSession) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/StartSession) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/StartSession) # StopAutoMLJob A method for forcing a running job to shut down. ## Request Syntax ``` { "AutoMLJobName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AutoMLJobName](#API_StopAutoMLJob_RequestSyntax) ** The name of the object you are requesting. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/StopAutoMLJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/StopAutoMLJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/StopAutoMLJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/StopAutoMLJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/StopAutoMLJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/StopAutoMLJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/StopAutoMLJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/StopAutoMLJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/StopAutoMLJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/StopAutoMLJob) # StopCompilationJob Stops a model compilation job. To stop a job, Amazon SageMaker AI sends the algorithm the SIGTERM signal. This gracefully shuts the job down. If the job hasn't stopped, it sends the SIGKILL signal. When it receives a `StopCompilationJob` request, Amazon SageMaker AI changes the `CompilationJobStatus` of the job to `Stopping`. After Amazon SageMaker stops the job, it sets the `CompilationJobStatus` to `Stopped`. ## Request Syntax ``` { "CompilationJobName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CompilationJobName](#API_StopCompilationJob_RequestSyntax) ** The name of the model compilation job to stop. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/StopCompilationJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/StopCompilationJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/StopCompilationJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/StopCompilationJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/StopCompilationJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/StopCompilationJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/StopCompilationJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/StopCompilationJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/StopCompilationJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/StopCompilationJob) # StopEdgeDeploymentStage Stops a stage in an edge deployment plan. ## Request Syntax ``` { "EdgeDeploymentPlanName": "string", "StageName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [EdgeDeploymentPlanName](#API_StopEdgeDeploymentStage_RequestSyntax) ** The name of the edge deployment plan to stop. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [StageName](#API_StopEdgeDeploymentStage_RequestSyntax) ** The name of the stage to stop. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/StopEdgeDeploymentStage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/StopEdgeDeploymentStage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/StopEdgeDeploymentStage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/StopEdgeDeploymentStage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/StopEdgeDeploymentStage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/StopEdgeDeploymentStage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/StopEdgeDeploymentStage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/StopEdgeDeploymentStage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/StopEdgeDeploymentStage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/StopEdgeDeploymentStage) # StopEdgePackagingJob Request to stop an edge packaging job. ## Request Syntax ``` { "EdgePackagingJobName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [EdgePackagingJobName](#API_StopEdgePackagingJob_RequestSyntax) ** The name of the edge packaging job. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/StopEdgePackagingJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/StopEdgePackagingJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/StopEdgePackagingJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/StopEdgePackagingJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/StopEdgePackagingJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/StopEdgePackagingJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/StopEdgePackagingJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/StopEdgePackagingJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/StopEdgePackagingJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/StopEdgePackagingJob) # StopHyperParameterTuningJob 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. ## Request Syntax ``` { "HyperParameterTuningJobName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [HyperParameterTuningJobName](#API_StopHyperParameterTuningJob_RequestSyntax) ** The name of the tuning job to stop. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/StopHyperParameterTuningJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/StopHyperParameterTuningJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/StopHyperParameterTuningJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/StopHyperParameterTuningJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/StopHyperParameterTuningJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/StopHyperParameterTuningJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/StopHyperParameterTuningJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/StopHyperParameterTuningJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/StopHyperParameterTuningJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/StopHyperParameterTuningJob) # StopInferenceExperiment Stops an inference experiment. ## Request Syntax ``` { "DesiredModelVariants": [ { "InfrastructureConfig": { "InfrastructureType": "string", "RealTimeInferenceConfig": { "InstanceCount": number, "InstanceType": "string" } }, "ModelName": "string", "VariantName": "string" } ], "DesiredState": "string", "ModelVariantActions": { "string" : "string" }, "Name": "string", "Reason": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DesiredModelVariants](#API_StopInferenceExperiment_RequestSyntax) ** An array of `ModelVariantConfig` objects. There is one for each variant that you want to deploy after the inference experiment stops. Each `ModelVariantConfig` describes the infrastructure configuration for deploying the corresponding variant. Type: Array of [ModelVariantConfig](API_ModelVariantConfig.md) objects Array Members: Minimum number of 1 item. Maximum number of 2 items. Required: No ** [DesiredState](#API_StopInferenceExperiment_RequestSyntax) ** The desired state of the experiment after stopping. The possible states are the following: + `Completed`: The experiment completed successfully + `Cancelled`: The experiment was canceled Type: String Valid Values: `Completed | Cancelled` Required: No ** [ModelVariantActions](#API_StopInferenceExperiment_RequestSyntax) ** Array of key-value pairs, with names of variants mapped to actions. The possible actions are the following: + `Promote` - Promote the shadow variant to a production variant + `Remove` - Delete the variant + `Retain` - Keep the variant as it is Type: String to string map Map Entries: Maximum number of 2 items. Key Length Constraints: Minimum length of 0. Maximum length of 63. Key Pattern: `[a-zA-Z0-9]([\-a-zA-Z0-9]*[a-zA-Z0-9])?` Valid Values: `Retain | Remove | Promote` Required: Yes ** [Name](#API_StopInferenceExperiment_RequestSyntax) ** The name of the inference experiment to stop. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` Required: Yes ** [Reason](#API_StopInferenceExperiment_RequestSyntax) ** The reason for stopping the experiment. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `.*` Required: No ## Response Syntax ``` { "InferenceExperimentArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [InferenceExperimentArn](#API_StopInferenceExperiment_ResponseSyntax) ** The ARN of the stopped inference experiment. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:inference-experiment/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/StopInferenceExperiment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/StopInferenceExperiment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/StopInferenceExperiment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/StopInferenceExperiment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/StopInferenceExperiment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/StopInferenceExperiment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/StopInferenceExperiment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/StopInferenceExperiment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/StopInferenceExperiment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/StopInferenceExperiment) # StopInferenceRecommendationsJob Stops an Inference Recommender job. ## Request Syntax ``` { "JobName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [JobName](#API_StopInferenceRecommendationsJob_RequestSyntax) ** The name of the job you want to stop. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/StopInferenceRecommendationsJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/StopInferenceRecommendationsJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/StopInferenceRecommendationsJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/StopInferenceRecommendationsJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/StopInferenceRecommendationsJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/StopInferenceRecommendationsJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/StopInferenceRecommendationsJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/StopInferenceRecommendationsJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/StopInferenceRecommendationsJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/StopInferenceRecommendationsJob) # StopLabelingJob 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. ## Request Syntax ``` { "LabelingJobName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [LabelingJobName](#API_StopLabelingJob_RequestSyntax) ** The name of the labeling job to stop. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/StopLabelingJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/StopLabelingJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/StopLabelingJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/StopLabelingJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/StopLabelingJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/StopLabelingJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/StopLabelingJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/StopLabelingJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/StopLabelingJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/StopLabelingJob) # StopMlflowTrackingServer Programmatically stop an MLflow Tracking Server. ## Request Syntax ``` { "TrackingServerName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [TrackingServerName](#API_StopMlflowTrackingServer_RequestSyntax) ** The name of the tracking server to stop. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}` Required: Yes ## Response Syntax ``` { "TrackingServerArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [TrackingServerArn](#API_StopMlflowTrackingServer_ResponseSyntax) ** The ARN of the stopped tracking server. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:mlflow-tracking-server/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/StopMlflowTrackingServer) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/StopMlflowTrackingServer) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/StopMlflowTrackingServer) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/StopMlflowTrackingServer) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/StopMlflowTrackingServer) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/StopMlflowTrackingServer) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/StopMlflowTrackingServer) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/StopMlflowTrackingServer) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/StopMlflowTrackingServer) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/StopMlflowTrackingServer) # StopMonitoringSchedule Stops a previously started monitoring schedule. ## Request Syntax ``` { "MonitoringScheduleName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [MonitoringScheduleName](#API_StopMonitoringSchedule_RequestSyntax) ** The name of the schedule to stop. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/StopMonitoringSchedule) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/StopMonitoringSchedule) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/StopMonitoringSchedule) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/StopMonitoringSchedule) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/StopMonitoringSchedule) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/StopMonitoringSchedule) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/StopMonitoringSchedule) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/StopMonitoringSchedule) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/StopMonitoringSchedule) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/StopMonitoringSchedule) # StopNotebookInstance Terminates the ML compute instance. Before terminating the instance, SageMaker AI disconnects the ML storage volume from it. SageMaker AI preserves the ML storage volume. SageMaker AI stops charging you for the ML compute instance when you call `StopNotebookInstance`. To access data on the ML storage volume for a notebook instance that has been terminated, call the `StartNotebookInstance` API. `StartNotebookInstance` launches another ML compute instance, configures it, and attaches the preserved ML storage volume so you can continue your work. ## Request Syntax ``` { "NotebookInstanceName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [NotebookInstanceName](#API_StopNotebookInstance_RequestSyntax) ** The name of the notebook instance to terminate. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9])*` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/StopNotebookInstance) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/StopNotebookInstance) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/StopNotebookInstance) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/StopNotebookInstance) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/StopNotebookInstance) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/StopNotebookInstance) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/StopNotebookInstance) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/StopNotebookInstance) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/StopNotebookInstance) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/StopNotebookInstance) # StopOptimizationJob Ends a running inference optimization job. ## Request Syntax ``` { "OptimizationJobName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [OptimizationJobName](#API_StopOptimizationJob_RequestSyntax) ** The name that you assigned to the optimization job. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/StopOptimizationJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/StopOptimizationJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/StopOptimizationJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/StopOptimizationJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/StopOptimizationJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/StopOptimizationJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/StopOptimizationJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/StopOptimizationJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/StopOptimizationJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/StopOptimizationJob) # StopPipelineExecution Stops a pipeline execution. **Callback Step** A pipeline execution won't stop while a callback step is running. When you call `StopPipelineExecution` on a pipeline execution with a running callback step, SageMaker Pipelines sends an additional Amazon SQS message to the specified SQS queue. The body of the SQS message contains a "Status" field which is set to "Stopping". You should add logic to your Amazon SQS message consumer to take any needed action (for example, resource cleanup) upon receipt of the message followed by a call to `SendPipelineExecutionStepSuccess` or `SendPipelineExecutionStepFailure`. Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution. **Lambda Step** A pipeline execution can't be stopped while a lambda step is running because the Lambda function invoked by the lambda step can't be stopped. If you attempt to stop the execution while the Lambda function is running, the pipeline waits for the Lambda function to finish or until the timeout is hit, whichever occurs first, and then stops. If the Lambda function finishes, the pipeline execution status is `Stopped`. If the timeout is hit the pipeline execution status is `Failed`. ## Request Syntax ``` { "ClientRequestToken": "string", "PipelineExecutionArn": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClientRequestToken](#API_StopPipelineExecution_RequestSyntax) ** A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once. Type: String Length Constraints: Minimum length of 32. Maximum length of 128. Required: Yes ** [PipelineExecutionArn](#API_StopPipelineExecution_RequestSyntax) ** The Amazon Resource Name (ARN) of the pipeline execution. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:pipeline\/.*\/execution\/.*` Required: Yes ## Response Syntax ``` { "PipelineExecutionArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [PipelineExecutionArn](#API_StopPipelineExecution_ResponseSyntax) ** The Amazon Resource Name (ARN) of the pipeline execution. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:pipeline\/.*\/execution\/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/StopPipelineExecution) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/StopPipelineExecution) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/StopPipelineExecution) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/StopPipelineExecution) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/StopPipelineExecution) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/StopPipelineExecution) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/StopPipelineExecution) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/StopPipelineExecution) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/StopPipelineExecution) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/StopPipelineExecution) # StopProcessingJob Stops a processing job. ## Request Syntax ``` { "ProcessingJobName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ProcessingJobName](#API_StopProcessingJob_RequestSyntax) ** The name of the processing job to stop. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/StopProcessingJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/StopProcessingJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/StopProcessingJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/StopProcessingJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/StopProcessingJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/StopProcessingJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/StopProcessingJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/StopProcessingJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/StopProcessingJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/StopProcessingJob) # StopTrainingJob Stops a training job. To stop a job, SageMaker sends the algorithm the `SIGTERM` signal, which delays job termination for 120 seconds. Algorithms might use this 120-second window to save the model artifacts, so the results of the training is not lost. When it receives a `StopTrainingJob` request, SageMaker changes the status of the job to `Stopping`. After SageMaker stops the job, it sets the status to `Stopped`. ## Request Syntax ``` { "TrainingJobName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [TrainingJobName](#API_StopTrainingJob_RequestSyntax) ** The name of the training job to stop. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/StopTrainingJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/StopTrainingJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/StopTrainingJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/StopTrainingJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/StopTrainingJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/StopTrainingJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/StopTrainingJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/StopTrainingJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/StopTrainingJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/StopTrainingJob) # StopTransformJob Stops a batch 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 batch transform job before it is completed, Amazon SageMaker doesn't store the job's output in Amazon S3. ## Request Syntax ``` { "TransformJobName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [TransformJobName](#API_StopTransformJob_RequestSyntax) ** The name of the batch transform job to stop. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/StopTransformJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/StopTransformJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/StopTransformJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/StopTransformJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/StopTransformJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/StopTransformJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/StopTransformJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/StopTransformJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/StopTransformJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/StopTransformJob) # UpdateAction Updates an action. ## Request Syntax ``` { "ActionName": "string", "Description": "string", "Properties": { "string" : "string" }, "PropertiesToRemove": [ "string" ], "Status": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ActionName](#API_UpdateAction_RequestSyntax) ** The name of the action to update. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` Required: Yes ** [Description](#API_UpdateAction_RequestSyntax) ** The new description for the action. Type: String Length Constraints: Minimum length of 0. Maximum length of 3072. Pattern: `.*` Required: No ** [Properties](#API_UpdateAction_RequestSyntax) ** The new list of properties. Overwrites the current property list. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 30 items. Key Length Constraints: Minimum length of 0. Maximum length of 2500. Key Pattern: `.*` Value Length Constraints: Minimum length of 0. Maximum length of 2500. Value Pattern: `.*` Required: No ** [PropertiesToRemove](#API_UpdateAction_RequestSyntax) ** A list of properties to remove. Type: Array of strings Length Constraints: Minimum length of 0. Maximum length of 2500. Pattern: `.*` Required: No ** [Status](#API_UpdateAction_RequestSyntax) ** The new status for the action. Type: String Valid Values: `Unknown | InProgress | Completed | Failed | Stopping | Stopped` Required: No ## Response Syntax ``` { "ActionArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ActionArn](#API_UpdateAction_ResponseSyntax) ** The Amazon Resource Name (ARN) of the action. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:action/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateAction) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateAction) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateAction) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateAction) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateAction) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateAction) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateAction) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateAction) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateAction) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateAction) # UpdateAppImageConfig Updates the properties of an AppImageConfig. ## Request Syntax ``` { "AppImageConfigName": "string", "CodeEditorAppImageConfig": { "ContainerConfig": { "ContainerArguments": [ "string" ], "ContainerEntrypoint": [ "string" ], "ContainerEnvironmentVariables": { "string" : "string" } }, "FileSystemConfig": { "DefaultGid": number, "DefaultUid": number, "MountPath": "string" } }, "JupyterLabAppImageConfig": { "ContainerConfig": { "ContainerArguments": [ "string" ], "ContainerEntrypoint": [ "string" ], "ContainerEnvironmentVariables": { "string" : "string" } }, "FileSystemConfig": { "DefaultGid": number, "DefaultUid": number, "MountPath": "string" } }, "KernelGatewayImageConfig": { "FileSystemConfig": { "DefaultGid": number, "DefaultUid": number, "MountPath": "string" }, "KernelSpecs": [ { "DisplayName": "string", "Name": "string" } ] } } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AppImageConfigName](#API_UpdateAppImageConfig_RequestSyntax) ** The name of the AppImageConfig to update. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [CodeEditorAppImageConfig](#API_UpdateAppImageConfig_RequestSyntax) ** The Code Editor app running on the image. Type: [CodeEditorAppImageConfig](API_CodeEditorAppImageConfig.md) object Required: No ** [JupyterLabAppImageConfig](#API_UpdateAppImageConfig_RequestSyntax) ** The JupyterLab app running on the image. Type: [JupyterLabAppImageConfig](API_JupyterLabAppImageConfig.md) object Required: No ** [KernelGatewayImageConfig](#API_UpdateAppImageConfig_RequestSyntax) ** The new KernelGateway app to run on the image. Type: [KernelGatewayImageConfig](API_KernelGatewayImageConfig.md) object Required: No ## Response Syntax ``` { "AppImageConfigArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AppImageConfigArn](#API_UpdateAppImageConfig_ResponseSyntax) ** The ARN for the AppImageConfig. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:app-image-config/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateAppImageConfig) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateAppImageConfig) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateAppImageConfig) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateAppImageConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateAppImageConfig) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateAppImageConfig) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateAppImageConfig) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateAppImageConfig) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateAppImageConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateAppImageConfig) # UpdateArtifact Updates an artifact. ## Request Syntax ``` { "ArtifactArn": "string", "ArtifactName": "string", "Properties": { "string" : "string" }, "PropertiesToRemove": [ "string" ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ArtifactArn](#API_UpdateArtifact_RequestSyntax) ** The Amazon Resource Name (ARN) of the artifact to update. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:artifact/.*` Required: Yes ** [ArtifactName](#API_UpdateArtifact_RequestSyntax) ** The new name for the artifact. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` Required: No ** [Properties](#API_UpdateArtifact_RequestSyntax) ** The new list of properties. Overwrites the current property list. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 30 items. Key Length Constraints: Minimum length of 0. Maximum length of 2500. Key Pattern: `.*` Value Length Constraints: Minimum length of 0. Maximum length of 4096. Value Pattern: `.*` Required: No ** [PropertiesToRemove](#API_UpdateArtifact_RequestSyntax) ** A list of properties to remove. Type: Array of strings Length Constraints: Minimum length of 0. Maximum length of 2500. Pattern: `.*` Required: No ## Response Syntax ``` { "ArtifactArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ArtifactArn](#API_UpdateArtifact_ResponseSyntax) ** The Amazon Resource Name (ARN) of the artifact. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:artifact/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateArtifact) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateArtifact) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateArtifact) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateArtifact) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateArtifact) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateArtifact) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateArtifact) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateArtifact) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateArtifact) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateArtifact) # UpdateCluster Updates a SageMaker HyperPod cluster. ## Request Syntax ``` { "AutoScaling": { "AutoScalerType": "string", "Mode": "string" }, "ClusterName": "string", "ClusterRole": "string", "InstanceGroups": [ { "CapacityRequirements": { "OnDemand": { }, "Spot": { } }, "ExecutionRole": "string", "ImageId": "string", "InstanceCount": number, "InstanceGroupName": "string", "InstanceStorageConfigs": [ { ... } ], "InstanceType": "string", "KubernetesConfig": { "Labels": { "string" : "string" }, "Taints": [ { "Effect": "string", "Key": "string", "Value": "string" } ] }, "LifeCycleConfig": { "OnCreate": "string", "SourceS3Uri": "string" }, "MinInstanceCount": number, "OnStartDeepHealthChecks": [ "string" ], "OverrideVpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] }, "ScheduledUpdateConfig": { "DeploymentConfig": { "AutoRollbackConfiguration": [ { "AlarmName": "string" } ], "RollingUpdatePolicy": { "MaximumBatchSize": { "Type": "string", "Value": number }, "RollbackMaximumBatchSize": { "Type": "string", "Value": number } }, "WaitIntervalInSeconds": number }, "ScheduleExpression": "string" }, "SlurmConfig": { "NodeType": "string", "PartitionNames": [ "string" ] }, "ThreadsPerCore": number, "TrainingPlanArn": "string" } ], "InstanceGroupsToDelete": [ "string" ], "NodeProvisioningMode": "string", "NodeRecovery": "string", "Orchestrator": { "Eks": { "ClusterArn": "string" }, "Slurm": { "SlurmConfigStrategy": "string" } }, "RestrictedInstanceGroups": [ { "EnvironmentConfig": { "FSxLustreConfig": { "PerUnitStorageThroughput": number, "SizeInGiB": number } }, "ExecutionRole": "string", "InstanceCount": number, "InstanceGroupName": "string", "InstanceStorageConfigs": [ { ... } ], "InstanceType": "string", "OnStartDeepHealthChecks": [ "string" ], "OverrideVpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] }, "ScheduledUpdateConfig": { "DeploymentConfig": { "AutoRollbackConfiguration": [ { "AlarmName": "string" } ], "RollingUpdatePolicy": { "MaximumBatchSize": { "Type": "string", "Value": number }, "RollbackMaximumBatchSize": { "Type": "string", "Value": number } }, "WaitIntervalInSeconds": number }, "ScheduleExpression": "string" }, "ThreadsPerCore": number, "TrainingPlanArn": "string" } ], "TieredStorageConfig": { "InstanceMemoryAllocationPercentage": number, "Mode": "string" } } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AutoScaling](#API_UpdateCluster_RequestSyntax) ** Updates the autoscaling configuration for the cluster. Use to enable or disable automatic node scaling. Type: [ClusterAutoScalingConfig](API_ClusterAutoScalingConfig.md) object Required: No ** [ClusterName](#API_UpdateCluster_RequestSyntax) ** Specify the name of the SageMaker HyperPod cluster you want to update. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})` Required: Yes ** [ClusterRole](#API_UpdateCluster_RequestSyntax) ** The Amazon Resource Name (ARN) of the IAM role that HyperPod assumes for cluster autoscaling operations. Cannot be updated while autoscaling is enabled. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` Required: No ** [InstanceGroups](#API_UpdateCluster_RequestSyntax) ** Specify the instance groups to update. Type: Array of [ClusterInstanceGroupSpecification](API_ClusterInstanceGroupSpecification.md) objects Array Members: Minimum number of 1 item. Maximum number of 100 items. Required: No ** [InstanceGroupsToDelete](#API_UpdateCluster_RequestSyntax) ** Specify the names of the instance groups to delete. Use a single `,` as the separator between multiple names. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 100 items. Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9])*` Required: No ** [NodeProvisioningMode](#API_UpdateCluster_RequestSyntax) ** Determines how instance provisioning is handled during cluster operations. In `Continuous` mode, the cluster provisions available instances incrementally and retries until the target count is reached. The cluster becomes operational once cluster-level resources are ready. Use `CurrentCount` and `TargetCount` in `DescribeCluster` to track provisioning progress. Type: String Valid Values: `Continuous` Required: No ** [NodeRecovery](#API_UpdateCluster_RequestSyntax) ** The node recovery mode to be applied to the SageMaker HyperPod cluster. Type: String Valid Values: `Automatic | None` Required: No ** [Orchestrator](#API_UpdateCluster_RequestSyntax) ** The type of orchestrator used for the SageMaker HyperPod cluster. Type: [ClusterOrchestrator](API_ClusterOrchestrator.md) object Required: No ** [RestrictedInstanceGroups](#API_UpdateCluster_RequestSyntax) ** The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster. Type: Array of [ClusterRestrictedInstanceGroupSpecification](API_ClusterRestrictedInstanceGroupSpecification.md) objects Array Members: Minimum number of 1 item. Maximum number of 100 items. Required: No ** [TieredStorageConfig](#API_UpdateCluster_RequestSyntax) ** Updates the configuration for managed tier checkpointing on the HyperPod cluster. For example, you can enable or disable the feature and modify the percentage of cluster memory allocated for checkpoint storage. Type: [ClusterTieredStorageConfig](API_ClusterTieredStorageConfig.md) object Required: No ## Response Syntax ``` { "ClusterArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ClusterArn](#API_UpdateCluster_ResponseSyntax) ** The Amazon Resource Name (ARN) of the updated SageMaker HyperPod cluster. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateCluster) # UpdateClusterSchedulerConfig Update the cluster policy configuration. ## Request Syntax ``` { "ClusterSchedulerConfigId": "string", "Description": "string", "SchedulerConfig": { "FairShare": "string", "IdleResourceSharing": "string", "PriorityClasses": [ { "Name": "string", "Weight": number } ] }, "TargetVersion": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClusterSchedulerConfigId](#API_UpdateClusterSchedulerConfig_RequestSyntax) ** ID of the cluster policy. Type: String Length Constraints: Minimum length of 0. Maximum length of 12. Pattern: `[a-z0-9]{12}` Required: Yes ** [Description](#API_UpdateClusterSchedulerConfig_RequestSyntax) ** Description of the cluster policy. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*` Required: No ** [SchedulerConfig](#API_UpdateClusterSchedulerConfig_RequestSyntax) ** Cluster policy configuration. Type: [SchedulerConfig](API_SchedulerConfig.md) object Required: No ** [TargetVersion](#API_UpdateClusterSchedulerConfig_RequestSyntax) ** Target version. Type: Integer Required: Yes ## Response Syntax ``` { "ClusterSchedulerConfigArn": "string", "ClusterSchedulerConfigVersion": number } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ClusterSchedulerConfigArn](#API_UpdateClusterSchedulerConfig_ResponseSyntax) ** ARN of the cluster policy. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:cluster-scheduler-config/[a-z0-9]{12}` ** [ClusterSchedulerConfigVersion](#API_UpdateClusterSchedulerConfig_ResponseSyntax) ** Version of the cluster policy. Type: Integer ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateClusterSchedulerConfig) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateClusterSchedulerConfig) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateClusterSchedulerConfig) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateClusterSchedulerConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateClusterSchedulerConfig) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateClusterSchedulerConfig) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateClusterSchedulerConfig) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateClusterSchedulerConfig) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateClusterSchedulerConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateClusterSchedulerConfig) # UpdateClusterSoftware Updates the platform software of a SageMaker HyperPod cluster for security patching. To learn how to use this API, see [Update the SageMaker HyperPod platform software of a cluster](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod-operate.html#sagemaker-hyperpod-operate-cli-command-update-cluster-software). **Important** The `UpgradeClusterSoftware` API call may impact your SageMaker HyperPod cluster uptime and availability. Plan accordingly to mitigate potential disruptions to your workloads. ## Request Syntax ``` { "ClusterName": "string", "DeploymentConfig": { "AutoRollbackConfiguration": [ { "AlarmName": "string" } ], "RollingUpdatePolicy": { "MaximumBatchSize": { "Type": "string", "Value": number }, "RollbackMaximumBatchSize": { "Type": "string", "Value": number } }, "WaitIntervalInSeconds": number }, "ImageId": "string", "InstanceGroups": [ { "InstanceGroupName": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClusterName](#API_UpdateClusterSoftware_RequestSyntax) ** Specify the name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster you want to update for security patching. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})` Required: Yes ** [DeploymentConfig](#API_UpdateClusterSoftware_RequestSyntax) ** The configuration to use when updating the AMI versions. Type: [DeploymentConfiguration](API_DeploymentConfiguration.md) object Required: No ** [ImageId](#API_UpdateClusterSoftware_RequestSyntax) ** When configuring your HyperPod cluster, you can specify an image ID using one of the following options: + `HyperPodPublicAmiId`: Use a HyperPod public AMI + `CustomAmiId`: Use your custom AMI + `default`: Use the default latest system image If you choose to use a custom AMI (`CustomAmiId`), ensure it meets the following requirements: + Encryption: The custom AMI must be unencrypted. + Ownership: The custom AMI must be owned by the same AWS account that is creating the HyperPod cluster. + Volume support: Only the primary AMI snapshot volume is supported; additional AMI volumes are not supported. When updating the instance group's AMI through the `UpdateClusterSoftware` operation, if an instance group uses a custom AMI, you must provide an `ImageId` or use the default as input. Note that if you don't specify an instance group in your `UpdateClusterSoftware` request, then all of the instance groups are patched with the specified image. Type: String Length Constraints: Minimum length of 7. Maximum length of 21. Pattern: `ami-[0-9a-fA-F]{8,17}|default` Required: No ** [InstanceGroups](#API_UpdateClusterSoftware_RequestSyntax) ** The array of instance groups for which to update AMI versions. Type: Array of [UpdateClusterSoftwareInstanceGroupSpecification](API_UpdateClusterSoftwareInstanceGroupSpecification.md) objects Array Members: Minimum number of 1 item. Maximum number of 100 items. Required: No ## Response Syntax ``` { "ClusterArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ClusterArn](#API_UpdateClusterSoftware_ResponseSyntax) ** The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster being updated for security patching. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateClusterSoftware) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateClusterSoftware) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateClusterSoftware) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateClusterSoftware) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateClusterSoftware) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateClusterSoftware) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateClusterSoftware) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateClusterSoftware) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateClusterSoftware) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateClusterSoftware) # UpdateCodeRepository Updates the specified Git repository with the specified values. ## Request Syntax ``` { "CodeRepositoryName": "string", "GitConfig": { "SecretArn": "string" } } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CodeRepositoryName](#API_UpdateCodeRepository_RequestSyntax) ** The name of the Git repository to update. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [GitConfig](#API_UpdateCodeRepository_RequestSyntax) ** 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}` Type: [GitConfigForUpdate](API_GitConfigForUpdate.md) object Required: No ## Response Syntax ``` { "CodeRepositoryArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CodeRepositoryArn](#API_UpdateCodeRepository_ResponseSyntax) ** The ARN of the Git repository. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:code-repository/[\S]{1,2048}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateCodeRepository) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateCodeRepository) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateCodeRepository) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateCodeRepository) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateCodeRepository) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateCodeRepository) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateCodeRepository) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateCodeRepository) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateCodeRepository) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateCodeRepository) # UpdateComputeQuota Update the compute allocation definition. ## Request Syntax ``` { "ActivationState": "string", "ComputeQuotaConfig": { "ComputeQuotaResources": [ { "AcceleratorPartition": { "Count": number, "Type": "string" }, "Accelerators": number, "Count": number, "InstanceType": "string", "MemoryInGiB": number, "VCpu": number } ], "PreemptTeamTasks": "string", "ResourceSharingConfig": { "AbsoluteBorrowLimits": [ { "AcceleratorPartition": { "Count": number, "Type": "string" }, "Accelerators": number, "Count": number, "InstanceType": "string", "MemoryInGiB": number, "VCpu": number } ], "BorrowLimit": number, "Strategy": "string" } }, "ComputeQuotaId": "string", "ComputeQuotaTarget": { "FairShareWeight": number, "TeamName": "string" }, "Description": "string", "TargetVersion": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ActivationState](#API_UpdateComputeQuota_RequestSyntax) ** The state of the compute allocation being described. Use to enable or disable compute allocation. Default is `Enabled`. Type: String Valid Values: `Enabled | Disabled` Required: No ** [ComputeQuotaConfig](#API_UpdateComputeQuota_RequestSyntax) ** Configuration of the compute allocation definition. This includes the resource sharing option, and the setting to preempt low priority tasks. Type: [ComputeQuotaConfig](API_ComputeQuotaConfig.md) object Required: No ** [ComputeQuotaId](#API_UpdateComputeQuota_RequestSyntax) ** ID of the compute allocation definition. Type: String Pattern: `[a-z0-9]{12}` Required: Yes ** [ComputeQuotaTarget](#API_UpdateComputeQuota_RequestSyntax) ** The target entity to allocate compute resources to. Type: [ComputeQuotaTarget](API_ComputeQuotaTarget.md) object Required: No ** [Description](#API_UpdateComputeQuota_RequestSyntax) ** Description of the compute allocation definition. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*` Required: No ** [TargetVersion](#API_UpdateComputeQuota_RequestSyntax) ** Target version. Type: Integer Required: Yes ## Response Syntax ``` { "ComputeQuotaArn": "string", "ComputeQuotaVersion": number } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ComputeQuotaArn](#API_UpdateComputeQuota_ResponseSyntax) ** ARN of the compute allocation definition. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:compute-quota/[a-z0-9]{12}` ** [ComputeQuotaVersion](#API_UpdateComputeQuota_ResponseSyntax) ** Version of the compute allocation definition. Type: Integer ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateComputeQuota) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateComputeQuota) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateComputeQuota) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateComputeQuota) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateComputeQuota) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateComputeQuota) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateComputeQuota) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateComputeQuota) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateComputeQuota) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateComputeQuota) # UpdateContext Updates a context. ## Request Syntax ``` { "ContextName": "string", "Description": "string", "Properties": { "string" : "string" }, "PropertiesToRemove": [ "string" ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ContextName](#API_UpdateContext_RequestSyntax) ** The name of the context to update. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,119}` Required: Yes ** [Description](#API_UpdateContext_RequestSyntax) ** The new description for the context. Type: String Length Constraints: Minimum length of 0. Maximum length of 3072. Pattern: `.*` Required: No ** [Properties](#API_UpdateContext_RequestSyntax) ** The new list of properties. Overwrites the current property list. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 30 items. Key Length Constraints: Minimum length of 0. Maximum length of 2500. Key Pattern: `.*` Value Length Constraints: Minimum length of 0. Maximum length of 2500. Value Pattern: `.*` Required: No ** [PropertiesToRemove](#API_UpdateContext_RequestSyntax) ** A list of properties to remove. Type: Array of strings Length Constraints: Minimum length of 0. Maximum length of 2500. Pattern: `.*` Required: No ## Response Syntax ``` { "ContextArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ContextArn](#API_UpdateContext_ResponseSyntax) ** The Amazon Resource Name (ARN) of the context. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:context/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateContext) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateContext) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateContext) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateContext) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateContext) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateContext) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateContext) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateContext) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateContext) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateContext) # UpdateDeviceFleet Updates a fleet of devices. ## Request Syntax ``` { "Description": "string", "DeviceFleetName": "string", "EnableIotRoleAlias": boolean, "OutputConfig": { "KmsKeyId": "string", "PresetDeploymentConfig": "string", "PresetDeploymentType": "string", "S3OutputLocation": "string" }, "RoleArn": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Description](#API_UpdateDeviceFleet_RequestSyntax) ** Description of the fleet. Type: String Length Constraints: Minimum length of 1. Maximum length of 800. Pattern: `[-a-zA-Z0-9_.,;:! ]*` Required: No ** [DeviceFleetName](#API_UpdateDeviceFleet_RequestSyntax) ** The name of the fleet. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [EnableIotRoleAlias](#API_UpdateDeviceFleet_RequestSyntax) ** Whether to create an AWS IoT Role Alias during device fleet creation. The name of the role alias generated will match this pattern: "SageMakerEdge-\$1DeviceFleetName\$1". For example, if your device fleet is called "demo-fleet", the name of the role alias will be "SageMakerEdge-demo-fleet". Type: Boolean Required: No ** [OutputConfig](#API_UpdateDeviceFleet_RequestSyntax) ** Output configuration for storing sample data collected by the fleet. Type: [EdgeOutputConfig](API_EdgeOutputConfig.md) object Required: Yes ** [RoleArn](#API_UpdateDeviceFleet_RequestSyntax) ** The Amazon Resource Name (ARN) of the device. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` Required: No ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateDeviceFleet) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateDeviceFleet) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateDeviceFleet) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateDeviceFleet) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateDeviceFleet) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateDeviceFleet) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateDeviceFleet) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateDeviceFleet) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateDeviceFleet) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateDeviceFleet) # UpdateDevices Updates one or more devices in a fleet. ## Request Syntax ``` { "DeviceFleetName": "string", "Devices": [ { "Description": "string", "DeviceName": "string", "IotThingName": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DeviceFleetName](#API_UpdateDevices_RequestSyntax) ** The name of the fleet the devices belong to. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [Devices](#API_UpdateDevices_RequestSyntax) ** List of devices to register with Edge Manager agent. Type: Array of [Device](API_Device.md) objects Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateDevices) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateDevices) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateDevices) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateDevices) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateDevices) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateDevices) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateDevices) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateDevices) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateDevices) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateDevices) # UpdateDomain Updates the default settings for new user profiles in the domain. ## Request Syntax ``` { "AppNetworkAccessType": "string", "AppSecurityGroupManagement": "string", "DefaultSpaceSettings": { "CustomFileSystemConfigs": [ { ... } ], "CustomPosixUserConfig": { "Gid": number, "Uid": number }, "ExecutionRole": "string", "JupyterLabAppSettings": { "AppLifecycleManagement": { "IdleSettings": { "IdleTimeoutInMinutes": number, "LifecycleManagement": "string", "MaxIdleTimeoutInMinutes": number, "MinIdleTimeoutInMinutes": number } }, "BuiltInLifecycleConfigArn": "string", "CodeRepositories": [ { "RepositoryUrl": "string" } ], "CustomImages": [ { "AppImageConfigName": "string", "ImageName": "string", "ImageVersionNumber": number } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" }, "EmrSettings": { "AssumableRoleArns": [ "string" ], "ExecutionRoleArns": [ "string" ] }, "LifecycleConfigArns": [ "string" ] }, "JupyterServerAppSettings": { "CodeRepositories": [ { "RepositoryUrl": "string" } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" }, "LifecycleConfigArns": [ "string" ] }, "KernelGatewayAppSettings": { "CustomImages": [ { "AppImageConfigName": "string", "ImageName": "string", "ImageVersionNumber": number } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" }, "LifecycleConfigArns": [ "string" ] }, "SecurityGroups": [ "string" ], "SpaceStorageSettings": { "DefaultEbsStorageSettings": { "DefaultEbsVolumeSizeInGb": number, "MaximumEbsVolumeSizeInGb": number } } }, "DefaultUserSettings": { "AutoMountHomeEFS": "string", "CanvasAppSettings": { "DirectDeploySettings": { "Status": "string" }, "EmrServerlessSettings": { "ExecutionRoleArn": "string", "Status": "string" }, "GenerativeAiSettings": { "AmazonBedrockRoleArn": "string" }, "IdentityProviderOAuthSettings": [ { "DataSourceName": "string", "SecretArn": "string", "Status": "string" } ], "KendraSettings": { "Status": "string" }, "ModelRegisterSettings": { "CrossAccountModelRegisterRoleArn": "string", "Status": "string" }, "TimeSeriesForecastingSettings": { "AmazonForecastRoleArn": "string", "Status": "string" }, "WorkspaceSettings": { "S3ArtifactPath": "string", "S3KmsKeyId": "string" } }, "CodeEditorAppSettings": { "AppLifecycleManagement": { "IdleSettings": { "IdleTimeoutInMinutes": number, "LifecycleManagement": "string", "MaxIdleTimeoutInMinutes": number, "MinIdleTimeoutInMinutes": number } }, "BuiltInLifecycleConfigArn": "string", "CustomImages": [ { "AppImageConfigName": "string", "ImageName": "string", "ImageVersionNumber": number } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" }, "LifecycleConfigArns": [ "string" ] }, "CustomFileSystemConfigs": [ { ... } ], "CustomPosixUserConfig": { "Gid": number, "Uid": number }, "DefaultLandingUri": "string", "ExecutionRole": "string", "JupyterLabAppSettings": { "AppLifecycleManagement": { "IdleSettings": { "IdleTimeoutInMinutes": number, "LifecycleManagement": "string", "MaxIdleTimeoutInMinutes": number, "MinIdleTimeoutInMinutes": number } }, "BuiltInLifecycleConfigArn": "string", "CodeRepositories": [ { "RepositoryUrl": "string" } ], "CustomImages": [ { "AppImageConfigName": "string", "ImageName": "string", "ImageVersionNumber": number } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" }, "EmrSettings": { "AssumableRoleArns": [ "string" ], "ExecutionRoleArns": [ "string" ] }, "LifecycleConfigArns": [ "string" ] }, "JupyterServerAppSettings": { "CodeRepositories": [ { "RepositoryUrl": "string" } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" }, "LifecycleConfigArns": [ "string" ] }, "KernelGatewayAppSettings": { "CustomImages": [ { "AppImageConfigName": "string", "ImageName": "string", "ImageVersionNumber": number } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" }, "LifecycleConfigArns": [ "string" ] }, "RSessionAppSettings": { "CustomImages": [ { "AppImageConfigName": "string", "ImageName": "string", "ImageVersionNumber": number } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" } }, "RStudioServerProAppSettings": { "AccessStatus": "string", "UserGroup": "string" }, "SecurityGroups": [ "string" ], "SharingSettings": { "NotebookOutputOption": "string", "S3KmsKeyId": "string", "S3OutputPath": "string" }, "SpaceStorageSettings": { "DefaultEbsStorageSettings": { "DefaultEbsVolumeSizeInGb": number, "MaximumEbsVolumeSizeInGb": number } }, "StudioWebPortal": "string", "StudioWebPortalSettings": { "HiddenAppTypes": [ "string" ], "HiddenInstanceTypes": [ "string" ], "HiddenMlTools": [ "string" ], "HiddenSageMakerImageVersionAliases": [ { "SageMakerImageName": "string", "VersionAliases": [ "string" ] } ] }, "TensorBoardAppSettings": { "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" } } }, "DomainId": "string", "DomainSettingsForUpdate": { "AmazonQSettings": { "QProfileArn": "string", "Status": "string" }, "DockerSettings": { "EnableDockerAccess": "string", "RootlessDocker": "string", "VpcOnlyTrustedAccounts": [ "string" ] }, "ExecutionRoleIdentityConfig": "string", "IpAddressType": "string", "RStudioServerProDomainSettingsForUpdate": { "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" }, "DomainExecutionRoleArn": "string", "RStudioConnectUrl": "string", "RStudioPackageManagerUrl": "string" }, "SecurityGroupIds": [ "string" ], "TrustedIdentityPropagationSettings": { "Status": "string" }, "UnifiedStudioSettings": { "DomainAccountId": "string", "DomainId": "string", "DomainRegion": "string", "EnvironmentId": "string", "ProjectId": "string", "ProjectS3Path": "string", "SingleSignOnApplicationArn": "string", "StudioWebPortalAccess": "string" } }, "SubnetIds": [ "string" ], "TagPropagation": "string", "VpcId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AppNetworkAccessType](#API_UpdateDomain_RequestSyntax) ** Specifies the VPC used for non-EFS traffic. + `PublicInternetOnly` - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access. + `VpcOnly` - All Studio traffic is through the specified VPC and subnets. This configuration can only be modified if there are no apps in the `InService`, `Pending`, or `Deleting` state. The configuration cannot be updated if `DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn` is already set or `DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn` is provided as part of the same request. Type: String Valid Values: `PublicInternetOnly | VpcOnly` Required: No ** [AppSecurityGroupManagement](#API_UpdateDomain_RequestSyntax) ** The entity that creates and manages the required security groups for inter-app communication in `VPCOnly` mode. Required when `CreateDomain.AppNetworkAccessType` is `VPCOnly` and `DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn` is provided. If setting up the domain for use with RStudio, this value must be set to `Service`. Type: String Valid Values: `Service | Customer` Required: No ** [DefaultSpaceSettings](#API_UpdateDomain_RequestSyntax) ** The default settings for shared spaces that users create in the domain. Type: [DefaultSpaceSettings](API_DefaultSpaceSettings.md) object Required: No ** [DefaultUserSettings](#API_UpdateDomain_RequestSyntax) ** A collection of settings. Type: [UserSettings](API_UserSettings.md) object Required: No ** [DomainId](#API_UpdateDomain_RequestSyntax) ** The ID of the domain to be updated. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `d-(-*[a-z0-9]){1,61}` Required: Yes ** [DomainSettingsForUpdate](#API_UpdateDomain_RequestSyntax) ** A collection of `DomainSettings` configuration values to update. Type: [DomainSettingsForUpdate](API_DomainSettingsForUpdate.md) object Required: No ** [SubnetIds](#API_UpdateDomain_RequestSyntax) ** The VPC subnets that Studio uses for communication. If removing subnets, ensure there are no apps in the `InService`, `Pending`, or `Deleting` state. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 16 items. Length Constraints: Minimum length of 0. Maximum length of 32. Pattern: `[-0-9a-zA-Z]+` Required: No ** [TagPropagation](#API_UpdateDomain_RequestSyntax) ** Indicates whether custom tag propagation is supported for the domain. Defaults to `DISABLED`. Type: String Valid Values: `ENABLED | DISABLED` Required: No ** [VpcId](#API_UpdateDomain_RequestSyntax) ** The identifier for the VPC used by the domain for network communication. Use this field only when adding VPC configuration to a SageMaker AI domain used in Amazon SageMaker Unified Studio that was created without VPC settings. SageMaker AI doesn't automatically apply VPC updates to existing applications. Stop and restart your applications to apply the changes. Type: String Length Constraints: Minimum length of 0. Maximum length of 32. Pattern: `[-0-9a-zA-Z]+` Required: No ## Response Syntax ``` { "DomainArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DomainArn](#API_UpdateDomain_ResponseSyntax) ** The Amazon Resource Name (ARN) of the domain. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:domain/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateDomain) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateDomain) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateDomain) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateDomain) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateDomain) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateDomain) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateDomain) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateDomain) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateDomain) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateDomain) # UpdateEndpoint Deploys the `EndpointConfig` specified in the request to a new fleet of instances. SageMaker shifts endpoint traffic to the new instances with the updated endpoint configuration and then deletes the old instances using the previous `EndpointConfig` (there is no availability loss). For more information about how to control the update and traffic shifting process, see [ Update models in production](https://docs.aws.amazon.com/sagemaker/latest/dg/deployment-guardrails.html). When 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](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html) API. **Note** 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. ## Request Syntax ``` { "DeploymentConfig": { "AutoRollbackConfiguration": { "Alarms": [ { "AlarmName": "string" } ] }, "BlueGreenUpdatePolicy": { "MaximumExecutionTimeoutInSeconds": number, "TerminationWaitInSeconds": number, "TrafficRoutingConfiguration": { "CanarySize": { "Type": "string", "Value": number }, "LinearStepSize": { "Type": "string", "Value": number }, "Type": "string", "WaitIntervalInSeconds": number } }, "RollingUpdatePolicy": { "MaximumBatchSize": { "Type": "string", "Value": number }, "MaximumExecutionTimeoutInSeconds": number, "RollbackMaximumBatchSize": { "Type": "string", "Value": number }, "WaitIntervalInSeconds": number } }, "EndpointConfigName": "string", "EndpointName": "string", "ExcludeRetainedVariantProperties": [ { "VariantPropertyType": "string" } ], "RetainAllVariantProperties": boolean, "RetainDeploymentConfig": boolean } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DeploymentConfig](#API_UpdateEndpoint_RequestSyntax) ** The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations. Type: [DeploymentConfig](API_DeploymentConfig.md) object Required: No ** [EndpointConfigName](#API_UpdateEndpoint_RequestSyntax) ** The name of the new endpoint configuration. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [EndpointName](#API_UpdateEndpoint_RequestSyntax) ** The name of the endpoint whose configuration you want to update. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [ExcludeRetainedVariantProperties](#API_UpdateEndpoint_RequestSyntax) ** When you are updating endpoint resources with `RetainAllVariantProperties`, whose value is set to `true`, `ExcludeRetainedVariantProperties` specifies the list of type [VariantProperty](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VariantProperty.html) to override with the values provided by `EndpointConfig`. If you don't specify a value for `ExcludeRetainedVariantProperties`, no variant properties are overridden. Type: Array of [VariantProperty](API_VariantProperty.md) objects Array Members: Minimum number of 0 items. Maximum number of 3 items. Required: No ** [RetainAllVariantProperties](#API_UpdateEndpoint_RequestSyntax) ** When updating endpoint resources, enables or disables the retention of [variant properties](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VariantProperty.html), 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`. Type: Boolean Required: No ** [RetainDeploymentConfig](#API_UpdateEndpoint_RequestSyntax) ** Specifies whether to reuse the last deployment configuration. The default value is false (the configuration is not reused). Type: Boolean Required: No ## Response Syntax ``` { "EndpointArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [EndpointArn](#API_UpdateEndpoint_ResponseSyntax) ** The Amazon Resource Name (ARN) of the endpoint. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:endpoint/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateEndpoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateEndpoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateEndpoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateEndpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateEndpoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateEndpoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateEndpoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateEndpoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateEndpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateEndpoint) # UpdateEndpointWeightsAndCapacities Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint. When it receives the request, SageMaker sets the endpoint status to `Updating`. After updating the endpoint, it sets the status to `InService`. To check the status of an endpoint, use the [DescribeEndpoint](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html) API. ## Request Syntax ``` { "DesiredWeightsAndCapacities": [ { "DesiredInstanceCount": number, "DesiredWeight": number, "ServerlessUpdateConfig": { "MaxConcurrency": number, "ProvisionedConcurrency": number }, "VariantName": "string" } ], "EndpointName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DesiredWeightsAndCapacities](#API_UpdateEndpointWeightsAndCapacities_RequestSyntax) ** An object that provides new capacity and weight values for a variant. Type: Array of [DesiredWeightAndCapacity](API_DesiredWeightAndCapacity.md) objects Array Members: Minimum number of 1 item. Required: Yes ** [EndpointName](#API_UpdateEndpointWeightsAndCapacities_RequestSyntax) ** The name of an existing SageMaker endpoint. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "EndpointArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [EndpointArn](#API_UpdateEndpointWeightsAndCapacities_ResponseSyntax) ** The Amazon Resource Name (ARN) of the updated endpoint. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:endpoint/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateEndpointWeightsAndCapacities) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateEndpointWeightsAndCapacities) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateEndpointWeightsAndCapacities) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateEndpointWeightsAndCapacities) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateEndpointWeightsAndCapacities) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateEndpointWeightsAndCapacities) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateEndpointWeightsAndCapacities) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateEndpointWeightsAndCapacities) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateEndpointWeightsAndCapacities) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateEndpointWeightsAndCapacities) # UpdateExperiment Adds, updates, or removes the description of an experiment. Updates the display name of an experiment. ## Request Syntax ``` { "Description": "string", "DisplayName": "string", "ExperimentName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Description](#API_UpdateExperiment_RequestSyntax) ** The description of the experiment. Type: String Length Constraints: Minimum length of 0. Maximum length of 3072. Pattern: `.*` Required: No ** [DisplayName](#API_UpdateExperiment_RequestSyntax) ** The name of the experiment as displayed. The name doesn't need to be unique. If `DisplayName` isn't specified, `ExperimentName` is displayed. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` Required: No ** [ExperimentName](#API_UpdateExperiment_RequestSyntax) ** The name of the experiment to update. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` Required: Yes ## Response Syntax ``` { "ExperimentArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ExperimentArn](#API_UpdateExperiment_ResponseSyntax) ** The Amazon Resource Name (ARN) of the experiment. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:experiment/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateExperiment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateExperiment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateExperiment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateExperiment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateExperiment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateExperiment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateExperiment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateExperiment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateExperiment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateExperiment) # UpdateFeatureGroup Updates the feature group by either adding features or updating the online store configuration. Use one of the following request parameters at a time while using the `UpdateFeatureGroup` API. You can add features for your feature group using the `FeatureAdditions` request parameter. Features cannot be removed from a feature group. You can update the online store configuration by using the `OnlineStoreConfig` request parameter. If a `TtlDuration` is specified, the default `TtlDuration` applies for all records added to the feature group *after the feature group is updated*. If a record level `TtlDuration` exists from using the `PutRecord` API, the record level `TtlDuration` applies to that record instead of the default `TtlDuration`. To remove the default `TtlDuration` from an existing feature group, use the `UpdateFeatureGroup` API and set the `TtlDuration` `Unit` and `Value` to `null`. ## Request Syntax ``` { "FeatureAdditions": [ { "CollectionConfig": { ... }, "CollectionType": "string", "FeatureName": "string", "FeatureType": "string" } ], "FeatureGroupName": "string", "OnlineStoreConfig": { "TtlDuration": { "Unit": "string", "Value": number } }, "ThroughputConfig": { "ProvisionedReadCapacityUnits": number, "ProvisionedWriteCapacityUnits": number, "ThroughputMode": "string" } } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [FeatureAdditions](#API_UpdateFeatureGroup_RequestSyntax) ** Updates the feature group. Updating a feature group is an asynchronous operation. When you get an HTTP 200 response, you've made a valid request. It takes some time after you've made a valid request for Feature Store to update the feature group. Type: Array of [FeatureDefinition](API_FeatureDefinition.md) objects Array Members: Minimum number of 1 item. Maximum number of 100 items. Required: No ** [FeatureGroupName](#API_UpdateFeatureGroup_RequestSyntax) ** The name or Amazon Resource Name (ARN) of the feature group that you're updating. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:feature-group\/)?([a-zA-Z0-9]([_-]*[a-zA-Z0-9]){0,63})` Required: Yes ** [OnlineStoreConfig](#API_UpdateFeatureGroup_RequestSyntax) ** Updates the feature group online store configuration. Type: [OnlineStoreConfigUpdate](API_OnlineStoreConfigUpdate.md) object Required: No ** [ThroughputConfig](#API_UpdateFeatureGroup_RequestSyntax) ** The new throughput configuration for the feature group. You can switch between on-demand and provisioned modes or update the read / write capacity of provisioned feature groups. You can switch a feature group to on-demand only once in a 24 hour period. Type: [ThroughputConfigUpdate](API_ThroughputConfigUpdate.md) object Required: No ## Response Syntax ``` { "FeatureGroupArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [FeatureGroupArn](#API_UpdateFeatureGroup_ResponseSyntax) ** The Amazon Resource Number (ARN) of the feature group that you're updating. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:feature-group/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateFeatureGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateFeatureGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateFeatureGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateFeatureGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateFeatureGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateFeatureGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateFeatureGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateFeatureGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateFeatureGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateFeatureGroup) # UpdateFeatureMetadata Updates the description and parameters of the feature group. ## Request Syntax ``` { "Description": "string", "FeatureGroupName": "string", "FeatureName": "string", "ParameterAdditions": [ { "Key": "string", "Value": "string" } ], "ParameterRemovals": [ "string" ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Description](#API_UpdateFeatureMetadata_RequestSyntax) ** A description that you can write to better describe the feature. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: `.*` Required: No ** [FeatureGroupName](#API_UpdateFeatureMetadata_RequestSyntax) ** The name or Amazon Resource Name (ARN) of the feature group containing the feature that you're updating. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:feature-group\/)?([a-zA-Z0-9]([_-]*[a-zA-Z0-9]){0,63})` Required: Yes ** [FeatureName](#API_UpdateFeatureMetadata_RequestSyntax) ** The name of the feature that you're updating. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63}` Required: Yes ** [ParameterAdditions](#API_UpdateFeatureMetadata_RequestSyntax) ** A list of key-value pairs that you can add to better describe the feature. Type: Array of [FeatureParameter](API_FeatureParameter.md) objects Array Members: Minimum number of 0 items. Maximum number of 25 items. Required: No ** [ParameterRemovals](#API_UpdateFeatureMetadata_RequestSyntax) ** A list of parameter keys that you can specify to remove parameters that describe your feature. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 25 items. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-]*)` Required: No ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateFeatureMetadata) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateFeatureMetadata) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateFeatureMetadata) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateFeatureMetadata) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateFeatureMetadata) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateFeatureMetadata) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateFeatureMetadata) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateFeatureMetadata) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateFeatureMetadata) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateFeatureMetadata) # UpdateHub Update a hub. ## Request Syntax ``` { "HubDescription": "string", "HubDisplayName": "string", "HubName": "string", "HubSearchKeywords": [ "string" ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [HubDescription](#API_UpdateHub_RequestSyntax) ** A description of the updated hub. Type: String Length Constraints: Minimum length of 0. Maximum length of 1023. Pattern: `.*` Required: No ** [HubDisplayName](#API_UpdateHub_RequestSyntax) ** The display name of the hub. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: `.*` Required: No ** [HubName](#API_UpdateHub_RequestSyntax) ** The name of the hub to update. Type: String Pattern: `(arn:[a-z0-9-\.]{1,63}:sagemaker:\w+(?:-\w+)+:(\d{12}|aws):hub\/)?[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [HubSearchKeywords](#API_UpdateHub_RequestSyntax) ** The searchable keywords for the hub. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 50 items. Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: `[^A-Z]*` Required: No ## Response Syntax ``` { "HubArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [HubArn](#API_UpdateHub_ResponseSyntax) ** The Amazon Resource Name (ARN) of the updated hub. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateHub) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateHub) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateHub) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateHub) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateHub) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateHub) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateHub) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateHub) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateHub) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateHub) # UpdateHubContent Updates SageMaker hub content (either a `Model` or `Notebook` resource). You can update the metadata that describes the resource. In addition to the required request fields, specify at least one of the following fields to update: + `HubContentDescription` + `HubContentDisplayName` + `HubContentMarkdown` + `HubContentSearchKeywords` + `SupportStatus` For more information about hubs, see [Private curated hubs for foundation model access control in JumpStart](https://docs.aws.amazon.com/sagemaker/latest/dg/jumpstart-curated-hubs.html). **Note** If you want to update a `ModelReference` resource in your hub, use the `UpdateHubContentResource` API instead. ## Request Syntax ``` { "HubContentDescription": "string", "HubContentDisplayName": "string", "HubContentMarkdown": "string", "HubContentName": "string", "HubContentSearchKeywords": [ "string" ], "HubContentType": "string", "HubContentVersion": "string", "HubName": "string", "SupportStatus": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [HubContentDescription](#API_UpdateHubContent_RequestSyntax) ** The description of the hub content. Type: String Length Constraints: Minimum length of 0. Maximum length of 1023. Pattern: `.*` Required: No ** [HubContentDisplayName](#API_UpdateHubContent_RequestSyntax) ** The display name of the hub content. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: `.*` Required: No ** [HubContentMarkdown](#API_UpdateHubContent_RequestSyntax) ** A string that provides a description of the hub content. This string can include links, tables, and standard markdown formatting. Type: String Length Constraints: Minimum length of 0. Maximum length of 170391. Required: No ** [HubContentName](#API_UpdateHubContent_RequestSyntax) ** The name of the hub content resource that you want to update. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [HubContentSearchKeywords](#API_UpdateHubContent_RequestSyntax) ** The searchable keywords of the hub content. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 50 items. Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: `.*` Required: No ** [HubContentType](#API_UpdateHubContent_RequestSyntax) ** The content type of the resource that you want to update. Only specify a `Model` or `Notebook` resource for this API. To update a `ModelReference`, use the `UpdateHubContentReference` API instead. Type: String Valid Values: `Model | Notebook | ModelReference | DataSet | JsonDoc` Required: Yes ** [HubContentVersion](#API_UpdateHubContent_RequestSyntax) ** The hub content version that you want to update. For example, if you have two versions of a resource in your hub, you can update the second version. Type: String Length Constraints: Minimum length of 5. Maximum length of 14. Pattern: `\d{1,4}.\d{1,4}.\d{1,4}` Required: Yes ** [HubName](#API_UpdateHubContent_RequestSyntax) ** The name of the SageMaker hub that contains the hub content you want to update. You can optionally use the hub ARN instead. Type: String Pattern: `(arn:[a-z0-9-\.]{1,63}:sagemaker:\w+(?:-\w+)+:(\d{12}|aws):hub\/)?[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [SupportStatus](#API_UpdateHubContent_RequestSyntax) ** Indicates the current status of the hub content resource. Type: String Valid Values: `Supported | Deprecated | Restricted` Required: No ## Response Syntax ``` { "HubArn": "string", "HubContentArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [HubArn](#API_UpdateHubContent_ResponseSyntax) ** The ARN of the private model hub that contains the updated hub content. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: `.*` ** [HubContentArn](#API_UpdateHubContent_ResponseSyntax) ** The ARN of the hub content resource that was updated. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateHubContent) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateHubContent) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateHubContent) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateHubContent) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateHubContent) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateHubContent) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateHubContent) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateHubContent) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateHubContent) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateHubContent) # UpdateHubContentReference Updates the contents of a SageMaker hub for a `ModelReference` resource. A `ModelReference` allows you to access public SageMaker JumpStart models from within your private hub. When using this API, you can update the `MinVersion` field for additional flexibility in the model version. You shouldn't update any additional fields when using this API, because the metadata in your private hub should match the public JumpStart model's metadata. **Note** If you want to update a `Model` or `Notebook` resource in your hub, use the `UpdateHubContent` API instead. For more information about adding model references to your hub, see [ Add models to a private hub](https://docs.aws.amazon.com/sagemaker/latest/dg/jumpstart-curated-hubs-admin-guide-add-models.html). ## Request Syntax ``` { "HubContentName": "string", "HubContentType": "string", "HubName": "string", "MinVersion": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [HubContentName](#API_UpdateHubContentReference_RequestSyntax) ** The name of the hub content resource that you want to update. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [HubContentType](#API_UpdateHubContentReference_RequestSyntax) ** The content type of the resource that you want to update. Only specify a `ModelReference` resource for this API. To update a `Model` or `Notebook` resource, use the `UpdateHubContent` API instead. Type: String Valid Values: `Model | Notebook | ModelReference | DataSet | JsonDoc` Required: Yes ** [HubName](#API_UpdateHubContentReference_RequestSyntax) ** The name of the SageMaker hub that contains the hub content you want to update. You can optionally use the hub ARN instead. Type: String Pattern: `(arn:[a-z0-9-\.]{1,63}:sagemaker:\w+(?:-\w+)+:(\d{12}|aws):hub\/)?[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [MinVersion](#API_UpdateHubContentReference_RequestSyntax) ** The minimum hub content version of the referenced model that you want to use. The minimum version must be older than the latest available version of the referenced model. To support all versions of a model, set the value to `1.0.0`. Type: String Length Constraints: Minimum length of 5. Maximum length of 14. Pattern: `\d{1,4}.\d{1,4}.\d{1,4}` Required: No ## Response Syntax ``` { "HubArn": "string", "HubContentArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [HubArn](#API_UpdateHubContentReference_ResponseSyntax) ** The ARN of the private model hub that contains the updated hub content. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: `.*` ** [HubContentArn](#API_UpdateHubContentReference_ResponseSyntax) ** The ARN of the hub content resource that was updated. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateHubContentReference) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateHubContentReference) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateHubContentReference) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateHubContentReference) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateHubContentReference) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateHubContentReference) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateHubContentReference) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateHubContentReference) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateHubContentReference) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateHubContentReference) # UpdateImage Updates the properties of a SageMaker AI image. To change the image's tags, use the [AddTags](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html) and [DeleteTags](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteTags.html) APIs. ## Request Syntax ``` { "DeleteProperties": [ "string" ], "Description": "string", "DisplayName": "string", "ImageName": "string", "RoleArn": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DeleteProperties](#API_UpdateImage_RequestSyntax) ** A list of properties to delete. Only the `Description` and `DisplayName` properties can be deleted. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 2 items. Length Constraints: Minimum length of 1. Maximum length of 11. Pattern: `(^DisplayName$)|(^Description$)` Required: No ** [Description](#API_UpdateImage_RequestSyntax) ** The new description for the image. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Pattern: `.*` Required: No ** [DisplayName](#API_UpdateImage_RequestSyntax) ** The new display name for the image. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `\S(.*\S)?` Required: No ** [ImageName](#API_UpdateImage_RequestSyntax) ** The name of the image to update. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}` Required: Yes ** [RoleArn](#API_UpdateImage_RequestSyntax) ** The new ARN for the IAM role that enables Amazon SageMaker AI to perform tasks on your behalf. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` Required: No ## Response Syntax ``` { "ImageArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ImageArn](#API_UpdateImage_ResponseSyntax) ** The ARN of the image. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-zA-Z0-9]([-.]?[a-zA-Z0-9])*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateImage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateImage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateImage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateImage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateImage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateImage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateImage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateImage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateImage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateImage) # UpdateImageVersion Updates the properties of a SageMaker AI image version. ## Request Syntax ``` { "Alias": "string", "AliasesToAdd": [ "string" ], "AliasesToDelete": [ "string" ], "Horovod": boolean, "ImageName": "string", "JobType": "string", "MLFramework": "string", "Processor": "string", "ProgrammingLang": "string", "ReleaseNotes": "string", "VendorGuidance": "string", "Version": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Alias](#API_UpdateImageVersion_RequestSyntax) ** The alias of the image version. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `(?!^[.-])^([a-zA-Z0-9-_.]+)` Required: No ** [AliasesToAdd](#API_UpdateImageVersion_RequestSyntax) ** A list of aliases to add. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `(?!^[.-])^([a-zA-Z0-9-_.]+)` Required: No ** [AliasesToDelete](#API_UpdateImageVersion_RequestSyntax) ** A list of aliases to delete. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `(?!^[.-])^([a-zA-Z0-9-_.]+)` Required: No ** [Horovod](#API_UpdateImageVersion_RequestSyntax) ** Indicates Horovod compatibility. Type: Boolean Required: No ** [ImageName](#API_UpdateImageVersion_RequestSyntax) ** The name of the image. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}` Required: Yes ** [JobType](#API_UpdateImageVersion_RequestSyntax) ** Indicates SageMaker AI job type compatibility. + `TRAINING`: The image version is compatible with SageMaker AI training jobs. + `INFERENCE`: The image version is compatible with SageMaker AI inference jobs. + `NOTEBOOK_KERNEL`: The image version is compatible with SageMaker AI notebook kernels. Type: String Valid Values: `TRAINING | INFERENCE | NOTEBOOK_KERNEL` Required: No ** [MLFramework](#API_UpdateImageVersion_RequestSyntax) ** The machine learning framework vended in the image version. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z]+ ?\d+\.\d+(\.\d+)?` Required: No ** [Processor](#API_UpdateImageVersion_RequestSyntax) ** Indicates CPU or GPU compatibility. + `CPU`: The image version is compatible with CPU. + `GPU`: The image version is compatible with GPU. Type: String Valid Values: `CPU | GPU` Required: No ** [ProgrammingLang](#API_UpdateImageVersion_RequestSyntax) ** The supported programming language and its version. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z]+ ?\d+\.\d+(\.\d+)?` Required: No ** [ReleaseNotes](#API_UpdateImageVersion_RequestSyntax) ** The maintainer description of the image version. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `.*` Required: No ** [VendorGuidance](#API_UpdateImageVersion_RequestSyntax) ** The availability of the image version specified by the maintainer. + `NOT_PROVIDED`: The maintainers did not provide a status for image version stability. + `STABLE`: The image version is stable. + `TO_BE_ARCHIVED`: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months. + `ARCHIVED`: The image version is archived. Archived image versions are not searchable and are no longer actively supported. Type: String Valid Values: `NOT_PROVIDED | STABLE | TO_BE_ARCHIVED | ARCHIVED` Required: No ** [Version](#API_UpdateImageVersion_RequestSyntax) ** The version of the image. Type: Integer Valid Range: Minimum value of 0. Required: No ## Response Syntax ``` { "ImageVersionArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ImageVersionArn](#API_UpdateImageVersion_ResponseSyntax) ** The ARN of the image version. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `(arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+|None)` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateImageVersion) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateImageVersion) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateImageVersion) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateImageVersion) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateImageVersion) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateImageVersion) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateImageVersion) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateImageVersion) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateImageVersion) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateImageVersion) # UpdateInferenceComponent Updates an inference component. ## Request Syntax ``` { "DeploymentConfig": { "AutoRollbackConfiguration": { "Alarms": [ { "AlarmName": "string" } ] }, "RollingUpdatePolicy": { "MaximumBatchSize": { "Type": "string", "Value": number }, "MaximumExecutionTimeoutInSeconds": number, "RollbackMaximumBatchSize": { "Type": "string", "Value": number }, "WaitIntervalInSeconds": number } }, "InferenceComponentName": "string", "RuntimeConfig": { "CopyCount": number }, "Specification": { "BaseInferenceComponentName": "string", "ComputeResourceRequirements": { "MaxMemoryRequiredInMb": number, "MinMemoryRequiredInMb": number, "NumberOfAcceleratorDevicesRequired": number, "NumberOfCpuCoresRequired": number }, "Container": { "ArtifactUrl": "string", "Environment": { "string" : "string" }, "Image": "string" }, "DataCacheConfig": { "EnableCaching": boolean }, "ModelName": "string", "SchedulingConfig": { "AvailabilityZoneBalance": { "EnforcementMode": "string", "MaxImbalance": number }, "PlacementStrategy": "string" }, "StartupParameters": { "ContainerStartupHealthCheckTimeoutInSeconds": number, "ModelDataDownloadTimeoutInSeconds": number } } } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DeploymentConfig](#API_UpdateInferenceComponent_RequestSyntax) ** The deployment configuration for the inference component. The configuration contains the desired deployment strategy and rollback settings. Type: [InferenceComponentDeploymentConfig](API_InferenceComponentDeploymentConfig.md) object Required: No ** [InferenceComponentName](#API_UpdateInferenceComponent_RequestSyntax) ** The name of the inference component. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9]([\-a-zA-Z0-9]*[a-zA-Z0-9])?` Required: Yes ** [RuntimeConfig](#API_UpdateInferenceComponent_RequestSyntax) ** Runtime settings for a model that is deployed with an inference component. Type: [InferenceComponentRuntimeConfig](API_InferenceComponentRuntimeConfig.md) object Required: No ** [Specification](#API_UpdateInferenceComponent_RequestSyntax) ** Details about the resources to deploy with this inference component, including the model, container, and compute resources. Type: [InferenceComponentSpecification](API_InferenceComponentSpecification.md) object Required: No ## Response Syntax ``` { "InferenceComponentArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [InferenceComponentArn](#API_UpdateInferenceComponent_ResponseSyntax) ** The Amazon Resource Name (ARN) of the inference component. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateInferenceComponent) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateInferenceComponent) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateInferenceComponent) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateInferenceComponent) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateInferenceComponent) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateInferenceComponent) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateInferenceComponent) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateInferenceComponent) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateInferenceComponent) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateInferenceComponent) # UpdateInferenceComponentRuntimeConfig Runtime settings for a model that is deployed with an inference component. ## Request Syntax ``` { "DesiredRuntimeConfig": { "CopyCount": number }, "InferenceComponentName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DesiredRuntimeConfig](#API_UpdateInferenceComponentRuntimeConfig_RequestSyntax) ** Runtime settings for a model that is deployed with an inference component. Type: [InferenceComponentRuntimeConfig](API_InferenceComponentRuntimeConfig.md) object Required: Yes ** [InferenceComponentName](#API_UpdateInferenceComponentRuntimeConfig_RequestSyntax) ** The name of the inference component to update. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9]([\-a-zA-Z0-9]*[a-zA-Z0-9])?` Required: Yes ## Response Syntax ``` { "InferenceComponentArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [InferenceComponentArn](#API_UpdateInferenceComponentRuntimeConfig_ResponseSyntax) ** The Amazon Resource Name (ARN) of the inference component. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateInferenceComponentRuntimeConfig) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateInferenceComponentRuntimeConfig) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateInferenceComponentRuntimeConfig) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateInferenceComponentRuntimeConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateInferenceComponentRuntimeConfig) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateInferenceComponentRuntimeConfig) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateInferenceComponentRuntimeConfig) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateInferenceComponentRuntimeConfig) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateInferenceComponentRuntimeConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateInferenceComponentRuntimeConfig) # UpdateInferenceExperiment Updates an inference experiment that you created. The status of the inference experiment has to be either `Created`, `Running`. For more information on the status of an inference experiment, see [DescribeInferenceExperiment](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeInferenceExperiment.html). ## Request Syntax ``` { "DataStorageConfig": { "ContentType": { "CsvContentTypes": [ "string" ], "JsonContentTypes": [ "string" ] }, "Destination": "string", "KmsKey": "string" }, "Description": "string", "ModelVariants": [ { "InfrastructureConfig": { "InfrastructureType": "string", "RealTimeInferenceConfig": { "InstanceCount": number, "InstanceType": "string" } }, "ModelName": "string", "VariantName": "string" } ], "Name": "string", "Schedule": { "EndTime": number, "StartTime": number }, "ShadowModeConfig": { "ShadowModelVariants": [ { "SamplingPercentage": number, "ShadowModelVariantName": "string" } ], "SourceModelVariantName": "string" } } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DataStorageConfig](#API_UpdateInferenceExperiment_RequestSyntax) ** The Amazon S3 location and configuration for storing inference request and response data. Type: [InferenceExperimentDataStorageConfig](API_InferenceExperimentDataStorageConfig.md) object Required: No ** [Description](#API_UpdateInferenceExperiment_RequestSyntax) ** The description of the inference experiment. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `.*` Required: No ** [ModelVariants](#API_UpdateInferenceExperiment_RequestSyntax) ** An array of `ModelVariantConfig` objects. There is one for each variant, whose infrastructure configuration you want to update. Type: Array of [ModelVariantConfig](API_ModelVariantConfig.md) objects Array Members: Minimum number of 1 item. Maximum number of 2 items. Required: No ** [Name](#API_UpdateInferenceExperiment_RequestSyntax) ** The name of the inference experiment to be updated. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` Required: Yes ** [Schedule](#API_UpdateInferenceExperiment_RequestSyntax) ** The duration for which the inference experiment will run. If the status of the inference experiment is `Created`, then you can update both the start and end dates. If the status of the inference experiment is `Running`, then you can update only the end date. Type: [InferenceExperimentSchedule](API_InferenceExperimentSchedule.md) object Required: No ** [ShadowModeConfig](#API_UpdateInferenceExperiment_RequestSyntax) ** The configuration of `ShadowMode` inference experiment type. Use this field to specify a production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant also specify the percentage of requests that Amazon SageMaker replicates. Type: [ShadowModeConfig](API_ShadowModeConfig.md) object Required: No ## Response Syntax ``` { "InferenceExperimentArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [InferenceExperimentArn](#API_UpdateInferenceExperiment_ResponseSyntax) ** The ARN of the updated inference experiment. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:inference-experiment/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateInferenceExperiment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateInferenceExperiment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateInferenceExperiment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateInferenceExperiment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateInferenceExperiment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateInferenceExperiment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateInferenceExperiment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateInferenceExperiment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateInferenceExperiment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateInferenceExperiment) # UpdateMlflowApp Updates an MLflow App. ## Request Syntax ``` { "AccountDefaultStatus": "string", "Arn": "string", "ArtifactStoreUri": "string", "DefaultDomainIdList": [ "string" ], "ModelRegistrationMode": "string", "Name": "string", "WeeklyMaintenanceWindowStart": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AccountDefaultStatus](#API_UpdateMlflowApp_RequestSyntax) ** Indicates whether this this MLflow App is the default for the account. Type: String Valid Values: `ENABLED | DISABLED` Required: No ** [Arn](#API_UpdateMlflowApp_RequestSyntax) ** The ARN of the MLflow App to update. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:mlflow-app/.*` Required: Yes ** [ArtifactStoreUri](#API_UpdateMlflowApp_RequestSyntax) ** The new S3 URI for the general purpose bucket to use as the artifact store for the MLflow App. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `(https|s3)://([^/]+)/?(.*)` Required: No ** [DefaultDomainIdList](#API_UpdateMlflowApp_RequestSyntax) ** List of SageMaker Domain IDs for which this MLflow App is the default. Type: Array of strings Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `d-(-*[a-z0-9]){1,61}` Required: No ** [ModelRegistrationMode](#API_UpdateMlflowApp_RequestSyntax) ** Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to `AutoModelRegistrationEnabled`. To disable automatic model registration, set this value to `AutoModelRegistrationDisabled`. If not specified, `AutomaticModelRegistration` defaults to `AutoModelRegistrationEnabled` Type: String Valid Values: `AutoModelRegistrationEnabled | AutoModelRegistrationDisabled` Required: No ** [Name](#API_UpdateMlflowApp_RequestSyntax) ** The name of the MLflow App to update. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}` Required: No ** [WeeklyMaintenanceWindowStart](#API_UpdateMlflowApp_RequestSyntax) ** The new weekly maintenance window start day and time to update. The maintenance window day and time should be in Coordinated Universal Time (UTC) 24-hour standard time. For example: TUE:03:30. Type: String Length Constraints: Minimum length of 0. Maximum length of 9. Pattern: `(Mon|Tue|Wed|Thu|Fri|Sat|Sun):([01]\d|2[0-3]):([0-5]\d)` Required: No ## Response Syntax ``` { "Arn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Arn](#API_UpdateMlflowApp_ResponseSyntax) ** The ARN of the updated MLflow App. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:mlflow-app/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateMlflowApp) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateMlflowApp) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateMlflowApp) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateMlflowApp) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateMlflowApp) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateMlflowApp) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateMlflowApp) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateMlflowApp) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateMlflowApp) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateMlflowApp) # UpdateMlflowTrackingServer Updates properties of an existing MLflow Tracking Server. ## Request Syntax ``` { "ArtifactStoreUri": "string", "AutomaticModelRegistration": boolean, "S3BucketOwnerAccountId": "string", "S3BucketOwnerVerification": boolean, "TrackingServerName": "string", "TrackingServerSize": "string", "WeeklyMaintenanceWindowStart": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ArtifactStoreUri](#API_UpdateMlflowTrackingServer_RequestSyntax) ** The new S3 URI for the general purpose bucket to use as the artifact store for the MLflow Tracking Server. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `(https|s3)://([^/]+)/?(.*)` Required: No ** [AutomaticModelRegistration](#API_UpdateMlflowTrackingServer_RequestSyntax) ** Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to `True`. To disable automatic model registration, set this value to `False`. If not specified, `AutomaticModelRegistration` defaults to `False` Type: Boolean Required: No ** [S3BucketOwnerAccountId](#API_UpdateMlflowTrackingServer_RequestSyntax) ** The new expected AWS account ID that owns the Amazon S3 bucket for artifact storage. Type: String Length Constraints: Fixed length of 12. Pattern: `\d+` Required: No ** [S3BucketOwnerVerification](#API_UpdateMlflowTrackingServer_RequestSyntax) ** Whether to enable or disable Amazon S3 Bucket Owenrship Verifaction whenever the MLflow Tracking Server interacts with Amazon Amazon S3. Type: Boolean Required: No ** [TrackingServerName](#API_UpdateMlflowTrackingServer_RequestSyntax) ** The name of the MLflow Tracking Server to update. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}` Required: Yes ** [TrackingServerSize](#API_UpdateMlflowTrackingServer_RequestSyntax) ** The new size for the MLflow Tracking Server. Type: String Valid Values: `Small | Medium | Large` Required: No ** [WeeklyMaintenanceWindowStart](#API_UpdateMlflowTrackingServer_RequestSyntax) ** The new weekly maintenance window start day and time to update. The maintenance window day and time should be in Coordinated Universal Time (UTC) 24-hour standard time. For example: TUE:03:30. Type: String Length Constraints: Minimum length of 0. Maximum length of 9. Pattern: `(Mon|Tue|Wed|Thu|Fri|Sat|Sun):([01]\d|2[0-3]):([0-5]\d)` Required: No ## Response Syntax ``` { "TrackingServerArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [TrackingServerArn](#API_UpdateMlflowTrackingServer_ResponseSyntax) ** The ARN of the updated MLflow Tracking Server. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:mlflow-tracking-server/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateMlflowTrackingServer) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateMlflowTrackingServer) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateMlflowTrackingServer) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateMlflowTrackingServer) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateMlflowTrackingServer) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateMlflowTrackingServer) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateMlflowTrackingServer) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateMlflowTrackingServer) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateMlflowTrackingServer) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateMlflowTrackingServer) # UpdateModelCard Update an Amazon SageMaker Model Card. **Important** You cannot update both model card content and model card status in a single call. ## Request Syntax ``` { "Content": "string", "ModelCardName": "string", "ModelCardStatus": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Content](#API_UpdateModelCard_RequestSyntax) ** The updated model card content. Content must be in [model card JSON schema](https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema) and provided as a string. When updating model card content, be sure to include the full content and not just updated content. Type: String Length Constraints: Minimum length of 0. Maximum length of 100000. Pattern: `.*` Required: No ** [ModelCardName](#API_UpdateModelCard_RequestSyntax) ** The name or Amazon Resource Name (ARN) of the model card to update. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:model-card/.*)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})` Required: Yes ** [ModelCardStatus](#API_UpdateModelCard_RequestSyntax) ** The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval. + `Draft`: The model card is a work in progress. + `PendingReview`: The model card is pending review. + `Approved`: The model card is approved. + `Archived`: The model card is archived. No more updates should be made to the model card, but it can still be exported. Type: String Valid Values: `Draft | PendingReview | Approved | Archived` Required: No ## Response Syntax ``` { "ModelCardArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ModelCardArn](#API_UpdateModelCard_ResponseSyntax) ** The Amazon Resource Name (ARN) of the updated model card. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateModelCard) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateModelCard) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateModelCard) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateModelCard) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateModelCard) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateModelCard) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateModelCard) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateModelCard) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateModelCard) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateModelCard) # UpdateModelPackage Updates a versioned model. ## Request Syntax ``` { "AdditionalInferenceSpecificationsToAdd": [ { "Containers": [ { "AdditionalS3DataSource": { "CompressionType": "string", "ETag": "string", "S3DataType": "string", "S3Uri": "string" }, "BaseModel": { "HubContentName": "string", "HubContentVersion": "string", "RecipeName": "string" }, "ContainerHostname": "string", "Environment": { "string" : "string" }, "Framework": "string", "FrameworkVersion": "string", "Image": "string", "ImageDigest": "string", "IsCheckpoint": boolean, "ModelDataETag": "string", "ModelDataSource": { "S3DataSource": { "CompressionType": "string", "ETag": "string", "HubAccessConfig": { "HubContentArn": "string" }, "ManifestEtag": "string", "ManifestS3Uri": "string", "ModelAccessConfig": { "AcceptEula": boolean }, "S3DataType": "string", "S3Uri": "string" } }, "ModelDataUrl": "string", "ModelInput": { "DataInputConfig": "string" }, "NearestModelName": "string", "ProductId": "string" } ], "Description": "string", "Name": "string", "SupportedContentTypes": [ "string" ], "SupportedRealtimeInferenceInstanceTypes": [ "string" ], "SupportedResponseMIMETypes": [ "string" ], "SupportedTransformInstanceTypes": [ "string" ] } ], "ApprovalDescription": "string", "ClientToken": "string", "CustomerMetadataProperties": { "string" : "string" }, "CustomerMetadataPropertiesToRemove": [ "string" ], "InferenceSpecification": { "Containers": [ { "AdditionalS3DataSource": { "CompressionType": "string", "ETag": "string", "S3DataType": "string", "S3Uri": "string" }, "BaseModel": { "HubContentName": "string", "HubContentVersion": "string", "RecipeName": "string" }, "ContainerHostname": "string", "Environment": { "string" : "string" }, "Framework": "string", "FrameworkVersion": "string", "Image": "string", "ImageDigest": "string", "IsCheckpoint": boolean, "ModelDataETag": "string", "ModelDataSource": { "S3DataSource": { "CompressionType": "string", "ETag": "string", "HubAccessConfig": { "HubContentArn": "string" }, "ManifestEtag": "string", "ManifestS3Uri": "string", "ModelAccessConfig": { "AcceptEula": boolean }, "S3DataType": "string", "S3Uri": "string" } }, "ModelDataUrl": "string", "ModelInput": { "DataInputConfig": "string" }, "NearestModelName": "string", "ProductId": "string" } ], "SupportedContentTypes": [ "string" ], "SupportedRealtimeInferenceInstanceTypes": [ "string" ], "SupportedResponseMIMETypes": [ "string" ], "SupportedTransformInstanceTypes": [ "string" ] }, "ModelApprovalStatus": "string", "ModelCard": { "ModelCardContent": "string", "ModelCardStatus": "string" }, "ModelLifeCycle": { "Stage": "string", "StageDescription": "string", "StageStatus": "string" }, "ModelPackageArn": "string", "ModelPackageRegistrationType": "string", "SourceUri": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AdditionalInferenceSpecificationsToAdd](#API_UpdateModelPackage_RequestSyntax) ** An array of additional Inference Specification objects to be added to the existing array additional Inference Specification. Total number of additional Inference Specifications can not exceed 15. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts. Type: Array of [AdditionalInferenceSpecificationDefinition](API_AdditionalInferenceSpecificationDefinition.md) objects Array Members: Minimum number of 1 item. Maximum number of 15 items. Required: No ** [ApprovalDescription](#API_UpdateModelPackage_RequestSyntax) ** A description for the approval status of the model. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `.*` Required: No ** [ClientToken](#API_UpdateModelPackage_RequestSyntax) ** A unique token that guarantees that the call to this API is idempotent. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: `[a-zA-Z0-9-]+` Required: No ** [CustomerMetadataProperties](#API_UpdateModelPackage_RequestSyntax) ** The metadata properties associated with the model package versions. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)${1,128}` Value Length Constraints: Minimum length of 1. Maximum length of 256. Value Pattern: `([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)${1,256}` Required: No ** [CustomerMetadataPropertiesToRemove](#API_UpdateModelPackage_RequestSyntax) ** The metadata properties associated with the model package versions to remove. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)${1,128}` Required: No ** [InferenceSpecification](#API_UpdateModelPackage_RequestSyntax) ** Specifies details about inference jobs that you can run with models based on this model package, including the following information: + 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. Type: [InferenceSpecification](API_InferenceSpecification.md) object Required: No ** [ModelApprovalStatus](#API_UpdateModelPackage_RequestSyntax) ** The approval status of the model. Type: String Valid Values: `Approved | Rejected | PendingManualApproval` Required: No ** [ModelCard](#API_UpdateModelPackage_RequestSyntax) ** The model card associated with the model package. Since `ModelPackageModelCard` is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of `ModelCard`. The `ModelPackageModelCard` schema does not include `model_package_details`, and `model_overview` is composed of the `model_creator` and `model_artifact` properties. For more information about the model package model card schema, see [Model package model card schema](https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html#model-card-schema). For more information about the model card associated with the model package, see [View the Details of a Model Version](https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html). Type: [ModelPackageModelCard](API_ModelPackageModelCard.md) object Required: No ** [ModelLifeCycle](#API_UpdateModelPackage_RequestSyntax) ** A structure describing the current state of the model in its life cycle. Type: [ModelLifeCycle](API_ModelLifeCycle.md) object Required: No ** [ModelPackageArn](#API_UpdateModelPackage_RequestSyntax) ** The Amazon Resource Name (ARN) of the model package. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:model-package/[\S]{1,2048}` Required: Yes ** [ModelPackageRegistrationType](#API_UpdateModelPackage_RequestSyntax) ** The package registration type of the model package input. Type: String Valid Values: `Logged | Registered` Required: No ** [SourceUri](#API_UpdateModelPackage_RequestSyntax) ** The URI of the source for the model package. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `[\p{L}\p{M}\p{Z}\p{N}\p{P}]{0,1024}` Required: No ## Response Syntax ``` { "ModelPackageArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ModelPackageArn](#API_UpdateModelPackage_ResponseSyntax) ** The Amazon Resource Name (ARN) of the model. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:model-package/[\S]{1,2048}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateModelPackage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateModelPackage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateModelPackage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateModelPackage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateModelPackage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateModelPackage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateModelPackage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateModelPackage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateModelPackage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateModelPackage) # UpdateMonitoringAlert Update the parameters of a model monitor alert. ## Request Syntax ``` { "DatapointsToAlert": number, "EvaluationPeriod": number, "MonitoringAlertName": "string", "MonitoringScheduleName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DatapointsToAlert](#API_UpdateMonitoringAlert_RequestSyntax) ** Within `EvaluationPeriod`, how many execution failures will raise an alert. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: Yes ** [EvaluationPeriod](#API_UpdateMonitoringAlert_RequestSyntax) ** The number of most recent monitoring executions to consider when evaluating alert status. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: Yes ** [MonitoringAlertName](#API_UpdateMonitoringAlert_RequestSyntax) ** The name of a monitoring alert. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [MonitoringScheduleName](#API_UpdateMonitoringAlert_RequestSyntax) ** The name of a monitoring schedule. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "MonitoringAlertName": "string", "MonitoringScheduleArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [MonitoringAlertName](#API_UpdateMonitoringAlert_ResponseSyntax) ** The name of a monitoring alert. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ** [MonitoringScheduleArn](#API_UpdateMonitoringAlert_ResponseSyntax) ** The Amazon Resource Name (ARN) of the monitoring schedule. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateMonitoringAlert) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateMonitoringAlert) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateMonitoringAlert) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateMonitoringAlert) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateMonitoringAlert) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateMonitoringAlert) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateMonitoringAlert) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateMonitoringAlert) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateMonitoringAlert) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateMonitoringAlert) # UpdateMonitoringSchedule Updates a previously created schedule. ## Request Syntax ``` { "MonitoringScheduleConfig": { "MonitoringJobDefinition": { "BaselineConfig": { "BaseliningJobName": "string", "ConstraintsResource": { "S3Uri": "string" }, "StatisticsResource": { "S3Uri": "string" } }, "Environment": { "string" : "string" }, "MonitoringAppSpecification": { "ContainerArguments": [ "string" ], "ContainerEntrypoint": [ "string" ], "ImageUri": "string", "PostAnalyticsProcessorSourceUri": "string", "RecordPreprocessorSourceUri": "string" }, "MonitoringInputs": [ { "BatchTransformInput": { "DataCapturedDestinationS3Uri": "string", "DatasetFormat": { "Csv": { "Header": boolean }, "Json": { "Line": boolean }, "Parquet": { } }, "EndTimeOffset": "string", "ExcludeFeaturesAttribute": "string", "FeaturesAttribute": "string", "InferenceAttribute": "string", "LocalPath": "string", "ProbabilityAttribute": "string", "ProbabilityThresholdAttribute": number, "S3DataDistributionType": "string", "S3InputMode": "string", "StartTimeOffset": "string" }, "EndpointInput": { "EndpointName": "string", "EndTimeOffset": "string", "ExcludeFeaturesAttribute": "string", "FeaturesAttribute": "string", "InferenceAttribute": "string", "LocalPath": "string", "ProbabilityAttribute": "string", "ProbabilityThresholdAttribute": number, "S3DataDistributionType": "string", "S3InputMode": "string", "StartTimeOffset": "string" } } ], "MonitoringOutputConfig": { "KmsKeyId": "string", "MonitoringOutputs": [ { "S3Output": { "LocalPath": "string", "S3UploadMode": "string", "S3Uri": "string" } } ] }, "MonitoringResources": { "ClusterConfig": { "InstanceCount": number, "InstanceType": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number } }, "NetworkConfig": { "EnableInterContainerTrafficEncryption": boolean, "EnableNetworkIsolation": boolean, "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } }, "RoleArn": "string", "StoppingCondition": { "MaxRuntimeInSeconds": number } }, "MonitoringJobDefinitionName": "string", "MonitoringType": "string", "ScheduleConfig": { "DataAnalysisEndTime": "string", "DataAnalysisStartTime": "string", "ScheduleExpression": "string" } }, "MonitoringScheduleName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [MonitoringScheduleConfig](#API_UpdateMonitoringSchedule_RequestSyntax) ** The configuration object that specifies the monitoring schedule and defines the monitoring job. Type: [MonitoringScheduleConfig](API_MonitoringScheduleConfig.md) object Required: Yes ** [MonitoringScheduleName](#API_UpdateMonitoringSchedule_RequestSyntax) ** The name of the monitoring schedule. The name must be unique within an AWS Region within an AWS account. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "MonitoringScheduleArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [MonitoringScheduleArn](#API_UpdateMonitoringSchedule_ResponseSyntax) ** The Amazon Resource Name (ARN) of the monitoring schedule. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateMonitoringSchedule) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateMonitoringSchedule) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateMonitoringSchedule) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateMonitoringSchedule) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateMonitoringSchedule) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateMonitoringSchedule) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateMonitoringSchedule) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateMonitoringSchedule) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateMonitoringSchedule) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateMonitoringSchedule) # UpdateNotebookInstance 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. **Note** This API can attach lifecycle configurations to notebook instances. Lifecycle configuration scripts execute with root access and the notebook instance's IAM execution role privileges. Principals with this permission and access to lifecycle configurations can execute code with the execution role's credentials. See [Customize a Notebook Instance Using a Lifecycle Configuration Script](https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html) for security best practices. ## Request Syntax ``` { "AcceleratorTypes": [ "string" ], "AdditionalCodeRepositories": [ "string" ], "DefaultCodeRepository": "string", "DisassociateAcceleratorTypes": boolean, "DisassociateAdditionalCodeRepositories": boolean, "DisassociateDefaultCodeRepository": boolean, "DisassociateLifecycleConfig": boolean, "InstanceMetadataServiceConfiguration": { "MinimumInstanceMetadataServiceVersion": "string" }, "InstanceType": "string", "IpAddressType": "string", "LifecycleConfigName": "string", "NotebookInstanceName": "string", "PlatformIdentifier": "string", "RoleArn": "string", "RootAccess": "string", "VolumeSizeInGB": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AcceleratorTypes](#API_UpdateNotebookInstance_RequestSyntax) ** This parameter is no longer supported. Elastic Inference (EI) is no longer available. This parameter was used to specify a list of the EI instance types to associate with this notebook instance. Type: Array of strings Valid Values: `ml.eia1.medium | ml.eia1.large | ml.eia1.xlarge | ml.eia2.medium | ml.eia2.large | ml.eia2.xlarge` Required: No ** [AdditionalCodeRepositories](#API_UpdateNotebookInstance_RequestSyntax) ** 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](https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) 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 SageMaker AI Notebook Instances](https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 3 items. Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `https://([^/]+)/?(.*)$|^[a-zA-Z0-9](-*[a-zA-Z0-9])*` Required: No ** [DefaultCodeRepository](#API_UpdateNotebookInstance_RequestSyntax) ** 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](https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) 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 SageMaker AI Notebook Instances](https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `https://([^/]+)/?(.*)$|^[a-zA-Z0-9](-*[a-zA-Z0-9])*` Required: No ** [DisassociateAcceleratorTypes](#API_UpdateNotebookInstance_RequestSyntax) ** This parameter is no longer supported. Elastic Inference (EI) is no longer available. This parameter was used to specify a list of the EI instance types to remove from this notebook instance. Type: Boolean Required: No ** [DisassociateAdditionalCodeRepositories](#API_UpdateNotebookInstance_RequestSyntax) ** 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. Type: Boolean Required: No ** [DisassociateDefaultCodeRepository](#API_UpdateNotebookInstance_RequestSyntax) ** 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. Type: Boolean Required: No ** [DisassociateLifecycleConfig](#API_UpdateNotebookInstance_RequestSyntax) ** 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. Type: Boolean Required: No ** [InstanceMetadataServiceConfiguration](#API_UpdateNotebookInstance_RequestSyntax) ** Information on the IMDS configuration of the notebook instance Type: [InstanceMetadataServiceConfiguration](API_InstanceMetadataServiceConfiguration.md) object Required: No ** [InstanceType](#API_UpdateNotebookInstance_RequestSyntax) ** The Amazon ML compute instance type. Type: String Valid Values: `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.m5d.large | ml.m5d.xlarge | ml.m5d.2xlarge | ml.m5d.4xlarge | ml.m5d.8xlarge | ml.m5d.12xlarge | ml.m5d.16xlarge | ml.m5d.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 | ml.p3dn.24xlarge | 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.8xlarge | ml.r5.12xlarge | ml.r5.16xlarge | ml.r5.24xlarge | ml.g5.xlarge | ml.g5.2xlarge | ml.g5.4xlarge | ml.g5.8xlarge | ml.g5.16xlarge | ml.g5.12xlarge | ml.g5.24xlarge | ml.g5.48xlarge | ml.inf1.xlarge | ml.inf1.2xlarge | ml.inf1.6xlarge | ml.inf1.24xlarge | ml.trn1.2xlarge | ml.trn1.32xlarge | ml.trn1n.32xlarge | ml.inf2.xlarge | ml.inf2.8xlarge | ml.inf2.24xlarge | ml.inf2.48xlarge | ml.p4d.24xlarge | ml.p4de.24xlarge | ml.p5.48xlarge | ml.p6-b200.48xlarge | ml.m6i.large | ml.m6i.xlarge | ml.m6i.2xlarge | ml.m6i.4xlarge | ml.m6i.8xlarge | ml.m6i.12xlarge | ml.m6i.16xlarge | ml.m6i.24xlarge | ml.m6i.32xlarge | ml.m7i.large | ml.m7i.xlarge | ml.m7i.2xlarge | ml.m7i.4xlarge | ml.m7i.8xlarge | ml.m7i.12xlarge | ml.m7i.16xlarge | ml.m7i.24xlarge | ml.m7i.48xlarge | ml.c6i.large | ml.c6i.xlarge | ml.c6i.2xlarge | ml.c6i.4xlarge | ml.c6i.8xlarge | ml.c6i.12xlarge | ml.c6i.16xlarge | ml.c6i.24xlarge | ml.c6i.32xlarge | ml.c7i.large | ml.c7i.xlarge | ml.c7i.2xlarge | ml.c7i.4xlarge | ml.c7i.8xlarge | ml.c7i.12xlarge | ml.c7i.16xlarge | ml.c7i.24xlarge | ml.c7i.48xlarge | ml.r6i.large | ml.r6i.xlarge | ml.r6i.2xlarge | ml.r6i.4xlarge | ml.r6i.8xlarge | ml.r6i.12xlarge | ml.r6i.16xlarge | ml.r6i.24xlarge | ml.r6i.32xlarge | ml.r7i.large | ml.r7i.xlarge | ml.r7i.2xlarge | ml.r7i.4xlarge | ml.r7i.8xlarge | ml.r7i.12xlarge | ml.r7i.16xlarge | ml.r7i.24xlarge | ml.r7i.48xlarge | ml.m6id.large | ml.m6id.xlarge | ml.m6id.2xlarge | ml.m6id.4xlarge | ml.m6id.8xlarge | ml.m6id.12xlarge | ml.m6id.16xlarge | ml.m6id.24xlarge | ml.m6id.32xlarge | ml.c6id.large | ml.c6id.xlarge | ml.c6id.2xlarge | ml.c6id.4xlarge | ml.c6id.8xlarge | ml.c6id.12xlarge | ml.c6id.16xlarge | ml.c6id.24xlarge | ml.c6id.32xlarge | ml.r6id.large | ml.r6id.xlarge | ml.r6id.2xlarge | ml.r6id.4xlarge | ml.r6id.8xlarge | ml.r6id.12xlarge | ml.r6id.16xlarge | ml.r6id.24xlarge | ml.r6id.32xlarge | ml.g6.xlarge | ml.g6.2xlarge | ml.g6.4xlarge | ml.g6.8xlarge | ml.g6.12xlarge | ml.g6.16xlarge | ml.g6.24xlarge | ml.g6.48xlarge` Required: No ** [IpAddressType](#API_UpdateNotebookInstance_RequestSyntax) ** The IP address type for the notebook instance. Specify `ipv4` for IPv4-only connectivity or `dualstack` for both IPv4 and IPv6 connectivity. The notebook instance must be stopped before updating this setting. When you specify `dualstack`, the subnet must support IPv6 addressing. Type: String Valid Values: `ipv4 | dualstack` Required: No ** [LifecycleConfigName](#API_UpdateNotebookInstance_RequestSyntax) ** 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](https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html). Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9])*` Required: No ** [NotebookInstanceName](#API_UpdateNotebookInstance_RequestSyntax) ** The name of the notebook instance to update. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9])*` Required: Yes ** [PlatformIdentifier](#API_UpdateNotebookInstance_RequestSyntax) ** The platform identifier of the notebook instance runtime environment. Type: String Length Constraints: Minimum length of 0. Maximum length of 20. Pattern: `(notebook-al1-v1|notebook-al2-v1|notebook-al2-v2|notebook-al2-v3|notebook-al2023-v1)` Required: No ** [RoleArn](#API_UpdateNotebookInstance_RequestSyntax) ** The Amazon Resource Name (ARN) of the IAM role that SageMaker AI can assume to access the notebook instance. For more information, see [SageMaker AI Roles](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html). To be able to pass this role to SageMaker AI, the caller of this API must have the `iam:PassRole` permission. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` Required: No ** [RootAccess](#API_UpdateNotebookInstance_RequestSyntax) ** 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. Type: String Valid Values: `Enabled | Disabled` Required: No ** [VolumeSizeInGB](#API_UpdateNotebookInstance_RequestSyntax) ** 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 SageMaker AI 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. Type: Integer Valid Range: Minimum value of 5. Maximum value of 16384. Required: No ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateNotebookInstance) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateNotebookInstance) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateNotebookInstance) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateNotebookInstance) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateNotebookInstance) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateNotebookInstance) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateNotebookInstance) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateNotebookInstance) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateNotebookInstance) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateNotebookInstance) # UpdateNotebookInstanceLifecycleConfig Updates a notebook instance lifecycle configuration created with the [CreateNotebookInstanceLifecycleConfig](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateNotebookInstanceLifecycleConfig.html) API. **Note** Updates to lifecycle configurations affect all notebook instances using that configuration upon their next start. Lifecycle configuration scripts execute with root access and the notebook instance's IAM execution role privileges. Grant this permission only to trusted principals. See [Customize a Notebook Instance Using a Lifecycle Configuration Script](https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html) for security best practices. ## Request Syntax ``` { "NotebookInstanceLifecycleConfigName": "string", "OnCreate": [ { "Content": "string" } ], "OnStart": [ { "Content": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [NotebookInstanceLifecycleConfigName](#API_UpdateNotebookInstanceLifecycleConfig_RequestSyntax) ** The name of the lifecycle configuration. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9])*` Required: Yes ** [OnCreate](#API_UpdateNotebookInstanceLifecycleConfig_RequestSyntax) ** The shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string. Type: Array of [NotebookInstanceLifecycleHook](API_NotebookInstanceLifecycleHook.md) objects Array Members: Minimum number of 0 items. Maximum number of 1 item. Required: No ** [OnStart](#API_UpdateNotebookInstanceLifecycleConfig_RequestSyntax) ** 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. Type: Array of [NotebookInstanceLifecycleHook](API_NotebookInstanceLifecycleHook.md) objects Array Members: Minimum number of 0 items. Maximum number of 1 item. Required: No ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateNotebookInstanceLifecycleConfig) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateNotebookInstanceLifecycleConfig) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateNotebookInstanceLifecycleConfig) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateNotebookInstanceLifecycleConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateNotebookInstanceLifecycleConfig) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateNotebookInstanceLifecycleConfig) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateNotebookInstanceLifecycleConfig) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateNotebookInstanceLifecycleConfig) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateNotebookInstanceLifecycleConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateNotebookInstanceLifecycleConfig) # UpdatePartnerApp Updates all of the SageMaker Partner AI Apps in an account. ## Request Syntax ``` { "ApplicationConfig": { "AdminUsers": [ "string" ], "Arguments": { "string" : "string" }, "AssignedGroupPatterns": [ "string" ], "RoleGroupAssignments": [ { "GroupPatterns": [ "string" ], "RoleName": "string" } ] }, "AppVersion": "string", "Arn": "string", "ClientToken": "string", "EnableAutoMinorVersionUpgrade": boolean, "EnableIamSessionBasedIdentity": boolean, "MaintenanceConfig": { "MaintenanceWindowStart": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ], "Tier": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ApplicationConfig](#API_UpdatePartnerApp_RequestSyntax) ** Configuration settings for the SageMaker Partner AI App. Type: [PartnerAppConfig](API_PartnerAppConfig.md) object Required: No ** [AppVersion](#API_UpdatePartnerApp_RequestSyntax) ** The semantic version to upgrade the SageMaker Partner AI App to. Must be the same semantic version returned in the `AvailableUpgrade` field from `DescribePartnerApp`. Version skipping and downgrades are not supported. Type: String Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: `\d+\.\d+` Required: No ** [Arn](#API_UpdatePartnerApp_RequestSyntax) ** The ARN of the SageMaker Partner AI App to update. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:partner-app\/app-[A-Z0-9]{12}` Required: Yes ** [ClientToken](#API_UpdatePartnerApp_RequestSyntax) ** A unique token that guarantees that the call to this API is idempotent. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: `[a-zA-Z0-9-]+` Required: No ** [EnableAutoMinorVersionUpgrade](#API_UpdatePartnerApp_RequestSyntax) ** When set to `TRUE`, the SageMaker Partner AI App is automatically upgraded to the latest minor version during the next scheduled maintenance window, if one is available. Type: Boolean Required: No ** [EnableIamSessionBasedIdentity](#API_UpdatePartnerApp_RequestSyntax) ** When set to `TRUE`, the SageMaker Partner AI App sets the AWS IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user. Type: Boolean Required: No ** [MaintenanceConfig](#API_UpdatePartnerApp_RequestSyntax) ** Maintenance configuration settings for the SageMaker Partner AI App. Type: [PartnerAppMaintenanceConfig](API_PartnerAppMaintenanceConfig.md) object Required: No ** [Tags](#API_UpdatePartnerApp_RequestSyntax) ** Each tag consists of a key and an optional value. Tag keys must be unique per resource. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No ** [Tier](#API_UpdatePartnerApp_RequestSyntax) ** Indicates the instance type and size of the cluster attached to the SageMaker Partner AI App. Type: String Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: `(?!\s*$).+` Required: No ## Response Syntax ``` { "Arn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Arn](#API_UpdatePartnerApp_ResponseSyntax) ** The ARN of the SageMaker Partner AI App that was updated. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:partner-app\/app-[A-Z0-9]{12}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdatePartnerApp) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdatePartnerApp) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdatePartnerApp) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdatePartnerApp) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdatePartnerApp) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdatePartnerApp) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdatePartnerApp) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdatePartnerApp) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdatePartnerApp) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdatePartnerApp) # UpdatePipeline Updates a pipeline. ## Request Syntax ``` { "ParallelismConfiguration": { "MaxParallelExecutionSteps": number }, "PipelineDefinition": "string", "PipelineDefinitionS3Location": { "Bucket": "string", "ObjectKey": "string", "VersionId": "string" }, "PipelineDescription": "string", "PipelineDisplayName": "string", "PipelineName": "string", "RoleArn": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ParallelismConfiguration](#API_UpdatePipeline_RequestSyntax) ** If specified, it applies to all executions of this pipeline by default. Type: [ParallelismConfiguration](API_ParallelismConfiguration.md) object Required: No ** [PipelineDefinition](#API_UpdatePipeline_RequestSyntax) ** The JSON pipeline definition. Type: String Length Constraints: Minimum length of 1. Maximum length of 1048576. Pattern: `.*(?:[ \r\n\t].*)*` Required: No ** [PipelineDefinitionS3Location](#API_UpdatePipeline_RequestSyntax) ** The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location. Type: [PipelineDefinitionS3Location](API_PipelineDefinitionS3Location.md) object Required: No ** [PipelineDescription](#API_UpdatePipeline_RequestSyntax) ** The description of the pipeline. Type: String Length Constraints: Minimum length of 0. Maximum length of 3072. Pattern: `.*` Required: No ** [PipelineDisplayName](#API_UpdatePipeline_RequestSyntax) ** The display name of the pipeline. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}` Required: No ** [PipelineName](#API_UpdatePipeline_RequestSyntax) ** The name of the pipeline to update. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}` Required: Yes ** [RoleArn](#API_UpdatePipeline_RequestSyntax) ** The Amazon Resource Name (ARN) that the pipeline uses to execute. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` Required: No ## Response Syntax ``` { "PipelineArn": "string", "PipelineVersionId": number } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [PipelineArn](#API_UpdatePipeline_ResponseSyntax) ** The Amazon Resource Name (ARN) of the updated pipeline. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:pipeline/.*` ** [PipelineVersionId](#API_UpdatePipeline_ResponseSyntax) ** The ID of the pipeline version. Type: Long Valid Range: Minimum value of 1. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdatePipeline) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdatePipeline) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdatePipeline) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdatePipeline) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdatePipeline) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdatePipeline) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdatePipeline) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdatePipeline) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdatePipeline) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdatePipeline) # UpdatePipelineExecution Updates a pipeline execution. ## Request Syntax ``` { "ParallelismConfiguration": { "MaxParallelExecutionSteps": number }, "PipelineExecutionArn": "string", "PipelineExecutionDescription": "string", "PipelineExecutionDisplayName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ParallelismConfiguration](#API_UpdatePipelineExecution_RequestSyntax) ** This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run. Type: [ParallelismConfiguration](API_ParallelismConfiguration.md) object Required: No ** [PipelineExecutionArn](#API_UpdatePipelineExecution_RequestSyntax) ** The Amazon Resource Name (ARN) of the pipeline execution. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:pipeline\/.*\/execution\/.*` Required: Yes ** [PipelineExecutionDescription](#API_UpdatePipelineExecution_RequestSyntax) ** The description of the pipeline execution. Type: String Length Constraints: Minimum length of 0. Maximum length of 3072. Pattern: `.*` Required: No ** [PipelineExecutionDisplayName](#API_UpdatePipelineExecution_RequestSyntax) ** The display name of the pipeline execution. Type: String Length Constraints: Minimum length of 1. Maximum length of 82. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,81}` Required: No ## Response Syntax ``` { "PipelineExecutionArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [PipelineExecutionArn](#API_UpdatePipelineExecution_ResponseSyntax) ** The Amazon Resource Name (ARN) of the updated pipeline execution. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:pipeline\/.*\/execution\/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdatePipelineExecution) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdatePipelineExecution) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdatePipelineExecution) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdatePipelineExecution) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdatePipelineExecution) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdatePipelineExecution) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdatePipelineExecution) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdatePipelineExecution) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdatePipelineExecution) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdatePipelineExecution) # UpdatePipelineVersion Updates a pipeline version. ## Request Syntax ``` { "PipelineArn": "string", "PipelineVersionDescription": "string", "PipelineVersionDisplayName": "string", "PipelineVersionId": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [PipelineArn](#API_UpdatePipelineVersion_RequestSyntax) ** The Amazon Resource Name (ARN) of the pipeline. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:pipeline/.*` Required: Yes ** [PipelineVersionDescription](#API_UpdatePipelineVersion_RequestSyntax) ** The description of the pipeline version. Type: String Length Constraints: Minimum length of 0. Maximum length of 3072. Pattern: `.*` Required: No ** [PipelineVersionDisplayName](#API_UpdatePipelineVersion_RequestSyntax) ** The display name of the pipeline version. Type: String Length Constraints: Minimum length of 1. Maximum length of 82. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,81}` Required: No ** [PipelineVersionId](#API_UpdatePipelineVersion_RequestSyntax) ** The pipeline version ID to update. Type: Long Valid Range: Minimum value of 1. Required: Yes ## Response Syntax ``` { "PipelineArn": "string", "PipelineVersionId": number } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [PipelineArn](#API_UpdatePipelineVersion_ResponseSyntax) ** The Amazon Resource Name (ARN) of the pipeline. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:pipeline/.*` ** [PipelineVersionId](#API_UpdatePipelineVersion_ResponseSyntax) ** The ID of the pipeline version. Type: Long Valid Range: Minimum value of 1. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdatePipelineVersion) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdatePipelineVersion) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdatePipelineVersion) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdatePipelineVersion) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdatePipelineVersion) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdatePipelineVersion) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdatePipelineVersion) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdatePipelineVersion) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdatePipelineVersion) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdatePipelineVersion) # UpdateProject Updates a machine learning (ML) project that is created from a template that sets up an ML pipeline from training to deploying an approved model. **Note** You must not update a project that is in use. If you update the `ServiceCatalogProvisioningUpdateDetails` of a project that is active or being created, or updated, you may lose resources already created by the project. ## Request Syntax ``` { "ProjectDescription": "string", "ProjectName": "string", "ServiceCatalogProvisioningUpdateDetails": { "ProvisioningArtifactId": "string", "ProvisioningParameters": [ { "Key": "string", "Value": "string" } ] }, "Tags": [ { "Key": "string", "Value": "string" } ], "TemplateProvidersToUpdate": [ { "CfnTemplateProvider": { "Parameters": [ { "Key": "string", "Value": "string" } ], "TemplateName": "string", "TemplateURL": "string" } } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ProjectDescription](#API_UpdateProject_RequestSyntax) ** The description for the project. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*` Required: No ** [ProjectName](#API_UpdateProject_RequestSyntax) ** The name of the project. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}` Required: Yes ** [ServiceCatalogProvisioningUpdateDetails](#API_UpdateProject_RequestSyntax) ** The product ID and provisioning artifact ID to provision a service catalog. The provisioning artifact ID will default to the latest provisioning artifact ID of the product, if you don't provide the provisioning artifact ID. For more information, see [What is AWS Service Catalog](https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html). Type: [ServiceCatalogProvisioningUpdateDetails](API_ServiceCatalogProvisioningUpdateDetails.md) object Required: No ** [Tags](#API_UpdateProject_RequestSyntax) ** 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](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). In addition, the project must have tag update constraints set in order to include this parameter in the request. For more information, see [AWS Service Catalog Tag Update Constraints](https://docs.aws.amazon.com/servicecatalog/latest/adminguide/constraints-resourceupdate.html). Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No ** [TemplateProvidersToUpdate](#API_UpdateProject_RequestSyntax) ** The template providers to update in the project. Type: Array of [UpdateTemplateProvider](API_UpdateTemplateProvider.md) objects Array Members: Fixed number of 1 item. Required: No ## Response Syntax ``` { "ProjectArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ProjectArn](#API_UpdateProject_ResponseSyntax) ** The Amazon Resource Name (ARN) of the project. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:project/[\S]{1,2048}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateProject) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateProject) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateProject) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateProject) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateProject) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateProject) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateProject) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateProject) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateProject) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateProject) # UpdateSpace Updates the settings of a space. **Note** You can't edit the app type of a space in the `SpaceSettings`. ## Request Syntax ``` { "DomainId": "string", "SpaceDisplayName": "string", "SpaceName": "string", "SpaceSettings": { "AppType": "string", "CodeEditorAppSettings": { "AppLifecycleManagement": { "IdleSettings": { "IdleTimeoutInMinutes": number } }, "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" } }, "CustomFileSystems": [ { ... } ], "JupyterLabAppSettings": { "AppLifecycleManagement": { "IdleSettings": { "IdleTimeoutInMinutes": number } }, "CodeRepositories": [ { "RepositoryUrl": "string" } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" } }, "JupyterServerAppSettings": { "CodeRepositories": [ { "RepositoryUrl": "string" } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" }, "LifecycleConfigArns": [ "string" ] }, "KernelGatewayAppSettings": { "CustomImages": [ { "AppImageConfigName": "string", "ImageName": "string", "ImageVersionNumber": number } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" }, "LifecycleConfigArns": [ "string" ] }, "RemoteAccess": "string", "SpaceManagedResources": "string", "SpaceStorageSettings": { "EbsStorageSettings": { "EbsVolumeSizeInGb": number } } } } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DomainId](#API_UpdateSpace_RequestSyntax) ** The ID of the associated domain. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `d-(-*[a-z0-9]){1,61}` Required: Yes ** [SpaceDisplayName](#API_UpdateSpace_RequestSyntax) ** The name of the space that appears in the Amazon SageMaker Studio UI. Type: String Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: `(?!\s*$).+` Required: No ** [SpaceName](#API_UpdateSpace_RequestSyntax) ** The name of the space. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [SpaceSettings](#API_UpdateSpace_RequestSyntax) ** A collection of space settings. Type: [SpaceSettings](API_SpaceSettings.md) object Required: No ## Response Syntax ``` { "SpaceArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [SpaceArn](#API_UpdateSpace_ResponseSyntax) ** The space's Amazon Resource Name (ARN). Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:space/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateSpace) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateSpace) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateSpace) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateSpace) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateSpace) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateSpace) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateSpace) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateSpace) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateSpace) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateSpace) # UpdateTrainingJob Update a model training job to request a new Debugger profiling configuration or to change warm pool retention length. ## Request Syntax ``` { "ProfilerConfig": { "DisableProfiler": boolean, "ProfilingIntervalInMilliseconds": number, "ProfilingParameters": { "string" : "string" }, "S3OutputPath": "string" }, "ProfilerRuleConfigurations": [ { "InstanceType": "string", "LocalPath": "string", "RuleConfigurationName": "string", "RuleEvaluatorImage": "string", "RuleParameters": { "string" : "string" }, "S3OutputPath": "string", "VolumeSizeInGB": number } ], "RemoteDebugConfig": { "EnableRemoteDebug": boolean }, "ResourceConfig": { "KeepAlivePeriodInSeconds": number }, "TrainingJobName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ProfilerConfig](#API_UpdateTrainingJob_RequestSyntax) ** Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths. Type: [ProfilerConfigForUpdate](API_ProfilerConfigForUpdate.md) object Required: No ** [ProfilerRuleConfigurations](#API_UpdateTrainingJob_RequestSyntax) ** Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics. Type: Array of [ProfilerRuleConfiguration](API_ProfilerRuleConfiguration.md) objects Array Members: Minimum number of 0 items. Maximum number of 20 items. Required: No ** [RemoteDebugConfig](#API_UpdateTrainingJob_RequestSyntax) ** Configuration for remote debugging while the training job is running. You can update the remote debugging configuration when the `SecondaryStatus` of the job is `Downloading` or `Training`.To learn more about the remote debugging functionality of SageMaker, see [Access a training container through AWS Systems Manager (SSM) for remote debugging](https://docs.aws.amazon.com/sagemaker/latest/dg/train-remote-debugging.html). Type: [RemoteDebugConfigForUpdate](API_RemoteDebugConfigForUpdate.md) object Required: No ** [ResourceConfig](#API_UpdateTrainingJob_RequestSyntax) ** The training job `ResourceConfig` to update warm pool retention length. Type: [ResourceConfigForUpdate](API_ResourceConfigForUpdate.md) object Required: No ** [TrainingJobName](#API_UpdateTrainingJob_RequestSyntax) ** The name of a training job to update the Debugger profiling configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "TrainingJobArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [TrainingJobArn](#API_UpdateTrainingJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the training job. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:training-job/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateTrainingJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateTrainingJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateTrainingJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateTrainingJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateTrainingJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateTrainingJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateTrainingJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateTrainingJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateTrainingJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateTrainingJob) # UpdateTrial Updates the display name of a trial. ## Request Syntax ``` { "DisplayName": "string", "TrialName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DisplayName](#API_UpdateTrial_RequestSyntax) ** The name of the trial as displayed. The name doesn't need to be unique. If `DisplayName` isn't specified, `TrialName` is displayed. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` Required: No ** [TrialName](#API_UpdateTrial_RequestSyntax) ** The name of the trial to update. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` Required: Yes ## Response Syntax ``` { "TrialArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [TrialArn](#API_UpdateTrial_ResponseSyntax) ** The Amazon Resource Name (ARN) of the trial. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:experiment-trial/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateTrial) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateTrial) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateTrial) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateTrial) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateTrial) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateTrial) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateTrial) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateTrial) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateTrial) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateTrial) # UpdateTrialComponent Updates one or more properties of a trial component. ## Request Syntax ``` { "DisplayName": "string", "EndTime": number, "InputArtifacts": { "string" : { "MediaType": "string", "Value": "string" } }, "InputArtifactsToRemove": [ "string" ], "OutputArtifacts": { "string" : { "MediaType": "string", "Value": "string" } }, "OutputArtifactsToRemove": [ "string" ], "Parameters": { "string" : { "NumberValue": number, "StringValue": "string" } }, "ParametersToRemove": [ "string" ], "StartTime": number, "Status": { "Message": "string", "PrimaryStatus": "string" }, "TrialComponentName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DisplayName](#API_UpdateTrialComponent_RequestSyntax) ** The name of the component as displayed. The name doesn't need to be unique. If `DisplayName` isn't specified, `TrialComponentName` is displayed. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` Required: No ** [EndTime](#API_UpdateTrialComponent_RequestSyntax) ** When the component ended. Type: Timestamp Required: No ** [InputArtifacts](#API_UpdateTrialComponent_RequestSyntax) ** Replaces all of the component's input artifacts with the specified artifacts or adds new input artifacts. Existing input artifacts are replaced if the trial component is updated with an identical input artifact key. Type: String to [TrialComponentArtifact](API_TrialComponentArtifact.md) object map Map Entries: Minimum number of 0 items. Maximum number of 60 items. Key Length Constraints: Minimum length of 0. Maximum length of 128. Key Pattern: `.*` Required: No ** [InputArtifactsToRemove](#API_UpdateTrialComponent_RequestSyntax) ** The input artifacts to remove from the component. Type: Array of strings Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `.*` Required: No ** [OutputArtifacts](#API_UpdateTrialComponent_RequestSyntax) ** Replaces all of the component's output artifacts with the specified artifacts or adds new output artifacts. Existing output artifacts are replaced if the trial component is updated with an identical output artifact key. Type: String to [TrialComponentArtifact](API_TrialComponentArtifact.md) object map Map Entries: Minimum number of 0 items. Maximum number of 60 items. Key Length Constraints: Minimum length of 0. Maximum length of 128. Key Pattern: `.*` Required: No ** [OutputArtifactsToRemove](#API_UpdateTrialComponent_RequestSyntax) ** The output artifacts to remove from the component. Type: Array of strings Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `.*` Required: No ** [Parameters](#API_UpdateTrialComponent_RequestSyntax) ** Replaces all of the component's hyperparameters with the specified hyperparameters or add new hyperparameters. Existing hyperparameters are replaced if the trial component is updated with an identical hyperparameter key. Type: String to [TrialComponentParameterValue](API_TrialComponentParameterValue.md) object map Map Entries: Minimum number of 0 items. Maximum number of 300 items. Key Length Constraints: Minimum length of 0. Maximum length of 320. Key Pattern: `.*` Required: No ** [ParametersToRemove](#API_UpdateTrialComponent_RequestSyntax) ** The hyperparameters to remove from the component. Type: Array of strings Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `.*` Required: No ** [StartTime](#API_UpdateTrialComponent_RequestSyntax) ** When the component started. Type: Timestamp Required: No ** [Status](#API_UpdateTrialComponent_RequestSyntax) ** The new status of the component. Type: [TrialComponentStatus](API_TrialComponentStatus.md) object Required: No ** [TrialComponentName](#API_UpdateTrialComponent_RequestSyntax) ** The name of the component to update. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}` Required: Yes ## Response Syntax ``` { "TrialComponentArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [TrialComponentArn](#API_UpdateTrialComponent_ResponseSyntax) ** The Amazon Resource Name (ARN) of the trial component. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:experiment-trial-component/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateTrialComponent) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateTrialComponent) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateTrialComponent) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateTrialComponent) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateTrialComponent) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateTrialComponent) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateTrialComponent) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateTrialComponent) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateTrialComponent) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateTrialComponent) # UpdateUserProfile Updates a user profile. ## Request Syntax ``` { "DomainId": "string", "UserProfileName": "string", "UserSettings": { "AutoMountHomeEFS": "string", "CanvasAppSettings": { "DirectDeploySettings": { "Status": "string" }, "EmrServerlessSettings": { "ExecutionRoleArn": "string", "Status": "string" }, "GenerativeAiSettings": { "AmazonBedrockRoleArn": "string" }, "IdentityProviderOAuthSettings": [ { "DataSourceName": "string", "SecretArn": "string", "Status": "string" } ], "KendraSettings": { "Status": "string" }, "ModelRegisterSettings": { "CrossAccountModelRegisterRoleArn": "string", "Status": "string" }, "TimeSeriesForecastingSettings": { "AmazonForecastRoleArn": "string", "Status": "string" }, "WorkspaceSettings": { "S3ArtifactPath": "string", "S3KmsKeyId": "string" } }, "CodeEditorAppSettings": { "AppLifecycleManagement": { "IdleSettings": { "IdleTimeoutInMinutes": number, "LifecycleManagement": "string", "MaxIdleTimeoutInMinutes": number, "MinIdleTimeoutInMinutes": number } }, "BuiltInLifecycleConfigArn": "string", "CustomImages": [ { "AppImageConfigName": "string", "ImageName": "string", "ImageVersionNumber": number } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" }, "LifecycleConfigArns": [ "string" ] }, "CustomFileSystemConfigs": [ { ... } ], "CustomPosixUserConfig": { "Gid": number, "Uid": number }, "DefaultLandingUri": "string", "ExecutionRole": "string", "JupyterLabAppSettings": { "AppLifecycleManagement": { "IdleSettings": { "IdleTimeoutInMinutes": number, "LifecycleManagement": "string", "MaxIdleTimeoutInMinutes": number, "MinIdleTimeoutInMinutes": number } }, "BuiltInLifecycleConfigArn": "string", "CodeRepositories": [ { "RepositoryUrl": "string" } ], "CustomImages": [ { "AppImageConfigName": "string", "ImageName": "string", "ImageVersionNumber": number } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" }, "EmrSettings": { "AssumableRoleArns": [ "string" ], "ExecutionRoleArns": [ "string" ] }, "LifecycleConfigArns": [ "string" ] }, "JupyterServerAppSettings": { "CodeRepositories": [ { "RepositoryUrl": "string" } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" }, "LifecycleConfigArns": [ "string" ] }, "KernelGatewayAppSettings": { "CustomImages": [ { "AppImageConfigName": "string", "ImageName": "string", "ImageVersionNumber": number } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" }, "LifecycleConfigArns": [ "string" ] }, "RSessionAppSettings": { "CustomImages": [ { "AppImageConfigName": "string", "ImageName": "string", "ImageVersionNumber": number } ], "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" } }, "RStudioServerProAppSettings": { "AccessStatus": "string", "UserGroup": "string" }, "SecurityGroups": [ "string" ], "SharingSettings": { "NotebookOutputOption": "string", "S3KmsKeyId": "string", "S3OutputPath": "string" }, "SpaceStorageSettings": { "DefaultEbsStorageSettings": { "DefaultEbsVolumeSizeInGb": number, "MaximumEbsVolumeSizeInGb": number } }, "StudioWebPortal": "string", "StudioWebPortalSettings": { "HiddenAppTypes": [ "string" ], "HiddenInstanceTypes": [ "string" ], "HiddenMlTools": [ "string" ], "HiddenSageMakerImageVersionAliases": [ { "SageMakerImageName": "string", "VersionAliases": [ "string" ] } ] }, "TensorBoardAppSettings": { "DefaultResourceSpec": { "InstanceType": "string", "LifecycleConfigArn": "string", "SageMakerImageArn": "string", "SageMakerImageVersionAlias": "string", "SageMakerImageVersionArn": "string" } } } } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DomainId](#API_UpdateUserProfile_RequestSyntax) ** The domain ID. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `d-(-*[a-z0-9]){1,61}` Required: Yes ** [UserProfileName](#API_UpdateUserProfile_RequestSyntax) ** The user profile name. Type: String Length Constraints: Minimum length of 0. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ** [UserSettings](#API_UpdateUserProfile_RequestSyntax) ** A collection of settings. Type: [UserSettings](API_UserSettings.md) object Required: No ## Response Syntax ``` { "UserProfileArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [UserProfileArn](#API_UpdateUserProfile_ResponseSyntax) ** The user profile Amazon Resource Name (ARN). Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:user-profile/.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceInUse ** Resource being accessed is in use. HTTP Status Code: 400 ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ** ResourceNotFound ** Resource being access is not found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateUserProfile) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateUserProfile) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateUserProfile) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateUserProfile) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateUserProfile) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateUserProfile) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateUserProfile) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateUserProfile) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateUserProfile) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateUserProfile) # UpdateWorkforce Use this operation to update your workforce. You can use this operation to require that workers use specific IP addresses to work on tasks and to update your OpenID Connect (OIDC) Identity Provider (IdP) workforce configuration. The worker portal is now supported in VPC and public internet. Use `SourceIpConfig` to restrict worker access to tasks to a specific range of IP addresses. You specify allowed IP addresses by creating a list of up to ten [CIDRs](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html). 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. To restrict public internet access for all workers, configure the `SourceIpConfig` CIDR value. For example, when using `SourceIpConfig` with an `IpAddressType` of `IPv4`, you can restrict access to the IPv4 CIDR block "10.0.0.0/16". When using an `IpAddressType` of `dualstack`, you can specify both the IPv4 and IPv6 CIDR blocks, such as "10.0.0.0/16" for IPv4 only, "2001:db8:1234:1a00::/56" for IPv6 only, or "10.0.0.0/16" and "2001:db8:1234:1a00::/56" for dual stack. **Important** Amazon SageMaker does not support Source Ip restriction for worker portals in VPC. Use `OidcConfig` to update the configuration of a workforce created using your own OIDC IdP. **Important** You can only update your OIDC IdP configuration when there are no work teams associated with your workforce. You can delete work teams using the [DeleteWorkteam](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteWorkteam.html) operation. After restricting access to a range of IP addresses or updating your OIDC IdP configuration with this operation, you can view details about your update workforce using the [DescribeWorkforce](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeWorkforce.html) operation. **Important** This operation only applies to private workforces. ## Request Syntax ``` { "IpAddressType": "string", "OidcConfig": { "AuthenticationRequestExtraParams": { "string" : "string" }, "AuthorizationEndpoint": "string", "ClientId": "string", "ClientSecret": "string", "Issuer": "string", "JwksUri": "string", "LogoutEndpoint": "string", "Scope": "string", "TokenEndpoint": "string", "UserInfoEndpoint": "string" }, "SourceIpConfig": { "Cidrs": [ "string" ] }, "WorkforceName": "string", "WorkforceVpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ], "VpcId": "string" } } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [IpAddressType](#API_UpdateWorkforce_RequestSyntax) ** Use this parameter to specify whether you want `IPv4` only or `dualstack` (`IPv4` and `IPv6`) to support your labeling workforce. Type: String Valid Values: `ipv4 | dualstack` Required: No ** [OidcConfig](#API_UpdateWorkforce_RequestSyntax) ** Use this parameter to update your OIDC Identity Provider (IdP) configuration for a workforce made using your own IdP. Type: [OidcConfig](API_OidcConfig.md) object Required: No ** [SourceIpConfig](#API_UpdateWorkforce_RequestSyntax) ** A list of one to ten worker IP address ranges ([CIDRs](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html)) that can be used to access tasks assigned to this workforce. Maximum: Ten CIDR values Type: [SourceIpConfig](API_SourceIpConfig.md) object Required: No ** [WorkforceName](#API_UpdateWorkforce_RequestSyntax) ** The name of the private workforce that you want to update. You can find your workforce name by using the [ListWorkforces](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListWorkforces.html) operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9]([a-zA-Z0-9\-]){0,62}` Required: Yes ** [WorkforceVpcConfig](#API_UpdateWorkforce_RequestSyntax) ** Use this parameter to update your VPC configuration for a workforce. Type: [WorkforceVpcConfigRequest](API_WorkforceVpcConfigRequest.md) object Required: No ## Response Syntax ``` { "Workforce": { "CognitoConfig": { "ClientId": "string", "UserPool": "string" }, "CreateDate": number, "FailureReason": "string", "IpAddressType": "string", "LastUpdatedDate": number, "OidcConfig": { "AuthenticationRequestExtraParams": { "string" : "string" }, "AuthorizationEndpoint": "string", "ClientId": "string", "Issuer": "string", "JwksUri": "string", "LogoutEndpoint": "string", "Scope": "string", "TokenEndpoint": "string", "UserInfoEndpoint": "string" }, "SourceIpConfig": { "Cidrs": [ "string" ] }, "Status": "string", "SubDomain": "string", "WorkforceArn": "string", "WorkforceName": "string", "WorkforceVpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ], "VpcEndpointId": "string", "VpcId": "string" } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Workforce](#API_UpdateWorkforce_ResponseSyntax) ** 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](https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private.html). Type: [Workforce](API_Workforce.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConflictException ** There was a conflict when you attempted to modify a SageMaker entity such as an `Experiment` or `Artifact`. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateWorkforce) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateWorkforce) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateWorkforce) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateWorkforce) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateWorkforce) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateWorkforce) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateWorkforce) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateWorkforce) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateWorkforce) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateWorkforce) # UpdateWorkteam Updates an existing work team with new member definitions or description. ## Request Syntax ``` { "Description": "string", "MemberDefinitions": [ { "CognitoMemberDefinition": { "ClientId": "string", "UserGroup": "string", "UserPool": "string" }, "OidcMemberDefinition": { "Groups": [ "string" ] } } ], "NotificationConfiguration": { "NotificationTopicArn": "string" }, "WorkerAccessConfiguration": { "S3Presign": { "IamPolicyConstraints": { "SourceIp": "string", "VpcSourceIp": "string" } } }, "WorkteamName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Description](#API_UpdateWorkteam_RequestSyntax) ** An updated description for the work team. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: `.+` Required: No ** [MemberDefinitions](#API_UpdateWorkteam_RequestSyntax) ** 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](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html). 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. Type: Array of [MemberDefinition](API_MemberDefinition.md) objects Array Members: Minimum number of 1 item. Maximum number of 10 items. Required: No ** [NotificationConfiguration](#API_UpdateWorkteam_RequestSyntax) ** Configures SNS topic notifications for available or expiring work items Type: [NotificationConfiguration](API_NotificationConfiguration.md) object Required: No ** [WorkerAccessConfiguration](#API_UpdateWorkteam_RequestSyntax) ** Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL. Type: [WorkerAccessConfiguration](API_WorkerAccessConfiguration.md) object Required: No ** [WorkteamName](#API_UpdateWorkteam_RequestSyntax) ** The name of the work team to update. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` Required: Yes ## Response Syntax ``` { "Workteam": { "CreateDate": number, "Description": "string", "LastUpdatedDate": number, "MemberDefinitions": [ { "CognitoMemberDefinition": { "ClientId": "string", "UserGroup": "string", "UserPool": "string" }, "OidcMemberDefinition": { "Groups": [ "string" ] } } ], "NotificationConfiguration": { "NotificationTopicArn": "string" }, "ProductListingIds": [ "string" ], "SubDomain": "string", "WorkerAccessConfiguration": { "S3Presign": { "IamPolicyConstraints": { "SourceIp": "string", "VpcSourceIp": "string" } } }, "WorkforceArn": "string", "WorkteamArn": "string", "WorkteamName": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Workteam](#API_UpdateWorkteam_ResponseSyntax) ** A `Workteam` object that describes the updated work team. Type: [Workteam](API_Workteam.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceLimitExceeded ** You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/UpdateWorkteam) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/UpdateWorkteam) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/UpdateWorkteam) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/UpdateWorkteam) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/UpdateWorkteam) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/UpdateWorkteam) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/UpdateWorkteam) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/UpdateWorkteam) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/UpdateWorkteam) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/UpdateWorkteam) # Amazon SageMaker Runtime The following actions are supported by Amazon SageMaker Runtime: + [InvokeEndpoint](API_runtime_InvokeEndpoint.md) + [InvokeEndpointAsync](API_runtime_InvokeEndpointAsync.md) + [InvokeEndpointWithResponseStream](API_runtime_InvokeEndpointWithResponseStream.md) # InvokeEndpoint After you deploy a model into production using Amazon SageMaker AI hosting services, your client applications use this API to get inferences from the model hosted at the specified endpoint. For an overview of Amazon SageMaker AI, see [How It Works](https://docs.aws.amazon.com/sagemaker/latest/dg/how-it-works.html). Amazon SageMaker AI strips all POST headers except those supported by the API. Amazon SageMaker AI might add additional headers. You should not rely on the behavior of headers outside those enumerated in the request syntax. Calls to `InvokeEndpoint` are authenticated by using AWS Signature Version 4. For information, see [Authenticating Requests (AWS Signature Version 4)](https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html) in the *Amazon S3 API Reference*. A customer's model containers must respond to requests within 60 seconds. The model itself can have a maximum processing time of 60 seconds before responding to invocations. If your model is going to take 50-60 seconds of processing time, the SDK socket timeout should be set to be 70 seconds. **Note** Endpoints are scoped to an individual account, and are not public. The URL does not contain the account ID, but Amazon SageMaker AI determines the account ID from the authentication token that is supplied by the caller. ## Request Syntax ``` POST /endpoints/EndpointName/invocations HTTP/1.1 Content-Type: ContentType Accept: Accept X-Amzn-SageMaker-Custom-Attributes: CustomAttributes X-Amzn-SageMaker-Target-Model: TargetModel X-Amzn-SageMaker-Target-Variant: TargetVariant X-Amzn-SageMaker-Target-Container-Hostname: TargetContainerHostname X-Amzn-SageMaker-Inference-Id: InferenceId X-Amzn-SageMaker-Enable-Explanations: EnableExplanations X-Amzn-SageMaker-Inference-Component: InferenceComponentName X-Amzn-SageMaker-Session-Id: SessionId Body ``` ## URI Request Parameters The request uses the following URI parameters. ** [Accept](#API_runtime_InvokeEndpoint_RequestSyntax) ** The desired MIME type of the inference response from the model container. Length Constraints: Maximum length of 1024. Pattern: `\p{ASCII}*` ** [ContentType](#API_runtime_InvokeEndpoint_RequestSyntax) ** The MIME type of the input data in the request body. Length Constraints: Maximum length of 1024. Pattern: `\p{ASCII}*` ** [CustomAttributes](#API_runtime_InvokeEndpoint_RequestSyntax) ** Provides additional information about a request for an inference submitted to a model hosted at an Amazon SageMaker AI endpoint. The information is an opaque value that is forwarded verbatim. You could use this value, for example, to provide an ID that you can use to track a request or to provide other metadata that a service endpoint was programmed to process. The value must consist of no more than 1024 visible US-ASCII characters as specified in [Section 3.3.6. Field Value Components](https://datatracker.ietf.org/doc/html/rfc7230#section-3.2.6) of the Hypertext Transfer Protocol (HTTP/1.1). The code in your model is responsible for setting or updating any custom attributes in the response. If your code does not set this value in the response, an empty value is returned. For example, if a custom attribute represents the trace ID, your model can prepend the custom attribute with `Trace ID:` in your post-processing function. This feature is currently supported in the AWS SDKs but not in the Amazon SageMaker AI Python SDK. Length Constraints: Maximum length of 1024. Pattern: `\p{ASCII}*` ** [EnableExplanations](#API_runtime_InvokeEndpoint_RequestSyntax) ** An optional JMESPath expression used to override the `EnableExplanations` parameter of the `ClarifyExplainerConfig` API. See the [EnableExplanations](https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html#clarify-online-explainability-create-endpoint-enable) section in the developer guide for more information. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `.*` ** [EndpointName](#API_runtime_InvokeEndpoint_RequestSyntax) ** The name of the endpoint that you specified when you created the endpoint using the [CreateEndpoint](https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpoint.html) API. Length Constraints: Maximum length of 63. Pattern: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*` Required: Yes ** [InferenceComponentName](#API_runtime_InvokeEndpoint_RequestSyntax) ** If the endpoint hosts one or more inference components, this parameter specifies the name of inference component to invoke. Length Constraints: Maximum length of 63. Pattern: `^[a-zA-Z0-9]([\-a-zA-Z0-9]*[a-zA-Z0-9])?$` ** [InferenceId](#API_runtime_InvokeEndpoint_RequestSyntax) ** If you provide a value, it is added to the captured data when you enable data capture on the endpoint. For information about data capture, see [Capture Data](https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-data-capture.html). Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `\A\S[\p{Print}]*\z` ** [SessionId](#API_runtime_InvokeEndpoint_RequestSyntax) ** Creates a stateful session or identifies an existing one. You can do one of the following: + Create a stateful session by specifying the value `NEW_SESSION`. + Send your request to an existing stateful session by specifying the ID of that session. With a stateful session, you can send multiple requests to a stateful model. When you create a session with a stateful model, the model must create the session ID and set the expiration time. The model must also provide that information in the response to your request. You can get the ID and timestamp from the `NewSessionId` response parameter. For any subsequent request where you specify that session ID, SageMaker AI routes the request to the same instance that supports the session. Length Constraints: Maximum length of 256. Pattern: `^(NEW_SESSION)$|^[a-zA-Z0-9](-*[a-zA-Z0-9])*$` ** [TargetContainerHostname](#API_runtime_InvokeEndpoint_RequestSyntax) ** If the endpoint hosts multiple containers and is configured to use direct invocation, this parameter specifies the host name of the container to invoke. Length Constraints: Maximum length of 63. Pattern: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*` ** [TargetModel](#API_runtime_InvokeEndpoint_RequestSyntax) ** The model to request for inference when invoking a multi-model endpoint. Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `\A\S[\p{Print}]*\z` ** [TargetVariant](#API_runtime_InvokeEndpoint_RequestSyntax) ** Specify the production variant to send the inference request to when invoking an endpoint that is running two or more variants. Note that this parameter overrides the default behavior for the endpoint, which is to distribute the invocation traffic based on the variant weights. For information about how to use variant targeting to perform a/b testing, see [Test models in production](https://docs.aws.amazon.com/sagemaker/latest/dg/model-ab-testing.html) Length Constraints: Maximum length of 63. Pattern: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*` ## Request Body The request accepts the following binary data. ** [Body](#API_runtime_InvokeEndpoint_RequestSyntax) ** Provides input data, in the format specified in the `ContentType` request header. Amazon SageMaker AI passes all of the data in the body to the model. For information about the format of the request body, see [Common Data Formats-Inference](https://docs.aws.amazon.com/sagemaker/latest/dg/cdf-inference.html). Length Constraints: Maximum length of 6291456. Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-Type: ContentType x-Amzn-Invoked-Production-Variant: InvokedProductionVariant X-Amzn-SageMaker-Custom-Attributes: CustomAttributes X-Amzn-SageMaker-New-Session-Id: NewSessionId X-Amzn-SageMaker-Closed-Session-Id: ClosedSessionId Body ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The response returns the following HTTP headers. ** [ClosedSessionId](#API_runtime_InvokeEndpoint_ResponseSyntax) ** If you closed a stateful session with your request, the ID of that session. Length Constraints: Maximum length of 256. Pattern: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*$` ** [ContentType](#API_runtime_InvokeEndpoint_ResponseSyntax) ** The MIME type of the inference returned from the model container. Length Constraints: Maximum length of 1024. Pattern: `\p{ASCII}*` ** [CustomAttributes](#API_runtime_InvokeEndpoint_ResponseSyntax) ** Provides additional information in the response about the inference returned by a model hosted at an Amazon SageMaker AI endpoint. The information is an opaque value that is forwarded verbatim. You could use this value, for example, to return an ID received in the `CustomAttributes` header of a request or other metadata that a service endpoint was programmed to produce. The value must consist of no more than 1024 visible US-ASCII characters as specified in [Section 3.3.6. Field Value Components](https://tools.ietf.org/html/rfc7230#section-3.2.6) of the Hypertext Transfer Protocol (HTTP/1.1). If the customer wants the custom attribute returned, the model must set the custom attribute to be included on the way back. The code in your model is responsible for setting or updating any custom attributes in the response. If your code does not set this value in the response, an empty value is returned. For example, if a custom attribute represents the trace ID, your model can prepend the custom attribute with `Trace ID:` in your post-processing function. This feature is currently supported in the AWS SDKs but not in the Amazon SageMaker AI Python SDK. Length Constraints: Maximum length of 1024. Pattern: `\p{ASCII}*` ** [InvokedProductionVariant](#API_runtime_InvokeEndpoint_ResponseSyntax) ** Identifies the production variant that was invoked. Length Constraints: Maximum length of 1024. Pattern: `\p{ASCII}*` ** [NewSessionId](#API_runtime_InvokeEndpoint_ResponseSyntax) ** If you created a stateful session with your request, the ID and expiration time that the model assigns to that session. Length Constraints: Maximum length of 256. Pattern: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*;\sExpires=[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$` The response returns the following as the HTTP body. ** [Body](#API_runtime_InvokeEndpoint_ResponseSyntax) ** Includes the inference provided by the model. For information about the format of the response body, see [Common Data Formats-Inference](https://docs.aws.amazon.com/sagemaker/latest/dg/cdf-inference.html). If the explainer is activated, the body includes the explanations provided by the model. For more information, see the **Response section** under [Invoke the Endpoint](https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-invoke-endpoint.html#clarify-online-explainability-response) in the Developer Guide. Length Constraints: Maximum length of 6291456. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalDependencyException ** Your request caused an exception with an internal dependency. Contact customer support. HTTP Status Code: 530 ** InternalFailure ** An internal failure occurred. HTTP Status Code: 500 ** ModelError ** Model (owned by the customer in the container) returned 4xx or 5xx error code. ** LogStreamArn ** The Amazon Resource Name (ARN) of the log stream. ** OriginalMessage ** Original message. ** OriginalStatusCode ** Original status code. HTTP Status Code: 424 ** ModelNotReadyException ** Either a serverless endpoint variant's resources are still being provisioned, or a multi-model endpoint is still downloading or loading the target model. Wait and try your request again. HTTP Status Code: 429 ** ServiceUnavailable ** The service is unavailable. Try your call again. HTTP Status Code: 503 ** ValidationError ** Inspect your request and try again. HTTP Status Code: 400 ## Examples ### Pass a trace ID in the CustomAttribute of a request and return it in the CustomAttribute of the response. In this example a trace ID is passed to the service endpoint in the `CustomAttributes` header of the request and then retrieved and returned in the `CustomAttributes` header of the response. #### Sample Request ``` import boto3 client = boto3.client('sagemaker-runtime') custom_attributes = "c000b4f9-df62-4c85-a0bf-7c525f9104a4" # An example of a trace ID. endpoint_name = "..." # Your endpoint name. content_type = "..." # The MIME type of the input data in the request body. accept = "..." # The desired MIME type of the inference in the response. payload = "..." # Payload for inference. response = client.invoke_endpoint( EndpointName=endpoint_name, CustomAttributes=custom_attributes, ContentType=content_type, Accept=accept, Body=payload ) print(response['CustomAttributes']) # If model receives and updates the custom_attributes header # by adding "Trace id: " in front of custom_attributes in the request, # custom_attributes in response becomes # "Trace ID: c000b4f9-df62-4c85-a0bf-7c525f9104a4" ``` #### Sample Response ``` Trace ID: c000b4f9-df62-4c85-a0bf-7c525f9104a4 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/runtime.sagemaker-2017-05-13/InvokeEndpoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/runtime.sagemaker-2017-05-13/InvokeEndpoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.sagemaker-2017-05-13/InvokeEndpoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/runtime.sagemaker-2017-05-13/InvokeEndpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.sagemaker-2017-05-13/InvokeEndpoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/runtime.sagemaker-2017-05-13/InvokeEndpoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/runtime.sagemaker-2017-05-13/InvokeEndpoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/runtime.sagemaker-2017-05-13/InvokeEndpoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/runtime.sagemaker-2017-05-13/InvokeEndpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.sagemaker-2017-05-13/InvokeEndpoint) # InvokeEndpointAsync After you deploy a model into production using Amazon SageMaker AI hosting services, your client applications use this API to get inferences from the model hosted at the specified endpoint in an asynchronous manner. Inference requests sent to this API are enqueued for asynchronous processing. The processing of the inference request may or may not complete before you receive a response from this API. The response from this API will not contain the result of the inference request but contain information about where you can locate it. Amazon SageMaker AI strips all POST headers except those supported by the API. Amazon SageMaker AI might add additional headers. You should not rely on the behavior of headers outside those enumerated in the request syntax. Calls to `InvokeEndpointAsync` are authenticated by using AWS Signature Version 4. For information, see [Authenticating Requests (AWS Signature Version 4)](https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html) in the *Amazon S3 API Reference*. ## Request Syntax ``` POST /endpoints/EndpointName/async-invocations HTTP/1.1 X-Amzn-SageMaker-Content-Type: ContentType X-Amzn-SageMaker-Accept: Accept X-Amzn-SageMaker-Custom-Attributes: CustomAttributes X-Amzn-SageMaker-Inference-Id: InferenceId X-Amzn-SageMaker-InputLocation: InputLocation X-Amzn-SageMaker-RequestTTLSeconds: RequestTTLSeconds X-Amzn-SageMaker-InvocationTimeoutSeconds: InvocationTimeoutSeconds ``` ## URI Request Parameters The request uses the following URI parameters. ** [Accept](#API_runtime_InvokeEndpointAsync_RequestSyntax) ** The desired MIME type of the inference response from the model container. Length Constraints: Maximum length of 1024. Pattern: `\p{ASCII}*` ** [ContentType](#API_runtime_InvokeEndpointAsync_RequestSyntax) ** The MIME type of the input data in the request body. Length Constraints: Maximum length of 1024. Pattern: `\p{ASCII}*` ** [CustomAttributes](#API_runtime_InvokeEndpointAsync_RequestSyntax) ** Provides additional information about a request for an inference submitted to a model hosted at an Amazon SageMaker AI endpoint. The information is an opaque value that is forwarded verbatim. You could use this value, for example, to provide an ID that you can use to track a request or to provide other metadata that a service endpoint was programmed to process. The value must consist of no more than 1024 visible US-ASCII characters as specified in [Section 3.3.6. Field Value Components](https://datatracker.ietf.org/doc/html/rfc7230#section-3.2.6) of the Hypertext Transfer Protocol (HTTP/1.1). The code in your model is responsible for setting or updating any custom attributes in the response. If your code does not set this value in the response, an empty value is returned. For example, if a custom attribute represents the trace ID, your model can prepend the custom attribute with `Trace ID:` in your post-processing function. This feature is currently supported in the AWS SDKs but not in the Amazon SageMaker AI Python SDK. Length Constraints: Maximum length of 1024. Pattern: `\p{ASCII}*` ** [EndpointName](#API_runtime_InvokeEndpointAsync_RequestSyntax) ** The name of the endpoint that you specified when you created the endpoint using the [CreateEndpoint](https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpoint.html) API. Length Constraints: Maximum length of 63. Pattern: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*` Required: Yes ** [InferenceId](#API_runtime_InvokeEndpointAsync_RequestSyntax) ** The identifier for the inference request. Amazon SageMaker AI will generate an identifier for you if none is specified. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `\A\S[\p{Print}]*\z` ** [InputLocation](#API_runtime_InvokeEndpointAsync_RequestSyntax) ** The Amazon S3 URI where the inference request payload is stored. Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `^(https|s3)://([^/]+)/?(.*)$` Required: Yes ** [InvocationTimeoutSeconds](#API_runtime_InvokeEndpointAsync_RequestSyntax) ** Maximum amount of time in seconds a request can be processed before it is marked as expired. The default is 15 minutes, or 900 seconds. Valid Range: Minimum value of 1. Maximum value of 3600. ** [RequestTTLSeconds](#API_runtime_InvokeEndpointAsync_RequestSyntax) ** Maximum age in seconds a request can be in the queue before it is marked as expired. The default is 6 hours, or 21,600 seconds. Valid Range: Minimum value of 60. Maximum value of 21600. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 202 X-Amzn-SageMaker-OutputLocation: OutputLocation X-Amzn-SageMaker-FailureLocation: FailureLocation Content-type: application/json { "InferenceId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 202 response. The response returns the following HTTP headers. ** [FailureLocation](#API_runtime_InvokeEndpointAsync_ResponseSyntax) ** The Amazon S3 URI where the inference failure response payload is stored. Length Constraints: Maximum length of 1024. Pattern: `\p{ASCII}*` ** [OutputLocation](#API_runtime_InvokeEndpointAsync_ResponseSyntax) ** The Amazon S3 URI where the inference response payload is stored. Length Constraints: Maximum length of 1024. Pattern: `\p{ASCII}*` The following data is returned in JSON format by the service. ** [InferenceId](#API_runtime_InvokeEndpointAsync_ResponseSyntax) ** Identifier for an inference request. This will be the same as the `InferenceId` specified in the input. Amazon SageMaker AI will generate an identifier for you if you do not specify one. Type: String Length Constraints: Maximum length of 1024. Pattern: `\p{ASCII}*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalFailure ** An internal failure occurred. HTTP Status Code: 500 ** ServiceUnavailable ** The service is unavailable. Try your call again. HTTP Status Code: 503 ** ValidationError ** Inspect your request and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/runtime.sagemaker-2017-05-13/InvokeEndpointAsync) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/runtime.sagemaker-2017-05-13/InvokeEndpointAsync) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.sagemaker-2017-05-13/InvokeEndpointAsync) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/runtime.sagemaker-2017-05-13/InvokeEndpointAsync) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.sagemaker-2017-05-13/InvokeEndpointAsync) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/runtime.sagemaker-2017-05-13/InvokeEndpointAsync) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/runtime.sagemaker-2017-05-13/InvokeEndpointAsync) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/runtime.sagemaker-2017-05-13/InvokeEndpointAsync) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/runtime.sagemaker-2017-05-13/InvokeEndpointAsync) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.sagemaker-2017-05-13/InvokeEndpointAsync) # InvokeEndpointWithResponseStream Invokes a model at the specified endpoint to return the inference response as a stream. The inference stream provides the response payload incrementally as a series of parts. Before you can get an inference stream, you must have access to a model that's deployed using Amazon SageMaker AI hosting services, and the container for that model must support inference streaming. For more information that can help you use this API, see the following sections in the *Amazon SageMaker AI Developer Guide*: + For information about how to add streaming support to a model, see [How Containers Serve Requests](https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-inference-code.html#your-algorithms-inference-code-how-containe-serves-requests). + For information about how to process the streaming response, see [Invoke real-time endpoints](https://docs.aws.amazon.com/sagemaker/latest/dg/realtime-endpoints-test-endpoints.html). Before you can use this operation, your IAM permissions must allow the `sagemaker:InvokeEndpoint` action. For more information about Amazon SageMaker AI actions for IAM policies, see [Actions, resources, and condition keys for Amazon SageMaker AI](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonsagemaker.html) in the *IAM Service Authorization Reference*. Amazon SageMaker AI strips all POST headers except those supported by the API. Amazon SageMaker AI might add additional headers. You should not rely on the behavior of headers outside those enumerated in the request syntax. Calls to `InvokeEndpointWithResponseStream` are authenticated by using AWS Signature Version 4. For information, see [Authenticating Requests (AWS Signature Version 4)](https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html) in the *Amazon S3 API Reference*. ## Request Syntax ``` POST /endpoints/EndpointName/invocations-response-stream HTTP/1.1 Content-Type: ContentType X-Amzn-SageMaker-Accept: Accept X-Amzn-SageMaker-Custom-Attributes: CustomAttributes X-Amzn-SageMaker-Target-Variant: TargetVariant X-Amzn-SageMaker-Target-Container-Hostname: TargetContainerHostname X-Amzn-SageMaker-Inference-Id: InferenceId X-Amzn-SageMaker-Inference-Component: InferenceComponentName X-Amzn-SageMaker-Session-Id: SessionId Body ``` ## URI Request Parameters The request uses the following URI parameters. ** [Accept](#API_runtime_InvokeEndpointWithResponseStream_RequestSyntax) ** The desired MIME type of the inference response from the model container. Length Constraints: Maximum length of 1024. Pattern: `\p{ASCII}*` ** [ContentType](#API_runtime_InvokeEndpointWithResponseStream_RequestSyntax) ** The MIME type of the input data in the request body. Length Constraints: Maximum length of 1024. Pattern: `\p{ASCII}*` ** [CustomAttributes](#API_runtime_InvokeEndpointWithResponseStream_RequestSyntax) ** Provides additional information about a request for an inference submitted to a model hosted at an Amazon SageMaker AI endpoint. The information is an opaque value that is forwarded verbatim. You could use this value, for example, to provide an ID that you can use to track a request or to provide other metadata that a service endpoint was programmed to process. The value must consist of no more than 1024 visible US-ASCII characters as specified in [Section 3.3.6. Field Value Components](https://datatracker.ietf.org/doc/html/rfc7230#section-3.2.6) of the Hypertext Transfer Protocol (HTTP/1.1). The code in your model is responsible for setting or updating any custom attributes in the response. If your code does not set this value in the response, an empty value is returned. For example, if a custom attribute represents the trace ID, your model can prepend the custom attribute with `Trace ID:` in your post-processing function. This feature is currently supported in the AWS SDKs but not in the Amazon SageMaker AI Python SDK. Length Constraints: Maximum length of 1024. Pattern: `\p{ASCII}*` ** [EndpointName](#API_runtime_InvokeEndpointWithResponseStream_RequestSyntax) ** The name of the endpoint that you specified when you created the endpoint using the [CreateEndpoint](https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpoint.html) API. Length Constraints: Maximum length of 63. Pattern: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*` Required: Yes ** [InferenceComponentName](#API_runtime_InvokeEndpointWithResponseStream_RequestSyntax) ** If the endpoint hosts one or more inference components, this parameter specifies the name of inference component to invoke for a streaming response. Length Constraints: Maximum length of 63. Pattern: `^[a-zA-Z0-9]([\-a-zA-Z0-9]*[a-zA-Z0-9])?$` ** [InferenceId](#API_runtime_InvokeEndpointWithResponseStream_RequestSyntax) ** An identifier that you assign to your request. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `\A\S[\p{Print}]*\z` ** [SessionId](#API_runtime_InvokeEndpointWithResponseStream_RequestSyntax) ** The ID of a stateful session to handle your request. You can't create a stateful session by using the `InvokeEndpointWithResponseStream` action. Instead, you can create one by using the ` InvokeEndpoint ` action. In your request, you specify `NEW_SESSION` for the `SessionId` request parameter. The response to that request provides the session ID for the `NewSessionId` response parameter. Length Constraints: Maximum length of 256. Pattern: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*$` ** [TargetContainerHostname](#API_runtime_InvokeEndpointWithResponseStream_RequestSyntax) ** If the endpoint hosts multiple containers and is configured to use direct invocation, this parameter specifies the host name of the container to invoke. Length Constraints: Maximum length of 63. Pattern: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*` ** [TargetVariant](#API_runtime_InvokeEndpointWithResponseStream_RequestSyntax) ** Specify the production variant to send the inference request to when invoking an endpoint that is running two or more variants. Note that this parameter overrides the default behavior for the endpoint, which is to distribute the invocation traffic based on the variant weights. For information about how to use variant targeting to perform a/b testing, see [Test models in production](https://docs.aws.amazon.com/sagemaker/latest/dg/model-ab-testing.html) Length Constraints: Maximum length of 63. Pattern: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*` ## Request Body The request accepts the following binary data. ** [Body](#API_runtime_InvokeEndpointWithResponseStream_RequestSyntax) ** Provides input data, in the format specified in the `ContentType` request header. Amazon SageMaker AI passes all of the data in the body to the model. For information about the format of the request body, see [Common Data Formats-Inference](https://docs.aws.amazon.com/sagemaker/latest/dg/cdf-inference.html). Length Constraints: Maximum length of 6291456. Required: Yes ## Response Syntax ``` HTTP/1.1 200 X-Amzn-SageMaker-Content-Type: ContentType x-Amzn-Invoked-Production-Variant: InvokedProductionVariant X-Amzn-SageMaker-Custom-Attributes: CustomAttributes Content-type: application/json { "InternalStreamFailure": { }, "ModelStreamError": { }, "PayloadPart": { "Bytes": blob } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The response returns the following HTTP headers. ** [ContentType](#API_runtime_InvokeEndpointWithResponseStream_ResponseSyntax) ** The MIME type of the inference returned from the model container. Length Constraints: Maximum length of 1024. Pattern: `\p{ASCII}*` ** [CustomAttributes](#API_runtime_InvokeEndpointWithResponseStream_ResponseSyntax) ** Provides additional information in the response about the inference returned by a model hosted at an Amazon SageMaker AI endpoint. The information is an opaque value that is forwarded verbatim. You could use this value, for example, to return an ID received in the `CustomAttributes` header of a request or other metadata that a service endpoint was programmed to produce. The value must consist of no more than 1024 visible US-ASCII characters as specified in [Section 3.3.6. Field Value Components](https://tools.ietf.org/html/rfc7230#section-3.2.6) of the Hypertext Transfer Protocol (HTTP/1.1). If the customer wants the custom attribute returned, the model must set the custom attribute to be included on the way back. The code in your model is responsible for setting or updating any custom attributes in the response. If your code does not set this value in the response, an empty value is returned. For example, if a custom attribute represents the trace ID, your model can prepend the custom attribute with `Trace ID:` in your post-processing function. This feature is currently supported in the AWS SDKs but not in the Amazon SageMaker AI Python SDK. Length Constraints: Maximum length of 1024. Pattern: `\p{ASCII}*` ** [InvokedProductionVariant](#API_runtime_InvokeEndpointWithResponseStream_ResponseSyntax) ** Identifies the production variant that was invoked. Length Constraints: Maximum length of 1024. Pattern: `\p{ASCII}*` The following data is returned in JSON format by the service. ** [InternalStreamFailure](#API_runtime_InvokeEndpointWithResponseStream_ResponseSyntax) ** The stream processing failed because of an unknown error, exception or failure. Try your request again. Type: Exception HTTP Status Code: ** [ModelStreamError](#API_runtime_InvokeEndpointWithResponseStream_ResponseSyntax) ** An error occurred while streaming the response body. This error can have the following error codes: ModelInvocationTimeExceeded The model failed to finish sending the response within the timeout period allowed by Amazon SageMaker AI. StreamBroken The Transmission Control Protocol (TCP) connection between the client and the model was reset or closed. Type: Exception HTTP Status Code: ** [PayloadPart](#API_runtime_InvokeEndpointWithResponseStream_ResponseSyntax) ** A wrapper for pieces of the payload that's returned in response to a streaming inference request. A streaming inference response consists of one or more payload parts. Type: [PayloadPart](API_runtime_PayloadPart.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalFailure ** An internal failure occurred. HTTP Status Code: 500 ** InternalStreamFailure ** The stream processing failed because of an unknown error, exception or failure. Try your request again. HTTP Status Code: 500 ** ModelError ** Model (owned by the customer in the container) returned 4xx or 5xx error code. ** LogStreamArn ** The Amazon Resource Name (ARN) of the log stream. ** OriginalMessage ** Original message. ** OriginalStatusCode ** Original status code. HTTP Status Code: 424 ** ModelStreamError ** An error occurred while streaming the response body. This error can have the following error codes: ModelInvocationTimeExceeded The model failed to finish sending the response within the timeout period allowed by Amazon SageMaker AI. StreamBroken The Transmission Control Protocol (TCP) connection between the client and the model was reset or closed. ** ErrorCode ** This error can have the following error codes: ModelInvocationTimeExceeded The model failed to finish sending the response within the timeout period allowed by Amazon SageMaker AI. StreamBroken The Transmission Control Protocol (TCP) connection between the client and the model was reset or closed. HTTP Status Code: 400 ** ServiceUnavailable ** The service is unavailable. Try your call again. HTTP Status Code: 503 ** ValidationError ** Inspect your request and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/runtime.sagemaker-2017-05-13/InvokeEndpointWithResponseStream) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/runtime.sagemaker-2017-05-13/InvokeEndpointWithResponseStream) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.sagemaker-2017-05-13/InvokeEndpointWithResponseStream) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/runtime.sagemaker-2017-05-13/InvokeEndpointWithResponseStream) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.sagemaker-2017-05-13/InvokeEndpointWithResponseStream) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/runtime.sagemaker-2017-05-13/InvokeEndpointWithResponseStream) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/runtime.sagemaker-2017-05-13/InvokeEndpointWithResponseStream) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/runtime.sagemaker-2017-05-13/InvokeEndpointWithResponseStream) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/runtime.sagemaker-2017-05-13/InvokeEndpointWithResponseStream) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.sagemaker-2017-05-13/InvokeEndpointWithResponseStream) # Amazon Sagemaker Edge Manager The following actions are supported by Amazon Sagemaker Edge Manager: + [GetDeployments](API_edge_GetDeployments.md) + [GetDeviceRegistration](API_edge_GetDeviceRegistration.md) + [SendHeartbeat](API_edge_SendHeartbeat.md) # GetDeployments Use to get the active deployments from a device. ## Request Syntax ``` POST /GetDeployments HTTP/1.1 Content-type: application/json { "DeviceFleetName": "string", "DeviceName": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [DeviceFleetName](#API_edge_GetDeployments_RequestSyntax) ** The name of the fleet to which the device belongs. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z0-9](-*_*[a-zA-Z0-9])*$` Required: Yes ** [DeviceName](#API_edge_GetDeployments_RequestSyntax) ** The unique name of the device from which you want to get the configuration of active deployments. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z0-9](-*_*[a-zA-Z0-9])*$` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Deployments": [ { "Definitions": [ { "Checksum": { "Sum": "string", "Type": "string" }, "ModelHandle": "string", "S3Url": "string", "State": "string" } ], "DeploymentName": "string", "FailureHandlingPolicy": "string", "Type": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Deployments](#API_edge_GetDeployments_ResponseSyntax) ** Returns a list of the configurations of the active deployments on the device. Type: Array of [EdgeDeployment](API_edge_EdgeDeployment.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalServiceException ** An internal failure occurred. Try your request again. If the problem persists, contact AWS customer support. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-edge-2020-09-23/GetDeployments) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-edge-2020-09-23/GetDeployments) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-edge-2020-09-23/GetDeployments) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-edge-2020-09-23/GetDeployments) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-edge-2020-09-23/GetDeployments) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-edge-2020-09-23/GetDeployments) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-edge-2020-09-23/GetDeployments) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-edge-2020-09-23/GetDeployments) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-edge-2020-09-23/GetDeployments) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-edge-2020-09-23/GetDeployments) # GetDeviceRegistration Use to check if a device is registered with SageMaker Edge Manager. ## Request Syntax ``` POST /GetDeviceRegistration HTTP/1.1 Content-type: application/json { "DeviceFleetName": "string", "DeviceName": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [DeviceFleetName](#API_edge_GetDeviceRegistration_RequestSyntax) ** The name of the fleet to which the device belongs. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z0-9](-*_*[a-zA-Z0-9])*$` Required: Yes ** [DeviceName](#API_edge_GetDeviceRegistration_RequestSyntax) ** The unique name of the device from which you want to get the registration status. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z0-9](-*_*[a-zA-Z0-9])*$` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CacheTTL": "string", "DeviceRegistration": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CacheTTL](#API_edge_GetDeviceRegistration_ResponseSyntax) ** The amount of time, in seconds, that the registration status is stored on the device’s cache before it is refreshed. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. ** [DeviceRegistration](#API_edge_GetDeviceRegistration_ResponseSyntax) ** Describes if the device is currently registered with SageMaker Edge Manager. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalServiceException ** An internal failure occurred. Try your request again. If the problem persists, contact AWS customer support. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-edge-2020-09-23/GetDeviceRegistration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-edge-2020-09-23/GetDeviceRegistration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-edge-2020-09-23/GetDeviceRegistration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-edge-2020-09-23/GetDeviceRegistration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-edge-2020-09-23/GetDeviceRegistration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-edge-2020-09-23/GetDeviceRegistration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-edge-2020-09-23/GetDeviceRegistration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-edge-2020-09-23/GetDeviceRegistration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-edge-2020-09-23/GetDeviceRegistration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-edge-2020-09-23/GetDeviceRegistration) # SendHeartbeat Use to get the current status of devices registered on SageMaker Edge Manager. ## Request Syntax ``` POST /SendHeartbeat HTTP/1.1 Content-type: application/json { "AgentMetrics": [ { "Dimension": "string", "MetricName": "string", "Timestamp": number, "Value": number } ], "AgentVersion": "string", "DeploymentResult": { "DeploymentEndTime": number, "DeploymentModels": [ { "DesiredState": "string", "ModelHandle": "string", "ModelName": "string", "ModelVersion": "string", "RollbackFailureReason": "string", "State": "string", "Status": "string", "StatusReason": "string" } ], "DeploymentName": "string", "DeploymentStartTime": number, "DeploymentStatus": "string", "DeploymentStatusMessage": "string" }, "DeviceFleetName": "string", "DeviceName": "string", "Models": [ { "LatestInference": number, "LatestSampleTime": number, "ModelMetrics": [ { "Dimension": "string", "MetricName": "string", "Timestamp": number, "Value": number } ], "ModelName": "string", "ModelVersion": "string" } ] } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [AgentMetrics](#API_edge_SendHeartbeat_RequestSyntax) ** For internal use. Returns a list of SageMaker Edge Manager agent operating metrics. Type: Array of [EdgeMetric](API_edge_EdgeMetric.md) objects Required: No ** [AgentVersion](#API_edge_SendHeartbeat_RequestSyntax) ** Returns the version of the agent. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[a-zA-Z0-9\ \_\.]+` Required: Yes ** [DeploymentResult](#API_edge_SendHeartbeat_RequestSyntax) ** Returns the result of a deployment on the device. Type: [DeploymentResult](API_edge_DeploymentResult.md) object Required: No ** [DeviceFleetName](#API_edge_SendHeartbeat_RequestSyntax) ** The name of the fleet to which the device belongs. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z0-9](-*_*[a-zA-Z0-9])*$` Required: Yes ** [DeviceName](#API_edge_SendHeartbeat_RequestSyntax) ** The unique name of the device. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z0-9](-*_*[a-zA-Z0-9])*$` Required: Yes ** [Models](#API_edge_SendHeartbeat_RequestSyntax) ** Returns a list of models deployed on the the device. Type: Array of [Model](API_edge_Model.md) objects Required: No ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalServiceException ** An internal failure occurred. Try your request again. If the problem persists, contact AWS customer support. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-edge-2020-09-23/SendHeartbeat) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-edge-2020-09-23/SendHeartbeat) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-edge-2020-09-23/SendHeartbeat) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-edge-2020-09-23/SendHeartbeat) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-edge-2020-09-23/SendHeartbeat) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-edge-2020-09-23/SendHeartbeat) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-edge-2020-09-23/SendHeartbeat) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-edge-2020-09-23/SendHeartbeat) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-edge-2020-09-23/SendHeartbeat) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-edge-2020-09-23/SendHeartbeat) # Amazon SageMaker Feature Store Runtime The following actions are supported by Amazon SageMaker Feature Store Runtime: + [BatchGetRecord](API_feature_store_BatchGetRecord.md) + [DeleteRecord](API_feature_store_DeleteRecord.md) + [GetRecord](API_feature_store_GetRecord.md) + [PutRecord](API_feature_store_PutRecord.md) # BatchGetRecord Retrieves a batch of `Records` from a `FeatureGroup`. ## Request Syntax ``` POST /BatchGetRecord HTTP/1.1 Content-type: application/json { "ExpirationTimeResponse": "string", "Identifiers": [ { "FeatureGroupName": "string", "FeatureNames": [ "string" ], "RecordIdentifiersValueAsString": [ "string" ] } ] } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [ExpirationTimeResponse](#API_feature_store_BatchGetRecord_RequestSyntax) ** Parameter to request `ExpiresAt` in response. If `Enabled`, `BatchGetRecord` will return the value of `ExpiresAt`, if it is not null. If `Disabled` and null, `BatchGetRecord` will return null. Type: String Valid Values: `Enabled | Disabled` Required: No ** [Identifiers](#API_feature_store_BatchGetRecord_RequestSyntax) ** A list containing the name or Amazon Resource Name (ARN) of the `FeatureGroup`, the list of names of `Feature`s to be retrieved, and the corresponding `RecordIdentifier` values as strings. Type: Array of [BatchGetRecordIdentifier](API_feature_store_BatchGetRecordIdentifier.md) objects Array Members: Minimum number of 1 item. Maximum number of 100 items. Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Errors": [ { "ErrorCode": "string", "ErrorMessage": "string", "FeatureGroupName": "string", "RecordIdentifierValueAsString": "string" } ], "Records": [ { "ExpiresAt": "string", "FeatureGroupName": "string", "Record": [ { "FeatureName": "string", "ValueAsString": "string", "ValueAsStringList": [ "string" ] } ], "RecordIdentifierValueAsString": "string" } ], "UnprocessedIdentifiers": [ { "FeatureGroupName": "string", "FeatureNames": [ "string" ], "RecordIdentifiersValueAsString": [ "string" ] } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Errors](#API_feature_store_BatchGetRecord_ResponseSyntax) ** A list of errors that have occurred when retrieving a batch of Records. Type: Array of [BatchGetRecordError](API_feature_store_BatchGetRecordError.md) objects Array Members: Minimum number of 0 items. ** [Records](#API_feature_store_BatchGetRecord_ResponseSyntax) ** A list of Records you requested to be retrieved in batch. Type: Array of [BatchGetRecordResultDetail](API_feature_store_BatchGetRecordResultDetail.md) objects Array Members: Minimum number of 0 items. ** [UnprocessedIdentifiers](#API_feature_store_BatchGetRecord_ResponseSyntax) ** A unprocessed list of `FeatureGroup` names, with their corresponding `RecordIdentifier` value, and Feature name. Type: Array of [BatchGetRecordIdentifier](API_feature_store_BatchGetRecordIdentifier.md) objects Array Members: Minimum number of 0 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessForbidden ** You do not have permission to perform an action. HTTP Status Code: 403 ** InternalFailure ** An internal failure occurred. Try your request again. If the problem persists, contact AWS customer support. HTTP Status Code: 500 ** ServiceUnavailable ** The service is currently unavailable. HTTP Status Code: 503 ** ValidationError ** There was an error validating your request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-featurestore-runtime-2020-07-01/BatchGetRecord) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-featurestore-runtime-2020-07-01/BatchGetRecord) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-featurestore-runtime-2020-07-01/BatchGetRecord) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-featurestore-runtime-2020-07-01/BatchGetRecord) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-featurestore-runtime-2020-07-01/BatchGetRecord) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-featurestore-runtime-2020-07-01/BatchGetRecord) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-featurestore-runtime-2020-07-01/BatchGetRecord) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-featurestore-runtime-2020-07-01/BatchGetRecord) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-featurestore-runtime-2020-07-01/BatchGetRecord) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-featurestore-runtime-2020-07-01/BatchGetRecord) # DeleteRecord Deletes a `Record` from a `FeatureGroup` in the `OnlineStore`. Feature Store supports both `SoftDelete` and `HardDelete`. For `SoftDelete` (default), feature columns are set to `null` and the record is no longer retrievable by `GetRecord` or `BatchGetRecord`. For `HardDelete`, the complete `Record` is removed from the `OnlineStore`. In both cases, Feature Store appends the deleted record marker to the `OfflineStore`. The deleted record marker is a record with the same `RecordIdentifer` as the original, but with `is_deleted` value set to `True`, `EventTime` set to the delete input `EventTime`, and other feature values set to `null`. Note that the `EventTime` specified in `DeleteRecord` should be set later than the `EventTime` of the existing record in the `OnlineStore` for that `RecordIdentifer`. If it is not, the deletion does not occur: + For `SoftDelete`, the existing (not deleted) record remains in the `OnlineStore`, though the delete record marker is still written to the `OfflineStore`. + `HardDelete` returns `EventTime`: `400 ValidationException` to indicate that the delete operation failed. No delete record marker is written to the `OfflineStore`. When a record is deleted from the `OnlineStore`, the deleted record marker is appended to the `OfflineStore`. If you have the Iceberg table format enabled for your `OfflineStore`, you can remove all history of a record from the `OfflineStore` using Amazon Athena or Apache Spark. For information on how to hard delete a record from the `OfflineStore` with the Iceberg table format enabled, see [Delete records from the offline store](https://docs.aws.amazon.com/sagemaker/latest/dg/feature-store-delete-records.html#feature-store-delete-records-offline-store). ## Request Syntax ``` DELETE /FeatureGroup/FeatureGroupName?DeletionMode=DeletionMode&EventTime=EventTime&RecordIdentifierValueAsString=RecordIdentifierValueAsString&TargetStores=TargetStores HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DeletionMode](#API_feature_store_DeleteRecord_RequestSyntax) ** The name of the deletion mode for deleting the record. By default, the deletion mode is set to `SoftDelete`. Valid Values: `SoftDelete | HardDelete` ** [EventTime](#API_feature_store_DeleteRecord_RequestSyntax) ** Timestamp indicating when the deletion event occurred. `EventTime` can be used to query data at a certain point in time. Length Constraints: Maximum length of 358400. Pattern: `.*` Required: Yes ** [FeatureGroupName](#API_feature_store_DeleteRecord_RequestSyntax) ** The name or Amazon Resource Name (ARN) of the feature group to delete the record from. Length Constraints: Minimum length of 1. Maximum length of 150. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:feature-group/)?([a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63})` Required: Yes ** [RecordIdentifierValueAsString](#API_feature_store_DeleteRecord_RequestSyntax) ** The value for the `RecordIdentifier` that uniquely identifies the record, in string format. Length Constraints: Maximum length of 358400. Pattern: `.*` Required: Yes ** [TargetStores](#API_feature_store_DeleteRecord_RequestSyntax) ** A list of stores from which you're deleting the record. By default, Feature Store deletes the record from all of the stores that you're using for the `FeatureGroup`. Array Members: Minimum number of 1 item. Maximum number of 2 items. Valid Values: `OnlineStore | OfflineStore` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessForbidden ** You do not have permission to perform an action. HTTP Status Code: 403 ** InternalFailure ** An internal failure occurred. Try your request again. If the problem persists, contact AWS customer support. HTTP Status Code: 500 ** ServiceUnavailable ** The service is currently unavailable. HTTP Status Code: 503 ** ValidationError ** There was an error validating your request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-featurestore-runtime-2020-07-01/DeleteRecord) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-featurestore-runtime-2020-07-01/DeleteRecord) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-featurestore-runtime-2020-07-01/DeleteRecord) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-featurestore-runtime-2020-07-01/DeleteRecord) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-featurestore-runtime-2020-07-01/DeleteRecord) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-featurestore-runtime-2020-07-01/DeleteRecord) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-featurestore-runtime-2020-07-01/DeleteRecord) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-featurestore-runtime-2020-07-01/DeleteRecord) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-featurestore-runtime-2020-07-01/DeleteRecord) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-featurestore-runtime-2020-07-01/DeleteRecord) # GetRecord Use for `OnlineStore` serving from a `FeatureStore`. Only the latest records stored in the `OnlineStore` can be retrieved. If no Record with `RecordIdentifierValue` is found, then an empty result is returned. ## Request Syntax ``` GET /FeatureGroup/FeatureGroupName?ExpirationTimeResponse=ExpirationTimeResponse&FeatureName=FeatureNames&RecordIdentifierValueAsString=RecordIdentifierValueAsString HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [ExpirationTimeResponse](#API_feature_store_GetRecord_RequestSyntax) ** Parameter to request `ExpiresAt` in response. If `Enabled`, `GetRecord` will return the value of `ExpiresAt`, if it is not null. If `Disabled` and null, `GetRecord` will return null. Valid Values: `Enabled | Disabled` ** [FeatureGroupName](#API_feature_store_GetRecord_RequestSyntax) ** The name or Amazon Resource Name (ARN) of the feature group from which you want to retrieve a record. Length Constraints: Minimum length of 1. Maximum length of 150. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:feature-group/)?([a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63})` Required: Yes ** [FeatureNames](#API_feature_store_GetRecord_RequestSyntax) ** List of names of Features to be retrieved. If not specified, the latest value for all the Features are returned. Array Members: Minimum number of 1 item. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63}` ** [RecordIdentifierValueAsString](#API_feature_store_GetRecord_RequestSyntax) ** The value that corresponds to `RecordIdentifier` type and uniquely identifies the record in the `FeatureGroup`. Length Constraints: Maximum length of 358400. Pattern: `.*` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "ExpiresAt": "string", "Record": [ { "FeatureName": "string", "ValueAsString": "string", "ValueAsStringList": [ "string" ] } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ExpiresAt](#API_feature_store_GetRecord_ResponseSyntax) ** The `ExpiresAt` ISO string of the requested record. Type: String ** [Record](#API_feature_store_GetRecord_ResponseSyntax) ** The record you requested. A list of `FeatureValues`. Type: Array of [FeatureValue](API_feature_store_FeatureValue.md) objects Array Members: Minimum number of 1 item. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessForbidden ** You do not have permission to perform an action. HTTP Status Code: 403 ** InternalFailure ** An internal failure occurred. Try your request again. If the problem persists, contact AWS customer support. HTTP Status Code: 500 ** ResourceNotFound ** A resource that is required to perform an action was not found. HTTP Status Code: 404 ** ServiceUnavailable ** The service is currently unavailable. HTTP Status Code: 503 ** ValidationError ** There was an error validating your request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-featurestore-runtime-2020-07-01/GetRecord) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-featurestore-runtime-2020-07-01/GetRecord) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-featurestore-runtime-2020-07-01/GetRecord) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-featurestore-runtime-2020-07-01/GetRecord) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-featurestore-runtime-2020-07-01/GetRecord) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-featurestore-runtime-2020-07-01/GetRecord) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-featurestore-runtime-2020-07-01/GetRecord) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-featurestore-runtime-2020-07-01/GetRecord) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-featurestore-runtime-2020-07-01/GetRecord) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-featurestore-runtime-2020-07-01/GetRecord) # PutRecord The `PutRecord` API is used to ingest a list of `Records` into your feature group. If a new record’s `EventTime` is greater, the new record is written to both the `OnlineStore` and `OfflineStore`. Otherwise, the record is a historic record and it is written only to the `OfflineStore`. You can specify the ingestion to be applied to the `OnlineStore`, `OfflineStore`, or both by using the `TargetStores` request parameter. You can set the ingested record to expire at a given time to live (TTL) duration after the record’s event time, `ExpiresAt` = `EventTime` \$1 `TtlDuration`, by specifying the `TtlDuration` parameter. A record level `TtlDuration` is set when specifying the `TtlDuration` parameter using the `PutRecord` API call. If the input `TtlDuration` is `null` or unspecified, `TtlDuration` is set to the default feature group level `TtlDuration`. A record level `TtlDuration` supersedes the group level `TtlDuration`. ## Request Syntax ``` PUT /FeatureGroup/FeatureGroupName HTTP/1.1 Content-type: application/json { "Record": [ { "FeatureName": "string", "ValueAsString": "string", "ValueAsStringList": [ "string" ] } ], "TargetStores": [ "string" ], "TtlDuration": { "Unit": "string", "Value": number } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [FeatureGroupName](#API_feature_store_PutRecord_RequestSyntax) ** The name or Amazon Resource Name (ARN) of the feature group that you want to insert the record into. Length Constraints: Minimum length of 1. Maximum length of 150. Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:feature-group/)?([a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63})` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [Record](#API_feature_store_PutRecord_RequestSyntax) ** List of FeatureValues to be inserted. This will be a full over-write. If you only want to update few of the feature values, do the following: + Use `GetRecord` to retrieve the latest record. + Update the record returned from `GetRecord`. + Use `PutRecord` to update feature values. Type: Array of [FeatureValue](API_feature_store_FeatureValue.md) objects Array Members: Minimum number of 1 item. Required: Yes ** [TargetStores](#API_feature_store_PutRecord_RequestSyntax) ** A list of stores to which you're adding the record. By default, Feature Store adds the record to all of the stores that you're using for the `FeatureGroup`. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 2 items. Valid Values: `OnlineStore | OfflineStore` Required: No ** [TtlDuration](#API_feature_store_PutRecord_RequestSyntax) ** Time to live duration, where the record is hard deleted after the expiration time is reached; `ExpiresAt` = `EventTime` \$1 `TtlDuration`. For information on HardDelete, see the [DeleteRecord](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_feature_store_DeleteRecord.html) API in the Amazon SageMaker API Reference guide. Type: [TtlDuration](API_feature_store_TtlDuration.md) object Required: No ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessForbidden ** You do not have permission to perform an action. HTTP Status Code: 403 ** InternalFailure ** An internal failure occurred. Try your request again. If the problem persists, contact AWS customer support. HTTP Status Code: 500 ** ServiceUnavailable ** The service is currently unavailable. HTTP Status Code: 503 ** ValidationError ** There was an error validating your request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-featurestore-runtime-2020-07-01/PutRecord) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-featurestore-runtime-2020-07-01/PutRecord) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-featurestore-runtime-2020-07-01/PutRecord) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-featurestore-runtime-2020-07-01/PutRecord) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-featurestore-runtime-2020-07-01/PutRecord) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-featurestore-runtime-2020-07-01/PutRecord) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-featurestore-runtime-2020-07-01/PutRecord) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-featurestore-runtime-2020-07-01/PutRecord) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-featurestore-runtime-2020-07-01/PutRecord) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-featurestore-runtime-2020-07-01/PutRecord) # Amazon SageMaker geospatial capabilities The following actions are supported by Amazon SageMaker geospatial capabilities: + [DeleteEarthObservationJob](API_geospatial_DeleteEarthObservationJob.md) + [DeleteVectorEnrichmentJob](API_geospatial_DeleteVectorEnrichmentJob.md) + [ExportEarthObservationJob](API_geospatial_ExportEarthObservationJob.md) + [ExportVectorEnrichmentJob](API_geospatial_ExportVectorEnrichmentJob.md) + [GetEarthObservationJob](API_geospatial_GetEarthObservationJob.md) + [GetRasterDataCollection](API_geospatial_GetRasterDataCollection.md) + [GetTile](API_geospatial_GetTile.md) + [GetVectorEnrichmentJob](API_geospatial_GetVectorEnrichmentJob.md) + [ListEarthObservationJobs](API_geospatial_ListEarthObservationJobs.md) + [ListRasterDataCollections](API_geospatial_ListRasterDataCollections.md) + [ListTagsForResource](API_geospatial_ListTagsForResource.md) + [ListVectorEnrichmentJobs](API_geospatial_ListVectorEnrichmentJobs.md) + [SearchRasterDataCollection](API_geospatial_SearchRasterDataCollection.md) + [StartEarthObservationJob](API_geospatial_StartEarthObservationJob.md) + [StartVectorEnrichmentJob](API_geospatial_StartVectorEnrichmentJob.md) + [StopEarthObservationJob](API_geospatial_StopEarthObservationJob.md) + [StopVectorEnrichmentJob](API_geospatial_StopVectorEnrichmentJob.md) + [TagResource](API_geospatial_TagResource.md) + [UntagResource](API_geospatial_UntagResource.md) # DeleteEarthObservationJob Use this operation to delete an Earth Observation job. ## Request Syntax ``` DELETE /earth-observation-jobs/Arn HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [Arn](#API_geospatial_DeleteEarthObservationJob_RequestSyntax) ** The Amazon Resource Name (ARN) of the Earth Observation job being deleted. Pattern: `arn:aws[a-z-]{0,12}:sagemaker-geospatial:[a-z0-9-]{1,25}:[0-9]{12}:earth-observation-job/[a-z0-9]{12,}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. ** ResourceId ** Identifier of the resource affected. HTTP Status Code: 409 ** InternalServerException ** The request processing has failed because of an unknown error, exception, or failure. ** ResourceId ** HTTP Status Code: 500 ** ResourceNotFoundException ** The request references a resource which does not exist. ** ResourceId ** Identifier of the resource that was not found. HTTP Status Code: 404 ** ThrottlingException ** The request was denied due to request throttling. ** ResourceId ** HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the constraints specified by an AWS service. ** ResourceId ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-geospatial-2020-05-27/DeleteEarthObservationJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-geospatial-2020-05-27/DeleteEarthObservationJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-geospatial-2020-05-27/DeleteEarthObservationJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-geospatial-2020-05-27/DeleteEarthObservationJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-geospatial-2020-05-27/DeleteEarthObservationJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-geospatial-2020-05-27/DeleteEarthObservationJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-geospatial-2020-05-27/DeleteEarthObservationJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-geospatial-2020-05-27/DeleteEarthObservationJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-geospatial-2020-05-27/DeleteEarthObservationJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-geospatial-2020-05-27/DeleteEarthObservationJob) # DeleteVectorEnrichmentJob Use this operation to delete a Vector Enrichment job. ## Request Syntax ``` DELETE /vector-enrichment-jobs/Arn HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [Arn](#API_geospatial_DeleteVectorEnrichmentJob_RequestSyntax) ** The Amazon Resource Name (ARN) of the Vector Enrichment job being deleted. Pattern: `arn:aws[a-z-]{0,12}:sagemaker-geospatial:[a-z0-9-]{1,25}:[0-9]{12}:vector-enrichment-job/[a-z0-9]{12,}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. ** ResourceId ** Identifier of the resource affected. HTTP Status Code: 409 ** InternalServerException ** The request processing has failed because of an unknown error, exception, or failure. ** ResourceId ** HTTP Status Code: 500 ** ResourceNotFoundException ** The request references a resource which does not exist. ** ResourceId ** Identifier of the resource that was not found. HTTP Status Code: 404 ** ThrottlingException ** The request was denied due to request throttling. ** ResourceId ** HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the constraints specified by an AWS service. ** ResourceId ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-geospatial-2020-05-27/DeleteVectorEnrichmentJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-geospatial-2020-05-27/DeleteVectorEnrichmentJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-geospatial-2020-05-27/DeleteVectorEnrichmentJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-geospatial-2020-05-27/DeleteVectorEnrichmentJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-geospatial-2020-05-27/DeleteVectorEnrichmentJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-geospatial-2020-05-27/DeleteVectorEnrichmentJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-geospatial-2020-05-27/DeleteVectorEnrichmentJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-geospatial-2020-05-27/DeleteVectorEnrichmentJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-geospatial-2020-05-27/DeleteVectorEnrichmentJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-geospatial-2020-05-27/DeleteVectorEnrichmentJob) # ExportEarthObservationJob Use this operation to export results of an Earth Observation job and optionally source images used as input to the EOJ to an Amazon S3 location. ## Request Syntax ``` POST /export-earth-observation-job HTTP/1.1 Content-type: application/json { "Arn": "string", "ClientToken": "string", "ExecutionRoleArn": "string", "ExportSourceImages": boolean, "OutputConfig": { "S3Data": { "KmsKeyId": "string", "S3Uri": "string" } } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [Arn](#API_geospatial_ExportEarthObservationJob_RequestSyntax) ** The input Amazon Resource Name (ARN) of the Earth Observation job being exported. Type: String Pattern: `arn:aws[a-z-]{0,12}:sagemaker-geospatial:[a-z0-9-]{1,25}:[0-9]{12}:earth-observation-job/[a-z0-9]{12,}` Required: Yes ** [ClientToken](#API_geospatial_ExportEarthObservationJob_RequestSyntax) ** A unique token that guarantees that the call to this API is idempotent. Type: String Length Constraints: Minimum length of 36. Maximum length of 64. Required: No ** [ExecutionRoleArn](#API_geospatial_ExportEarthObservationJob_RequestSyntax) ** The Amazon Resource Name (ARN) of the IAM role that you specified for the job. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:(aws[a-z-]*):iam::([0-9]{12}):role/[a-zA-Z0-9+=,.@_/-]+` Required: Yes ** [ExportSourceImages](#API_geospatial_ExportEarthObservationJob_RequestSyntax) ** The source images provided to the Earth Observation job being exported. Type: Boolean Required: No ** [OutputConfig](#API_geospatial_ExportEarthObservationJob_RequestSyntax) ** An object containing information about the output file. Type: [OutputConfigInput](API_geospatial_OutputConfigInput.md) object Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Arn": "string", "CreationTime": "string", "ExecutionRoleArn": "string", "ExportSourceImages": boolean, "ExportStatus": "string", "OutputConfig": { "S3Data": { "KmsKeyId": "string", "S3Uri": "string" } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Arn](#API_geospatial_ExportEarthObservationJob_ResponseSyntax) ** The output Amazon Resource Name (ARN) of the Earth Observation job being exported. Type: String Pattern: `arn:aws[a-z-]{0,12}:sagemaker-geospatial:[a-z0-9-]{1,25}:[0-9]{12}:earth-observation-job/[a-z0-9]{12,}` ** [CreationTime](#API_geospatial_ExportEarthObservationJob_ResponseSyntax) ** The creation time. Type: Timestamp ** [ExecutionRoleArn](#API_geospatial_ExportEarthObservationJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the IAM role that you specified for the job. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:(aws[a-z-]*):iam::([0-9]{12}):role/[a-zA-Z0-9+=,.@_/-]+` ** [ExportSourceImages](#API_geospatial_ExportEarthObservationJob_ResponseSyntax) ** The source images provided to the Earth Observation job being exported. Type: Boolean ** [ExportStatus](#API_geospatial_ExportEarthObservationJob_ResponseSyntax) ** The status of the results of the Earth Observation job being exported. Type: String Valid Values: `IN_PROGRESS | SUCCEEDED | FAILED` ** [OutputConfig](#API_geospatial_ExportEarthObservationJob_ResponseSyntax) ** An object containing information about the output file. Type: [OutputConfigInput](API_geospatial_OutputConfigInput.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. ** ResourceId ** Identifier of the resource affected. HTTP Status Code: 409 ** InternalServerException ** The request processing has failed because of an unknown error, exception, or failure. ** ResourceId ** HTTP Status Code: 500 ** ResourceNotFoundException ** The request references a resource which does not exist. ** ResourceId ** Identifier of the resource that was not found. HTTP Status Code: 404 ** ServiceQuotaExceededException ** You have exceeded the service quota. ** ResourceId ** Identifier of the resource affected. HTTP Status Code: 402 ** ThrottlingException ** The request was denied due to request throttling. ** ResourceId ** HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the constraints specified by an AWS service. ** ResourceId ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-geospatial-2020-05-27/ExportEarthObservationJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-geospatial-2020-05-27/ExportEarthObservationJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-geospatial-2020-05-27/ExportEarthObservationJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-geospatial-2020-05-27/ExportEarthObservationJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-geospatial-2020-05-27/ExportEarthObservationJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-geospatial-2020-05-27/ExportEarthObservationJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-geospatial-2020-05-27/ExportEarthObservationJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-geospatial-2020-05-27/ExportEarthObservationJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-geospatial-2020-05-27/ExportEarthObservationJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-geospatial-2020-05-27/ExportEarthObservationJob) # ExportVectorEnrichmentJob Use this operation to copy results of a Vector Enrichment job to an Amazon S3 location. ## Request Syntax ``` POST /export-vector-enrichment-jobs HTTP/1.1 Content-type: application/json { "Arn": "string", "ClientToken": "string", "ExecutionRoleArn": "string", "OutputConfig": { "S3Data": { "KmsKeyId": "string", "S3Uri": "string" } } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [Arn](#API_geospatial_ExportVectorEnrichmentJob_RequestSyntax) ** The Amazon Resource Name (ARN) of the Vector Enrichment job. Type: String Pattern: `arn:aws[a-z-]{0,12}:sagemaker-geospatial:[a-z0-9-]{1,25}:[0-9]{12}:vector-enrichment-job/[a-z0-9]{12,}` Required: Yes ** [ClientToken](#API_geospatial_ExportVectorEnrichmentJob_RequestSyntax) ** A unique token that guarantees that the call to this API is idempotent. Type: String Length Constraints: Minimum length of 36. Maximum length of 64. Required: No ** [ExecutionRoleArn](#API_geospatial_ExportVectorEnrichmentJob_RequestSyntax) ** The Amazon Resource Name (ARN) of the IAM rolewith permission to upload to the location in OutputConfig. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:(aws[a-z-]*):iam::([0-9]{12}):role/[a-zA-Z0-9+=,.@_/-]+` Required: Yes ** [OutputConfig](#API_geospatial_ExportVectorEnrichmentJob_RequestSyntax) ** Output location information for exporting Vector Enrichment Job results. Type: [ExportVectorEnrichmentJobOutputConfig](API_geospatial_ExportVectorEnrichmentJobOutputConfig.md) object Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Arn": "string", "CreationTime": "string", "ExecutionRoleArn": "string", "ExportStatus": "string", "OutputConfig": { "S3Data": { "KmsKeyId": "string", "S3Uri": "string" } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Arn](#API_geospatial_ExportVectorEnrichmentJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the Vector Enrichment job being exported. Type: String Pattern: `arn:aws[a-z-]{0,12}:sagemaker-geospatial:[a-z0-9-]{1,25}:[0-9]{12}:vector-enrichment-job/[a-z0-9]{12,}` ** [CreationTime](#API_geospatial_ExportVectorEnrichmentJob_ResponseSyntax) ** The creation time. Type: Timestamp ** [ExecutionRoleArn](#API_geospatial_ExportVectorEnrichmentJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the IAM role with permission to upload to the location in OutputConfig. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:(aws[a-z-]*):iam::([0-9]{12}):role/[a-zA-Z0-9+=,.@_/-]+` ** [ExportStatus](#API_geospatial_ExportVectorEnrichmentJob_ResponseSyntax) ** The status of the results the Vector Enrichment job being exported. Type: String Valid Values: `IN_PROGRESS | SUCCEEDED | FAILED` ** [OutputConfig](#API_geospatial_ExportVectorEnrichmentJob_ResponseSyntax) ** Output location information for exporting Vector Enrichment Job results. Type: [ExportVectorEnrichmentJobOutputConfig](API_geospatial_ExportVectorEnrichmentJobOutputConfig.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. ** ResourceId ** Identifier of the resource affected. HTTP Status Code: 409 ** InternalServerException ** The request processing has failed because of an unknown error, exception, or failure. ** ResourceId ** HTTP Status Code: 500 ** ResourceNotFoundException ** The request references a resource which does not exist. ** ResourceId ** Identifier of the resource that was not found. HTTP Status Code: 404 ** ServiceQuotaExceededException ** You have exceeded the service quota. ** ResourceId ** Identifier of the resource affected. HTTP Status Code: 402 ** ThrottlingException ** The request was denied due to request throttling. ** ResourceId ** HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the constraints specified by an AWS service. ** ResourceId ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-geospatial-2020-05-27/ExportVectorEnrichmentJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-geospatial-2020-05-27/ExportVectorEnrichmentJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-geospatial-2020-05-27/ExportVectorEnrichmentJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-geospatial-2020-05-27/ExportVectorEnrichmentJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-geospatial-2020-05-27/ExportVectorEnrichmentJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-geospatial-2020-05-27/ExportVectorEnrichmentJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-geospatial-2020-05-27/ExportVectorEnrichmentJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-geospatial-2020-05-27/ExportVectorEnrichmentJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-geospatial-2020-05-27/ExportVectorEnrichmentJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-geospatial-2020-05-27/ExportVectorEnrichmentJob) # GetEarthObservationJob Get the details for a previously initiated Earth Observation job. ## Request Syntax ``` GET /earth-observation-jobs/Arn HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [Arn](#API_geospatial_GetEarthObservationJob_RequestSyntax) ** The Amazon Resource Name (ARN) of the Earth Observation job. Pattern: `arn:aws[a-z-]{0,12}:sagemaker-geospatial:[a-z0-9-]{1,25}:[0-9]{12}:earth-observation-job/[a-z0-9]{12,}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Arn": "string", "CreationTime": "string", "DurationInSeconds": number, "ErrorDetails": { "Message": "string", "Type": "string" }, "ExecutionRoleArn": "string", "ExportErrorDetails": { "ExportResults": { "Message": "string", "Type": "string" }, "ExportSourceImages": { "Message": "string", "Type": "string" } }, "ExportStatus": "string", "InputConfig": { "PreviousEarthObservationJobArn": "string", "RasterDataCollectionQuery": { "AreaOfInterest": { ... }, "PropertyFilters": { "LogicalOperator": "string", "Properties": [ { "Property": { ... } } ] }, "RasterDataCollectionArn": "string", "RasterDataCollectionName": "string", "TimeRangeFilter": { "EndTime": "string", "StartTime": "string" } } }, "JobConfig": { ... }, "KmsKeyId": "string", "Name": "string", "OutputBands": [ { "BandName": "string", "OutputDataType": "string" } ], "Status": "string", "Tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Arn](#API_geospatial_GetEarthObservationJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the Earth Observation job. Type: String ** [CreationTime](#API_geospatial_GetEarthObservationJob_ResponseSyntax) ** The creation time of the initiated Earth Observation job. Type: Timestamp ** [DurationInSeconds](#API_geospatial_GetEarthObservationJob_ResponseSyntax) ** The duration of Earth Observation job, in seconds. Type: Integer ** [ErrorDetails](#API_geospatial_GetEarthObservationJob_ResponseSyntax) ** Details about the errors generated during the Earth Observation job. Type: [EarthObservationJobErrorDetails](API_geospatial_EarthObservationJobErrorDetails.md) object ** [ExecutionRoleArn](#API_geospatial_GetEarthObservationJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the IAM role that you specified for the job. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:(aws[a-z-]*):iam::([0-9]{12}):role/[a-zA-Z0-9+=,.@_/-]+` ** [ExportErrorDetails](#API_geospatial_GetEarthObservationJob_ResponseSyntax) ** Details about the errors generated during ExportEarthObservationJob. Type: [ExportErrorDetails](API_geospatial_ExportErrorDetails.md) object ** [ExportStatus](#API_geospatial_GetEarthObservationJob_ResponseSyntax) ** The status of the Earth Observation job. Type: String Valid Values: `IN_PROGRESS | SUCCEEDED | FAILED` ** [InputConfig](#API_geospatial_GetEarthObservationJob_ResponseSyntax) ** Input data for the Earth Observation job. Type: [InputConfigOutput](API_geospatial_InputConfigOutput.md) object ** [JobConfig](#API_geospatial_GetEarthObservationJob_ResponseSyntax) ** An object containing information about the job configuration. Type: [JobConfigInput](API_geospatial_JobConfigInput.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. ** [KmsKeyId](#API_geospatial_GetEarthObservationJob_ResponseSyntax) ** The Key Management Service key ID for server-side encryption. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. ** [Name](#API_geospatial_GetEarthObservationJob_ResponseSyntax) ** The name of the Earth Observation job. Type: String ** [OutputBands](#API_geospatial_GetEarthObservationJob_ResponseSyntax) ** Bands available in the output of an operation. Type: Array of [OutputBand](API_geospatial_OutputBand.md) objects ** [Status](#API_geospatial_GetEarthObservationJob_ResponseSyntax) ** The status of a previously initiated Earth Observation job. Type: String Valid Values: `INITIALIZING | IN_PROGRESS | STOPPING | COMPLETED | STOPPED | FAILED | DELETING | DELETED` ** [Tags](#API_geospatial_GetEarthObservationJob_ResponseSyntax) ** Each tag consists of a key and a value. Type: String to string map ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** InternalServerException ** The request processing has failed because of an unknown error, exception, or failure. ** ResourceId ** HTTP Status Code: 500 ** ResourceNotFoundException ** The request references a resource which does not exist. ** ResourceId ** Identifier of the resource that was not found. HTTP Status Code: 404 ** ThrottlingException ** The request was denied due to request throttling. ** ResourceId ** HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the constraints specified by an AWS service. ** ResourceId ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-geospatial-2020-05-27/GetEarthObservationJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-geospatial-2020-05-27/GetEarthObservationJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-geospatial-2020-05-27/GetEarthObservationJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-geospatial-2020-05-27/GetEarthObservationJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-geospatial-2020-05-27/GetEarthObservationJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-geospatial-2020-05-27/GetEarthObservationJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-geospatial-2020-05-27/GetEarthObservationJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-geospatial-2020-05-27/GetEarthObservationJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-geospatial-2020-05-27/GetEarthObservationJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-geospatial-2020-05-27/GetEarthObservationJob) # GetRasterDataCollection Use this operation to get details of a specific raster data collection. ## Request Syntax ``` GET /raster-data-collection/Arn HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [Arn](#API_geospatial_GetRasterDataCollection_RequestSyntax) ** The Amazon Resource Name (ARN) of the raster data collection. Pattern: `arn:aws[a-z-]{0,12}:sagemaker-geospatial:[a-z0-9-]{1,25}:[0-9]{12}:raster-data-collection/(public|premium|user)/[a-z0-9]{12,}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Arn": "string", "Description": "string", "DescriptionPageUrl": "string", "ImageSourceBands": [ "string" ], "Name": "string", "SupportedFilters": [ { "Maximum": number, "Minimum": number, "Name": "string", "Type": "string" } ], "Tags": { "string" : "string" }, "Type": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Arn](#API_geospatial_GetRasterDataCollection_ResponseSyntax) ** The Amazon Resource Name (ARN) of the raster data collection. Type: String Pattern: `arn:aws[a-z-]{0,12}:sagemaker-geospatial:[a-z0-9-]{1,25}:[0-9]{12}:raster-data-collection/(public|premium|user)/[a-z0-9]{12,}` ** [Description](#API_geospatial_GetRasterDataCollection_ResponseSyntax) ** A description of the raster data collection. Type: String ** [DescriptionPageUrl](#API_geospatial_GetRasterDataCollection_ResponseSyntax) ** The URL of the description page. Type: String ** [ImageSourceBands](#API_geospatial_GetRasterDataCollection_ResponseSyntax) ** The list of image source bands in the raster data collection. Type: Array of strings ** [Name](#API_geospatial_GetRasterDataCollection_ResponseSyntax) ** The name of the raster data collection. Type: String ** [SupportedFilters](#API_geospatial_GetRasterDataCollection_ResponseSyntax) ** The filters supported by the raster data collection. Type: Array of [Filter](API_geospatial_Filter.md) objects ** [Tags](#API_geospatial_GetRasterDataCollection_ResponseSyntax) ** Each tag consists of a key and a value. Type: String to string map ** [Type](#API_geospatial_GetRasterDataCollection_ResponseSyntax) ** The raster data collection type. Type: String Valid Values: `PUBLIC | PREMIUM | USER` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** InternalServerException ** The request processing has failed because of an unknown error, exception, or failure. ** ResourceId ** HTTP Status Code: 500 ** ResourceNotFoundException ** The request references a resource which does not exist. ** ResourceId ** Identifier of the resource that was not found. HTTP Status Code: 404 ** ThrottlingException ** The request was denied due to request throttling. ** ResourceId ** HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the constraints specified by an AWS service. ** ResourceId ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-geospatial-2020-05-27/GetRasterDataCollection) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-geospatial-2020-05-27/GetRasterDataCollection) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-geospatial-2020-05-27/GetRasterDataCollection) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-geospatial-2020-05-27/GetRasterDataCollection) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-geospatial-2020-05-27/GetRasterDataCollection) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-geospatial-2020-05-27/GetRasterDataCollection) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-geospatial-2020-05-27/GetRasterDataCollection) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-geospatial-2020-05-27/GetRasterDataCollection) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-geospatial-2020-05-27/GetRasterDataCollection) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-geospatial-2020-05-27/GetRasterDataCollection) # GetTile Gets a web mercator tile for the given Earth Observation job. ## Request Syntax ``` GET /tile/z/x/y?Arn=Arn&ExecutionRoleArn=ExecutionRoleArn&ImageAssets=ImageAssets&ImageMask=ImageMask&OutputDataType=OutputDataType&OutputFormat=OutputFormat&PropertyFilters=PropertyFilters&Target=Target&TimeRangeFilter=TimeRangeFilter HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [Arn](#API_geospatial_GetTile_RequestSyntax) ** The Amazon Resource Name (ARN) of the tile operation. Pattern: `arn:aws[a-z-]{0,12}:sagemaker-geospatial:[a-z0-9-]{1,25}:[0-9]{12}:earth-observation-job/[a-z0-9]{12,}` Required: Yes ** [ExecutionRoleArn](#API_geospatial_GetTile_RequestSyntax) ** The Amazon Resource Name (ARN) of the IAM role that you specify. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:(aws[a-z-]*):iam::([0-9]{12}):role/[a-zA-Z0-9+=,.@_/-]+` ** [ImageAssets](#API_geospatial_GetTile_RequestSyntax) ** The particular assets or bands to tile. Array Members: Minimum number of 1 item. Required: Yes ** [ImageMask](#API_geospatial_GetTile_RequestSyntax) ** Determines whether or not to return a valid data mask. ** [OutputDataType](#API_geospatial_GetTile_RequestSyntax) ** The output data type of the tile operation. Valid Values: `INT32 | FLOAT32 | INT16 | FLOAT64 | UINT16` ** [OutputFormat](#API_geospatial_GetTile_RequestSyntax) ** The data format of the output tile. The formats include .npy, .png and .jpg. ** [PropertyFilters](#API_geospatial_GetTile_RequestSyntax) ** Property filters for the imagery to tile. ** [Target](#API_geospatial_GetTile_RequestSyntax) ** Determines what part of the Earth Observation job to tile. 'INPUT' or 'OUTPUT' are the valid options. Valid Values: `INPUT | OUTPUT` Required: Yes ** [TimeRangeFilter](#API_geospatial_GetTile_RequestSyntax) ** Time range filter applied to imagery to find the images to tile. ** [x](#API_geospatial_GetTile_RequestSyntax) ** The x coordinate of the tile input. Required: Yes ** [y](#API_geospatial_GetTile_RequestSyntax) ** The y coordinate of the tile input. Required: Yes ** [z](#API_geospatial_GetTile_RequestSyntax) ** The z coordinate of the tile input. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 BinaryFile ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The response returns the following as the HTTP body. ** [BinaryFile](#API_geospatial_GetTile_ResponseSyntax) ** The output binary file. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** InternalServerException ** The request processing has failed because of an unknown error, exception, or failure. ** ResourceId ** HTTP Status Code: 500 ** ResourceNotFoundException ** The request references a resource which does not exist. ** ResourceId ** Identifier of the resource that was not found. HTTP Status Code: 404 ** ThrottlingException ** The request was denied due to request throttling. ** ResourceId ** HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the constraints specified by an AWS service. ** ResourceId ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-geospatial-2020-05-27/GetTile) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-geospatial-2020-05-27/GetTile) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-geospatial-2020-05-27/GetTile) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-geospatial-2020-05-27/GetTile) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-geospatial-2020-05-27/GetTile) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-geospatial-2020-05-27/GetTile) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-geospatial-2020-05-27/GetTile) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-geospatial-2020-05-27/GetTile) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-geospatial-2020-05-27/GetTile) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-geospatial-2020-05-27/GetTile) # GetVectorEnrichmentJob Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN). ## Request Syntax ``` GET /vector-enrichment-jobs/Arn HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [Arn](#API_geospatial_GetVectorEnrichmentJob_RequestSyntax) ** The Amazon Resource Name (ARN) of the Vector Enrichment job. Pattern: `arn:aws[a-z-]{0,12}:sagemaker-geospatial:[a-z0-9-]{1,25}:[0-9]{12}:vector-enrichment-job/[a-z0-9]{12,}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Arn": "string", "CreationTime": "string", "DurationInSeconds": number, "ErrorDetails": { "ErrorMessage": "string", "ErrorType": "string" }, "ExecutionRoleArn": "string", "ExportErrorDetails": { "Message": "string", "Type": "string" }, "ExportStatus": "string", "InputConfig": { "DataSourceConfig": { ... }, "DocumentType": "string" }, "JobConfig": { ... }, "KmsKeyId": "string", "Name": "string", "Status": "string", "Tags": { "string" : "string" }, "Type": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Arn](#API_geospatial_GetVectorEnrichmentJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the Vector Enrichment job. Type: String ** [CreationTime](#API_geospatial_GetVectorEnrichmentJob_ResponseSyntax) ** The creation time. Type: Timestamp ** [DurationInSeconds](#API_geospatial_GetVectorEnrichmentJob_ResponseSyntax) ** The duration of the Vector Enrichment job, in seconds. Type: Integer ** [ErrorDetails](#API_geospatial_GetVectorEnrichmentJob_ResponseSyntax) ** Details about the errors generated during the Vector Enrichment job. Type: [VectorEnrichmentJobErrorDetails](API_geospatial_VectorEnrichmentJobErrorDetails.md) object ** [ExecutionRoleArn](#API_geospatial_GetVectorEnrichmentJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the IAM role that you specified for the job. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:(aws[a-z-]*):iam::([0-9]{12}):role/[a-zA-Z0-9+=,.@_/-]+` ** [ExportErrorDetails](#API_geospatial_GetVectorEnrichmentJob_ResponseSyntax) ** Details about the errors generated during the ExportVectorEnrichmentJob. Type: [VectorEnrichmentJobExportErrorDetails](API_geospatial_VectorEnrichmentJobExportErrorDetails.md) object ** [ExportStatus](#API_geospatial_GetVectorEnrichmentJob_ResponseSyntax) ** The export status of the Vector Enrichment job being initiated. Type: String Valid Values: `IN_PROGRESS | SUCCEEDED | FAILED` ** [InputConfig](#API_geospatial_GetVectorEnrichmentJob_ResponseSyntax) ** Input configuration information for the Vector Enrichment job. Type: [VectorEnrichmentJobInputConfig](API_geospatial_VectorEnrichmentJobInputConfig.md) object ** [JobConfig](#API_geospatial_GetVectorEnrichmentJob_ResponseSyntax) ** An object containing information about the job configuration. Type: [VectorEnrichmentJobConfig](API_geospatial_VectorEnrichmentJobConfig.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. ** [KmsKeyId](#API_geospatial_GetVectorEnrichmentJob_ResponseSyntax) ** The Key Management Service key ID for server-side encryption. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. ** [Name](#API_geospatial_GetVectorEnrichmentJob_ResponseSyntax) ** The name of the Vector Enrichment job. Type: String ** [Status](#API_geospatial_GetVectorEnrichmentJob_ResponseSyntax) ** The status of the initiated Vector Enrichment job. Type: String Valid Values: `INITIALIZING | IN_PROGRESS | STOPPING | STOPPED | COMPLETED | FAILED | DELETING | DELETED` ** [Tags](#API_geospatial_GetVectorEnrichmentJob_ResponseSyntax) ** Each tag consists of a key and a value. Type: String to string map ** [Type](#API_geospatial_GetVectorEnrichmentJob_ResponseSyntax) ** The type of the Vector Enrichment job being initiated. Type: String Valid Values: `REVERSE_GEOCODING | MAP_MATCHING` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** InternalServerException ** The request processing has failed because of an unknown error, exception, or failure. ** ResourceId ** HTTP Status Code: 500 ** ResourceNotFoundException ** The request references a resource which does not exist. ** ResourceId ** Identifier of the resource that was not found. HTTP Status Code: 404 ** ThrottlingException ** The request was denied due to request throttling. ** ResourceId ** HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the constraints specified by an AWS service. ** ResourceId ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-geospatial-2020-05-27/GetVectorEnrichmentJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-geospatial-2020-05-27/GetVectorEnrichmentJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-geospatial-2020-05-27/GetVectorEnrichmentJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-geospatial-2020-05-27/GetVectorEnrichmentJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-geospatial-2020-05-27/GetVectorEnrichmentJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-geospatial-2020-05-27/GetVectorEnrichmentJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-geospatial-2020-05-27/GetVectorEnrichmentJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-geospatial-2020-05-27/GetVectorEnrichmentJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-geospatial-2020-05-27/GetVectorEnrichmentJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-geospatial-2020-05-27/GetVectorEnrichmentJob) # ListEarthObservationJobs Use this operation to get a list of the Earth Observation jobs associated with the calling AWS account. ## Request Syntax ``` POST /list-earth-observation-jobs HTTP/1.1 Content-type: application/json { "MaxResults": number, "NextToken": "string", "SortBy": "string", "SortOrder": "string", "StatusEquals": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [MaxResults](#API_geospatial_ListEarthObservationJobs_RequestSyntax) ** The total number of items to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 20. Required: No ** [NextToken](#API_geospatial_ListEarthObservationJobs_RequestSyntax) ** If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Required: No ** [SortBy](#API_geospatial_ListEarthObservationJobs_RequestSyntax) ** The parameter by which to sort the results. Type: String Required: No ** [SortOrder](#API_geospatial_ListEarthObservationJobs_RequestSyntax) ** An optional value that specifies whether you want the results sorted in `Ascending` or `Descending` order. Type: String Valid Values: `ASCENDING | DESCENDING` Required: No ** [StatusEquals](#API_geospatial_ListEarthObservationJobs_RequestSyntax) ** A filter that retrieves only jobs with a specific status. Type: String Valid Values: `INITIALIZING | IN_PROGRESS | STOPPING | COMPLETED | STOPPED | FAILED | DELETING | DELETED` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "EarthObservationJobSummaries": [ { "Arn": "string", "CreationTime": "string", "DurationInSeconds": number, "Name": "string", "OperationType": "string", "Status": "string", "Tags": { "string" : "string" } } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [EarthObservationJobSummaries](#API_geospatial_ListEarthObservationJobs_ResponseSyntax) ** Contains summary information about the Earth Observation jobs. Type: Array of [ListEarthObservationJobOutputConfig](API_geospatial_ListEarthObservationJobOutputConfig.md) objects ** [NextToken](#API_geospatial_ListEarthObservationJobs_ResponseSyntax) ** If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** InternalServerException ** The request processing has failed because of an unknown error, exception, or failure. ** ResourceId ** HTTP Status Code: 500 ** ResourceNotFoundException ** The request references a resource which does not exist. ** ResourceId ** Identifier of the resource that was not found. HTTP Status Code: 404 ** ThrottlingException ** The request was denied due to request throttling. ** ResourceId ** HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the constraints specified by an AWS service. ** ResourceId ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-geospatial-2020-05-27/ListEarthObservationJobs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-geospatial-2020-05-27/ListEarthObservationJobs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-geospatial-2020-05-27/ListEarthObservationJobs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-geospatial-2020-05-27/ListEarthObservationJobs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-geospatial-2020-05-27/ListEarthObservationJobs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-geospatial-2020-05-27/ListEarthObservationJobs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-geospatial-2020-05-27/ListEarthObservationJobs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-geospatial-2020-05-27/ListEarthObservationJobs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-geospatial-2020-05-27/ListEarthObservationJobs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-geospatial-2020-05-27/ListEarthObservationJobs) # ListRasterDataCollections Use this operation to get raster data collections. ## Request Syntax ``` GET /raster-data-collections?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [MaxResults](#API_geospatial_ListRasterDataCollections_RequestSyntax) ** The total number of items to return. Valid Range: Minimum value of 1. Maximum value of 20. ** [NextToken](#API_geospatial_ListRasterDataCollections_RequestSyntax) ** If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results. Length Constraints: Minimum length of 0. Maximum length of 8192. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "RasterDataCollectionSummaries": [ { "Arn": "string", "Description": "string", "DescriptionPageUrl": "string", "Name": "string", "SupportedFilters": [ { "Maximum": number, "Minimum": number, "Name": "string", "Type": "string" } ], "Tags": { "string" : "string" }, "Type": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_geospatial_ListRasterDataCollections_ResponseSyntax) ** If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. ** [RasterDataCollectionSummaries](#API_geospatial_ListRasterDataCollections_ResponseSyntax) ** Contains summary information about the raster data collection. Type: Array of [RasterDataCollectionMetadata](API_geospatial_RasterDataCollectionMetadata.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** InternalServerException ** The request processing has failed because of an unknown error, exception, or failure. ** ResourceId ** HTTP Status Code: 500 ** ResourceNotFoundException ** The request references a resource which does not exist. ** ResourceId ** Identifier of the resource that was not found. HTTP Status Code: 404 ** ThrottlingException ** The request was denied due to request throttling. ** ResourceId ** HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the constraints specified by an AWS service. ** ResourceId ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-geospatial-2020-05-27/ListRasterDataCollections) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-geospatial-2020-05-27/ListRasterDataCollections) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-geospatial-2020-05-27/ListRasterDataCollections) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-geospatial-2020-05-27/ListRasterDataCollections) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-geospatial-2020-05-27/ListRasterDataCollections) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-geospatial-2020-05-27/ListRasterDataCollections) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-geospatial-2020-05-27/ListRasterDataCollections) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-geospatial-2020-05-27/ListRasterDataCollections) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-geospatial-2020-05-27/ListRasterDataCollections) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-geospatial-2020-05-27/ListRasterDataCollections) # ListTagsForResource Lists the tags attached to the resource. ## Request Syntax ``` GET /tags/ResourceArn HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [ResourceArn](#API_geospatial_ListTagsForResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the resource you want to tag. Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Tags](#API_geospatial_ListTagsForResource_ResponseSyntax) ** Each tag consists of a key and a value. Type: String to string map ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** InternalServerException ** The request processing has failed because of an unknown error, exception, or failure. ** ResourceId ** HTTP Status Code: 500 ** ResourceNotFoundException ** The request references a resource which does not exist. ** ResourceId ** Identifier of the resource that was not found. HTTP Status Code: 404 ** ThrottlingException ** The request was denied due to request throttling. ** ResourceId ** HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the constraints specified by an AWS service. ** ResourceId ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-geospatial-2020-05-27/ListTagsForResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-geospatial-2020-05-27/ListTagsForResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-geospatial-2020-05-27/ListTagsForResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-geospatial-2020-05-27/ListTagsForResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-geospatial-2020-05-27/ListTagsForResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-geospatial-2020-05-27/ListTagsForResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-geospatial-2020-05-27/ListTagsForResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-geospatial-2020-05-27/ListTagsForResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-geospatial-2020-05-27/ListTagsForResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-geospatial-2020-05-27/ListTagsForResource) # ListVectorEnrichmentJobs Retrieves a list of vector enrichment jobs. ## Request Syntax ``` POST /list-vector-enrichment-jobs HTTP/1.1 Content-type: application/json { "MaxResults": number, "NextToken": "string", "SortBy": "string", "SortOrder": "string", "StatusEquals": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [MaxResults](#API_geospatial_ListVectorEnrichmentJobs_RequestSyntax) ** The maximum number of items to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 20. Required: No ** [NextToken](#API_geospatial_ListVectorEnrichmentJobs_RequestSyntax) ** If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Required: No ** [SortBy](#API_geospatial_ListVectorEnrichmentJobs_RequestSyntax) ** The parameter by which to sort the results. Type: String Required: No ** [SortOrder](#API_geospatial_ListVectorEnrichmentJobs_RequestSyntax) ** An optional value that specifies whether you want the results sorted in `Ascending` or `Descending` order. Type: String Valid Values: `ASCENDING | DESCENDING` Required: No ** [StatusEquals](#API_geospatial_ListVectorEnrichmentJobs_RequestSyntax) ** A filter that retrieves only jobs with a specific status. Type: String Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "VectorEnrichmentJobSummaries": [ { "Arn": "string", "CreationTime": "string", "DurationInSeconds": number, "Name": "string", "Status": "string", "Tags": { "string" : "string" }, "Type": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_geospatial_ListVectorEnrichmentJobs_ResponseSyntax) ** If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. ** [VectorEnrichmentJobSummaries](#API_geospatial_ListVectorEnrichmentJobs_ResponseSyntax) ** Contains summary information about the Vector Enrichment jobs. Type: Array of [ListVectorEnrichmentJobOutputConfig](API_geospatial_ListVectorEnrichmentJobOutputConfig.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** InternalServerException ** The request processing has failed because of an unknown error, exception, or failure. ** ResourceId ** HTTP Status Code: 500 ** ResourceNotFoundException ** The request references a resource which does not exist. ** ResourceId ** Identifier of the resource that was not found. HTTP Status Code: 404 ** ThrottlingException ** The request was denied due to request throttling. ** ResourceId ** HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the constraints specified by an AWS service. ** ResourceId ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-geospatial-2020-05-27/ListVectorEnrichmentJobs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-geospatial-2020-05-27/ListVectorEnrichmentJobs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-geospatial-2020-05-27/ListVectorEnrichmentJobs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-geospatial-2020-05-27/ListVectorEnrichmentJobs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-geospatial-2020-05-27/ListVectorEnrichmentJobs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-geospatial-2020-05-27/ListVectorEnrichmentJobs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-geospatial-2020-05-27/ListVectorEnrichmentJobs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-geospatial-2020-05-27/ListVectorEnrichmentJobs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-geospatial-2020-05-27/ListVectorEnrichmentJobs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-geospatial-2020-05-27/ListVectorEnrichmentJobs) # SearchRasterDataCollection Allows you run image query on a specific raster data collection to get a list of the satellite imagery matching the selected filters. ## Request Syntax ``` POST /search-raster-data-collection HTTP/1.1 Content-type: application/json { "Arn": "string", "NextToken": "string", "RasterDataCollectionQuery": { "AreaOfInterest": { ... }, "BandFilter": [ "string" ], "PropertyFilters": { "LogicalOperator": "string", "Properties": [ { "Property": { ... } } ] }, "TimeRangeFilter": { "EndTime": number, "StartTime": number } } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [Arn](#API_geospatial_SearchRasterDataCollection_RequestSyntax) ** The Amazon Resource Name (ARN) of the raster data collection. Type: String Pattern: `arn:aws[a-z-]{0,12}:sagemaker-geospatial:[a-z0-9-]{1,25}:[0-9]{12}:raster-data-collection/(public|premium|user)/[a-z0-9]{12,}` Required: Yes ** [NextToken](#API_geospatial_SearchRasterDataCollection_RequestSyntax) ** If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. Required: No ** [RasterDataCollectionQuery](#API_geospatial_SearchRasterDataCollection_RequestSyntax) ** RasterDataCollectionQuery consisting of [AreaOfInterest(AOI)](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_geospatial_AreaOfInterest.html), [PropertyFilters](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_geospatial_PropertyFilter.html) and [TimeRangeFilterInput](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_geospatial_TimeRangeFilterInput.html) used in [SearchRasterDataCollection](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_geospatial_SearchRasterDataCollection.html). Type: [RasterDataCollectionQueryWithBandFilterInput](API_geospatial_RasterDataCollectionQueryWithBandFilterInput.md) object Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "ApproximateResultCount": number, "Items": [ { "Assets": { "string" : { "Href": "string" } }, "DateTime": number, "Geometry": { "Coordinates": [ [ [ number ] ] ], "Type": "string" }, "Id": "string", "Properties": { "EoCloudCover": number, "LandsatCloudCoverLand": number, "Platform": "string", "ViewOffNadir": number, "ViewSunAzimuth": number, "ViewSunElevation": number } } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ApproximateResultCount](#API_geospatial_SearchRasterDataCollection_ResponseSyntax) ** Approximate number of results in the response. Type: Integer ** [Items](#API_geospatial_SearchRasterDataCollection_ResponseSyntax) ** List of items matching the Raster DataCollectionQuery. Type: Array of [ItemSource](API_geospatial_ItemSource.md) objects ** [NextToken](#API_geospatial_SearchRasterDataCollection_ResponseSyntax) ** If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results. Type: String Length Constraints: Minimum length of 0. Maximum length of 8192. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** InternalServerException ** The request processing has failed because of an unknown error, exception, or failure. ** ResourceId ** HTTP Status Code: 500 ** ResourceNotFoundException ** The request references a resource which does not exist. ** ResourceId ** Identifier of the resource that was not found. HTTP Status Code: 404 ** ThrottlingException ** The request was denied due to request throttling. ** ResourceId ** HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the constraints specified by an AWS service. ** ResourceId ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-geospatial-2020-05-27/SearchRasterDataCollection) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-geospatial-2020-05-27/SearchRasterDataCollection) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-geospatial-2020-05-27/SearchRasterDataCollection) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-geospatial-2020-05-27/SearchRasterDataCollection) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-geospatial-2020-05-27/SearchRasterDataCollection) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-geospatial-2020-05-27/SearchRasterDataCollection) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-geospatial-2020-05-27/SearchRasterDataCollection) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-geospatial-2020-05-27/SearchRasterDataCollection) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-geospatial-2020-05-27/SearchRasterDataCollection) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-geospatial-2020-05-27/SearchRasterDataCollection) # StartEarthObservationJob Use this operation to create an Earth observation job. ## Request Syntax ``` POST /earth-observation-jobs HTTP/1.1 Content-type: application/json { "ClientToken": "string", "ExecutionRoleArn": "string", "InputConfig": { "PreviousEarthObservationJobArn": "string", "RasterDataCollectionQuery": { "AreaOfInterest": { ... }, "PropertyFilters": { "LogicalOperator": "string", "Properties": [ { "Property": { ... } } ] }, "RasterDataCollectionArn": "string", "TimeRangeFilter": { "EndTime": number, "StartTime": number } } }, "JobConfig": { ... }, "KmsKeyId": "string", "Name": "string", "Tags": { "string" : "string" } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [ClientToken](#API_geospatial_StartEarthObservationJob_RequestSyntax) ** A unique token that guarantees that the call to this API is idempotent. Type: String Length Constraints: Minimum length of 36. Maximum length of 64. Required: No ** [ExecutionRoleArn](#API_geospatial_StartEarthObservationJob_RequestSyntax) ** The Amazon Resource Name (ARN) of the IAM role that you specified for the job. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:(aws[a-z-]*):iam::([0-9]{12}):role/[a-zA-Z0-9+=,.@_/-]+` Required: Yes ** [InputConfig](#API_geospatial_StartEarthObservationJob_RequestSyntax) ** Input configuration information for the Earth Observation job. Type: [InputConfigInput](API_geospatial_InputConfigInput.md) object Required: Yes ** [JobConfig](#API_geospatial_StartEarthObservationJob_RequestSyntax) ** An object containing information about the job configuration. Type: [JobConfigInput](API_geospatial_JobConfigInput.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: Yes ** [KmsKeyId](#API_geospatial_StartEarthObservationJob_RequestSyntax) ** The Key Management Service key ID for server-side encryption. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Required: No ** [Name](#API_geospatial_StartEarthObservationJob_RequestSyntax) ** The name of the Earth Observation job. Type: String Length Constraints: Minimum length of 0. Maximum length of 200. Required: Yes ** [Tags](#API_geospatial_StartEarthObservationJob_RequestSyntax) ** Each tag consists of a key and a value. Type: String to string map Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Arn": "string", "CreationTime": "string", "DurationInSeconds": number, "ExecutionRoleArn": "string", "InputConfig": { "PreviousEarthObservationJobArn": "string", "RasterDataCollectionQuery": { "AreaOfInterest": { ... }, "PropertyFilters": { "LogicalOperator": "string", "Properties": [ { "Property": { ... } } ] }, "RasterDataCollectionArn": "string", "RasterDataCollectionName": "string", "TimeRangeFilter": { "EndTime": "string", "StartTime": "string" } } }, "JobConfig": { ... }, "KmsKeyId": "string", "Name": "string", "Status": "string", "Tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Arn](#API_geospatial_StartEarthObservationJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the Earth Observation job. Type: String ** [CreationTime](#API_geospatial_StartEarthObservationJob_ResponseSyntax) ** The creation time. Type: Timestamp ** [DurationInSeconds](#API_geospatial_StartEarthObservationJob_ResponseSyntax) ** The duration of the session, in seconds. Type: Integer ** [ExecutionRoleArn](#API_geospatial_StartEarthObservationJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the IAM role that you specified for the job. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:(aws[a-z-]*):iam::([0-9]{12}):role/[a-zA-Z0-9+=,.@_/-]+` ** [InputConfig](#API_geospatial_StartEarthObservationJob_ResponseSyntax) ** Input configuration information for the Earth Observation job. Type: [InputConfigOutput](API_geospatial_InputConfigOutput.md) object ** [JobConfig](#API_geospatial_StartEarthObservationJob_ResponseSyntax) ** An object containing information about the job configuration. Type: [JobConfigInput](API_geospatial_JobConfigInput.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. ** [KmsKeyId](#API_geospatial_StartEarthObservationJob_ResponseSyntax) ** The Key Management Service key ID for server-side encryption. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. ** [Name](#API_geospatial_StartEarthObservationJob_ResponseSyntax) ** The name of the Earth Observation job. Type: String ** [Status](#API_geospatial_StartEarthObservationJob_ResponseSyntax) ** The status of the Earth Observation job. Type: String Valid Values: `INITIALIZING | IN_PROGRESS | STOPPING | COMPLETED | STOPPED | FAILED | DELETING | DELETED` ** [Tags](#API_geospatial_StartEarthObservationJob_ResponseSyntax) ** Each tag consists of a key and a value. Type: String to string map ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. ** ResourceId ** Identifier of the resource affected. HTTP Status Code: 409 ** InternalServerException ** The request processing has failed because of an unknown error, exception, or failure. ** ResourceId ** HTTP Status Code: 500 ** ResourceNotFoundException ** The request references a resource which does not exist. ** ResourceId ** Identifier of the resource that was not found. HTTP Status Code: 404 ** ServiceQuotaExceededException ** You have exceeded the service quota. ** ResourceId ** Identifier of the resource affected. HTTP Status Code: 402 ** ThrottlingException ** The request was denied due to request throttling. ** ResourceId ** HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the constraints specified by an AWS service. ** ResourceId ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-geospatial-2020-05-27/StartEarthObservationJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-geospatial-2020-05-27/StartEarthObservationJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-geospatial-2020-05-27/StartEarthObservationJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-geospatial-2020-05-27/StartEarthObservationJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-geospatial-2020-05-27/StartEarthObservationJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-geospatial-2020-05-27/StartEarthObservationJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-geospatial-2020-05-27/StartEarthObservationJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-geospatial-2020-05-27/StartEarthObservationJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-geospatial-2020-05-27/StartEarthObservationJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-geospatial-2020-05-27/StartEarthObservationJob) # StartVectorEnrichmentJob Creates a Vector Enrichment job for the supplied job type. Currently, there are two supported job types: reverse geocoding and map matching. ## Request Syntax ``` POST /vector-enrichment-jobs HTTP/1.1 Content-type: application/json { "ClientToken": "string", "ExecutionRoleArn": "string", "InputConfig": { "DataSourceConfig": { ... }, "DocumentType": "string" }, "JobConfig": { ... }, "KmsKeyId": "string", "Name": "string", "Tags": { "string" : "string" } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [ClientToken](#API_geospatial_StartVectorEnrichmentJob_RequestSyntax) ** A unique token that guarantees that the call to this API is idempotent. Type: String Length Constraints: Minimum length of 36. Maximum length of 64. Required: No ** [ExecutionRoleArn](#API_geospatial_StartVectorEnrichmentJob_RequestSyntax) ** The Amazon Resource Name (ARN) of the IAM role that you specified for the job. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:(aws[a-z-]*):iam::([0-9]{12}):role/[a-zA-Z0-9+=,.@_/-]+` Required: Yes ** [InputConfig](#API_geospatial_StartVectorEnrichmentJob_RequestSyntax) ** Input configuration information for the Vector Enrichment job. Type: [VectorEnrichmentJobInputConfig](API_geospatial_VectorEnrichmentJobInputConfig.md) object Required: Yes ** [JobConfig](#API_geospatial_StartVectorEnrichmentJob_RequestSyntax) ** An object containing information about the job configuration. Type: [VectorEnrichmentJobConfig](API_geospatial_VectorEnrichmentJobConfig.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: Yes ** [KmsKeyId](#API_geospatial_StartVectorEnrichmentJob_RequestSyntax) ** The Key Management Service key ID for server-side encryption. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Required: No ** [Name](#API_geospatial_StartVectorEnrichmentJob_RequestSyntax) ** The name of the Vector Enrichment job. Type: String Length Constraints: Minimum length of 0. Maximum length of 200. Required: Yes ** [Tags](#API_geospatial_StartVectorEnrichmentJob_RequestSyntax) ** Each tag consists of a key and a value. Type: String to string map Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Arn": "string", "CreationTime": "string", "DurationInSeconds": number, "ExecutionRoleArn": "string", "InputConfig": { "DataSourceConfig": { ... }, "DocumentType": "string" }, "JobConfig": { ... }, "KmsKeyId": "string", "Name": "string", "Status": "string", "Tags": { "string" : "string" }, "Type": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Arn](#API_geospatial_StartVectorEnrichmentJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the Vector Enrichment job. Type: String Pattern: `arn:aws[a-z-]{0,12}:sagemaker-geospatial:[a-z0-9-]{1,25}:[0-9]{12}:vector-enrichment-job/[a-z0-9]{12,}` ** [CreationTime](#API_geospatial_StartVectorEnrichmentJob_ResponseSyntax) ** The creation time. Type: Timestamp ** [DurationInSeconds](#API_geospatial_StartVectorEnrichmentJob_ResponseSyntax) ** The duration of the Vector Enrichment job, in seconds. Type: Integer ** [ExecutionRoleArn](#API_geospatial_StartVectorEnrichmentJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the IAM role that you specified for the job. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:(aws[a-z-]*):iam::([0-9]{12}):role/[a-zA-Z0-9+=,.@_/-]+` ** [InputConfig](#API_geospatial_StartVectorEnrichmentJob_ResponseSyntax) ** Input configuration information for starting the Vector Enrichment job. Type: [VectorEnrichmentJobInputConfig](API_geospatial_VectorEnrichmentJobInputConfig.md) object ** [JobConfig](#API_geospatial_StartVectorEnrichmentJob_ResponseSyntax) ** An object containing information about the job configuration. Type: [VectorEnrichmentJobConfig](API_geospatial_VectorEnrichmentJobConfig.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. ** [KmsKeyId](#API_geospatial_StartVectorEnrichmentJob_ResponseSyntax) ** The Key Management Service key ID for server-side encryption. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. ** [Name](#API_geospatial_StartVectorEnrichmentJob_ResponseSyntax) ** The name of the Vector Enrichment job. Type: String ** [Status](#API_geospatial_StartVectorEnrichmentJob_ResponseSyntax) ** The status of the Vector Enrichment job being started. Type: String Valid Values: `INITIALIZING | IN_PROGRESS | STOPPING | STOPPED | COMPLETED | FAILED | DELETING | DELETED` ** [Tags](#API_geospatial_StartVectorEnrichmentJob_ResponseSyntax) ** Each tag consists of a key and a value. Type: String to string map ** [Type](#API_geospatial_StartVectorEnrichmentJob_ResponseSyntax) ** The type of the Vector Enrichment job. Type: String Valid Values: `REVERSE_GEOCODING | MAP_MATCHING` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. ** ResourceId ** Identifier of the resource affected. HTTP Status Code: 409 ** InternalServerException ** The request processing has failed because of an unknown error, exception, or failure. ** ResourceId ** HTTP Status Code: 500 ** ResourceNotFoundException ** The request references a resource which does not exist. ** ResourceId ** Identifier of the resource that was not found. HTTP Status Code: 404 ** ServiceQuotaExceededException ** You have exceeded the service quota. ** ResourceId ** Identifier of the resource affected. HTTP Status Code: 402 ** ThrottlingException ** The request was denied due to request throttling. ** ResourceId ** HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the constraints specified by an AWS service. ** ResourceId ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-geospatial-2020-05-27/StartVectorEnrichmentJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-geospatial-2020-05-27/StartVectorEnrichmentJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-geospatial-2020-05-27/StartVectorEnrichmentJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-geospatial-2020-05-27/StartVectorEnrichmentJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-geospatial-2020-05-27/StartVectorEnrichmentJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-geospatial-2020-05-27/StartVectorEnrichmentJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-geospatial-2020-05-27/StartVectorEnrichmentJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-geospatial-2020-05-27/StartVectorEnrichmentJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-geospatial-2020-05-27/StartVectorEnrichmentJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-geospatial-2020-05-27/StartVectorEnrichmentJob) # StopEarthObservationJob Use this operation to stop an existing earth observation job. ## Request Syntax ``` POST /earth-observation-jobs/stop HTTP/1.1 Content-type: application/json { "Arn": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [Arn](#API_geospatial_StopEarthObservationJob_RequestSyntax) ** The Amazon Resource Name (ARN) of the Earth Observation job being stopped. Type: String Pattern: `arn:aws[a-z-]{0,12}:sagemaker-geospatial:[a-z0-9-]{1,25}:[0-9]{12}:earth-observation-job/[a-z0-9]{12,}` Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. ** ResourceId ** Identifier of the resource affected. HTTP Status Code: 409 ** InternalServerException ** The request processing has failed because of an unknown error, exception, or failure. ** ResourceId ** HTTP Status Code: 500 ** ResourceNotFoundException ** The request references a resource which does not exist. ** ResourceId ** Identifier of the resource that was not found. HTTP Status Code: 404 ** ThrottlingException ** The request was denied due to request throttling. ** ResourceId ** HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the constraints specified by an AWS service. ** ResourceId ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-geospatial-2020-05-27/StopEarthObservationJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-geospatial-2020-05-27/StopEarthObservationJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-geospatial-2020-05-27/StopEarthObservationJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-geospatial-2020-05-27/StopEarthObservationJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-geospatial-2020-05-27/StopEarthObservationJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-geospatial-2020-05-27/StopEarthObservationJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-geospatial-2020-05-27/StopEarthObservationJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-geospatial-2020-05-27/StopEarthObservationJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-geospatial-2020-05-27/StopEarthObservationJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-geospatial-2020-05-27/StopEarthObservationJob) # StopVectorEnrichmentJob Stops the Vector Enrichment job for a given job ARN. ## Request Syntax ``` POST /vector-enrichment-jobs/stop HTTP/1.1 Content-type: application/json { "Arn": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [Arn](#API_geospatial_StopVectorEnrichmentJob_RequestSyntax) ** The Amazon Resource Name (ARN) of the Vector Enrichment job. Type: String Pattern: `arn:aws[a-z-]{0,12}:sagemaker-geospatial:[a-z0-9-]{1,25}:[0-9]{12}:vector-enrichment-job/[a-z0-9]{12,}` Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. ** ResourceId ** Identifier of the resource affected. HTTP Status Code: 409 ** InternalServerException ** The request processing has failed because of an unknown error, exception, or failure. ** ResourceId ** HTTP Status Code: 500 ** ResourceNotFoundException ** The request references a resource which does not exist. ** ResourceId ** Identifier of the resource that was not found. HTTP Status Code: 404 ** ThrottlingException ** The request was denied due to request throttling. ** ResourceId ** HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the constraints specified by an AWS service. ** ResourceId ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-geospatial-2020-05-27/StopVectorEnrichmentJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-geospatial-2020-05-27/StopVectorEnrichmentJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-geospatial-2020-05-27/StopVectorEnrichmentJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-geospatial-2020-05-27/StopVectorEnrichmentJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-geospatial-2020-05-27/StopVectorEnrichmentJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-geospatial-2020-05-27/StopVectorEnrichmentJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-geospatial-2020-05-27/StopVectorEnrichmentJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-geospatial-2020-05-27/StopVectorEnrichmentJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-geospatial-2020-05-27/StopVectorEnrichmentJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-geospatial-2020-05-27/StopVectorEnrichmentJob) # TagResource The resource you want to tag. ## Request Syntax ``` PUT /tags/ResourceArn HTTP/1.1 Content-type: application/json { "Tags": { "string" : "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [ResourceArn](#API_geospatial_TagResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the resource you want to tag. Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [Tags](#API_geospatial_TagResource_RequestSyntax) ** Each tag consists of a key and a value. Type: String to string map Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** InternalServerException ** The request processing has failed because of an unknown error, exception, or failure. ** ResourceId ** HTTP Status Code: 500 ** ResourceNotFoundException ** The request references a resource which does not exist. ** ResourceId ** Identifier of the resource that was not found. HTTP Status Code: 404 ** ThrottlingException ** The request was denied due to request throttling. ** ResourceId ** HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the constraints specified by an AWS service. ** ResourceId ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-geospatial-2020-05-27/TagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-geospatial-2020-05-27/TagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-geospatial-2020-05-27/TagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-geospatial-2020-05-27/TagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-geospatial-2020-05-27/TagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-geospatial-2020-05-27/TagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-geospatial-2020-05-27/TagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-geospatial-2020-05-27/TagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-geospatial-2020-05-27/TagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-geospatial-2020-05-27/TagResource) # UntagResource The resource you want to untag. ## Request Syntax ``` DELETE /tags/ResourceArn?tagKeys=TagKeys HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [ResourceArn](#API_geospatial_UntagResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the resource you want to untag. Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes ** [TagKeys](#API_geospatial_UntagResource_RequestSyntax) ** Keys of the tags you want to remove. Array Members: Minimum number of 1 item. Maximum number of 50 items. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** InternalServerException ** The request processing has failed because of an unknown error, exception, or failure. ** ResourceId ** HTTP Status Code: 500 ** ResourceNotFoundException ** The request references a resource which does not exist. ** ResourceId ** Identifier of the resource that was not found. HTTP Status Code: 404 ** ThrottlingException ** The request was denied due to request throttling. ** ResourceId ** HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the constraints specified by an AWS service. ** ResourceId ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-geospatial-2020-05-27/UntagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-geospatial-2020-05-27/UntagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-geospatial-2020-05-27/UntagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-geospatial-2020-05-27/UntagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-geospatial-2020-05-27/UntagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-geospatial-2020-05-27/UntagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-geospatial-2020-05-27/UntagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-geospatial-2020-05-27/UntagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-geospatial-2020-05-27/UntagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-geospatial-2020-05-27/UntagResource) # Amazon SageMaker Metrics Service The following actions are supported by Amazon SageMaker Metrics Service: + [BatchGetMetrics](API_metrics_BatchGetMetrics.md) + [BatchPutMetrics](API_metrics_BatchPutMetrics.md) # BatchGetMetrics Used to retrieve training metrics from SageMaker. ## Request Syntax ``` POST /BatchGetMetrics HTTP/1.1 Content-type: application/json { "MetricQueries": [ { "End": number, "MetricName": "string", "MetricStat": "string", "Period": "string", "ResourceArn": "string", "Start": number, "XAxisType": "string" } ] } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [MetricQueries](#API_metrics_BatchGetMetrics_RequestSyntax) ** Queries made to retrieve training metrics from SageMaker. Type: Array of [MetricQuery](API_metrics_MetricQuery.md) objects Array Members: Minimum number of 1 item. Maximum number of 100 items. Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "MetricQueryResults": [ { "Message": "string", "MetricValues": [ number ], "Status": "string", "XAxisValues": [ number ] } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [MetricQueryResults](#API_metrics_BatchGetMetrics_ResponseSyntax) ** The results of a query to retrieve training metrics from SageMaker. Type: Array of [MetricQueryResult](API_metrics_MetricQueryResult.md) objects Array Members: Minimum number of 1 item. Maximum number of 100 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-metrics-2022-09-30/BatchGetMetrics) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-metrics-2022-09-30/BatchGetMetrics) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-metrics-2022-09-30/BatchGetMetrics) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-metrics-2022-09-30/BatchGetMetrics) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-metrics-2022-09-30/BatchGetMetrics) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-metrics-2022-09-30/BatchGetMetrics) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-metrics-2022-09-30/BatchGetMetrics) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-metrics-2022-09-30/BatchGetMetrics) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-metrics-2022-09-30/BatchGetMetrics) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-metrics-2022-09-30/BatchGetMetrics) # BatchPutMetrics Used to ingest training metrics into SageMaker. These metrics can be visualized in SageMaker Studio. ## Request Syntax ``` PUT /BatchPutMetrics HTTP/1.1 Content-type: application/json { "MetricData": [ { "MetricName": "string", "Step": number, "Timestamp": number, "Value": number } ], "TrialComponentName": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [MetricData](#API_metrics_BatchPutMetrics_RequestSyntax) ** A list of raw metric values to put. Type: Array of [RawMetricData](API_metrics_RawMetricData.md) objects Array Members: Minimum number of 1 item. Maximum number of 10 items. Required: Yes ** [TrialComponentName](#API_metrics_BatchPutMetrics_RequestSyntax) ** The name of the Trial Component to associate with the metrics. The Trial Component name must be entirely lowercase. Type: String Length Constraints: Minimum length of 1. Maximum length of 120. Pattern: `^[a-z0-9](-*[a-z0-9]){0,119}` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Errors": [ { "Code": "string", "MetricIndex": number } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Errors](#API_metrics_BatchPutMetrics_ResponseSyntax) ** Lists any errors that occur when inserting metric data. Type: Array of [BatchPutMetricsError](API_metrics_BatchPutMetricsError.md) objects Array Members: Minimum number of 1 item. Maximum number of 10 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-metrics-2022-09-30/BatchPutMetrics) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-metrics-2022-09-30/BatchPutMetrics) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-metrics-2022-09-30/BatchPutMetrics) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-metrics-2022-09-30/BatchPutMetrics) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-metrics-2022-09-30/BatchPutMetrics) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-metrics-2022-09-30/BatchPutMetrics) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-metrics-2022-09-30/BatchPutMetrics) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-metrics-2022-09-30/BatchPutMetrics) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-metrics-2022-09-30/BatchPutMetrics) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-metrics-2022-09-30/BatchPutMetrics)