Amazon Comprehend Scope

The Amazon Comprehend activities use the AWS Identity and Access Management (IAM) service to establish an authenticated connection between UiPath and your AWS resources. This connection enables a Robot to call the Amazon Comprehend APIs to read and write resources on your behalf.

To establish an authenticated connection, you create or use an existing IAM user and generate access keys (Access Key Id and Secret Access Key). When you create your IAM user, you assign the policies and permissions that specify the resources your Robot can access (e.g., AmazonComprehendFullAccess).

After creating your IAM user and assigning your policies, you enter the Access Key Id and Secret Access Key in the Amazon Comprehend Scope activity. When you run your automation project, the keys are used to sign the API requests being made by each of the activities.

How it works

The following steps and message sequence diagram is an example of how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.

1. Complete the Setup steps.
2. Add the Amazon Comprehend Scope activity to your project.
3. Enter values for the properties located in the body of the activity.
4. If you wish to re-use the connection in downstream scope activities, enter a variable in the Output property.

In the Body of the Activity

• Authentication Type - The type of authentication you want to use. You can choose either AmazonComprehend, or Existing Connection. Your choice of authentication determines which other authentication properties you see.
• Access Key - The Access Key ID of the IAM User that you want to authenticate. This field supports only Strings or String variables. To retrieve the Access Key ID, see one of the following sections in the AWS documentation:
  • Managing Access Keys (Console)
  • Managing Access Keys (AWS CLI)
  • Managing Access Keys (AWS API)
• Region - The AWS Service Endpoint that you want to use for your connection. Enter a RegionEndpoint or RegionEndpoint variable.
  Note:

  Depending on the activities you're using, select a region where the service(s) is available.

  The list of regions can be found by typing in 'RegionEndpoint' - which is an object type - and then a period (.) which will show the list of regions (see image below).

  Future versions of Amazon Comprehend will provide a drop down list to make this selection easier.

• Secret - The Secret Access Key of the IAM User that you want to connect to the Amazon Rekognition service. This field supports only Strings or String variables. To retrieve the Secret Access Key, see one of the following sections in the AWS documentation:
  • Managing Access Keys (Console)
  • Managing Access Keys (AWS CLI)

  • Managing Access Keys (AWS API)

    Important:

    If you're using an existing IAM user and no longer have the Secret Access Key, you create a new one by clicking the Create access key button in your IAM user summary - this action also creates a new a Access Key Id

    After you click the Create access key button a dialogue box opens. Per the AWS instructions: "Choose Download .csv file to save the access key ID and secret access key to a CSV file on your computer. Store the file in a secure location. You will not have access to the secret access key again after this dialog box closes. After you have downloaded the CSV file, choose Close."

    Amazon recommends frequent key rotation, so you can create new keys at anytime if you can't find the Secret Access Key associated with your Access Key ID. If you do create new keys, be sure to update any Amazon Scope activities in your existing projects.

    To learn more, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html?icmpid=docs_iam_console" target="_blank">Managing Access Keys for IAM Users</a> in the AWS documentation.

• Existing Connection - A previously authenticated AmazonComprehend connection object. Enter an AmazonComprehendConnection variable.

Properties

Common

• DisplayName - The display name of the activity. This field supports only Strings or String variables.

Misc

• Private - If this checkbox is selected, the values of variables and arguments are no longer logged at Verbose level.

Options

• ReportApiErrorAsException - When selected, API error responses are reported in BusinessActivityExecutionException by all child activities that use this application scope. When cleared, the child activity populates the API error message in the ResponseStatus output property and workflow execution continues. Check the ResponseStatus property to confirm successful execution.

Output

• Connection - The connection which can be passed to a child application scope. This field only supports AmazonComprehendConnection variables.