Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListApps

Lists apps.

Request Syntax


{
   "DomainIdEquals": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SortBy": "string",
   "SortOrder": "string",
   "SpaceNameEquals": "string",
   "UserProfileNameEquals": "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.

DomainIdEquals

A parameter to search for the domain ID.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 63.

Pattern: d-(-*[a-z0-9]){1,61}

Required: No

MaxResults

This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.

Type: Integer

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

Required: No

NextToken

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

Pattern: .*

Required: No

SortBy

The parameter by which to sort the results. The default is CreationTime.

Type: String

Valid Values: CreationTime

Required: No

SortOrder

The sort order for the results. The default is Ascending.

Type: String

Valid Values: Ascending | Descending

Required: No

SpaceNameEquals

A parameter to search by space name. If UserProfileNameEquals is set, then this value cannot be set.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 63.

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

Required: No

UserProfileNameEquals

A parameter to search by user profile name. If SpaceNameEquals is set, then this value cannot be set.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 63.

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

Required: No

Response Syntax


{
   "Apps": [ 
      { 
         "AppName": "string",
         "AppType": "string",
         "CreationTime": number,
         "DomainId": "string",
         "ResourceSpec": { 
            "InstanceType": "string",
            "LifecycleConfigArn": "string",
            "SageMakerImageArn": "string",
            "SageMakerImageVersionAlias": "string",
            "SageMakerImageVersionArn": "string"
         },
         "SpaceName": "string",
         "Status": "string",
         "UserProfileName": "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.

Apps

The list of apps.

Type: Array of AppDetails objects

NextToken

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

Pattern: .*

Errors

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