AWS Console

This article outlines the integration with the AWS Console connector, enabling metadata management through features such as crawling, querying, and data preview. It also ensures secure authentication via Credential Manager.

Overview

Connector Details

Connector Category

Application

OvalEdge Releases Supported

8.1

Connectivity

[How the connection is established with AWS Console]

AWS SDK

Verified AWS Console Version

AWS APIs (STS, EC2, S3)

circle-info

The AWS Console connector has been validated with the mentioned "Verified AWS Console Versions" and is expected to be compatible with other supported AWS Console versions. If there are any issues with validation or metadata crawling, please submit a support ticket for investigation and feedback.

Connector Features

Feature
Availability

Crawling

Delta Crawling

Profiling

Query Sheet

Data Preview

Auto Lineage

Manual Lineage

Secure Authentication via Credential Manager

Data Quality

DAM (Data Access Management)

Bridge

Metadata Mapping

The following objects are crawled from the AWS Console and mapped to the corresponding UI assets.

AWS Console Object
AWS Console Attribute
OvalEdge Attribute
OvalEdge Category
OvalEdge Type

Region

Region Name

Region Identifier

Container

Container

EC2 instance

Instance ID

Instance ID

Table / Entity

Entity

S3 bucket

Bucket Name

Bucket Name

File Folder

File Folder

Set up a Connection

Prerequisites

The following are the prerequisites to establish a connection:

Network and API access

The connector calls AWS over HTTPS. Ensure that outbound TCP port 443 (TLS) from the OvalEdge application environment to AWS service endpoints is allowed. If you use an HTTP proxy, it must permit HTTPS access to AWS. Connectivity uses AWS regional and global endpoints.

circle-exclamation

Service Account User Permissions

circle-exclamation
circle-info

👨‍💻 Who can provide these permissions? These permissions are typically granted by the AWS Console administrator, as users may not have the required access to assign them independently.

Operation
Objects
API/Scopes
Access Permission

Connection Validation

Caller Identity

sts:GetCallerIdentity

IAM policy allowing sts:GetCallerIdentity

Crawling & Regions

Enabled Regions

ec2:DescribeRegions

IAM policy allowing ec2:DescribeRegions

Crawling & Query - EC2

Instances in a Region

ec2:DescribeInstances

IAM policy allowing ec2:DescribeInstances

Crawling & Query - S3

Buckets in the account

s3:ListAllMyBucket

IAM policy allowing s3:ListAllMyBuckets

circle-exclamation

Connection Configuration Steps

circle-exclamation
  1. Log in to OvalEdge, go to Administration > Connectors, click + (New Connector), search for AWS Console, and complete the required parameters.

circle-info

Fields marked with an asterisk (*) are mandatory for establishing a connection.

Field Name
Description

Connector Type

By default, "AWS Console" is displayed as the selected connector type.

Credential Manager*

Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on your selection.

Supported Credential Managers:

  • OE Credential Manager

  • AWS Secrets Manager

  • HashiCorp Vault

  • Azure Key Vault

Connector Name*

Enter a unique name for the AWS Console connection

(Example: "AWS_Console").

Connector description

Enter a brief description of the connector.

Access Key ID*

Enter the AWS IAM access key ID for the integration user or role.

Secret Access Key*

Enter the AWS IAM secret access key (masked).

Region

Enter the AWS Region (for example, us-xxx-1). If not provided, us-east-1 is used by default.

Default Governance Roles

Default Governance Roles*

Select the appropriate users or teams for each governance role from the drop-down list. All users and teams configured in OvalEdge Security are displayed for selection.

Admin Roles

Admin Roles*

Select one or more users from the dropdown list for Integration Admin and Security & Governance Admin. All users configured in OvalEdge Security are available for selection.

No of Archive Objects

No Of Archive Objects*

This shows the number of recent metadata changes to a dataset at the source. By default, it is off. To enable it, toggle the Archive button and specify the number of objects to archive.

Example: Setting it to 4 retrieves the last four changes, displayed in the 'Version' column of the 'Metadata Changes' module.

Bridge

Select Bridge*

If applicable, select the bridge from the drop-down list.

The drop-down list displays all active bridges configured in OvalEdge. These bridges enable communication between data sources and OvalEdge without altering firewall rules.

  1. After entering all connection details, the following actions can be performed:

    1. Click Validate to verify the connection.

    2. Click Save to store the connection for future use.

    3. Click Save & Configure to apply additional settings before saving.

  2. The saved connection will appear on the Connectors home page.

Manage Connector Operations

Crawl/Profile

circle-exclamation

The Crawl/Profile button allows users to select one or more schemas for crawling.

  1. Navigate to the Connectors page and click Crawl/Profile.

  2. Select the schemas to crawl.

  3. The Crawl option is selected by default.

  4. Click Run to collect metadata from the connected source and load it into the OvalEdge Data Catalog.

  5. After a successful crawl, the information appears in the Data Catalog > Databases/Tables/Reports/Files/APIs tab.

The Schedule checkbox allows automated crawling at defined intervals, from a minute to a year.

  1. Click the Schedule checkbox to enable the Select Period drop-down.

  2. Select a time period for the operation from the drop-down menu.

  3. Click Schedule to initiate metadata collection from the connected source.

  4. The system will automatically execute the crawl operation at the scheduled time.

Other Operations

The Connectors page in OvalEdge provides a centralized view of all configured connectors, including their health status.

Managing connectors includes:

  • Connectors Health: Displays the current status of each connector using a green icon for active connections and a red icon for inactive connections, helping to monitor the connectivity with data sources.

  • Viewing: Click the Eye icon next to the connector name to view connector details, including databases, tables, columns, and codes.

Nine Dots Menu Options:

To view, edit, validate, configure, or delete connectors, click on the Nine Dots menu.

  • Edit Connector: Update and revalidate the data source.

  • Validate Connector: Check the connection's integrity.

  • Settings: Modify connector settings.

    • Crawler: Configure data extraction.

    • Access Instructions: Add notes on how data can be accessed.

    • Business Glossary Settings: Manage term associations at the connector level.

  • Delete Connector: Remove a connector with confirmation.

Connectivity Troubleshooting

If incorrect parameters are entered, error messages may appear. Ensure all inputs are accurate to resolve these issues. If issues persist, contact the assigned support team.

S.No.
Error Message(s)
Error Description & Resolution

1

Invalid connection config

Error Description:

  • Connection details are missing or incomplete.

Resolution:

  • Enter all required fields, including Access Key ID and Secret Access Key, and save again.

2

Access Key ID is required.

Error Description:

  • Access Key ID is missing.

Resolution:

  • Enter a valid Access Key ID.

3

Secret Access Key is required.

Error Description:

  • Secret Access Key is missing.

Resolution:

  • Enter a valid Secret Access Key.

4

AWS credentials validation failed

Error Description:

  • AWS could not validate the credentials.

Resolution:

  • Verify the IAM user status, ensure keys are active, check system time, and confirm network access to AWS over HTTPS. Retry validation.

5

Invalid token / signature mismatch

Error Description:

  • AWS rejected the request due to authentication failure.

Resolution:

  • Regenerate the keys if needed, ensure correct values are entered without extra spaces, and verify IAM permissions.

6

Failed to list AWS regions / objects

Error Description:

  • EC2 or S3 API call failed due to missing permissions.

Resolution:

  • Update IAM permissions, verify Region configuration, and retry.


Copyright © 2026, OvalEdge LLC, Peachtree Corners GA USA

Last updated

Was this helpful?