Skip to content
AWS for Query.Farm

aws.dms.describe_endpoint_settings

Example SQL Queries

SELECT * FROM
aws.dms.describe_endpoint_settings
WHERE
"engine_name" = 'VALUE';

Description

Returns information about the possible endpoint settings available when you create an endpoint for a specific database engine.

Table Definition

Column NameColumn Data Type
engine_name Required Input Column

The database engine used for your source or target endpoint.

VARCHAR
marker Input Column

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

VARCHAR
max_records Input Column

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

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
endpoint_settings

Descriptions of the endpoint settings available for your source or target database engine.

STRUCT(
    "name" VARCHAR,
    "type" VARCHAR,
    "enum_values" VARCHAR[],
    "sensitive" BOOLEAN,
    "units" VARCHAR,
    "applicability" VARCHAR,
    "int_value_min" BIGINT,
    "int_value_max" BIGINT,
    "default_value" VARCHAR
)[]
Show child fields
endpoint_settings[]
Show child fields
endpoint_settings[].applicability

The relevance or validity of an endpoint setting for an engine name and its endpoint type.

endpoint_settings[].default_value

The default value of the endpoint setting if no value is specified using CreateEndpoint or ModifyEndpoint.

endpoint_settings[].enum_values[]
endpoint_settings[].int_value_max

The maximum value of an endpoint setting that is of type int.

endpoint_settings[].int_value_min

The minimum value of an endpoint setting that is of type int.

endpoint_settings[].name

The name that you want to give the endpoint settings.

endpoint_settings[].sensitive

A value that marks this endpoint setting as sensitive.

endpoint_settings[].type

The type of endpoint. Valid values are source and target.

endpoint_settings[].units

The unit of measure for this endpoint setting.