Gets a list of build project names, with each build project name representing a single build project.
Request Syntax
{
"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.
Note
In the following list, the required parameters are described first.
- nextToken
-
During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
Type: String
Length Constraints: Minimum length of 1.
Required: No
- sortBy
-
The criterion to be used to list build project names. Valid values include:
-
CREATED_TIME: List based on when each build project was created. -
LAST_MODIFIED_TIME: List based on when information about each build project was last changed. -
NAME: List based on each build project's name.
Use
sortOrderto specify in what order to list the build project names based on the preceding criteria.Type: String
Valid Values:
NAME | CREATED_TIME | LAST_MODIFIED_TIMERequired: No
-
- sortOrder
-
The order in which to list build projects. Valid values include:
-
ASCENDING: List in ascending order. -
DESCENDING: List in descending order.
Use
sortByto specify the criterion to be used to list build project names.Type: String
Valid Values:
ASCENDING | DESCENDINGRequired: No
-
Response Syntax
{
"nextToken": "string",
"projects": [ "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
-
If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call.
Type: String
- projects
-
The list of build project names, with each build project name representing a single build project.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Length Constraints: Minimum length of 1.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidInputException
-
The input value that was provided is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
