Skip to content
AWS for Query.Farm

aws.dms.describe_data_providers

Example SQL Queries

SELECT * FROM
aws.dms.describe_data_providers;

Description

Returns a paginated list of data providers for your account in the current region.

Table Definition

Column NameColumn Data Type
filters Input Column

Filters applied to the data providers described in the form of key-value pairs.

Valid filter names: data-provider-identifier

STRUCT(
    "name" VARCHAR,
    "values" VARCHAR[]
)[]
Show child fields
filters[]
Show child fields
filters[].name

The name of the filter as specified for a Describe* or similar operation.

filters[].values[]
marker Input Column

Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

VARCHAR
max_records Input Column

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, DMS includes a pagination token in the response so that you can retrieve the remaining results.

BIGINT
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
data_providers

A description of data providers.

STRUCT(
    "data_provider_name" VARCHAR,
    "data_provider_arn" VARCHAR,
    "data_provider_creation_time" TIMESTAMP_S,
    "description" VARCHAR,
    "engine" VARCHAR,
    "settings" STRUCT(
        "redshift_settings" STRUCT(
            "server_name" VARCHAR,
            "port" BIGINT,
            "database_name" VARCHAR
        ),
        "postgre_sql_settings" STRUCT(
            "server_name" VARCHAR,
            "port" BIGINT,
            "database_name" VARCHAR,
            "ssl_mode" VARCHAR,
            "certificate_arn" VARCHAR
        ),
        "my_sql_settings" STRUCT(
            "server_name" VARCHAR,
            "port" BIGINT,
            "ssl_mode" VARCHAR,
            "certificate_arn" VARCHAR
        ),
        "oracle_settings" STRUCT(
            "server_name" VARCHAR,
            "port" BIGINT,
            "database_name" VARCHAR,
            "ssl_mode" VARCHAR,
            "certificate_arn" VARCHAR,
            "asm_server" VARCHAR,
            "secrets_manager_oracle_asm_secret_id" VARCHAR,
            "secrets_manager_oracle_asm_access_role_arn" VARCHAR,
            "secrets_manager_security_db_encryption_secret_id" VARCHAR,
            "secrets_manager_security_db_encryption_access_role_arn" VARCHAR
        ),
        "microsoft_sql_server_settings" STRUCT(
            "server_name" VARCHAR,
            "port" BIGINT,
            "database_name" VARCHAR,
            "ssl_mode" VARCHAR,
            "certificate_arn" VARCHAR
        ),
        "doc_db_settings" STRUCT(
            "server_name" VARCHAR,
            "port" BIGINT,
            "database_name" VARCHAR,
            "ssl_mode" VARCHAR,
            "certificate_arn" VARCHAR
        ),
        "maria_db_settings" STRUCT(
            "server_name" VARCHAR,
            "port" BIGINT,
            "ssl_mode" VARCHAR,
            "certificate_arn" VARCHAR
        ),
        "mongo_db_settings" STRUCT(
            "server_name" VARCHAR,
            "port" BIGINT,
            "database_name" VARCHAR,
            "ssl_mode" VARCHAR,
            "certificate_arn" VARCHAR,
            "auth_type" VARCHAR,
            "auth_source" VARCHAR,
            "auth_mechanism" VARCHAR
        )
    )
)[]
Show child fields
data_providers[]
Show child fields
data_providers[].data_provider_arn

The Amazon Resource Name (ARN) string that uniquely identifies the data provider.

data_providers[].data_provider_creation_time

The time the data provider was created.

data_providers[].data_provider_name

The name of the data provider.

data_providers[].description

A description of the data provider. Descriptions can have up to 31 characters. A description can contain only ASCII letters, digits, and hyphens ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter.

data_providers[].engine

The type of database engine for the data provider. Valid values include "aurora", "aurora-postgresql", "mysql", "oracle", "postgres", "sqlserver", redshift, mariadb, mongodb, and docdb. A value of "aurora" represents Amazon Aurora MySQL-Compatible Edition.

data_providers[].settings

The settings in JSON format for a data provider.

Show child fields
data_providers[].settings.doc_db_settings

Provides information that defines a DocumentDB data provider.

Show child fields
data_providers[].settings.doc_db_settings.certificate_arn

The Amazon Resource Name (ARN) of the certificate used for SSL connection.

data_providers[].settings.doc_db_settings.database_name

The database name on the DocumentDB data provider.

data_providers[].settings.doc_db_settings.port

The port value for the DocumentDB data provider.

data_providers[].settings.doc_db_settings.server_name

The name of the source DocumentDB server.

data_providers[].settings.doc_db_settings.ssl_mode

The SSL mode used to connect to the DocumentDB data provider. The default value is none.

data_providers[].settings.maria_db_settings

Provides information that defines a MariaDB data provider.

Show child fields
data_providers[].settings.maria_db_settings.certificate_arn

The Amazon Resource Name (ARN) of the certificate used for SSL connection.

data_providers[].settings.maria_db_settings.port

The port value for the MariaDB data provider

data_providers[].settings.maria_db_settings.server_name

The name of the MariaDB server.

data_providers[].settings.maria_db_settings.ssl_mode

The SSL mode used to connect to the MariaDB data provider. The default value is none.

data_providers[].settings.microsoft_sql_server_settings

Provides information that defines a Microsoft SQL Server data provider.

Show child fields
data_providers[].settings.microsoft_sql_server_settings.certificate_arn

The Amazon Resource Name (ARN) of the certificate used for SSL connection.

data_providers[].settings.microsoft_sql_server_settings.database_name

The database name on the Microsoft SQL Server data provider.

data_providers[].settings.microsoft_sql_server_settings.port

The port value for the Microsoft SQL Server data provider.

data_providers[].settings.microsoft_sql_server_settings.server_name

The name of the Microsoft SQL Server server.

data_providers[].settings.microsoft_sql_server_settings.ssl_mode

The SSL mode used to connect to the Microsoft SQL Server data provider. The default value is none.

data_providers[].settings.mongo_db_settings

Provides information that defines a MongoDB data provider.

Show child fields
data_providers[].settings.mongo_db_settings.auth_mechanism

The authentication method for connecting to the data provider. Valid values are DEFAULT, MONGODB_CR, or SCRAM_SHA_1.

data_providers[].settings.mongo_db_settings.auth_source

The MongoDB database name. This setting isn't used when AuthType is set to "no".

The default is "admin".

data_providers[].settings.mongo_db_settings.auth_type

The authentication type for the database connection. Valid values are PASSWORD or NO.

data_providers[].settings.mongo_db_settings.certificate_arn

The Amazon Resource Name (ARN) of the certificate used for SSL connection.

data_providers[].settings.mongo_db_settings.database_name

The database name on the MongoDB data provider.

data_providers[].settings.mongo_db_settings.port

The port value for the MongoDB data provider.

data_providers[].settings.mongo_db_settings.server_name

The name of the MongoDB server.

data_providers[].settings.mongo_db_settings.ssl_mode

The SSL mode used to connect to the MongoDB data provider. The default value is none.

data_providers[].settings.my_sql_settings

Provides information that defines a MySQL data provider.

Show child fields
data_providers[].settings.my_sql_settings.certificate_arn

The Amazon Resource Name (ARN) of the certificate used for SSL connection.

data_providers[].settings.my_sql_settings.port

The port value for the MySQL data provider.

data_providers[].settings.my_sql_settings.server_name

The name of the MySQL server.

data_providers[].settings.my_sql_settings.ssl_mode

The SSL mode used to connect to the MySQL data provider. The default value is none.

data_providers[].settings.oracle_settings

Provides information that defines an Oracle data provider.

Show child fields
data_providers[].settings.oracle_settings.asm_server

The address of your Oracle Automatic Storage Management (ASM) server. You can set this value from the asm_server value. You set asm_server as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.

data_providers[].settings.oracle_settings.certificate_arn

The Amazon Resource Name (ARN) of the certificate used for SSL connection.

data_providers[].settings.oracle_settings.database_name

The database name on the Oracle data provider.

data_providers[].settings.oracle_settings.port

The port value for the Oracle data provider.

data_providers[].settings.oracle_settings.secrets_manager_oracle_asm_access_role_arn

The ARN of the IAM role that provides access to the secret in Secrets Manager that contains the Oracle ASM connection details.

data_providers[].settings.oracle_settings.secrets_manager_oracle_asm_secret_id

The identifier of the secret in Secrets Manager that contains the Oracle ASM connection details.

Required only if your data provider uses the Oracle ASM server.

data_providers[].settings.oracle_settings.secrets_manager_security_db_encryption_access_role_arn

The ARN of the IAM role that provides access to the secret in Secrets Manager that contains the TDE password.

data_providers[].settings.oracle_settings.secrets_manager_security_db_encryption_secret_id

The identifier of the secret in Secrets Manager that contains the transparent data encryption (TDE) password. DMS requires this password to access Oracle redo logs encrypted by TDE using Binary Reader.

data_providers[].settings.oracle_settings.server_name

The name of the Oracle server.

data_providers[].settings.oracle_settings.ssl_mode

The SSL mode used to connect to the Oracle data provider. The default value is none.

data_providers[].settings.postgre_sql_settings

Provides information that defines a PostgreSQL data provider.

Show child fields
data_providers[].settings.postgre_sql_settings.certificate_arn

The Amazon Resource Name (ARN) of the certificate used for SSL connection.

data_providers[].settings.postgre_sql_settings.database_name

The database name on the PostgreSQL data provider.

data_providers[].settings.postgre_sql_settings.port

The port value for the PostgreSQL data provider.

data_providers[].settings.postgre_sql_settings.server_name

The name of the PostgreSQL server.

data_providers[].settings.postgre_sql_settings.ssl_mode

The SSL mode used to connect to the PostgreSQL data provider. The default value is none.

data_providers[].settings.redshift_settings

Provides information that defines an Amazon Redshift data provider.

Show child fields
data_providers[].settings.redshift_settings.database_name

The database name on the Amazon Redshift data provider.

data_providers[].settings.redshift_settings.port

The port value for the Amazon Redshift data provider.

data_providers[].settings.redshift_settings.server_name

The name of the Amazon Redshift server.