View a markdown version of this page

UpdateProject - Amazon Textract

UpdateProject

Updates the configuration of an existing project. If you omit a configuration, UpdateProject leaves it unchanged. A configuration that you supply replaces the stored one, so include every setting that you want to keep.

Request Syntax

{ "CustomConfiguration": { "Blueprints": [ { "BlueprintArn": "string", "BlueprintVersion": "string" } ], "FallbackBlueprints": [ { "BlueprintArn": "string", "BlueprintVersion": "string" } ] }, "EncryptionConfiguration": { "KmsEncryptionContext": { "string" : "string" }, "KmsKeyId": "string" }, "ExtractionConfiguration": { "BoundingBox": { "State": "string" }, "Granularity": { "Types": [ "string" ] }, "OutputFormat": { "AdditionalFileFormat": { "State": "string" }, "TextFormat": { "Types": [ "string" ] } } }, "GenerativeConfiguration": { "FigureCaption": { "State": "string" }, "Summarization": { "State": "string" } }, "ProjectArn": "string", "ProjectDescription": "string", "SensitiveDataConfiguration": { "DetectionMode": "string", "PiiEntitiesConfiguration": { "PiiEntityTypes": [ "string" ], "RedactionMaskMode": "string" } }, "SplitterConfiguration": { "State": "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.

CustomConfiguration

The configuration that associates blueprints with the project for custom output extraction. Replaces the stored custom configuration. To disable custom configuration, specify an empty Blueprints list.

Type: CustomConfiguration object

Required: No

EncryptionConfiguration

The AWS KMS encryption configuration used to encrypt the project at rest.

Type: EncryptionConfiguration object

Required: No

ExtractionConfiguration

The configuration that controls how Amazon Textract extracts content from the document, including bounding boxes, granularity, and output format. Replaces the stored extraction configuration.

Type: ExtractionConfiguration object

Required: No

GenerativeConfiguration

The configuration that controls generative capabilities such as summarization and figure captioning. Replaces the stored generative configuration, so a capability that you omit is turned off.

Type: GenerativeConfiguration object

Required: No

ProjectArn

The Amazon Resource Name (ARN) of the project to update.

Type: String

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

Pattern: ^arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):textract:[a-zA-Z0-9-]*:(aws|[0-9]{12}):project/[a-zA-Z0-9-]{12,36}$

Required: Yes

ProjectDescription

The updated description of the project.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 300.

Pattern: ^[a-zA-Z0-9\s!"\#\$%'&\(\)\*\+\,\-\./:;=\?@\[\\\]\^_`\{\|\}~><À-ÖØ-Üßà-öø-üẞ¿¡Œ-œ°£¥₹€§©ª®™¹±-µ✓⑆-⑉฿₽₱₦₣₩₫₺]*$

Required: No

SensitiveDataConfiguration

The configuration that controls detection and redaction of sensitive data, such as personally identifiable information (PII). Replaces the stored sensitive data configuration. To turn off detection, set DetectionMode to DISABLED.

Type: SensitiveDataConfiguration object

Required: No

SplitterConfiguration

The configuration that controls whether multi-document packets are split into individual documents. Replaces the stored splitter configuration.

Type: SplitterConfiguration object

Required: No

Response Syntax

{ "ProjectArn": "string", "Status": "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.

ProjectArn

The Amazon Resource Name (ARN) of the project that was updated.

Type: String

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

Pattern: ^arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):textract:[a-zA-Z0-9-]*:(aws|[0-9]{12}):project/[a-zA-Z0-9-]{12,36}$

Status

The status of the project after the update.

Type: String

Valid Values: COMPLETED | FAILED

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

ConflictException

Updating or deleting a resource can cause an inconsistent state.

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

LimitExceededException

An Amazon Textract service limit was exceeded. For example, if you start too many asynchronous jobs concurrently, calls to start operations (StartDocumentTextDetection, for example) raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Textract service limit.

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: