DescribeContext
Describes a context.
Request Syntax
{
"ContextName": "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 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
-
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/.* - ContextName
-
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
-
The type of the context.
Type: String
Length Constraints: Maximum length of 256.
- CreatedBy
-
Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
Type: UserContext object
- CreationTime
-
When the context was created.
Type: Timestamp
- Description
-
The description of the context.
Type: String
Length Constraints: Maximum length of 3072.
Pattern:
.* - LastModifiedBy
-
Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
Type: UserContext object
- LastModifiedTime
-
When the context was last modified.
Type: Timestamp
- LineageGroupArn
-
The Amazon Resource Name (ARN) of the lineage group.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:lineage-group/.* - Properties
-
A list of the context's properties.
Type: String to string map
Map Entries: Maximum number of 30 items.
Key Length Constraints: Maximum length of 2500.
Key Pattern:
.*Value Length Constraints: Maximum length of 2500.
Value Pattern:
.* - Source
-
The source of the context.
Type: ContextSource object
Errors
For information about the errors that are common to all actions, see Common Errors.
- 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:
