AWS connectors
There are four connectors that can be used to invoke different Amazon Web Services (AWS):
All Amazon connectors are displayed on the process diagram with their respective AWS logos.
Important: All AWS connectors require an AWS account with permission to access the features provided by Amazon. This account is separate to the Alfresco hosted environment and should be created and managed by customers.
Lambda
The INVOKE action is used by the Lambda connector to invoke Amazon Web Services (AWS) Lambda functions.
The input parameters to invoke a Lambda function are:
| Parameter | Type | Description |
|---|---|---|
| function | String | Required. The name of the Lambda function to invoke, for example lambda-2. |
| payload | JSON | Optional. The payload that will be passed to the Lambda function as a JSON object. |
The output parameters from invoking a Lambda function are:
| Parameter | Type | Description |
|---|---|---|
| lambdaPayload | JSON | Optional. The Lambda function results payload. |
| lambdaStatus | Integer | Optional. The Lambda function invocation status code. |
| lambdaLog | String | Optional. The log produced during the function invocation. |
Lambda configuration parameters
The configuration parameters for the Lambda connector are:
| Parameter | Description |
|---|---|
| AWS_LAMBDA_AWS_ACCESS_KEY | Required. The access key to authenticate against AWS with. |
| AWS_LAMBDA_AWS_SECRET_KEY | Required. The secret key to authenticate against AWS with. |
| AWS_LAMBDA_AWS_REGION | Required. The region of AWS to invoke the Lambda functions in. |
Lambda errors
The possible errors that can be handled by the Lambda connector are:
| Error | Description |
|---|---|
| MISSING_INPUT | A mandatory input variable was not provided. |
| INVALID_INPUT | The input variable has an invalid type. |
| SERVICE_ERROR | The service encountered an internal error. |
| INVALID_REQUEST | The request body could not be parsed as JSON. |
| REQUEST_TOO_LARGE | The request payload exceeded the Invoke request body JSON input limit. |
| UNKNOWN_ERROR | Unexpected runtime error. |
| BAD_REQUEST | The server could not understand the request due to invalid syntax. |
| UNAUTHORIZED | The request has not been applied because it lacks valid authentication. |
| FORBIDDEN | The server understood the request but refuses to authorize it. |
| NOT_FOUND | The server could not find what was requested. |
| METHOD_NOT_ALLOWED | The request method is known by the server but is not supported. |
| NOT_ACCEPTABLE | The server cannot produce a response matching the list of acceptable values. |
| REQUEST_TIMEOUT | The server would like to shut down this unused connection. |
| CONFLICT | The request conflicts with current state of the server. |
| GONE | No longer available. |
| UNPROCESSABLE_ENTITY | The server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions. |
| LOCKED | The resource that is being accessed is locked. |
| FAILED_DEPENDENCY | The request failed due to failure of a previous request. |
| INTERNAL_SERVER_ERROR | The server has encountered a situation it doesn't know how to handle. |
| NOT_IMPLEMENTED | The request method is not supported by the server and cannot be handled. |
| BAD_GATEWAY | The server got an invalid response. |
| SERVICE_UNAVAILABLE | The server is not ready to handle the request. |
| GATEWAY_TIMEOUT | The server is acting as a gateway and cannot get a response in time. |
Comprehend
The ENTITY action is used by the Comprehend connector to execute Amazon Comprehend natural language processing (NLP) services and identify and analyze text from UTF-8 plain text files.
The Amazon Comprehend APIs that are called using the connector are:
- Detect Dominant Language API
- Detect Entities API
- Batch Detect Entities API
- Start Entities Detection Job API
- Describe Entities Detection Job API
The input parameters of the Comprehend connector are:
| Parameter | Type | Description |
|---|---|---|
| file | File | Requires one. A variable of type file to send for analysis. |
| text | String | Requires one. Raw text to be sent for analysis. |
| mediaType | String | Optional. The media type of the file to be analyzed, for example application/octect-stream. |
| maxEntities | Integer | Optional. The maximum number of entities to be extracted, for example 5. |
| confidenceLevel | String | Optional The confidence level to use in the analysis between 0 and 1, for example 0.75. |
| timeout | Integer | Optional. The timeout period for calling the Comprehend service in milliseconds, for example 910000. |
The output parameters from the Comprehend analysis are:
| Parameter | Type | Description |
|---|---|---|
| awsResponse | JSON | Optional. The result of the analysis from the Comprehend service. |
| aisResponse | JSON | Optional. The result of the analysis in Alfresco Intelligence Service format. |
| entities | JSON | Optional. The result object containing the entities detected. |
Comprehend configuration parameters
The configuration parameters for the Comprehend connector are:
| Parameter | Description |
|---|---|
| AWS_ACCESS_KEY_ID | Required. The access key to authenticate against AWS with. |
| AWS_SECRET_KEY | Required. The secret key to authenticate against AWS with. |
| AWS_REGION | Required. The region of AWS to use the Comprehend service in. |
| AWS_S3_BUCKET | Required. The name of the S3 bucket to use. |
| AWS_COMPREHEND_ROLE_ARN | Required. The Amazon Resource Name for Comprehend to use. |
Comprehend errors
The possible errors that can be handled by the Comprehend connector are:
| Error | Description |
|---|---|
| MISSING_INPUT | A mandatory input variable was not provided. |
| INVALID_INPUT | The input variable has an invalid type. |
| INVALID_RESULT_FORMAT | The REST service result payload cannot be parsed. |
| TEXT_SIZE_LIMIT_EXCEEDED | The size of the input text exceeds the limit. |
| TOO_MANY_REQUEST | The request throughput limit was exceeded. |
| UNSUPPORTED_LANGUAGE | The language of the input text can't be processed. |
| CLIENT_EXECUTION_TIMEOUT | The execution ends because of timeout. |
| UNKNOWN_ERROR | Unexpected runtime error. |
| BAD_REQUEST | The server could not understand the request due to invalid syntax. |
| UNAUTHORIZED | The request has not been applied because it lacks valid authentication. |
| FORBIDDEN | The server understood the request but refuses to authorize it. |
| NOT_FOUND | The server could not find what was requested. |
| METHOD_NOT_ALLOWED | The request method is known by the server but is not supported. |
| NOT_ACCEPTABLE | The server cannot produce a response matching the list of acceptable values. |
| REQUEST_TIMEOUT | The server would like to shut down this unused connection. |
| CONFLICT | The request conflicts with current state of the server. |
| GONE | No longer available. |
| UNPROCESSABLE_ENTITY | The server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions. |
| LOCKED | The resource that is being accessed is locked. |
| FAILED_DEPENDENCY | The request failed due to failure of a previous request. |
| INTERNAL_SERVER_ERROR | The server has encountered a situation it doesn't know how to handle. |
| NOT_IMPLEMENTED | The request method is not supported by the server and cannot be handled. |
| BAD_GATEWAY | The server got an invalid response. |
| SERVICE_UNAVAILABLE | The server is not ready to handle the request. |
| GATEWAY_TIMEOUT | The server is acting as a gateway and cannot get a response in time. |
Rekognition
The LABEL action is used by the Rekognition connector to execute Amazon Rekognition services to identify and label the objects in JPEG and PNG files that are less than 15mb in size.
The Amazon Rekognition API that is called is the Detect Labels API.
Files between 5mb and 15mb are uploaded to an Amazon S3 bucket before processing. The IAM user configured to run the Rekognition service requires access to this bucket, the Rekognition service itself and to have the rekognition:DetectLabels permission.
The input parameters of the Rekognition connector are:
| Parameter | Type | Description |
|---|---|---|
| file | File | Required. A variable of type file to send for analysis. |
| mediaType | String | Optional. The media type of the file to be analyzed, for example application/octect-stream. |
| maxLabels | Integer | Optional. The maximum number of labels to be return. The default value is 10. |
| confidenceLevel | String | Optional The confidence level to use in the analysis between 0 and 1, for example 0.75. |
| timeout | Integer | Optional. The timeout period for calling the Rekognition service in milliseconds, for example 910000. |
The output parameters from the Rekognition analysis are:
| Parameter | Type | Description |
|---|---|---|
| awsResponse | JSON | Optional. The result of the analysis from the Rekognition service. |
| aisResponse | JSON | Optional. The result of the image analysis in Alfresco Intelligence Service format. |
| labels | JSON | Optional. The result object containing the labels detected. |
Rekognition configuration parameters
The configuration parameters for the Rekognition connector are:
| Parameter | Description |
|---|---|
| AWS_ACCESS_KEY_ID | Required. The access key to authenticate against AWS with. |
| AWS_SECRET_KEY | Required. The secret key to authenticate against AWS with. |
| AWS_REGION | Required. The region of AWS to use the Rekognition service in. |
| AWS_S3_BUCKET | Required. The name of the S3 bucket to use. |
Rekognition errors
The possible errors that can be handled by the Rekognition connector are:
| Error | Description |
|---|---|
| MISSING_INPUT | A mandatory input variable was not provided. |
| INVALID_INPUT | The input variable has an invalid type. |
| INVALID_RESULT_FORMAT | The REST service result payload cannot be parsed. |
| PROVISIONED_THROUGHPUT_EXCEEDED | The number of requests exceeded your throughput limit. |
| ACCESS_DENIED | The user is not authorized to perform the action. |
| IMAGE_TOO_LARGE | The input image size exceeds the allowed limit. |
| INVALID_IMAGE_FORMAT | The provided image format is not supported. |
| LIMIT_EXCEEDED | The service limit was exceeded. |
| THROTTLING_ERROR | The service is temporarily unable to process the request. |
| UNKNOWN_ERROR | Unexpected runtime error. |
| BAD_REQUEST | The server could not understand the request due to invalid syntax. |
| UNAUTHORIZED | The request has not been applied because it lacks valid authentication. |
| FORBIDDEN | The server understood the request but refuses to authorize it. |
| NOT_FOUND | The server could not find what was requested. |
| METHOD_NOT_ALLOWED | The request method is known by the server but is not supported. |
| NOT_ACCEPTABLE | The server cannot produce a response matching the list of acceptable values. |
| REQUEST_TIMEOUT | The server would like to shut down this unused connection. |
| CONFLICT | The request conflicts with current state of the server. |
| GONE | No longer available. |
| UNPROCESSABLE_ENTITY | The server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions. |
| LOCKED | The resource that is being accessed is locked. |
| FAILED_DEPENDENCY | The request failed due to failure of a previous request. |
| INTERNAL_SERVER_ERROR | The server has encountered a situation it doesn't know how to handle. |
| NOT_IMPLEMENTED | The request method is not supported by the server and cannot be handled. |
| BAD_GATEWAY | The server got an invalid response. |
| SERVICE_UNAVAILABLE | The server is not ready to handle the request. |
| GATEWAY_TIMEOUT | The server is acting as a gateway and cannot get a response in time. |
Textract
The EXTRACT action is used by the Textract connector to execute Amazon Textract to extract text and metadata from JPEG and PNG files that are less than 5mb in size.
The Amazon Textract APIs called are the Detect Document Text API which joins all LINE block objects with a line separator between them and the Analyze Document API with FORM and TABLES analysis.
The IAM user configured to run the Textract services needs to have the textract:DetectDocumentText and textract:AnalyzeDocument permissions.
The input parameters of the Textract connector are:
| Parameter | Type | Description |
|---|---|---|
| file | File | Required. A variable of type file to send for extraction. |
| outputFormat | String | Optional. The format of the output file. Possible values are JSON and TXT. The default value is JSON. |
| confidenceLevel | String | Optional The confidence level to use in the analysis between 0 and 1, for example 0.75. |
| timeout | Integer | Optional. The timeout period for calling the Textract service in milliseconds, for example 910000. |
The output parameters from the Textract analysis are:
| Parameter | Type | Description |
|---|---|---|
| awsResult | JSON | Optional. The result of the analysis from the Textract service. |
Textract configuration parameters
The configuration parameters for the Textract connector are:
| Parameter | Description |
|---|---|
| AWS_ACCESS_KEY_ID | Required. The access key to authenticate against AWS with. |
| AWS_SECRET_KEY | Required. The secret key to authenticate against AWS with. |
| AWS_REGION | Required. The region of AWS to use the Textract service in. |
| AWS_S3_BUCKET | Required. The name of the S3 bucket to use. |
Textract errors
The possible errors that can be handled by the Textract connector are:
| Error | Description |
|---|---|
| MISSING_INPUT | A mandatory input variable was not provided. |
| INVALID_INPUT | The input variable has an invalid type. |
| INVALID_RESULT_FORMAT | The REST service result payload cannot be parsed. |
| PROVISIONED_THROUGHPUT_EXCEEDED | The number of requests exceeded your throughput limit. |
| ACCESS_DENIED | The user is not authorized to perform the action. |
| IMAGE_TOO_LARGE | The input image size exceeds the allowed limit. |
| INVALID_IMAGE_FORMAT | The provided image format is not supported. |
| LIMIT_EXCEEDED | The service limit was exceeded. |
| THROTTLING_ERROR | The service is temporarily unable to process the request. |
| UNKNOWN_ERROR | Unexpected runtime error. |
| BAD_REQUEST | The server could not understand the request due to invalid syntax. |
| UNAUTHORIZED | The request has not been applied because it lacks valid authentication. |
| FORBIDDEN | The server understood the request but refuses to authorize it. |
| NOT_FOUND | The server could not find what was requested. |
| METHOD_NOT_ALLOWED | The request method is known by the server but is not supported. |
| NOT_ACCEPTABLE | The server cannot produce a response matching the list of acceptable values. |
| REQUEST_TIMEOUT | The server would like to shut down this unused connection. |
| CONFLICT | The request conflicts with current state of the server. |
| GONE | No longer available. |
| UNPROCESSABLE_ENTITY | The server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions. |
| LOCKED | The resource that is being accessed is locked. |
| FAILED_DEPENDENCY | The request failed due to failure of a previous request. |
| INTERNAL_SERVER_ERROR | The server has encountered a situation it doesn't know how to handle. |
| NOT_IMPLEMENTED | The request method is not supported by the server and cannot be handled. |
| BAD_GATEWAY | The server got an invalid response. |
| SERVICE_UNAVAILABLE | The server is not ready to handle the request. |
| GATEWAY_TIMEOUT | The server is acting as a gateway and cannot get a response in time. |
© 2023 Alfresco Software, Inc. All Rights Reserved.
We use cookies on this site to enhance your user experience
By using this site, you are agreeing to allow us to collect and use cookies as outlined in Alfresco’s Cookie Statement and Terms of Use (and you have a legitimate interest in Alfresco and our products, authorizing us to contact you in such methods). If you are not ok with these terms, please do not use this website.