SageMaker / Client / list_apps
list_apps#
- SageMaker.Client.list_apps(**kwargs)#
Lists apps.
See also: AWS API Documentation
Request Syntax
response = client.list_apps( NextToken='string', MaxResults=123, SortOrder='Ascending'|'Descending', SortBy='CreationTime', DomainIdEquals='string', UserProfileNameEquals='string', SpaceNameEquals='string' )
- Parameters:
NextToken (string) – If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
MaxResults (integer) – 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 theNextToken
value in the as part of a subsequent call. The default value is 10.SortOrder (string) – The sort order for the results. The default is Ascending.
SortBy (string) – The parameter by which to sort the results. The default is CreationTime.
DomainIdEquals (string) – A parameter to search for the domain ID.
UserProfileNameEquals (string) – A parameter to search by user profile name. If
SpaceNameEquals
is set, then this value cannot be set.SpaceNameEquals (string) – A parameter to search by space name. If
UserProfileNameEquals
is set, then this value cannot be set.
- Return type:
dict
- Returns:
Response Syntax
{ 'Apps': [ { 'DomainId': 'string', 'UserProfileName': 'string', 'SpaceName': 'string', 'AppType': 'JupyterServer'|'KernelGateway'|'DetailedProfiler'|'TensorBoard'|'VSCode'|'Savitur'|'CodeEditor'|'JupyterLab'|'RStudioServerPro'|'RSession'|'RSessionGateway'|'Canvas'|'DatasetManager'|'SageMakerLite'|'Local', 'AppName': 'string', 'Status': 'Deleted'|'Deleting'|'Failed'|'InService'|'Pending', 'CreationTime': datetime(2015, 1, 1), 'ResourceSpec': { 'SageMakerImageArn': 'string', 'SageMakerImageVersionArn': 'string', 'SageMakerImageVersionAlias': 'string', 'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'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.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'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.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge', 'LifecycleConfigArn': 'string' } }, ], 'NextToken': 'string' }
Response Structure
(dict) –
Apps (list) –
The list of apps.
(dict) –
Details about an Amazon SageMaker app.
DomainId (string) –
The domain ID.
UserProfileName (string) –
The user profile name.
SpaceName (string) –
The name of the space.
AppType (string) –
The type of app.
AppName (string) –
The name of the app.
Status (string) –
The status.
CreationTime (datetime) –
The creation time.
ResourceSpec (dict) –
Specifies the ARN’s of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
SageMakerImageArn (string) –
The ARN of the SageMaker image that the image version belongs to.
SageMakerImageVersionArn (string) –
The ARN of the image version created on the instance.
SageMakerImageVersionAlias (string) –
The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.
InstanceType (string) –
The instance type that the image version runs on.
Note
JupyterServer apps only support the
system
value.For KernelGateway apps, the
system
value is translated toml.t3.medium
. KernelGateway apps also support all other values for available instance types.LifecycleConfigArn (string) –
The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
NextToken (string) –
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.