Skip to main content

GetAwsTextractJobStatus

Description

Retrieves the current status of an AWS Textract job.

Tags

AWS, Amazon, ML, Machine Learning, Textract

Properties

In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
AWS Task ID *awsTaskId${awsTaskId}

Supports Expression Language, using FlowFile attributes and Environment variables.
AWS Credentials Provider Service *AWS Credentials Provider serviceController Service:
AWSCredentialsProviderService

Implementations:
AWSCredentialsProviderControllerService
The Controller Service that is used to obtain AWS credentials provider
Region *RegionUS West (Oregon)
  • AWS GovCloud (US-East)
  • AWS GovCloud (US-West)
  • Africa (Cape Town)
  • Asia Pacific (Hong Kong)
  • Asia Pacific (Hyderabad)
  • Asia Pacific (Jakarta)
  • Asia Pacific (Malaysia)
  • Asia Pacific (Melbourne)
  • Asia Pacific (Mumbai)
  • Asia Pacific (Osaka)
  • Asia Pacific (Seoul)
  • Asia Pacific (Singapore)
  • Asia Pacific (Sydney)
  • Asia Pacific (Tokyo)
  • Canada (Central)
  • Canada West (Calgary)
  • China (Beijing)
  • China (Ningxia)
  • EU ISOE West
  • Europe (Frankfurt)
  • Europe (Ireland)
  • Europe (London)
  • Europe (Milan)
  • Europe (Paris)
  • Europe (Spain)
  • Europe (Stockholm)
  • Europe (Zurich)
  • Israel (Tel Aviv)
  • Middle East (Bahrain)
  • Middle East (UAE)
  • South America (Sao Paulo)
  • US East (N. Virginia)
  • US East (Ohio)
  • US ISO East
  • US ISO WEST
  • US ISOB East (Ohio)
  • US West (N. California)
  • US West (Oregon)
  • aws-cn-global
  • aws-global
  • aws-iso-b-global
  • aws-iso-global
  • aws-us-gov-global
Communications Timeout *Communications Timeout30 secs
SSL Context ServiceSSL Context ServiceController Service:
SSLContextService

Implementations:
StandardRestrictedSSLContextService
StandardSSLContextService
Specifies an optional SSL Context Service that, if provided, will be used to create connections
Endpoint Override URLEndpoint Override URLEndpoint URL to use instead of the AWS default including scheme, host, port, and path. The AWS libraries select an endpoint URL based on the AWS region, but this property overrides the selected endpoint URL, allowing use with other S3-compatible endpoints.

Supports Expression Language, using Environment variables.
Proxy Configuration Serviceproxy-configuration-serviceController Service:
ProxyConfigurationService

Implementations:
StandardProxyConfigurationService
Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP + AuthN
Textract Type *textract-type${awsTextractType}Supported values: "Document Analysis", "Document Text Detection", "Expense Analysis"

Supports Expression Language, using FlowFile attributes and Environment variables.

Dynamic Properties

This component does not support dynamic properties.

Relationships

NameDescription
failureThe job failed, the original FlowFile will be routed to this relationship.
originalUpon successful completion, the original FlowFile will be routed to this relationship.
runningThe job is currently still being processed
successJob successfully finished. FlowFile will be routed to this relation.
throttledRetrieving results failed for some reason, but the issue is likely to resolve on its own, such as Provisioned Throughput Exceeded or a Throttling failure. It is generally expected to retry this relationship.

Reads Attributes

This processor does not read attributes.

Writes Attributes

This processor does not write attributes.

State Management

This component does not store state.

Restricted

This component is not restricted.

Input Requirement

Input requirements are not specified for this component.

System Resource Considerations

This component does not specify system resource considerations.

See Also

StartAwsTextractJob