# ListProjects
<a name="API_ListProjects"></a>

Lists Amazon DataZone projects.

## Request Syntax
<a name="API_ListProjects_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/projects?groupIdentifier=groupIdentifier&maxResults=maxResults&name=name&nextToken=nextToken&userIdentifier=userIdentifier HTTP/1.1
```

## URI Request Parameters
<a name="API_ListProjects_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_ListProjects_RequestSyntax) **   <a name="datazone-ListProjects-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [groupIdentifier](#API_ListProjects_RequestSyntax) **   <a name="datazone-ListProjects-request-uri-groupIdentifier"></a>
The identifier of a group.

 ** [maxResults](#API_ListProjects_RequestSyntax) **   <a name="datazone-ListProjects-request-uri-maxResults"></a>
The maximum number of projects to return in a single call to `ListProjects`. When the number of projects to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `ListProjects` to list the next set of projects.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [name](#API_ListProjects_RequestSyntax) **   <a name="datazone-ListProjects-request-uri-name"></a>
The name of the project.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+` 

 ** [nextToken](#API_ListProjects_RequestSyntax) **   <a name="datazone-ListProjects-request-uri-nextToken"></a>
When the number of projects is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of projects, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListProjects` to list the next set of projects.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

 ** [userIdentifier](#API_ListProjects_RequestSyntax) **   <a name="datazone-ListProjects-request-uri-userIdentifier"></a>
The identifier of the Amazon DataZone user.

## Request Body
<a name="API_ListProjects_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListProjects_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "createdAt": "string",
         "createdBy": "string",
         "description": "string",
         "domainId": "string",
         "domainUnitId": "string",
         "failureReasons": [ 
            { 
               "code": "string",
               "message": "string"
            }
         ],
         "id": "string",
         "name": "string",
         "projectStatus": "string",
         "updatedAt": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListProjects_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_ListProjects_ResponseSyntax) **   <a name="datazone-ListProjects-response-items"></a>
The results of the `ListProjects` action.  
Type: Array of [ProjectSummary](API_ProjectSummary.md) objects

 ** [nextToken](#API_ListProjects_ResponseSyntax) **   <a name="datazone-ListProjects-response-nextToken"></a>
When the number of projects is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of projects, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListProjects` to list the next set of projects.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Errors
<a name="API_ListProjects_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListProjects_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/ListProjects) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/ListProjects) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/ListProjects) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/ListProjects) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/ListProjects) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/ListProjects) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/ListProjects) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/ListProjects) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/ListProjects) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/ListProjects)