Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListApps

Lists all custom apps or service apps for the given simulation and domain.

Request Syntax


GET /listapps?domain=Domain&maxResults=MaxResults&nextToken=NextToken&simulation=Simulation HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Domain

The name of the domain that you want to list apps for.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_.-]+$

MaxResults

The maximum number of apps to list.

Valid Range: Minimum value of 1.

NextToken

If SimSpace Weaver returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

Simulation

The name of the simulation that you want to list apps for.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_.-]+$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Apps": [ 
      { 
         "Domain": "string",
         "Name": "string",
         "Simulation": "string",
         "Status": "string",
         "TargetStatus": "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 for the given simulation and domain.

Type: Array of SimulationAppMetadata objects

NextToken

Type: String

Errors

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

AccessDeniedException

HTTP Status Code: 403

InternalServerException

HTTP Status Code: 500

ResourceNotFoundException

HTTP Status Code: 404

ValidationException

HTTP Status Code: 400