GetProject
Gets the details of a project, including its configuration, status, and timestamps.
Request Syntax
{
"ProjectArn": "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.
- ProjectArn
-
The Amazon Resource Name (ARN) of the project to retrieve.
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
Response Syntax
{
"CreationTime": number,
"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"
}
},
"LastModifiedTime": number,
"ProjectArn": "string",
"ProjectDescription": "string",
"ProjectName": "string",
"SensitiveDataConfiguration": {
"DetectionMode": "string",
"PiiEntitiesConfiguration": {
"PiiEntityTypes": [ "string" ],
"RedactionMaskMode": "string"
}
},
"SplitterConfiguration": {
"State": "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.
- CreationTime
-
The date and time that the project was created.
Type: Timestamp
- CustomConfiguration
-
The configuration that associates blueprints with the project for custom output extraction.
Type: CustomConfiguration object
- EncryptionConfiguration
-
The AWS KMS encryption configuration used to encrypt the project at rest.
Type: EncryptionConfiguration object
- ExtractionConfiguration
-
The configuration that controls how Amazon Textract extracts content from the document, including bounding boxes, granularity, and output format.
Type: ExtractionConfiguration object
- GenerativeConfiguration
-
The configuration that controls generative capabilities such as summarization and figure captioning.
Type: GenerativeConfiguration object
- LastModifiedTime
-
The date and time that the project was last modified.
Type: Timestamp
- ProjectArn
-
The Amazon Resource Name (ARN) of the project.
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}$ - ProjectDescription
-
The description of the project.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 300.
Pattern:
^[a-zA-Z0-9\s!"\#\$%'&\(\)\*\+\,\-\./:;=\?@\[\\\]\^_`\{\|\}~><À-ÖØ-Üßà-öø-üẞ¿¡Œ-œ°£¥₹€§©ª®™¹±-µ✓⑆-⑉฿₽₱₦₣₩₫₺]*$ - ProjectName
-
The name of the project.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^[a-zA-Z0-9-_]+$ - SensitiveDataConfiguration
-
The configuration that controls detection and redaction of sensitive data, such as personally identifiable information (PII).
Type: SensitiveDataConfiguration object
- SplitterConfiguration
-
The configuration that controls whether multi-document packets are split into individual documents.
Type: SplitterConfiguration object
- Status
-
The status of the project, indicating whether it was created successfully or failed.
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
- 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
InvalidParameterExceptionexception occurs when neither of theS3ObjectorBytesvalues are supplied in theDocumentrequest 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: