UpdateContext - Amazon SageMaker Service

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.

The request accepts the following data in JSON format.

ContextName

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

The new description for the context.

Type: String

Length Constraints: Maximum length of 3072.

Pattern: .*

Required: No

Properties

The new list of properties. Overwrites the current property list.

Type: String to string map

Map Entries: Maximum number of 30 items.

Key Length Constraints: Maximum length of 256.

Key Pattern: .*

Value Length Constraints: Maximum length of 256.

Value Pattern: .*

Required: No

PropertiesToRemove

A list of properties to remove.

Type: Array of strings

Length Constraints: Maximum length of 256.

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

The Amazon Resource Name (ARN) of the context.

Type: String

Length Constraints: 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 Errors.

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: