DatabaseMigrationService / Client / describe_data_providers

describe_data_providers

DatabaseMigrationService.Client.describe_data_providers(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.describe_data_providers(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string'
)

Parameters:

• Filters (list) –

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

  • (dict) –

    Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.

    • Name (string) – [REQUIRED]

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

    • Values (list) – [REQUIRED]

      The filter value, which can specify one or more values used to narrow the returned results.

      • (string) –

• MaxRecords (integer) – 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.

• Marker (string) –

  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.

Return type:

dict

Returns:

Response Syntax

{
    'Marker': 'string',
    'DataProviders': [
        {
            'DataProviderName': 'string',
            'DataProviderArn': 'string',
            'DataProviderCreationTime': datetime(2015, 1, 1),
            'Description': 'string',
            'Engine': 'string',
            'Settings': {
                'RedshiftSettings': {
                    'ServerName': 'string',
                    'Port': 123,
                    'DatabaseName': 'string'
                },
                'PostgreSqlSettings': {
                    'ServerName': 'string',
                    'Port': 123,
                    'DatabaseName': 'string',
                    'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
                    'CertificateArn': 'string'
                },
                'MySqlSettings': {
                    'ServerName': 'string',
                    'Port': 123,
                    'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
                    'CertificateArn': 'string'
                },
                'OracleSettings': {
                    'ServerName': 'string',
                    'Port': 123,
                    'DatabaseName': 'string',
                    'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
                    'CertificateArn': 'string',
                    'AsmServer': 'string',
                    'SecretsManagerOracleAsmSecretId': 'string',
                    'SecretsManagerOracleAsmAccessRoleArn': 'string',
                    'SecretsManagerSecurityDbEncryptionSecretId': 'string',
                    'SecretsManagerSecurityDbEncryptionAccessRoleArn': 'string'
                },
                'MicrosoftSqlServerSettings': {
                    'ServerName': 'string',
                    'Port': 123,
                    'DatabaseName': 'string',
                    'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
                    'CertificateArn': 'string'
                },
                'DocDbSettings': {
                    'ServerName': 'string',
                    'Port': 123,
                    'DatabaseName': 'string',
                    'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
                    'CertificateArn': 'string'
                },
                'MariaDbSettings': {
                    'ServerName': 'string',
                    'Port': 123,
                    'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
                    'CertificateArn': 'string'
                },
                'MongoDbSettings': {
                    'ServerName': 'string',
                    'Port': 123,
                    'DatabaseName': 'string',
                    'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
                    'CertificateArn': 'string',
                    'AuthType': 'no'|'password',
                    'AuthSource': 'string',
                    'AuthMechanism': 'default'|'mongodb_cr'|'scram_sha_1'
                }
            }
        },
    ]
}

Response Structure

• (dict) –

  • Marker (string) –

    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.

  • DataProviders (list) –

    A description of data providers.

    • (dict) –

      Provides information that defines a data provider.

      • DataProviderName (string) –

        The name of the data provider.

      • DataProviderArn (string) –

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

      • DataProviderCreationTime (datetime) –

        The time the data provider was created.

      • Description (string) –

        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.

      • Engine (string) –

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

      • Settings (dict) –

        The settings in JSON format for a data provider.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: RedshiftSettings, PostgreSqlSettings, MySqlSettings, OracleSettings, MicrosoftSqlServerSettings, DocDbSettings, MariaDbSettings, MongoDbSettings. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        

        • RedshiftSettings (dict) –

          Provides information that defines an Amazon Redshift data provider.

          • ServerName (string) –

            The name of the Amazon Redshift server.

          • Port (integer) –

            The port value for the Amazon Redshift data provider.

          • DatabaseName (string) –

            The database name on the Amazon Redshift data provider.

        • PostgreSqlSettings (dict) –

          Provides information that defines a PostgreSQL data provider.

          • ServerName (string) –

            The name of the PostgreSQL server.

          • Port (integer) –

            The port value for the PostgreSQL data provider.

          • DatabaseName (string) –

            The database name on the PostgreSQL data provider.

          • SslMode (string) –

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

          • CertificateArn (string) –

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

        • MySqlSettings (dict) –

          Provides information that defines a MySQL data provider.

          • ServerName (string) –

            The name of the MySQL server.

          • Port (integer) –

            The port value for the MySQL data provider.

          • SslMode (string) –

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

          • CertificateArn (string) –

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

        • OracleSettings (dict) –

          Provides information that defines an Oracle data provider.

          • ServerName (string) –

            The name of the Oracle server.

          • Port (integer) –

            The port value for the Oracle data provider.

          • DatabaseName (string) –

            The database name on the Oracle data provider.

          • SslMode (string) –

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

          • CertificateArn (string) –

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

          • AsmServer (string) –

            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.

          • SecretsManagerOracleAsmSecretId (string) –

            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.

          • SecretsManagerOracleAsmAccessRoleArn (string) –

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

          • SecretsManagerSecurityDbEncryptionSecretId (string) –

            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.

          • SecretsManagerSecurityDbEncryptionAccessRoleArn (string) –

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

        • MicrosoftSqlServerSettings (dict) –

          Provides information that defines a Microsoft SQL Server data provider.

          • ServerName (string) –

            The name of the Microsoft SQL Server server.

          • Port (integer) –

            The port value for the Microsoft SQL Server data provider.

          • DatabaseName (string) –

            The database name on the Microsoft SQL Server data provider.

          • SslMode (string) –

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

          • CertificateArn (string) –

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

        • DocDbSettings (dict) –

          Provides information that defines a DocumentDB data provider.

          • ServerName (string) –

            The name of the source DocumentDB server.

          • Port (integer) –

            The port value for the DocumentDB data provider.

          • DatabaseName (string) –

            The database name on the DocumentDB data provider.

          • SslMode (string) –

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

          • CertificateArn (string) –

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

        • MariaDbSettings (dict) –

          Provides information that defines a MariaDB data provider.

          • ServerName (string) –

            The name of the MariaDB server.

          • Port (integer) –

            The port value for the MariaDB data provider

          • SslMode (string) –

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

          • CertificateArn (string) –

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

        • MongoDbSettings (dict) –

          Provides information that defines a MongoDB data provider.

          • ServerName (string) –

            The name of the MongoDB server.

          • Port (integer) –

            The port value for the MongoDB data provider.

          • DatabaseName (string) –

            The database name on the MongoDB data provider.

          • SslMode (string) –

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

          • CertificateArn (string) –

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

          • AuthType (string) –

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

          • AuthSource (string) –

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

            The default is "admin".

          • AuthMechanism (string) –

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

Exceptions

• DatabaseMigrationService.Client.exceptions.ResourceNotFoundFault

• DatabaseMigrationService.Client.exceptions.AccessDeniedFault