Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListStudioLifecycleConfigs

Lists the 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.

The request accepts the following data in JSON format.

AppTypeEquals

A parameter to search for the App Type to which the Lifecycle Configuration is attached.

Type: String

Valid Values: JupyterServer | KernelGateway

Required: No

CreationTimeAfter

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

Type: Timestamp

Required: No

CreationTimeBefore

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

Type: Timestamp

Required: No

MaxResults

The maximum number of Studio Lifecycle Configurations to return in the response. The default value is 10.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

ModifiedTimeAfter

A filter that returns only Lifecycle Configurations modified after the specified time.

Type: Timestamp

Required: No

ModifiedTimeBefore

A filter that returns only Lifecycle Configurations modified before the specified time.

Type: Timestamp

Required: No

NameContains

A string in the Lifecycle Configuration name. This filter returns only Lifecycle Configurations whose name contains the specified string.

Type: String

Length Constraints: Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}

Required: No

NextToken

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

Pattern: .*

Required: No

SortBy

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

Type: String

Valid Values: CreationTime | LastModifiedTime | Name

Required: No

SortOrder

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

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

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

StudioLifecycleConfigs

A list of Lifecycle Configurations and their properties.

Type: Array of StudioLifecycleConfigDetails objects

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceInUse

Resource being accessed is in use.

HTTP Status Code: 400