ListContexts - Amazon SageMaker Service

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.

The request accepts the following data in JSON format.

ContextType

A filter that returns only contexts of the specified type.

Type: String

Length Constraints: Maximum length of 256.

Required: No

CreatedAfter

A filter that returns only contexts created on or after the specified time.

Type: Timestamp

Required: No

CreatedBefore

A filter that returns only contexts created on or before the specified time.

Type: Timestamp

Required: No

MaxResults

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

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: Maximum length of 8192.

Pattern: .*

Required: No

SortBy

The property used to sort results. The default value is CreationTime.

Type: String

Valid Values: Name | CreationTime

Required: No

SortOrder

The sort order. The default value is Descending.

Type: String

Valid Values: Ascending | Descending

Required: No

SourceUri

A filter that returns only contexts with the specified source URI.

Type: String

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

A list of contexts and their properties.

Type: Array of ContextSummary objects

NextToken

A token for getting the next set of contexts, if there are any.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

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: