[Ultimate]{class="badge positive"}
Connect AWS Redshift to Experience Platform using the Flow Service API
Read this guide to learn how you can connect your AWS Redshift source account to Adobe Experience Platform using the Flow Service API.
Getting started
This guide requires a working understanding of the following components of Adobe Experience Platform:
- Sources: Experience Platform allows data to be ingested from various sources while providing you with the ability to structure, label, and enhance incoming data using Experience Platform services.
- Sandboxes: Experience Platform provides virtual sandboxes which partition a single Experience Platform instance into separate virtual environments to help develop and evolve digital experience applications.
Using Experience Platform APIs
For information on how to successfully make calls to Experience Platform APIs, see the guide on getting started with Experience Platform APIs.
Connect AWS Redshift to Experience Platform on Azure azure
Read the steps below for information on how to connect your AWS Redshift source to Experience Platform on Azure.
Gather required credentials
Provide the required connection properties to connect Flow Service with AWS Redshift. You can also provide the optional table property to scope your connection to a single table.
serverportusernamepassworddatabasetable{SCHEMA}.{TABLE}, for example, test_schema.my_table. Provide exactly one schema and one table separated by a single period.connectionSpec.id3416976c-a9ca-4bba-901a-1f08f66978ff.For more information about getting started, refer to this AWS Redshift document.
Create a base connection for AWS Redshift on Experience Platform on Azure [#azure-base]
A base connection retains information between your source and Experience Platform, including your source’s authentication credentials, the current state of the connection, and your unique base connection ID. The base connection ID allows you to explore and navigate files from within your source and identify the specific items that you want to ingest, including information regarding their data types and formats.
To create a base connection ID, make a POST request to the /connections endpoint while providing your AWS Redshift authentication credentials as part of the request parameters.
To scope the connection to a single table, include auth.params.table in your request. When provided, root exploration (GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root) returns only the specified table. Omit auth.params.table to return the full list of tables in the database during root exploration.
API format
POST /connections
Request
The following request creates a base connection for AWS Redshift scoped to a single table:
| code language-shell |
|---|
|
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 | |
|---|---|
| Property | Description |
auth.params.server |
The server name of your AWS Redshift instance. |
auth.params.port |
The TCP port that a AWS Redshift server uses to listen for client connections. |
auth.params.username |
The username associated with your AWS Redshift account. |
auth.params.password |
The password that corresponds with the user account. |
auth.params.database |
The AWS Redshift database where data is to be fetched from. |
auth.params.table |
Optional. The table to scope this connection to. Use <schema>.<table>, for example, test_schema.my_table. Provide exactly one schema and one table separated by a single period. When provided, root exploration returns only the specified table. When omitted, root exploration returns all tables in the database. |
connectionSpec.id |
The AWS Redshift connection specification ID: 3416976c-a9ca-4bba-901a-1f08f66978ff |
Response
A successful response returns the newly created connection, including its unique identifier (id). This ID is required to explore your data in the next tutorial.
| code language-json |
|---|
|
Connect AWS Redshift to Experience Platform on AWS Web Services (AWS) aws
Read the steps below for information on how to connect your AWS Redshift source to Experience Platform on AWS.
Create a base connection for AWS Redshift on Experience Platform on AWS aws-base
API format
POST /connections
Request
The following request creates a base connection for AWS Redshift:
| code language-shell |
|---|
|
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 | |
|---|---|
| Property | Description |
auth.params.server |
The server name of your AWS Redshift instance. |
auth.params.port |
The TCP port that a AWS Redshift server uses to listen for client connections. |
auth.params.username |
The username associated with your AWS Redshift account. |
auth.params.password |
The password that corresponds with the user account. |
auth.params.database |
The AWS Redshift database where data is to be fetched from. |
auth.params.schema |
The name of the schema associated with your AWS Redshift database. You must ensure that the user you want to give database access to, also has access to this schema. |
connectionSpec.id |
The AWS Redshift connection specification ID: 3416976c-a9ca-4bba-901a-1f08f66978ff |
Response
A successful response returns details of the newly created connection, including its unique identifier (id). This ID is required to explore your storage in the next tutorial.
| code language-json |
|---|
|
Next steps
By following this tutorial, you have created an AWS Redshift base connection using the Flow Service API. You can use this base connection ID in the following tutorials: