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

ListApps

Returns a list of the existing Amplify apps.

Request Syntax


GET /apps?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of records to list in a single response.

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

nextToken

A pagination token. If non-null, the pagination token is returned in a result. Pass its value in another request to retrieve more entries.

Length Constraints: Maximum length of 2000.

Pattern: (?s).*

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "apps": [ 
      { 
         "appArn": "string",
         "appId": "string",
         "autoBranchCreationConfig": { 
            "basicAuthCredentials": "string",
            "buildSpec": "string",
            "enableAutoBuild": boolean,
            "enableBasicAuth": boolean,
            "enablePerformanceMode": boolean,
            "enablePullRequestPreview": boolean,
            "environmentVariables": { 
               "string" : "string" 
            },
            "framework": "string",
            "pullRequestEnvironmentName": "string",
            "stage": "string"
         },
         "autoBranchCreationPatterns": [ "string" ],
         "basicAuthCredentials": "string",
         "buildSpec": "string",
         "createTime": number,
         "customHeaders": "string",
         "customRules": [ 
            { 
               "condition": "string",
               "source": "string",
               "status": "string",
               "target": "string"
            }
         ],
         "defaultDomain": "string",
         "description": "string",
         "enableAutoBranchCreation": boolean,
         "enableBasicAuth": boolean,
         "enableBranchAutoBuild": boolean,
         "enableBranchAutoDeletion": boolean,
         "environmentVariables": { 
            "string" : "string" 
         },
         "iamServiceRoleArn": "string",
         "name": "string",
         "platform": "string",
         "productionBranch": { 
            "branchName": "string",
            "lastDeployTime": number,
            "status": "string",
            "thumbnailUrl": "string"
         },
         "repository": "string",
         "repositoryCloneMethod": "string",
         "tags": { 
            "string" : "string" 
         },
         "updateTime": number
      }
   ],
   "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

A list of Amplify apps.

Type: Array of App objects

nextToken

A pagination token. Set to null to start listing apps from start. If non-null, the pagination token is returned in a result. Pass its value in here to list more projects.

Type: String

Length Constraints: Maximum length of 2000.

Pattern: (?s).*

Errors

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

BadRequestException

A request contains unexpected data.

HTTP Status Code: 400

InternalFailureException

The service failed to perform an operation due to an internal issue.

HTTP Status Code: 500

UnauthorizedException

An operation failed due to a lack of access.

HTTP Status Code: 401