Amazon Connect Scope

The Amazon Connect 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 Connect 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., AmazonConnectFullAccess).

After creating your IAM user and assigning your policies, you enter the Access Key Id and Secret Access Key in the Amazon Connect 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.

Complete the Setup steps.
Add the Amazon Connect Scope activity to your project.
Enter values for the Authentication properties.
Enter values for the Instance properties.

Properties

The values for the following properties are specified when adding this activity to your project in UiPath Studio.

Authentication

AccessKeyId - String - The Access Key ID of the IAM User that you want to authenticate. Enter a String or String variable.

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).
Secret - String - The Secret Access Key of the IAM User that you want to connect to the Amazon Connect service. Enter a String or String variable.

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

See additional note and image below.

Common

DisplayName - String - The display name of the activity. Enter a String or String variable.

Instance

InstanceId - String - The id of your Amazon Connect instance. Enter a String or String variable.

To retrieve the Instance ID, see the AWS documentation.
Region - The AWS Service Endpoint that you want to use for your connection. Choose one of seven options: US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Europe (Frankfurt), Europe (London). The default value is US East (N. Virginia).

Depending on the activities you're using, select a region where the service(s) is available. For a list of regions where Amazon Connect is available, see AWS Region Table in the AWS documentation.

Note:
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 Managing Access Keys for IAM Users in the AWS documentation.