ListProjects
Gets a list of the projects in an Amazon account.
Request Syntax
{
"CreationTimeAfter": number
,
"CreationTimeBefore": number
,
"MaxResults": number
,
"NameContains": "string
",
"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.
- CreationTimeAfter
-
A filter that returns the projects that were created after a specified time.
Type: Timestamp
Required: No
- CreationTimeBefore
-
A filter that returns the projects that were created before a specified time.
Type: Timestamp
Required: No
- MaxResults
-
The maximum number of projects to return in the response.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NameContains
-
A filter that returns the projects whose name contains a specified string.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}
Required: No
- NextToken
-
If the result of the previous
ListProjects
request was truncated, the response includes aNextToken
. To retrieve the next set of projects, use the token in the next request.Type: String
Length Constraints: Maximum length of 8192.
Pattern:
.*
Required: No
- SortBy
-
The field by which to sort results. The default is
CreationTime
.Type: String
Valid Values:
Name | CreationTime
Required: No
- SortOrder
-
The sort order for results. The default is
Ascending
.Type: String
Valid Values:
Ascending | Descending
Required: No
Response Syntax
{
"NextToken": "string",
"ProjectSummaryList": [
{
"CreationTime": number,
"ProjectArn": "string",
"ProjectDescription": "string",
"ProjectId": "string",
"ProjectName": "string",
"ProjectStatus": "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 the result of the previous
ListCompilationJobs
request was truncated, the response includes aNextToken
. To retrieve the next set of model compilation jobs, use the token in the next request.Type: String
Length Constraints: Maximum length of 8192.
Pattern:
.*
- ProjectSummaryList
-
A list of summaries of projects.
Type: Array of ProjectSummary objects
Errors
For information about the errors that are common to all actions, see Common Errors.
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: