Description and usage of InvokeAWSGatewayApi processor:

InvokeAWSGatewayApi is a client for AWS Gateway API endpoint.

Tags:

Amazon, AWS, Client, Gateway-API, Rest, http, https

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, whether a property supports the Expression Language Guide, and whether a property is considered “sensitive”, meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the nifi.properties file has an entry for the property nifi.sensitive.props.key.

Name

Default Value

Allowable Values

Description

HTTP Method

GET HTTP request method (GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS).Methods other than POST, PUT and PATCH will be sent without a message body.

Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)


Amazon Region

us-west-2 * AWS GovCloud (US) 
* AWS GovCloud (US-East) 
* US East (N. Virginia) 
* US East (Ohio) 
* US West (N. California) 
* US West (Oregon) 
* EU (Ireland) 
* EU (London) 
* EU (Paris) 
* EU (Frankfurt) 
* EU (Stockholm) 
* Asia Pacific (Hong Kong) 
* Asia Pacific (Mumbai) 
* Asia Pacific (Singapore) 
* Asia Pacific (Sydney) 
* Asia Pacific (Tokyo) 
* Asia Pacific (Seoul) 
* South America (Sao Paulo) 
* China (Beijing) 
* China (Ningxia) 
* Canada (Central) 
No Description Provided.
Access Key ID No Description Provided.

Sensitive Property: true


Supports Expression Language: true (will be evaluated using variable registry only)


Secret Access Key No Description Provided.

Sensitive Property: true


Supports Expression Language: true (will be evaluated using variable registry only)


Credentials File Path to a file containing AWS access key and secret key in properties file format.
AWS Credentials Provider service

Controller Service API: 


AWSCredentialsProviderService

Implementation: 

AWSCredentialsProviderControllerService


The Controller Service that is used to obtain aws credentials provider

Communications Timeout

30 secs No Description Provided.

Amazon Gateway Api ResourceName

The Name of the Gateway API Resource

Amazon Gateway Api Endpoint

The API Endpoint
Amazon Gateway API Key The API Key

Sensitive Property: true


Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)


Attributes to Send Regular expression that defines which attributes to send as HTTP headers in the request. If not defined, no attributes are sent as headers. Also any dynamic properties set will be sent as headers. The dynamic property key will be the header key and the dynamic property value will be interpreted as expression language will be the header value.
Put Response Body In Attribute If set, the response body received back will be put into an attribute of the original FlowFile instead of a separate FlowFile. The attribute key to put to is determined by evaluating value of this property. 

Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)


Content-Type

${mime.type} The Content-Type to specify for when content is being transmitted through a PUT, POST or PATCH. In the case of an empty value after evaluating an expression language expression, Content-Type defaults to application/octet-stream

Supports Expression Language: true (undefined scope)


Send Message Body true * true
* false
If true, sends the HTTP message body on POST/PUT/PATCH requests (default). If false, suppresses the message body and content-type header for these requests.
Always Output Response false * true
* false
Will force a response FlowFile to be generated and routed to the 'Response' relationship regardless of what the server status code received is or if the processor is configured to put the server response body in the request attribute. In the later configuration a request FlowFile with the response body in the attribute and a typical response FlowFile will be emitted to their respective relationships.
Penalize on "No Retry" false * true
* false
Enabling this property will penalize FlowFiles that are routed to the "No Retry" relationship.
Proxy Host Proxy host name or IP

Supports Expression Language: true (will be evaluated using variable registry only)


Proxy Host Port Proxy host port

Supports Expression Language: true (will be evaluated using variable registry only)


Proxy Username Proxy username

Supports Expression Language: true (undefined scope)


Proxy Password Proxy password

Sensitive Property: true


Supports Expression Language: true (undefined scope)


Query Parameters The query parameters for this request in the form of Name=Value separated by &

Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)


Max Length To Put In Attribute 256 If routing the response body to an attribute of the original (by setting the "Put response body in attribute" property or by receiving an error status code), the number of characters put to the attribute value will be at most this amount. This is important because attributes are held in memory and large attributes will quickly cause out of memory issues. If the output goes longer than this value, it will be truncated to fit. Consider making this smaller if able.
Add Response Headers To Request false * true
* false
Enabling this property saves all the response headers to the original request. This may be when the response headers are needed but a response is not generated due to the status code received.
Proxy Configuration Service

Controller Service API: 


ProxyConfigurationService

Implementation: 

StandardProxyConfigurationService


Specifies the Proxy Configuration Controller Service to proxy network requests. If set, it supersedes proxy settings configured per component. Supported proxies: HTTP + AuthN

Dynamic Properties:

Dynamic Properties allow the user to specify both the name and value of a property.

Name

Value

Description

Header Name Attribute Expression Language Send request header with a key matching the Dynamic Property Key and a value created by evaluating the Attribute Expression Language set in the value of the Dynamic Property.

Supports Expression Language: true (undefined scope)


Relationships:

Name

Description

Original The original FlowFile will be routed upon success (2xx status codes). It will have new attributes detailing the success of the request.
Failure The original FlowFile will be routed on any type of connection failure, timeout or general exception. It will have new attributes detailing the request.
Retry The original FlowFile will be routed on any status code that can be retried (5xx status codes). It will have new attributes detailing the request.
No Retry The original FlowFile will be routed on any status code that should NOT be retried (1xx, 3xx, 4xx status codes). It will have new attributes detailing the request.
Response A Response FlowFile will be routed upon success (2xx status codes). If the 'Output Response Regardless' property is true then the response will be sent to this relationship regardless of the status code received.

Reads Attributes:

None specified.

Writes Attributes:

Name

Description

mime.type The MIME Type of the flowfiles
aws.gateway.api.status.code The status code that is returned
aws.gateway.api.status.message The status message that is returned
aws.gateway.api.response.body In the instance where the status code received is not a success (2xx)
aws.gateway.api.resource The request resource
aws.gateway.api.tx.id The transaction ID that is returned after reading the response
aws.gateway.api.java.exception.class The Java exception class raised when the processor fails
aws.gateway.api.java.exception.message The Java exception message raised when the processor fails

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component requires an incoming relationship.

System Resource Considerations:

None specified.