View a markdown version of this page

ListProjects - Amazon Textract

ListProjects

Lists the projects that are available to the caller, with optional filtering by blueprint. The results are paginated. If the response includes a NextToken value, pass it in a subsequent call to retrieve the next page of results.

Request Syntax

{ "BlueprintFilter": { "BlueprintArn": "string", "BlueprintVersion": "string" }, "MaxResults": number, "NextToken": "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.

BlueprintFilter

A filter that limits the results to projects associated with the specified blueprint.

Type: BlueprintFilter object

Required: No

MaxResults

The maximum number of projects to return in each page of results. If you don't specify a value, the service selects a default page size. Use the NextToken value in the response to retrieve any remaining results.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

NextToken

A pagination token returned from a previous call to ListProjects. Use it to retrieve the next page of results.

Type: String

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

Pattern: .*\S.*

Required: No

Response Syntax

{ "NextToken": "string", "Projects": [ { "CreationTime": number, "LastModifiedTime": number, "ProjectArn": "string", "ProjectName": "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

A pagination token to use in a subsequent call to ListProjects to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

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

Pattern: .*\S.*

Projects

A list of project summaries that match the request.

Type: Array of ProjectSummary objects

Errors

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

AccessDeniedException

You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.

HTTP Status Code: 400

InternalServerError

Amazon Textract experienced a service issue. Try your call again.

HTTP Status Code: 500

InvalidParameterException

An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.

HTTP Status Code: 400

ProvisionedThroughputExceededException

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

HTTP Status Code: 400

ResourceNotFoundException

Returned when an operation tried to access a nonexistent resource.

HTTP Status Code: 400

ValidationException

Indicates that a request was not valid. Check request for proper formatting.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: