External match API - AWS
Use this API to get information on potential matches in a tenant for entities that are added to the tenant from an external file.
Use the external match API to match records stored externally in a file with entities in a Reltio tenant. To use this API, you must provide an input file that contains the records to be matched that can be stored in AWS S3 storage.
The following sections provide information on the request API and request parameters for AWS. For information on the common request parameters and the input and output file formats, see topic External match API.
- Entities must be represented as a JSON array in an AWS S3 file.
- Each entity JSON should be on a separate line of an AWS S3 file.
Request parameters
The following request parameters are used:
| Parameters | Required | Description |
|---|---|---|
s3Region | Yes | Defines the AWS region for S3 bucket. |
urlExpirationPeriod | No | Expiration period in days for the download link from the S3 bucket (default and max value is 7). |
Header parameters
You can use the following parameters for authentication:
| Parameters | Required | Description |
|---|---|---|
awsAccessKey | No | The S3 access key for the amazon bucket. Reltio recommends that you only pass the awsAccessKey as a header parameter and not as a URI parameter. However, if you need to, the parameter must be escaped if they contain special characters. For example: as they are Base64 encoded, they can contain '+' and '/' characters. '+' must be escaped as %2B and '/' can be passed directly in the URI. |
awsSecretKey | No | The S3 secret key for the amazon bucket. Reltio recommends that you only pass the awsSecretKey as a header parameter and not as a URI parameter. However, if you need to, the parameter must be escaped if they contain special characters. For example: as they are Base64 encoded, they can contain '+' and '/' characters. '+' must be escaped as %2B and '/' can be passed directly in the URI. |
awsExternalId | No | An additional identifier that can be given to a role. |
awsRoleArn | No | The Amazon Resource Name (ARN) role that is assigned to you, if you have AWS credentials. |
awsRoleSessionName | No | A name that uniquely identifies the role session. |
AWS IAM Assumed Roles
-
Contact Reltio Support to obtain the Reltio AWS Account ID.
-
Create an AWS S3 bucket. For example,
reltio-external-match-bucket. For more information, see topic https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-bucket.html. -
Create an AWS access policy that allows read, write, and list access to S3 bucket. For example,
s3-reltio-external-match-policy. For more information, see topic https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_create.html. -
Create an AWS role to grant access to the policy.
-
Select Another AWS Account as the role type. For example,
reltio-extmatcher. -
Assign this role to the Reltio AWS Account ID that you receive in step 1. For more information, see https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user.html.
-
Assign the
s3-reltio-external-match-policypolicy to thereltio-extmatcherrole. -
Provide the role ARN to Reltio Support.Note: After the
AWS AssumeRoleis set up, theAWS accesskey andsecretkey are not needed. Instead, you must provideAWS IAM AssumeRoleandExternalID(if the AWS external ID is configured.