GetAwsTextractJobStatus

GetAwsTextractJobStatus 2.0.0

Bundle: org.apache.nifi | nifi-aws-nar
Description: Retrieves the current status of an AWS Textract job.
Tags: AWS, Amazon, ML, Machine Learning, Textract
Input Requirement
Supports Sensitive Dynamic Properties: false

Properties

AWS Credentials Provider Service
The Controller Service that is used to obtain AWS credentials provider

Display Name

AWS Credentials Provider Service

Description

The Controller Service that is used to obtain AWS credentials provider

API Name

AWS Credentials Provider service

Service Interface

org.apache.nifi.processors.aws.credentials.provider.service.AWSCredentialsProviderService

Service Implementations

org.apache.nifi.processors.aws.credentials.provider.service.AWSCredentialsProviderControllerService

Expression Language Scope

Not Supported

Sensitive

false

Required

true
AWS Task ID

Display Name

AWS Task ID

Description

API Name

awsTaskId

Default Value

${awsTaskId}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
Communications Timeout

Display Name

Communications Timeout

Description

API Name

Communications Timeout

Default Value

30 secs

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Endpoint Override URL
Endpoint 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.

Display Name

Endpoint Override URL

Description

Endpoint 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.

API Name

Endpoint Override URL

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
Proxy Configuration Service
Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP + AuthN

Display Name

Proxy Configuration Service

Description

Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP + AuthN

API Name

proxy-configuration-service

Service Interface

org.apache.nifi.proxy.ProxyConfigurationService

Service Implementations

org.apache.nifi.proxy.StandardProxyConfigurationService

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Region
Display Name

Region

Description

API Name

Region

Default Value

us-west-2

Allowable Values
- 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
Expression Language Scope

Not Supported

Sensitive

false

Required

true
SSL Context Service
Specifies an optional SSL Context Service that, if provided, will be used to create connections

Display Name

SSL Context Service

Description

Specifies an optional SSL Context Service that, if provided, will be used to create connections

API Name

SSL Context Service

Service Interface

org.apache.nifi.ssl.SSLContextService

Service Implementations

org.apache.nifi.ssl.StandardRestrictedSSLContextService

org.apache.nifi.ssl.StandardSSLContextService

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Textract Type
Supported values: "Document Analysis", "Document Text Detection", "Expense Analysis"

Display Name

Textract Type

Description

Supported values: "Document Analysis", "Document Text Detection", "Expense Analysis"

API Name

textract-type

Default Value

${awsTextractType}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true

Relationships

Name	Description
throttled	Retrieving 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.
success	Job successfully finished. FlowFile will be routed to this relation.
failure	The job failed, the original FlowFile will be routed to this relationship.
original	Upon successful completion, the original FlowFile will be routed to this relationship.
running	The job is currently still being processed