AWS Database Migration Service

Applies a pending maintenance action to a resource (for example, to a replication instance).

See also: AWS API Documentation

Request Syntax

client.apply_pending_maintenance_action(
    ReplicationInstanceArn='string',
    ApplyAction='string',
    OptInType='string'
)

type ReplicationInstanceArn

string

param ReplicationInstanceArn

[REQUIRED]

The Amazon Resource Name (ARN) of the AWS DMS resource that the pending maintenance action applies to.

type ApplyAction

string

param ApplyAction

[REQUIRED]

The pending maintenance action to apply to this resource.

type OptInType

string

param OptInType

[REQUIRED]

A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type immediate cannot be undone.

Valid values:

• immediate - Apply the maintenance action immediately.

• next-maintenance - Apply the maintenance action during the next maintenance window for the resource.

• undo-opt-in - Cancel any existing next-maintenance opt-in requests.

rtype

dict

returns

Response Syntax

{
    'ResourcePendingMaintenanceActions': {
        'ResourceIdentifier': 'string',
        'PendingMaintenanceActionDetails': [
            {
                'Action': 'string',
                'AutoAppliedAfterDate': datetime(2015, 1, 1),
                'ForcedApplyDate': datetime(2015, 1, 1),
                'OptInStatus': 'string',
                'CurrentApplyDate': datetime(2015, 1, 1),
                'Description': 'string'
            },
        ]
    }
}

Response Structure

• (dict) --

  • ResourcePendingMaintenanceActions (dict) --

    The AWS DMS resource that the pending maintenance action will be applied to.

    • ResourceIdentifier (string) --

      The Amazon Resource Name (ARN) of the DMS resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN) in the DMS documentation.

    • PendingMaintenanceActionDetails (list) --

      Detailed information about the pending maintenance action.

      • (dict) --

        • Action (string) --

          The type of pending maintenance action that is available for the resource.

        • AutoAppliedAfterDate (datetime) --

          The date of the maintenance window when the action will be applied. The maintenance action will be applied to the resource during its first maintenance window after this date. If this date is specified, any next-maintenance opt-in requests are ignored.

        • ForcedApplyDate (datetime) --

          The date when the maintenance action will be automatically applied. The maintenance action will be applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any immediate opt-in requests are ignored.

        • OptInStatus (string) --

          Indicates the type of opt-in request that has been received for the resource.

        • CurrentApplyDate (datetime) --

          The effective date when the pending maintenance action will be applied to the resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate , and the ForcedApplyDate . This value is blank if an opt-in request has not been received and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate .

        • Description (string) --

          A description providing more detail about the maintenance action.

For internal use only

See also: AWS API Documentation

Request Syntax

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

type ReplicationInstanceArn

string

param ReplicationInstanceArn

The ARN of the replication instance.

type Filters

list

param Filters

• (dict) --

  • Name (string) -- [REQUIRED]

    The name of the filter.

  • Values (list) -- [REQUIRED]

    The filter value.

    • (string) --

type Marker

string

param Marker

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 .

type MaxRecords

integer

param MaxRecords

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.

Default: 100

Constraints: Minimum 20, maximum 100.

rtype

dict

returns

Response Syntax

{
    'PendingMaintenanceActions': [
        {
            'ResourceIdentifier': 'string',
            'PendingMaintenanceActionDetails': [
                {
                    'Action': 'string',
                    'AutoAppliedAfterDate': datetime(2015, 1, 1),
                    'ForcedApplyDate': datetime(2015, 1, 1),
                    'OptInStatus': 'string',
                    'CurrentApplyDate': datetime(2015, 1, 1),
                    'Description': 'string'
                },
            ]
        },
    ],
    'Marker': 'string'
}

Response Structure

• (dict) --

  • PendingMaintenanceActions (list) --

    The pending maintenance action.

    • (dict) --

      • ResourceIdentifier (string) --

        The Amazon Resource Name (ARN) of the DMS resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN) in the DMS documentation.

      • PendingMaintenanceActionDetails (list) --

        Detailed information about the pending maintenance action.

        • (dict) --

          • Action (string) --

            The type of pending maintenance action that is available for the resource.

          • AutoAppliedAfterDate (datetime) --

            The date of the maintenance window when the action will be applied. The maintenance action will be applied to the resource during its first maintenance window after this date. If this date is specified, any next-maintenance opt-in requests are ignored.

          • ForcedApplyDate (datetime) --

            The date when the maintenance action will be automatically applied. The maintenance action will be applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any immediate opt-in requests are ignored.

          • OptInStatus (string) --

            Indicates the type of opt-in request that has been received for the resource.

          • CurrentApplyDate (datetime) --

            The effective date when the pending maintenance action will be applied to the resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate , and the ForcedApplyDate . This value is blank if an opt-in request has not been received and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate .

          • Description (string) --

            A description providing more detail about the maintenance action.

  • Marker (string) --

    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 .

{'RedshiftSettings': {'AcceptAnyDate': 'boolean',
                      'AfterConnectScript': 'string',
                      'BucketFolder': 'string',
                      'BucketName': 'string',
                      'ConnectionTimeout': 'integer',
                      'DatabaseName': 'string',
                      'DateFormat': 'string',
                      'EmptyAsNull': 'boolean',
                      'EncryptionMode': 'sse-s3 | sse-kms',
                      'FileTransferUploadStreams': 'integer',
                      'LoadTimeout': 'integer',
                      'MaxFileSize': 'integer',
                      'Password': 'string',
                      'Port': 'integer',
                      'RemoveQuotes': 'boolean',
                      'ReplaceChars': 'string',
                      'ReplaceInvalidChars': 'string',
                      'ServerName': 'string',
                      'ServerSideEncryptionKmsKeyId': 'string',
                      'ServiceAccessRoleArn': 'string',
                      'TimeFormat': 'string',
                      'TrimBlanks': 'boolean',
                      'TruncateColumns': 'boolean',
                      'Username': 'string',
                      'WriteBufferSize': 'integer'},
 'S3Settings': {'CdcInsertsOnly': 'boolean',
                'DataFormat': 'csv | parquet',
                'DataPageSize': 'integer',
                'DictPageSizeLimit': 'integer',
                'EnableStatistics': 'boolean',
                'EncodingType': 'plain | plain-dictionary | rle-dictionary',
                'EncryptionMode': 'sse-s3 | sse-kms',
                'ParquetVersion': 'parquet-1-0 | parquet-2-0',
                'RowGroupLength': 'integer',
                'ServerSideEncryptionKmsKeyId': 'string'}}

{'Endpoint': {'RedshiftSettings': {'AcceptAnyDate': 'boolean',
                                   'AfterConnectScript': 'string',
                                   'BucketFolder': 'string',
                                   'BucketName': 'string',
                                   'ConnectionTimeout': 'integer',
                                   'DatabaseName': 'string',
                                   'DateFormat': 'string',
                                   'EmptyAsNull': 'boolean',
                                   'EncryptionMode': 'sse-s3 | sse-kms',
                                   'FileTransferUploadStreams': 'integer',
                                   'LoadTimeout': 'integer',
                                   'MaxFileSize': 'integer',
                                   'Password': 'string',
                                   'Port': 'integer',
                                   'RemoveQuotes': 'boolean',
                                   'ReplaceChars': 'string',
                                   'ReplaceInvalidChars': 'string',
                                   'ServerName': 'string',
                                   'ServerSideEncryptionKmsKeyId': 'string',
                                   'ServiceAccessRoleArn': 'string',
                                   'TimeFormat': 'string',
                                   'TrimBlanks': 'boolean',
                                   'TruncateColumns': 'boolean',
                                   'Username': 'string',
                                   'WriteBufferSize': 'integer'},
              'S3Settings': {'CdcInsertsOnly': 'boolean',
                             'DataFormat': 'csv | parquet',
                             'DataPageSize': 'integer',
                             'DictPageSizeLimit': 'integer',
                             'EnableStatistics': 'boolean',
                             'EncodingType': 'plain | plain-dictionary | '
                                             'rle-dictionary',
                             'EncryptionMode': 'sse-s3 | sse-kms',
                             'ParquetVersion': 'parquet-1-0 | parquet-2-0',
                             'RowGroupLength': 'integer',
                             'ServerSideEncryptionKmsKeyId': 'string'}}}

Creates an endpoint using the provided settings.

See also: AWS API Documentation

Request Syntax

client.create_endpoint(
    EndpointIdentifier='string',
    EndpointType='source'|'target',
    EngineName='string',
    Username='string',
    Password='string',
    ServerName='string',
    Port=123,
    DatabaseName='string',
    ExtraConnectionAttributes='string',
    KmsKeyId='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    CertificateArn='string',
    SslMode='none'|'require'|'verify-ca'|'verify-full',
    ServiceAccessRoleArn='string',
    ExternalTableDefinition='string',
    DynamoDbSettings={
        'ServiceAccessRoleArn': 'string'
    },
    S3Settings={
        'ServiceAccessRoleArn': 'string',
        'ExternalTableDefinition': 'string',
        'CsvRowDelimiter': 'string',
        'CsvDelimiter': 'string',
        'BucketFolder': 'string',
        'BucketName': 'string',
        'CompressionType': 'none'|'gzip',
        'EncryptionMode': 'sse-s3'|'sse-kms',
        'ServerSideEncryptionKmsKeyId': 'string',
        'DataFormat': 'csv'|'parquet',
        'EncodingType': 'plain'|'plain-dictionary'|'rle-dictionary',
        'DictPageSizeLimit': 123,
        'RowGroupLength': 123,
        'DataPageSize': 123,
        'ParquetVersion': 'parquet-1-0'|'parquet-2-0',
        'EnableStatistics': True|False,
        'CdcInsertsOnly': True|False
    },
    DmsTransferSettings={
        'ServiceAccessRoleArn': 'string',
        'BucketName': 'string'
    },
    MongoDbSettings={
        'Username': 'string',
        'Password': 'string',
        'ServerName': 'string',
        'Port': 123,
        'DatabaseName': 'string',
        'AuthType': 'no'|'password',
        'AuthMechanism': 'default'|'mongodb_cr'|'scram_sha_1',
        'NestingLevel': 'none'|'one',
        'ExtractDocId': 'string',
        'DocsToInvestigate': 'string',
        'AuthSource': 'string',
        'KmsKeyId': 'string'
    },
    KinesisSettings={
        'StreamArn': 'string',
        'MessageFormat': 'json',
        'ServiceAccessRoleArn': 'string'
    },
    ElasticsearchSettings={
        'ServiceAccessRoleArn': 'string',
        'EndpointUri': 'string',
        'FullLoadErrorPercentage': 123,
        'ErrorRetryDuration': 123
    },
    RedshiftSettings={
        'AcceptAnyDate': True|False,
        'AfterConnectScript': 'string',
        'BucketFolder': 'string',
        'BucketName': 'string',
        'ConnectionTimeout': 123,
        'DatabaseName': 'string',
        'DateFormat': 'string',
        'EmptyAsNull': True|False,
        'EncryptionMode': 'sse-s3'|'sse-kms',
        'FileTransferUploadStreams': 123,
        'LoadTimeout': 123,
        'MaxFileSize': 123,
        'Password': 'string',
        'Port': 123,
        'RemoveQuotes': True|False,
        'ReplaceInvalidChars': 'string',
        'ReplaceChars': 'string',
        'ServerName': 'string',
        'ServiceAccessRoleArn': 'string',
        'ServerSideEncryptionKmsKeyId': 'string',
        'TimeFormat': 'string',
        'TrimBlanks': True|False,
        'TruncateColumns': True|False,
        'Username': 'string',
        'WriteBufferSize': 123
    }
)

type EndpointIdentifier

string

param EndpointIdentifier

[REQUIRED]

The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.

type EndpointType

string

param EndpointType

[REQUIRED]

The type of endpoint.

type EngineName

string

param EngineName

[REQUIRED]

The type of engine for the endpoint. Valid values, depending on the EndPointType value, include mysql , oracle , postgres , mariadb , aurora , aurora-postgresql , redshift , s3 , db2 , azuredb , sybase , dynamodb , mongodb , and sqlserver .

type Username

string

param Username

The user name to be used to log in to the endpoint database.

type Password

string

param Password

The password to be used to log in to the endpoint database.

type ServerName

string

param ServerName

The name of the server where the endpoint database resides.

type Port

integer

param Port

The port used by the endpoint database.

type DatabaseName

string

param DatabaseName

The name of the endpoint database.

type ExtraConnectionAttributes

string

param ExtraConnectionAttributes

Additional attributes associated with the connection.

type KmsKeyId

string

param KmsKeyId

The AWS KMS key identifier to use to encrypt the connection parameters. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

type Tags

list

param Tags

Tags to be added to the endpoint.

• (dict) --

  • Key (string) --

    A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and cannot be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").

  • Value (string) --

    A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and cannot be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").

type CertificateArn

string

param CertificateArn

The Amazon Resource Name (ARN) for the certificate.

type SslMode

string

param SslMode

The Secure Sockets Layer (SSL) mode to use for the SSL connection. The SSL mode can be one of four values: none , require , verify-ca , verify-full . The default value is none .

type ServiceAccessRoleArn

string

param ServiceAccessRoleArn

The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint.

type ExternalTableDefinition

string

param ExternalTableDefinition

The external table definition.

type DynamoDbSettings

dict

param DynamoDbSettings

Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see Using Object Mapping to Migrate Data to DynamoDB in the AWS Database Migration Service User Guide.

• ServiceAccessRoleArn (string) -- [REQUIRED]

  The Amazon Resource Name (ARN) used by the service access IAM role.

type S3Settings

dict

param S3Settings

Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the AWS Database Migration Service User Guide.

• ServiceAccessRoleArn (string) --

  The Amazon Resource Name (ARN) used by the service access IAM role.

• ExternalTableDefinition (string) --

  The external table definition.

• CsvRowDelimiter (string) --

  The delimiter used to separate rows in the source files. The default is a carriage return (\n ).

• CsvDelimiter (string) --

  The delimiter used to separate columns in the source files. The default is a comma.

• BucketFolder (string) --

  An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path <bucketFolder>/<schema_name>/<table_name>/ . If this parameter is not specified, then the path used is <schema_name>/<table_name>/ .

• BucketName (string) --

  The name of the S3 bucket.

• CompressionType (string) --

  An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed. Applies to both CSV and PARQUET data formats.

• EncryptionMode (string) --

  The type of server side encryption you want to use for your data. This is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (default) or SSE_KMS . To use SSE_S3 , you need an IAM role with permission to allow "arn:aws:s3:::dms-*" to use the following actions:

  • s3:CreateBucket

  • s3:ListBucket

  • s3:DeleteBucket

  • s3:GetBucketLocation

  • s3:GetObject

  • s3:PutObject

  • s3:DeleteObject

  • s3:GetObjectVersion

  • s3:GetBucketPolicy

  • s3:PutBucketPolicy

  • s3:DeleteBucketPolicy

• ServerSideEncryptionKmsKeyId (string) --

  If you are using SSE_KMS for the EncryptionMode , provide the KMS Key ID. The key you use needs an attached policy that enables IAM user permissions and allows use of the key.

  Here is a CLI example: aws dms create-endpoint --endpoint-identifier <value> --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn=<value>,BucketFolder=<value>,BucketName=<value>,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=<value>

• DataFormat (string) --

  The format of the data which you want to use for output. You can choose one of the following:

  • CSV : This is a row-based format with comma-separated values.

  • PARQUET : Apache Parquet is a columnar storage format that features efficient compression and provides faster query response.

• EncodingType (string) --

  The type of encoding you are using: RLE_DICTIONARY (default), PLAIN , or PLAIN_DICTIONARY .

  • RLE_DICTIONARY uses a combination of bit-packing and run-length encoding to store repeated values more efficiently.

  • PLAIN does not use encoding at all. Values are stored as they are.

  • PLAIN_DICTIONARY builds a dictionary of the values encountered in a given column. The dictionary is stored in a dictionary page for each column chunk.

• DictPageSizeLimit (integer) --

  The maximum size of an encoded dictionary page of a column. If the dictionary page exceeds this, this column is stored using an encoding type of PLAIN . Defaults to 1024 * 1024 bytes (1MiB), the maximum size of a dictionary page before it reverts to PLAIN encoding. For PARQUET format only.

• RowGroupLength (integer) --

  The number of rows in a row group. A smaller row group size provides faster reads. But as the number of row groups grows, the slower writes become. Defaults to 10,000 (ten thousand) rows. For PARQUET format only.

  If you choose a value larger than the maximum, RowGroupLength is set to the max row group length in bytes (64 * 1024 * 1024).

• DataPageSize (integer) --

  The size of one data page in bytes. Defaults to 1024 * 1024 bytes (1MiB). For PARQUET format only.

• ParquetVersion (string) --

  The version of Apache Parquet format you want to use: PARQUET_1_0 (default) or PARQUET_2_0 .

• EnableStatistics (boolean) --

  Enables statistics for Parquet pages and rowGroups. Choose TRUE to enable statistics, choose FALSE to disable. Statistics include NULL , DISTINCT , MAX , and MIN values. Defaults to TRUE . For PARQUET format only.

• CdcInsertsOnly (boolean) --

  Option to write only INSERT operations to the comma-separated value (CSV) output files. By default, the first field in a CSV record contains the letter I (insert), U (update) or D (delete) to indicate whether the row was inserted, updated, or deleted at the source database. If cdcInsertsOnly is set to true, then only INSERT s are recorded in the CSV file, without the I annotation on each line. Valid values are TRUE and FALSE .

type DmsTransferSettings

dict

param DmsTransferSettings

The settings in JSON format for the DMS transfer type of source endpoint.

Possible attributes include the following:

• serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.

• bucketName - The name of the S3 bucket to use.

• compressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this value.

Shorthand syntax for these attributes is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string

JSON syntax for these attributes is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }

• ServiceAccessRoleArn (string) --

  The IAM role that has permission to access the Amazon S3 bucket.

• BucketName (string) --

  The name of the S3 bucket to use.

type MongoDbSettings

dict

param MongoDbSettings

Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in Using MongoDB as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.

• Username (string) --

  The user name you use to access the MongoDB source endpoint.

• Password (string) --

  The password for the user account you use to access the MongoDB source endpoint.

• ServerName (string) --

  The name of the server on the MongoDB source endpoint.

• Port (integer) --

  The port value for the MongoDB source endpoint.

• DatabaseName (string) --

  The database name on the MongoDB source endpoint.

• AuthType (string) --

  The authentication type you use to access the MongoDB source endpoint.

  Valid values: NO, PASSWORD

  When NO is selected, user name and password parameters are not used and can be empty.

• AuthMechanism (string) --

  The authentication mechanism you use to access the MongoDB source endpoint.

  Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1

  DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.

• NestingLevel (string) --

  Specifies either document or table mode.

  Valid values: NONE, ONE

  Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.

• ExtractDocId (string) --

  Specifies the document ID. Use this attribute when NestingLevel is set to NONE.

  Default value is false.

• DocsToInvestigate (string) --

  Indicates the number of documents to preview to determine the document organization. Use this attribute when NestingLevel is set to ONE.

  Must be a positive value greater than 0. Default value is 1000.

• AuthSource (string) --

  The MongoDB database name. This attribute is not used when authType=NO .

  The default is admin.

• KmsKeyId (string) --

  The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

type KinesisSettings

dict

param KinesisSettings

Settings in JSON format for the target Amazon Kinesis Data Streams endpoint. For more information about the available settings, see `Using Object Mapping to Migrate Data to a Kinesis Data Stream <https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping >`__ in the AWS Database Migration User Guide.

• StreamArn (string) --

  The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.

• MessageFormat (string) --

  The output format for the records created on the endpoint. The message format is JSON .

• ServiceAccessRoleArn (string) --

  The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Amazon Kinesis data stream.

type ElasticsearchSettings

dict

param ElasticsearchSettings

Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in the AWS Database Migration User Guide.

• ServiceAccessRoleArn (string) -- [REQUIRED]

  The Amazon Resource Name (ARN) used by service to access the IAM role.

• EndpointUri (string) -- [REQUIRED]

  The endpoint for the ElasticSearch cluster.

• FullLoadErrorPercentage (integer) --

  The maximum percentage of records that can fail to be written before a full load operation stops.

• ErrorRetryDuration (integer) --

  The maximum number of seconds that DMS retries failed API requests to the Elasticsearch cluster.

type RedshiftSettings

dict

param RedshiftSettings

• AcceptAnyDate (boolean) --

  Allows any date format, including invalid formats such as 00/00/00 00:00:00, to be loaded without generating an error. You can choose TRUE or FALSE (default).

  This parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with the DATEFORMAT parameter. If the date format for the data does not match the DATEFORMAT specification, Amazon Redshift inserts a NULL value into that field.

• AfterConnectScript (string) --

  Code to run after connecting. This should be the code, not a filename.

• BucketFolder (string) --

  The location where the CSV files are stored before being uploaded to the S3 bucket.

• BucketName (string) --

  The name of the S3 bucket you want to use

• ConnectionTimeout (integer) --

  Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.

• DatabaseName (string) --

  The name of the Amazon Redshift data warehouse (service) you are working with.

• DateFormat (string) --

  The date format you are using. Valid values are auto (case-sensitive), your date format string enclosed in quotes, or NULL. If this is left unset (NULL), it defaults to a format of 'YYYY-MM-DD'. Using auto recognizes most strings, even some that are not supported when you use a date format string.

  If your date and time values use formats different from each other, set this to auto .

• EmptyAsNull (boolean) --

  Specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL. A value of TRUE sets empty CHAR and VARCHAR fields to null. The default is FALSE.

• EncryptionMode (string) --

  The type of server side encryption you want to use for your data. This is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (default) or SSE_KMS. To use SSE_S3, create an IAM role with a policy that allows "arn:aws:s3:::*" to use the following actions: "s3:PutObject", "s3:ListBucket" .

• FileTransferUploadStreams (integer) --

  Specifies the number of threads used to upload a single file. This accepts a value between 1 and 64. It defaults to 10.

• LoadTimeout (integer) --

  Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you begin loading.

• MaxFileSize (integer) --

  Specifies the maximum size (in KB) of any CSV file used to transfer data to Amazon Redshift. This accepts a value between 1 and 1048576. It defaults to 32768 KB (32 MB).

• Password (string) --

  The password for the user named in the username property.

• Port (integer) --

  The port number for Amazon Redshift. The default value is 5439.

• RemoveQuotes (boolean) --

  Removes surrounding quotation marks from strings in the incoming data. All characters within the quotation marks, including delimiters, are retained. Choose TRUE to remove quotation marks. The default is FALSE.

• ReplaceInvalidChars (string) --

  A list of chars you want to replace. Use with ReplaceChars .

• ReplaceChars (string) --

  Replaces invalid characters specified in ReplaceInvalidChars , substituting the specified value instead. The default is "?".

• ServerName (string) --

  The name of the Amazon Redshift cluster you are using.

• ServiceAccessRoleArn (string) --

  The ARN of the role that has access to the Redshift service.

• ServerSideEncryptionKmsKeyId (string) --

  If you are using SSE_KMS for the EncryptionMode , provide the KMS Key ID. The key you use needs an attached policy that enables IAM user permissions and allows use of the key.

• TimeFormat (string) --

  The time format you want to use. Valid values are auto (case-sensitive), 'timeformat_string', 'epochsecs', or 'epochmillisecs'. It defaults to 10. Using auto recognizes most strings, even some that are not supported when you use a time format string.

  If your date and time values use formats different from each other, set this to auto .

• TrimBlanks (boolean) --

  Removes the trailing white space characters from a VARCHAR string. This parameter applies only to columns with a VARCHAR data type. Choose TRUE to remove unneeded white space. The default is FALSE.

• TruncateColumns (boolean) --

  Truncates data in columns to the appropriate number of characters, so that it fits in the column. Applies only to columns with a VARCHAR or CHAR data type, and rows with a size of 4 MB or less. Choose TRUE to truncate data. The default is FALSE.

• Username (string) --

  An Amazon Redshift user name for a registered user.

• WriteBufferSize (integer) --

  The size of the write buffer to use in rows. Valid values range from 1 to 2048. Defaults to 1024. Use this setting to tune performance.

rtype

dict

returns

Response Syntax

{
    'Endpoint': {
        'EndpointIdentifier': 'string',
        'EndpointType': 'source'|'target',
        'EngineName': 'string',
        'EngineDisplayName': 'string',
        'Username': 'string',
        'ServerName': 'string',
        'Port': 123,
        'DatabaseName': 'string',
        'ExtraConnectionAttributes': 'string',
        'Status': 'string',
        'KmsKeyId': 'string',
        'EndpointArn': 'string',
        'CertificateArn': 'string',
        'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
        'ServiceAccessRoleArn': 'string',
        'ExternalTableDefinition': 'string',
        'ExternalId': 'string',
        'DynamoDbSettings': {
            'ServiceAccessRoleArn': 'string'
        },
        'S3Settings': {
            'ServiceAccessRoleArn': 'string',
            'ExternalTableDefinition': 'string',
            'CsvRowDelimiter': 'string',
            'CsvDelimiter': 'string',
            'BucketFolder': 'string',
            'BucketName': 'string',
            'CompressionType': 'none'|'gzip',
            'EncryptionMode': 'sse-s3'|'sse-kms',
            'ServerSideEncryptionKmsKeyId': 'string',
            'DataFormat': 'csv'|'parquet',
            'EncodingType': 'plain'|'plain-dictionary'|'rle-dictionary',
            'DictPageSizeLimit': 123,
            'RowGroupLength': 123,
            'DataPageSize': 123,
            'ParquetVersion': 'parquet-1-0'|'parquet-2-0',
            'EnableStatistics': True|False,
            'CdcInsertsOnly': True|False
        },
        'DmsTransferSettings': {
            'ServiceAccessRoleArn': 'string',
            'BucketName': 'string'
        },
        'MongoDbSettings': {
            'Username': 'string',
            'Password': 'string',
            'ServerName': 'string',
            'Port': 123,
            'DatabaseName': 'string',
            'AuthType': 'no'|'password',
            'AuthMechanism': 'default'|'mongodb_cr'|'scram_sha_1',
            'NestingLevel': 'none'|'one',
            'ExtractDocId': 'string',
            'DocsToInvestigate': 'string',
            'AuthSource': 'string',
            'KmsKeyId': 'string'
        },
        'KinesisSettings': {
            'StreamArn': 'string',
            'MessageFormat': 'json',
            'ServiceAccessRoleArn': 'string'
        },
        'ElasticsearchSettings': {
            'ServiceAccessRoleArn': 'string',
            'EndpointUri': 'string',
            'FullLoadErrorPercentage': 123,
            'ErrorRetryDuration': 123
        },
        'RedshiftSettings': {
            'AcceptAnyDate': True|False,
            'AfterConnectScript': 'string',
            'BucketFolder': 'string',
            'BucketName': 'string',
            'ConnectionTimeout': 123,
            'DatabaseName': 'string',
            'DateFormat': 'string',
            'EmptyAsNull': True|False,
            'EncryptionMode': 'sse-s3'|'sse-kms',
            'FileTransferUploadStreams': 123,
            'LoadTimeout': 123,
            'MaxFileSize': 123,
            'Password': 'string',
            'Port': 123,
            'RemoveQuotes': True|False,
            'ReplaceInvalidChars': 'string',
            'ReplaceChars': 'string',
            'ServerName': 'string',
            'ServiceAccessRoleArn': 'string',
            'ServerSideEncryptionKmsKeyId': 'string',
            'TimeFormat': 'string',
            'TrimBlanks': True|False,
            'TruncateColumns': True|False,
            'Username': 'string',
            'WriteBufferSize': 123
        }
    }
}

Response Structure

• (dict) --

  • Endpoint (dict) --

    The endpoint that was created.

    • EndpointIdentifier (string) --

      The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.

    • EndpointType (string) --

      The type of endpoint.

    • EngineName (string) --

      The database engine name. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, sybase, dynamodb, mongodb, and sqlserver.

    • EngineDisplayName (string) --

      The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL."

    • Username (string) --

      The user name used to connect to the endpoint.

    • ServerName (string) --

      The name of the server at the endpoint.

    • Port (integer) --

      The port value used to access the endpoint.

    • DatabaseName (string) --

      The name of the database at the endpoint.

    • ExtraConnectionAttributes (string) --

      Additional connection attributes used to connect to the endpoint.

    • Status (string) --

      The status of the endpoint.

    • KmsKeyId (string) --

      The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

    • EndpointArn (string) --

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

    • CertificateArn (string) --

      The Amazon Resource Name (ARN) used for SSL connection to the endpoint.

    • SslMode (string) --

      The SSL mode used to connect to the endpoint.

      SSL mode can be one of four values: none, require, verify-ca, verify-full.

      The default value is none.

    • ServiceAccessRoleArn (string) --

      The Amazon Resource Name (ARN) used by the service access IAM role.

    • ExternalTableDefinition (string) --

      The external table definition.

    • ExternalId (string) --

      Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account.

    • DynamoDbSettings (dict) --

      The settings for the target DynamoDB database. For more information, see the DynamoDBSettings structure.

      • ServiceAccessRoleArn (string) --

        The Amazon Resource Name (ARN) used by the service access IAM role.

    • S3Settings (dict) --

      The settings for the S3 target endpoint. For more information, see the S3Settings structure.

      • ServiceAccessRoleArn (string) --

        The Amazon Resource Name (ARN) used by the service access IAM role.

      • ExternalTableDefinition (string) --

        The external table definition.

      • CsvRowDelimiter (string) --

        The delimiter used to separate rows in the source files. The default is a carriage return (\n ).

      • CsvDelimiter (string) --

        The delimiter used to separate columns in the source files. The default is a comma.

      • BucketFolder (string) --

        An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path <bucketFolder>/<schema_name>/<table_name>/ . If this parameter is not specified, then the path used is <schema_name>/<table_name>/ .

      • BucketName (string) --

        The name of the S3 bucket.

      • CompressionType (string) --

        An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed. Applies to both CSV and PARQUET data formats.

      • EncryptionMode (string) --

        The type of server side encryption you want to use for your data. This is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (default) or SSE_KMS . To use SSE_S3 , you need an IAM role with permission to allow "arn:aws:s3:::dms-*" to use the following actions:

        • s3:CreateBucket

        • s3:ListBucket

        • s3:DeleteBucket

        • s3:GetBucketLocation

        • s3:GetObject

        • s3:PutObject

        • s3:DeleteObject

        • s3:GetObjectVersion

        • s3:GetBucketPolicy

        • s3:PutBucketPolicy

        • s3:DeleteBucketPolicy

      • ServerSideEncryptionKmsKeyId (string) --

        If you are using SSE_KMS for the EncryptionMode , provide the KMS Key ID. The key you use needs an attached policy that enables IAM user permissions and allows use of the key.

        Here is a CLI example: aws dms create-endpoint --endpoint-identifier <value> --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn=<value>,BucketFolder=<value>,BucketName=<value>,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=<value>

      • DataFormat (string) --

        The format of the data which you want to use for output. You can choose one of the following:

        • CSV : This is a row-based format with comma-separated values.

        • PARQUET : Apache Parquet is a columnar storage format that features efficient compression and provides faster query response.

      • EncodingType (string) --

        The type of encoding you are using: RLE_DICTIONARY (default), PLAIN , or PLAIN_DICTIONARY .

        • RLE_DICTIONARY uses a combination of bit-packing and run-length encoding to store repeated values more efficiently.

        • PLAIN does not use encoding at all. Values are stored as they are.

        • PLAIN_DICTIONARY builds a dictionary of the values encountered in a given column. The dictionary is stored in a dictionary page for each column chunk.

      • DictPageSizeLimit (integer) --

        The maximum size of an encoded dictionary page of a column. If the dictionary page exceeds this, this column is stored using an encoding type of PLAIN . Defaults to 1024 * 1024 bytes (1MiB), the maximum size of a dictionary page before it reverts to PLAIN encoding. For PARQUET format only.

      • RowGroupLength (integer) --

        The number of rows in a row group. A smaller row group size provides faster reads. But as the number of row groups grows, the slower writes become. Defaults to 10,000 (ten thousand) rows. For PARQUET format only.

        If you choose a value larger than the maximum, RowGroupLength is set to the max row group length in bytes (64 * 1024 * 1024).

      • DataPageSize (integer) --

        The size of one data page in bytes. Defaults to 1024 * 1024 bytes (1MiB). For PARQUET format only.

      • ParquetVersion (string) --

        The version of Apache Parquet format you want to use: PARQUET_1_0 (default) or PARQUET_2_0 .

      • EnableStatistics (boolean) --

        Enables statistics for Parquet pages and rowGroups. Choose TRUE to enable statistics, choose FALSE to disable. Statistics include NULL , DISTINCT , MAX , and MIN values. Defaults to TRUE . For PARQUET format only.

      • CdcInsertsOnly (boolean) --

        Option to write only INSERT operations to the comma-separated value (CSV) output files. By default, the first field in a CSV record contains the letter I (insert), U (update) or D (delete) to indicate whether the row was inserted, updated, or deleted at the source database. If cdcInsertsOnly is set to true, then only INSERT s are recorded in the CSV file, without the I annotation on each line. Valid values are TRUE and FALSE .

    • DmsTransferSettings (dict) --

      The settings in JSON format for the DMS transfer type of source endpoint.

      Possible attributes include the following:

      • serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.

      • bucketName - The name of the S3 bucket to use.

      • compressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this value.

      Shorthand syntax for these attributes is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string

      JSON syntax for these attributes is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }

      • ServiceAccessRoleArn (string) --

        The IAM role that has permission to access the Amazon S3 bucket.

      • BucketName (string) --

        The name of the S3 bucket to use.

    • MongoDbSettings (dict) --

      The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.

      • Username (string) --

        The user name you use to access the MongoDB source endpoint.

      • Password (string) --

        The password for the user account you use to access the MongoDB source endpoint.

      • ServerName (string) --

        The name of the server on the MongoDB source endpoint.

      • Port (integer) --

        The port value for the MongoDB source endpoint.

      • DatabaseName (string) --

        The database name on the MongoDB source endpoint.

      • AuthType (string) --

        The authentication type you use to access the MongoDB source endpoint.

        Valid values: NO, PASSWORD

        When NO is selected, user name and password parameters are not used and can be empty.

      • AuthMechanism (string) --

        The authentication mechanism you use to access the MongoDB source endpoint.

        Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1

        DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.

      • NestingLevel (string) --

        Specifies either document or table mode.

        Valid values: NONE, ONE

        Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.

      • ExtractDocId (string) --

        Specifies the document ID. Use this attribute when NestingLevel is set to NONE.

        Default value is false.

      • DocsToInvestigate (string) --

        Indicates the number of documents to preview to determine the document organization. Use this attribute when NestingLevel is set to ONE.

        Must be a positive value greater than 0. Default value is 1000.

      • AuthSource (string) --

        The MongoDB database name. This attribute is not used when authType=NO .

        The default is admin.

      • KmsKeyId (string) --

        The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

    • KinesisSettings (dict) --

      The settings for the Amazon Kinesis source endpoint. For more information, see the KinesisSettings structure.

      • StreamArn (string) --

        The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.

      • MessageFormat (string) --

        The output format for the records created on the endpoint. The message format is JSON .

      • ServiceAccessRoleArn (string) --

        The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Amazon Kinesis data stream.

    • ElasticsearchSettings (dict) --

      The settings for the Elasticsearch source endpoint. For more information, see the ElasticsearchSettings structure.

      • ServiceAccessRoleArn (string) --

        The Amazon Resource Name (ARN) used by service to access the IAM role.

      • EndpointUri (string) --

        The endpoint for the ElasticSearch cluster.

      • FullLoadErrorPercentage (integer) --

        The maximum percentage of records that can fail to be written before a full load operation stops.

      • ErrorRetryDuration (integer) --

        The maximum number of seconds that DMS retries failed API requests to the Elasticsearch cluster.

    • RedshiftSettings (dict) --

      Settings for the Amazon Redshift endpoint

      • AcceptAnyDate (boolean) --

        Allows any date format, including invalid formats such as 00/00/00 00:00:00, to be loaded without generating an error. You can choose TRUE or FALSE (default).

        This parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with the DATEFORMAT parameter. If the date format for the data does not match the DATEFORMAT specification, Amazon Redshift inserts a NULL value into that field.

      • AfterConnectScript (string) --

        Code to run after connecting. This should be the code, not a filename.

      • BucketFolder (string) --

        The location where the CSV files are stored before being uploaded to the S3 bucket.

      • BucketName (string) --

        The name of the S3 bucket you want to use

      • ConnectionTimeout (integer) --

        Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.

      • DatabaseName (string) --

        The name of the Amazon Redshift data warehouse (service) you are working with.

      • DateFormat (string) --

        The date format you are using. Valid values are auto (case-sensitive), your date format string enclosed in quotes, or NULL. If this is left unset (NULL), it defaults to a format of 'YYYY-MM-DD'. Using auto recognizes most strings, even some that are not supported when you use a date format string.

        If your date and time values use formats different from each other, set this to auto .

      • EmptyAsNull (boolean) --

        Specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL. A value of TRUE sets empty CHAR and VARCHAR fields to null. The default is FALSE.

      • EncryptionMode (string) --

        The type of server side encryption you want to use for your data. This is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (default) or SSE_KMS. To use SSE_S3, create an IAM role with a policy that allows "arn:aws:s3:::*" to use the following actions: "s3:PutObject", "s3:ListBucket" .

      • FileTransferUploadStreams (integer) --

        Specifies the number of threads used to upload a single file. This accepts a value between 1 and 64. It defaults to 10.

      • LoadTimeout (integer) --

        Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you begin loading.

      • MaxFileSize (integer) --

        Specifies the maximum size (in KB) of any CSV file used to transfer data to Amazon Redshift. This accepts a value between 1 and 1048576. It defaults to 32768 KB (32 MB).

      • Password (string) --

        The password for the user named in the username property.

      • Port (integer) --

        The port number for Amazon Redshift. The default value is 5439.

      • RemoveQuotes (boolean) --

        Removes surrounding quotation marks from strings in the incoming data. All characters within the quotation marks, including delimiters, are retained. Choose TRUE to remove quotation marks. The default is FALSE.

      • ReplaceInvalidChars (string) --

        A list of chars you want to replace. Use with ReplaceChars .

      • ReplaceChars (string) --

        Replaces invalid characters specified in ReplaceInvalidChars , substituting the specified value instead. The default is "?".

      • ServerName (string) --

        The name of the Amazon Redshift cluster you are using.

      • ServiceAccessRoleArn (string) --

        The ARN of the role that has access to the Redshift service.

      • ServerSideEncryptionKmsKeyId (string) --

        If you are using SSE_KMS for the EncryptionMode , provide the KMS Key ID. The key you use needs an attached policy that enables IAM user permissions and allows use of the key.

      • TimeFormat (string) --

        The time format you want to use. Valid values are auto (case-sensitive), 'timeformat_string', 'epochsecs', or 'epochmillisecs'. It defaults to 10. Using auto recognizes most strings, even some that are not supported when you use a time format string.

        If your date and time values use formats different from each other, set this to auto .

      • TrimBlanks (boolean) --

        Removes the trailing white space characters from a VARCHAR string. This parameter applies only to columns with a VARCHAR data type. Choose TRUE to remove unneeded white space. The default is FALSE.

      • TruncateColumns (boolean) --

        Truncates data in columns to the appropriate number of characters, so that it fits in the column. Applies only to columns with a VARCHAR or CHAR data type, and rows with a size of 4 MB or less. Choose TRUE to truncate data. The default is FALSE.

      • Username (string) --

        An Amazon Redshift user name for a registered user.

      • WriteBufferSize (integer) --

        The size of the write buffer to use in rows. Valid values range from 1 to 2048. Defaults to 1024. Use this setting to tune performance.

{'Endpoint': {'RedshiftSettings': {'AcceptAnyDate': 'boolean',
                                   'AfterConnectScript': 'string',
                                   'BucketFolder': 'string',
                                   'BucketName': 'string',
                                   'ConnectionTimeout': 'integer',
                                   'DatabaseName': 'string',
                                   'DateFormat': 'string',
                                   'EmptyAsNull': 'boolean',
                                   'EncryptionMode': 'sse-s3 | sse-kms',
                                   'FileTransferUploadStreams': 'integer',
                                   'LoadTimeout': 'integer',
                                   'MaxFileSize': 'integer',
                                   'Password': 'string',
                                   'Port': 'integer',
                                   'RemoveQuotes': 'boolean',
                                   'ReplaceChars': 'string',
                                   'ReplaceInvalidChars': 'string',
                                   'ServerName': 'string',
                                   'ServerSideEncryptionKmsKeyId': 'string',
                                   'ServiceAccessRoleArn': 'string',
                                   'TimeFormat': 'string',
                                   'TrimBlanks': 'boolean',
                                   'TruncateColumns': 'boolean',
                                   'Username': 'string',
                                   'WriteBufferSize': 'integer'},
              'S3Settings': {'CdcInsertsOnly': 'boolean',
                             'DataFormat': 'csv | parquet',
                             'DataPageSize': 'integer',
                             'DictPageSizeLimit': 'integer',
                             'EnableStatistics': 'boolean',
                             'EncodingType': 'plain | plain-dictionary | '
                                             'rle-dictionary',
                             'EncryptionMode': 'sse-s3 | sse-kms',
                             'ParquetVersion': 'parquet-1-0 | parquet-2-0',
                             'RowGroupLength': 'integer',
                             'ServerSideEncryptionKmsKeyId': 'string'}}}

Deletes the specified endpoint.

See also: AWS API Documentation

Request Syntax

client.delete_endpoint(
    EndpointArn='string'
)

type EndpointArn

string

param EndpointArn

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{
    'Endpoint': {
        'EndpointIdentifier': 'string',
        'EndpointType': 'source'|'target',
        'EngineName': 'string',
        'EngineDisplayName': 'string',
        'Username': 'string',
        'ServerName': 'string',
        'Port': 123,
        'DatabaseName': 'string',
        'ExtraConnectionAttributes': 'string',
        'Status': 'string',
        'KmsKeyId': 'string',
        'EndpointArn': 'string',
        'CertificateArn': 'string',
        'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
        'ServiceAccessRoleArn': 'string',
        'ExternalTableDefinition': 'string',
        'ExternalId': 'string',
        'DynamoDbSettings': {
            'ServiceAccessRoleArn': 'string'
        },
        'S3Settings': {
            'ServiceAccessRoleArn': 'string',
            'ExternalTableDefinition': 'string',
            'CsvRowDelimiter': 'string',
            'CsvDelimiter': 'string',
            'BucketFolder': 'string',
            'BucketName': 'string',
            'CompressionType': 'none'|'gzip',
            'EncryptionMode': 'sse-s3'|'sse-kms',
            'ServerSideEncryptionKmsKeyId': 'string',
            'DataFormat': 'csv'|'parquet',
            'EncodingType': 'plain'|'plain-dictionary'|'rle-dictionary',
            'DictPageSizeLimit': 123,
            'RowGroupLength': 123,
            'DataPageSize': 123,
            'ParquetVersion': 'parquet-1-0'|'parquet-2-0',
            'EnableStatistics': True|False,
            'CdcInsertsOnly': True|False
        },
        'DmsTransferSettings': {
            'ServiceAccessRoleArn': 'string',
            'BucketName': 'string'
        },
        'MongoDbSettings': {
            'Username': 'string',
            'Password': 'string',
            'ServerName': 'string',
            'Port': 123,
            'DatabaseName': 'string',
            'AuthType': 'no'|'password',
            'AuthMechanism': 'default'|'mongodb_cr'|'scram_sha_1',
            'NestingLevel': 'none'|'one',
            'ExtractDocId': 'string',
            'DocsToInvestigate': 'string',
            'AuthSource': 'string',
            'KmsKeyId': 'string'
        },
        'KinesisSettings': {
            'StreamArn': 'string',
            'MessageFormat': 'json',
            'ServiceAccessRoleArn': 'string'
        },
        'ElasticsearchSettings': {
            'ServiceAccessRoleArn': 'string',
            'EndpointUri': 'string',
            'FullLoadErrorPercentage': 123,
            'ErrorRetryDuration': 123
        },
        'RedshiftSettings': {
            'AcceptAnyDate': True|False,
            'AfterConnectScript': 'string',
            'BucketFolder': 'string',
            'BucketName': 'string',
            'ConnectionTimeout': 123,
            'DatabaseName': 'string',
            'DateFormat': 'string',
            'EmptyAsNull': True|False,
            'EncryptionMode': 'sse-s3'|'sse-kms',
            'FileTransferUploadStreams': 123,
            'LoadTimeout': 123,
            'MaxFileSize': 123,
            'Password': 'string',
            'Port': 123,
            'RemoveQuotes': True|False,
            'ReplaceInvalidChars': 'string',
            'ReplaceChars': 'string',
            'ServerName': 'string',
            'ServiceAccessRoleArn': 'string',
            'ServerSideEncryptionKmsKeyId': 'string',
            'TimeFormat': 'string',
            'TrimBlanks': True|False,
            'TruncateColumns': True|False,
            'Username': 'string',
            'WriteBufferSize': 123
        }
    }
}

Response Structure

• (dict) --

  • Endpoint (dict) --

    The endpoint that was deleted.

    • EndpointIdentifier (string) --

      The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.

    • EndpointType (string) --

      The type of endpoint.

    • EngineName (string) --

      The database engine name. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, sybase, dynamodb, mongodb, and sqlserver.

    • EngineDisplayName (string) --

      The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL."

    • Username (string) --

      The user name used to connect to the endpoint.

    • ServerName (string) --

      The name of the server at the endpoint.

    • Port (integer) --

      The port value used to access the endpoint.

    • DatabaseName (string) --

      The name of the database at the endpoint.

    • ExtraConnectionAttributes (string) --

      Additional connection attributes used to connect to the endpoint.

    • Status (string) --

      The status of the endpoint.

    • KmsKeyId (string) --

      The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

    • EndpointArn (string) --

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

    • CertificateArn (string) --

      The Amazon Resource Name (ARN) used for SSL connection to the endpoint.

    • SslMode (string) --

      The SSL mode used to connect to the endpoint.

      SSL mode can be one of four values: none, require, verify-ca, verify-full.

      The default value is none.

    • ServiceAccessRoleArn (string) --

      The Amazon Resource Name (ARN) used by the service access IAM role.

    • ExternalTableDefinition (string) --

      The external table definition.

    • ExternalId (string) --

      Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account.

    • DynamoDbSettings (dict) --

      The settings for the target DynamoDB database. For more information, see the DynamoDBSettings structure.

      • ServiceAccessRoleArn (string) --

        The Amazon Resource Name (ARN) used by the service access IAM role.

    • S3Settings (dict) --

      The settings for the S3 target endpoint. For more information, see the S3Settings structure.

      • ServiceAccessRoleArn (string) --

        The Amazon Resource Name (ARN) used by the service access IAM role.

      • ExternalTableDefinition (string) --

        The external table definition.

      • CsvRowDelimiter (string) --

        The delimiter used to separate rows in the source files. The default is a carriage return (\n ).

      • CsvDelimiter (string) --

        The delimiter used to separate columns in the source files. The default is a comma.

      • BucketFolder (string) --

        An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path <bucketFolder>/<schema_name>/<table_name>/ . If this parameter is not specified, then the path used is <schema_name>/<table_name>/ .

      • BucketName (string) --

        The name of the S3 bucket.

      • CompressionType (string) --

        An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed. Applies to both CSV and PARQUET data formats.

      • EncryptionMode (string) --

        The type of server side encryption you want to use for your data. This is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (default) or SSE_KMS . To use SSE_S3 , you need an IAM role with permission to allow "arn:aws:s3:::dms-*" to use the following actions:

        • s3:CreateBucket

        • s3:ListBucket

        • s3:DeleteBucket

        • s3:GetBucketLocation

        • s3:GetObject

        • s3:PutObject

        • s3:DeleteObject

        • s3:GetObjectVersion

        • s3:GetBucketPolicy

        • s3:PutBucketPolicy

        • s3:DeleteBucketPolicy

      • ServerSideEncryptionKmsKeyId (string) --

        If you are using SSE_KMS for the EncryptionMode , provide the KMS Key ID. The key you use needs an attached policy that enables IAM user permissions and allows use of the key.

        Here is a CLI example: aws dms create-endpoint --endpoint-identifier <value> --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn=<value>,BucketFolder=<value>,BucketName=<value>,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=<value>

      • DataFormat (string) --

        The format of the data which you want to use for output. You can choose one of the following:

        • CSV : This is a row-based format with comma-separated values.

        • PARQUET : Apache Parquet is a columnar storage format that features efficient compression and provides faster query response.

      • EncodingType (string) --

        The type of encoding you are using: RLE_DICTIONARY (default), PLAIN , or PLAIN_DICTIONARY .

        • RLE_DICTIONARY uses a combination of bit-packing and run-length encoding to store repeated values more efficiently.

        • PLAIN does not use encoding at all. Values are stored as they are.

        • PLAIN_DICTIONARY builds a dictionary of the values encountered in a given column. The dictionary is stored in a dictionary page for each column chunk.

      • DictPageSizeLimit (integer) --

        The maximum size of an encoded dictionary page of a column. If the dictionary page exceeds this, this column is stored using an encoding type of PLAIN . Defaults to 1024 * 1024 bytes (1MiB), the maximum size of a dictionary page before it reverts to PLAIN encoding. For PARQUET format only.

      • RowGroupLength (integer) --

        The number of rows in a row group. A smaller row group size provides faster reads. But as the number of row groups grows, the slower writes become. Defaults to 10,000 (ten thousand) rows. For PARQUET format only.

        If you choose a value larger than the maximum, RowGroupLength is set to the max row group length in bytes (64 * 1024 * 1024).

      • DataPageSize (integer) --

        The size of one data page in bytes. Defaults to 1024 * 1024 bytes (1MiB). For PARQUET format only.

      • ParquetVersion (string) --

        The version of Apache Parquet format you want to use: PARQUET_1_0 (default) or PARQUET_2_0 .

      • EnableStatistics (boolean) --

        Enables statistics for Parquet pages and rowGroups. Choose TRUE to enable statistics, choose FALSE to disable. Statistics include NULL , DISTINCT , MAX , and MIN values. Defaults to TRUE . For PARQUET format only.

      • CdcInsertsOnly (boolean) --

        Option to write only INSERT operations to the comma-separated value (CSV) output files. By default, the first field in a CSV record contains the letter I (insert), U (update) or D (delete) to indicate whether the row was inserted, updated, or deleted at the source database. If cdcInsertsOnly is set to true, then only INSERT s are recorded in the CSV file, without the I annotation on each line. Valid values are TRUE and FALSE .

    • DmsTransferSettings (dict) --

      The settings in JSON format for the DMS transfer type of source endpoint.

      Possible attributes include the following:

      • serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.

      • bucketName - The name of the S3 bucket to use.

      • compressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this value.

      Shorthand syntax for these attributes is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string

      JSON syntax for these attributes is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }

      • ServiceAccessRoleArn (string) --

        The IAM role that has permission to access the Amazon S3 bucket.

      • BucketName (string) --

        The name of the S3 bucket to use.

    • MongoDbSettings (dict) --

      The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.

      • Username (string) --

        The user name you use to access the MongoDB source endpoint.

      • Password (string) --

        The password for the user account you use to access the MongoDB source endpoint.

      • ServerName (string) --

        The name of the server on the MongoDB source endpoint.

      • Port (integer) --

        The port value for the MongoDB source endpoint.

      • DatabaseName (string) --

        The database name on the MongoDB source endpoint.

      • AuthType (string) --

        The authentication type you use to access the MongoDB source endpoint.

        Valid values: NO, PASSWORD

        When NO is selected, user name and password parameters are not used and can be empty.

      • AuthMechanism (string) --

        The authentication mechanism you use to access the MongoDB source endpoint.

        Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1

        DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.

      • NestingLevel (string) --

        Specifies either document or table mode.

        Valid values: NONE, ONE

        Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.

      • ExtractDocId (string) --

        Specifies the document ID. Use this attribute when NestingLevel is set to NONE.

        Default value is false.

      • DocsToInvestigate (string) --

        Indicates the number of documents to preview to determine the document organization. Use this attribute when NestingLevel is set to ONE.

        Must be a positive value greater than 0. Default value is 1000.

      • AuthSource (string) --

        The MongoDB database name. This attribute is not used when authType=NO .

        The default is admin.

      • KmsKeyId (string) --

        The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

    • KinesisSettings (dict) --

      The settings for the Amazon Kinesis source endpoint. For more information, see the KinesisSettings structure.

      • StreamArn (string) --

        The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.

      • MessageFormat (string) --

        The output format for the records created on the endpoint. The message format is JSON .

      • ServiceAccessRoleArn (string) --

        The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Amazon Kinesis data stream.

    • ElasticsearchSettings (dict) --

      The settings for the Elasticsearch source endpoint. For more information, see the ElasticsearchSettings structure.

      • ServiceAccessRoleArn (string) --

        The Amazon Resource Name (ARN) used by service to access the IAM role.

      • EndpointUri (string) --

        The endpoint for the ElasticSearch cluster.

      • FullLoadErrorPercentage (integer) --

        The maximum percentage of records that can fail to be written before a full load operation stops.

      • ErrorRetryDuration (integer) --

        The maximum number of seconds that DMS retries failed API requests to the Elasticsearch cluster.

    • RedshiftSettings (dict) --

      Settings for the Amazon Redshift endpoint

      • AcceptAnyDate (boolean) --

        Allows any date format, including invalid formats such as 00/00/00 00:00:00, to be loaded without generating an error. You can choose TRUE or FALSE (default).

        This parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with the DATEFORMAT parameter. If the date format for the data does not match the DATEFORMAT specification, Amazon Redshift inserts a NULL value into that field.

      • AfterConnectScript (string) --

        Code to run after connecting. This should be the code, not a filename.

      • BucketFolder (string) --

        The location where the CSV files are stored before being uploaded to the S3 bucket.

      • BucketName (string) --

        The name of the S3 bucket you want to use

      • ConnectionTimeout (integer) --

        Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.

      • DatabaseName (string) --

        The name of the Amazon Redshift data warehouse (service) you are working with.

      • DateFormat (string) --

        The date format you are using. Valid values are auto (case-sensitive), your date format string enclosed in quotes, or NULL. If this is left unset (NULL), it defaults to a format of 'YYYY-MM-DD'. Using auto recognizes most strings, even some that are not supported when you use a date format string.

        If your date and time values use formats different from each other, set this to auto .

      • EmptyAsNull (boolean) --

        Specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL. A value of TRUE sets empty CHAR and VARCHAR fields to null. The default is FALSE.

      • EncryptionMode (string) --

        The type of server side encryption you want to use for your data. This is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (default) or SSE_KMS. To use SSE_S3, create an IAM role with a policy that allows "arn:aws:s3:::*" to use the following actions: "s3:PutObject", "s3:ListBucket" .

      • FileTransferUploadStreams (integer) --

        Specifies the number of threads used to upload a single file. This accepts a value between 1 and 64. It defaults to 10.

      • LoadTimeout (integer) --

        Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you begin loading.

      • MaxFileSize (integer) --

        Specifies the maximum size (in KB) of any CSV file used to transfer data to Amazon Redshift. This accepts a value between 1 and 1048576. It defaults to 32768 KB (32 MB).

      • Password (string) --

        The password for the user named in the username property.

      • Port (integer) --

        The port number for Amazon Redshift. The default value is 5439.

      • RemoveQuotes (boolean) --

        Removes surrounding quotation marks from strings in the incoming data. All characters within the quotation marks, including delimiters, are retained. Choose TRUE to remove quotation marks. The default is FALSE.

      • ReplaceInvalidChars (string) --

        A list of chars you want to replace. Use with ReplaceChars .

      • ReplaceChars (string) --

        Replaces invalid characters specified in ReplaceInvalidChars , substituting the specified value instead. The default is "?".

      • ServerName (string) --

        The name of the Amazon Redshift cluster you are using.

      • ServiceAccessRoleArn (string) --

        The ARN of the role that has access to the Redshift service.

      • ServerSideEncryptionKmsKeyId (string) --

        If you are using SSE_KMS for the EncryptionMode , provide the KMS Key ID. The key you use needs an attached policy that enables IAM user permissions and allows use of the key.

      • TimeFormat (string) --

        The time format you want to use. Valid values are auto (case-sensitive), 'timeformat_string', 'epochsecs', or 'epochmillisecs'. It defaults to 10. Using auto recognizes most strings, even some that are not supported when you use a time format string.

        If your date and time values use formats different from each other, set this to auto .

      • TrimBlanks (boolean) --

        Removes the trailing white space characters from a VARCHAR string. This parameter applies only to columns with a VARCHAR data type. Choose TRUE to remove unneeded white space. The default is FALSE.

      • TruncateColumns (boolean) --

        Truncates data in columns to the appropriate number of characters, so that it fits in the column. Applies only to columns with a VARCHAR or CHAR data type, and rows with a size of 4 MB or less. Choose TRUE to truncate data. The default is FALSE.

      • Username (string) --

        An Amazon Redshift user name for a registered user.

      • WriteBufferSize (integer) --

        The size of the write buffer to use in rows. Valid values range from 1 to 2048. Defaults to 1024. Use this setting to tune performance.

{'Endpoints': {'RedshiftSettings': {'AcceptAnyDate': 'boolean',
                                    'AfterConnectScript': 'string',
                                    'BucketFolder': 'string',
                                    'BucketName': 'string',
                                    'ConnectionTimeout': 'integer',
                                    'DatabaseName': 'string',
                                    'DateFormat': 'string',
                                    'EmptyAsNull': 'boolean',
                                    'EncryptionMode': 'sse-s3 | sse-kms',
                                    'FileTransferUploadStreams': 'integer',
                                    'LoadTimeout': 'integer',
                                    'MaxFileSize': 'integer',
                                    'Password': 'string',
                                    'Port': 'integer',
                                    'RemoveQuotes': 'boolean',
                                    'ReplaceChars': 'string',
                                    'ReplaceInvalidChars': 'string',
                                    'ServerName': 'string',
                                    'ServerSideEncryptionKmsKeyId': 'string',
                                    'ServiceAccessRoleArn': 'string',
                                    'TimeFormat': 'string',
                                    'TrimBlanks': 'boolean',
                                    'TruncateColumns': 'boolean',
                                    'Username': 'string',
                                    'WriteBufferSize': 'integer'},
               'S3Settings': {'CdcInsertsOnly': 'boolean',
                              'DataFormat': 'csv | parquet',
                              'DataPageSize': 'integer',
                              'DictPageSizeLimit': 'integer',
                              'EnableStatistics': 'boolean',
                              'EncodingType': 'plain | plain-dictionary | '
                                              'rle-dictionary',
                              'EncryptionMode': 'sse-s3 | sse-kms',
                              'ParquetVersion': 'parquet-1-0 | parquet-2-0',
                              'RowGroupLength': 'integer',
                              'ServerSideEncryptionKmsKeyId': 'string'}}}

Returns information about the endpoints for your account in the current region.

See also: AWS API Documentation

Request Syntax

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

type Filters

list

param Filters

Filters applied to the describe action.

Valid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name

• (dict) --

  • Name (string) -- [REQUIRED]

    The name of the filter.

  • Values (list) -- [REQUIRED]

    The filter value.

    • (string) --

type MaxRecords

integer

param MaxRecords

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.

Default: 100

Constraints: Minimum 20, maximum 100.

type Marker

string

param Marker

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 .

rtype

dict

returns

Response Syntax

{
    'Marker': 'string',
    'Endpoints': [
        {
            'EndpointIdentifier': 'string',
            'EndpointType': 'source'|'target',
            'EngineName': 'string',
            'EngineDisplayName': 'string',
            'Username': 'string',
            'ServerName': 'string',
            'Port': 123,
            'DatabaseName': 'string',
            'ExtraConnectionAttributes': 'string',
            'Status': 'string',
            'KmsKeyId': 'string',
            'EndpointArn': 'string',
            'CertificateArn': 'string',
            'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
            'ServiceAccessRoleArn': 'string',
            'ExternalTableDefinition': 'string',
            'ExternalId': 'string',
            'DynamoDbSettings': {
                'ServiceAccessRoleArn': 'string'
            },
            'S3Settings': {
                'ServiceAccessRoleArn': 'string',
                'ExternalTableDefinition': 'string',
                'CsvRowDelimiter': 'string',
                'CsvDelimiter': 'string',
                'BucketFolder': 'string',
                'BucketName': 'string',
                'CompressionType': 'none'|'gzip',
                'EncryptionMode': 'sse-s3'|'sse-kms',
                'ServerSideEncryptionKmsKeyId': 'string',
                'DataFormat': 'csv'|'parquet',
                'EncodingType': 'plain'|'plain-dictionary'|'rle-dictionary',
                'DictPageSizeLimit': 123,
                'RowGroupLength': 123,
                'DataPageSize': 123,
                'ParquetVersion': 'parquet-1-0'|'parquet-2-0',
                'EnableStatistics': True|False,
                'CdcInsertsOnly': True|False
            },
            'DmsTransferSettings': {
                'ServiceAccessRoleArn': 'string',
                'BucketName': 'string'
            },
            'MongoDbSettings': {
                'Username': 'string',
                'Password': 'string',
                'ServerName': 'string',
                'Port': 123,
                'DatabaseName': 'string',
                'AuthType': 'no'|'password',
                'AuthMechanism': 'default'|'mongodb_cr'|'scram_sha_1',
                'NestingLevel': 'none'|'one',
                'ExtractDocId': 'string',
                'DocsToInvestigate': 'string',
                'AuthSource': 'string',
                'KmsKeyId': 'string'
            },
            'KinesisSettings': {
                'StreamArn': 'string',
                'MessageFormat': 'json',
                'ServiceAccessRoleArn': 'string'
            },
            'ElasticsearchSettings': {
                'ServiceAccessRoleArn': 'string',
                'EndpointUri': 'string',
                'FullLoadErrorPercentage': 123,
                'ErrorRetryDuration': 123
            },
            'RedshiftSettings': {
                'AcceptAnyDate': True|False,
                'AfterConnectScript': 'string',
                'BucketFolder': 'string',
                'BucketName': 'string',
                'ConnectionTimeout': 123,
                'DatabaseName': 'string',
                'DateFormat': 'string',
                'EmptyAsNull': True|False,
                'EncryptionMode': 'sse-s3'|'sse-kms',
                'FileTransferUploadStreams': 123,
                'LoadTimeout': 123,
                'MaxFileSize': 123,
                'Password': 'string',
                'Port': 123,
                'RemoveQuotes': True|False,
                'ReplaceInvalidChars': 'string',
                'ReplaceChars': 'string',
                'ServerName': 'string',
                'ServiceAccessRoleArn': 'string',
                'ServerSideEncryptionKmsKeyId': 'string',
                'TimeFormat': 'string',
                'TrimBlanks': True|False,
                'TruncateColumns': True|False,
                'Username': 'string',
                'WriteBufferSize': 123
            }
        },
    ]
}

Response Structure

• (dict) --

  • Marker (string) --

    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 .

  • Endpoints (list) --

    Endpoint description.

    • (dict) --

      • EndpointIdentifier (string) --

        The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.

      • EndpointType (string) --

        The type of endpoint.

      • EngineName (string) --

        The database engine name. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, sybase, dynamodb, mongodb, and sqlserver.

      • EngineDisplayName (string) --

        The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL."

      • Username (string) --

        The user name used to connect to the endpoint.

      • ServerName (string) --

        The name of the server at the endpoint.

      • Port (integer) --

        The port value used to access the endpoint.

      • DatabaseName (string) --

        The name of the database at the endpoint.

      • ExtraConnectionAttributes (string) --

        Additional connection attributes used to connect to the endpoint.

      • Status (string) --

        The status of the endpoint.

      • KmsKeyId (string) --

        The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

      • EndpointArn (string) --

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

      • CertificateArn (string) --

        The Amazon Resource Name (ARN) used for SSL connection to the endpoint.

      • SslMode (string) --

        The SSL mode used to connect to the endpoint.

        SSL mode can be one of four values: none, require, verify-ca, verify-full.

        The default value is none.

      • ServiceAccessRoleArn (string) --

        The Amazon Resource Name (ARN) used by the service access IAM role.

      • ExternalTableDefinition (string) --

        The external table definition.

      • ExternalId (string) --

        Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account.

      • DynamoDbSettings (dict) --

        The settings for the target DynamoDB database. For more information, see the DynamoDBSettings structure.

        • ServiceAccessRoleArn (string) --

          The Amazon Resource Name (ARN) used by the service access IAM role.

      • S3Settings (dict) --

        The settings for the S3 target endpoint. For more information, see the S3Settings structure.

        • ServiceAccessRoleArn (string) --

          The Amazon Resource Name (ARN) used by the service access IAM role.

        • ExternalTableDefinition (string) --

          The external table definition.

        • CsvRowDelimiter (string) --

          The delimiter used to separate rows in the source files. The default is a carriage return (\n ).

        • CsvDelimiter (string) --

          The delimiter used to separate columns in the source files. The default is a comma.

        • BucketFolder (string) --

          An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path <bucketFolder>/<schema_name>/<table_name>/ . If this parameter is not specified, then the path used is <schema_name>/<table_name>/ .

        • BucketName (string) --

          The name of the S3 bucket.

        • CompressionType (string) --

          An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed. Applies to both CSV and PARQUET data formats.

        • EncryptionMode (string) --

          The type of server side encryption you want to use for your data. This is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (default) or SSE_KMS . To use SSE_S3 , you need an IAM role with permission to allow "arn:aws:s3:::dms-*" to use the following actions:

          • s3:CreateBucket

          • s3:ListBucket

          • s3:DeleteBucket

          • s3:GetBucketLocation

          • s3:GetObject

          • s3:PutObject

          • s3:DeleteObject

          • s3:GetObjectVersion

          • s3:GetBucketPolicy

          • s3:PutBucketPolicy

          • s3:DeleteBucketPolicy

        • ServerSideEncryptionKmsKeyId (string) --

          If you are using SSE_KMS for the EncryptionMode , provide the KMS Key ID. The key you use needs an attached policy that enables IAM user permissions and allows use of the key.

          Here is a CLI example: aws dms create-endpoint --endpoint-identifier <value> --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn=<value>,BucketFolder=<value>,BucketName=<value>,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=<value>

        • DataFormat (string) --

          The format of the data which you want to use for output. You can choose one of the following:

          • CSV : This is a row-based format with comma-separated values.

          • PARQUET : Apache Parquet is a columnar storage format that features efficient compression and provides faster query response.

        • EncodingType (string) --

          The type of encoding you are using: RLE_DICTIONARY (default), PLAIN , or PLAIN_DICTIONARY .

          • RLE_DICTIONARY uses a combination of bit-packing and run-length encoding to store repeated values more efficiently.

          • PLAIN does not use encoding at all. Values are stored as they are.

          • PLAIN_DICTIONARY builds a dictionary of the values encountered in a given column. The dictionary is stored in a dictionary page for each column chunk.

        • DictPageSizeLimit (integer) --

          The maximum size of an encoded dictionary page of a column. If the dictionary page exceeds this, this column is stored using an encoding type of PLAIN . Defaults to 1024 * 1024 bytes (1MiB), the maximum size of a dictionary page before it reverts to PLAIN encoding. For PARQUET format only.

        • RowGroupLength (integer) --

          The number of rows in a row group. A smaller row group size provides faster reads. But as the number of row groups grows, the slower writes become. Defaults to 10,000 (ten thousand) rows. For PARQUET format only.

          If you choose a value larger than the maximum, RowGroupLength is set to the max row group length in bytes (64 * 1024 * 1024).

        • DataPageSize (integer) --

          The size of one data page in bytes. Defaults to 1024 * 1024 bytes (1MiB). For PARQUET format only.

        • ParquetVersion (string) --

          The version of Apache Parquet format you want to use: PARQUET_1_0 (default) or PARQUET_2_0 .

        • EnableStatistics (boolean) --

          Enables statistics for Parquet pages and rowGroups. Choose TRUE to enable statistics, choose FALSE to disable. Statistics include NULL , DISTINCT , MAX , and MIN values. Defaults to TRUE . For PARQUET format only.

        • CdcInsertsOnly (boolean) --

          Option to write only INSERT operations to the comma-separated value (CSV) output files. By default, the first field in a CSV record contains the letter I (insert), U (update) or D (delete) to indicate whether the row was inserted, updated, or deleted at the source database. If cdcInsertsOnly is set to true, then only INSERT s are recorded in the CSV file, without the I annotation on each line. Valid values are TRUE and FALSE .

      • DmsTransferSettings (dict) --

        The settings in JSON format for the DMS transfer type of source endpoint.

        Possible attributes include the following:

        • serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.

        • bucketName - The name of the S3 bucket to use.

        • compressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this value.

        Shorthand syntax for these attributes is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string

        JSON syntax for these attributes is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }

        • ServiceAccessRoleArn (string) --

          The IAM role that has permission to access the Amazon S3 bucket.

        • BucketName (string) --

          The name of the S3 bucket to use.

      • MongoDbSettings (dict) --

        The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.

        • Username (string) --

          The user name you use to access the MongoDB source endpoint.

        • Password (string) --

          The password for the user account you use to access the MongoDB source endpoint.

        • ServerName (string) --

          The name of the server on the MongoDB source endpoint.

        • Port (integer) --

          The port value for the MongoDB source endpoint.

        • DatabaseName (string) --

          The database name on the MongoDB source endpoint.

        • AuthType (string) --

          The authentication type you use to access the MongoDB source endpoint.

          Valid values: NO, PASSWORD

          When NO is selected, user name and password parameters are not used and can be empty.

        • AuthMechanism (string) --

          The authentication mechanism you use to access the MongoDB source endpoint.

          Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1

          DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.

        • NestingLevel (string) --

          Specifies either document or table mode.

          Valid values: NONE, ONE

          Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.

        • ExtractDocId (string) --

          Specifies the document ID. Use this attribute when NestingLevel is set to NONE.

          Default value is false.

        • DocsToInvestigate (string) --

          Indicates the number of documents to preview to determine the document organization. Use this attribute when NestingLevel is set to ONE.

          Must be a positive value greater than 0. Default value is 1000.

        • AuthSource (string) --

          The MongoDB database name. This attribute is not used when authType=NO .

          The default is admin.

        • KmsKeyId (string) --

          The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

      • KinesisSettings (dict) --

        The settings for the Amazon Kinesis source endpoint. For more information, see the KinesisSettings structure.

        • StreamArn (string) --

          The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.

        • MessageFormat (string) --

          The output format for the records created on the endpoint. The message format is JSON .

        • ServiceAccessRoleArn (string) --

          The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Amazon Kinesis data stream.

      • ElasticsearchSettings (dict) --

        The settings for the Elasticsearch source endpoint. For more information, see the ElasticsearchSettings structure.

        • ServiceAccessRoleArn (string) --

          The Amazon Resource Name (ARN) used by service to access the IAM role.

        • EndpointUri (string) --

          The endpoint for the ElasticSearch cluster.

        • FullLoadErrorPercentage (integer) --

          The maximum percentage of records that can fail to be written before a full load operation stops.

        • ErrorRetryDuration (integer) --

          The maximum number of seconds that DMS retries failed API requests to the Elasticsearch cluster.

      • RedshiftSettings (dict) --

        Settings for the Amazon Redshift endpoint

        • AcceptAnyDate (boolean) --

          Allows any date format, including invalid formats such as 00/00/00 00:00:00, to be loaded without generating an error. You can choose TRUE or FALSE (default).

          This parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with the DATEFORMAT parameter. If the date format for the data does not match the DATEFORMAT specification, Amazon Redshift inserts a NULL value into that field.

        • AfterConnectScript (string) --

          Code to run after connecting. This should be the code, not a filename.

        • BucketFolder (string) --

          The location where the CSV files are stored before being uploaded to the S3 bucket.

        • BucketName (string) --

          The name of the S3 bucket you want to use

        • ConnectionTimeout (integer) --

          Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.

        • DatabaseName (string) --

          The name of the Amazon Redshift data warehouse (service) you are working with.

        • DateFormat (string) --

          The date format you are using. Valid values are auto (case-sensitive), your date format string enclosed in quotes, or NULL. If this is left unset (NULL), it defaults to a format of 'YYYY-MM-DD'. Using auto recognizes most strings, even some that are not supported when you use a date format string.

          If your date and time values use formats different from each other, set this to auto .

        • EmptyAsNull (boolean) --

          Specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL. A value of TRUE sets empty CHAR and VARCHAR fields to null. The default is FALSE.

        • EncryptionMode (string) --

          The type of server side encryption you want to use for your data. This is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (default) or SSE_KMS. To use SSE_S3, create an IAM role with a policy that allows "arn:aws:s3:::*" to use the following actions: "s3:PutObject", "s3:ListBucket" .

        • FileTransferUploadStreams (integer) --

          Specifies the number of threads used to upload a single file. This accepts a value between 1 and 64. It defaults to 10.

        • LoadTimeout (integer) --

          Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you begin loading.

        • MaxFileSize (integer) --

          Specifies the maximum size (in KB) of any CSV file used to transfer data to Amazon Redshift. This accepts a value between 1 and 1048576. It defaults to 32768 KB (32 MB).

        • Password (string) --

          The password for the user named in the username property.

        • Port (integer) --

          The port number for Amazon Redshift. The default value is 5439.

        • RemoveQuotes (boolean) --

          Removes surrounding quotation marks from strings in the incoming data. All characters within the quotation marks, including delimiters, are retained. Choose TRUE to remove quotation marks. The default is FALSE.

        • ReplaceInvalidChars (string) --

          A list of chars you want to replace. Use with ReplaceChars .

        • ReplaceChars (string) --

          Replaces invalid characters specified in ReplaceInvalidChars , substituting the specified value instead. The default is "?".

        • ServerName (string) --

          The name of the Amazon Redshift cluster you are using.

        • ServiceAccessRoleArn (string) --

          The ARN of the role that has access to the Redshift service.

        • ServerSideEncryptionKmsKeyId (string) --

          If you are using SSE_KMS for the EncryptionMode , provide the KMS Key ID. The key you use needs an attached policy that enables IAM user permissions and allows use of the key.

        • TimeFormat (string) --

          The time format you want to use. Valid values are auto (case-sensitive), 'timeformat_string', 'epochsecs', or 'epochmillisecs'. It defaults to 10. Using auto recognizes most strings, even some that are not supported when you use a time format string.

          If your date and time values use formats different from each other, set this to auto .

        • TrimBlanks (boolean) --

          Removes the trailing white space characters from a VARCHAR string. This parameter applies only to columns with a VARCHAR data type. Choose TRUE to remove unneeded white space. The default is FALSE.

        • TruncateColumns (boolean) --

          Truncates data in columns to the appropriate number of characters, so that it fits in the column. Applies only to columns with a VARCHAR or CHAR data type, and rows with a size of 4 MB or less. Choose TRUE to truncate data. The default is FALSE.

        • Username (string) --

          An Amazon Redshift user name for a registered user.

        • WriteBufferSize (integer) --

          The size of the write buffer to use in rows. Valid values range from 1 to 2048. Defaults to 1024. Use this setting to tune performance.

{'OrderableReplicationInstances': {'AvailabilityZones': ['string']}}

Returns information about the replication instance types that can be created in the specified region.

See also: AWS API Documentation

Request Syntax

client.describe_orderable_replication_instances(
    MaxRecords=123,
    Marker='string'
)

type MaxRecords

integer

param MaxRecords

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.

Default: 100

Constraints: Minimum 20, maximum 100.

type Marker

string

param Marker

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 .

rtype

dict

returns

Response Syntax

{
    'OrderableReplicationInstances': [
        {
            'EngineVersion': 'string',
            'ReplicationInstanceClass': 'string',
            'StorageType': 'string',
            'MinAllocatedStorage': 123,
            'MaxAllocatedStorage': 123,
            'DefaultAllocatedStorage': 123,
            'IncludedAllocatedStorage': 123,
            'AvailabilityZones': [
                'string',
            ]
        },
    ],
    'Marker': 'string'
}

Response Structure

• (dict) --

  • OrderableReplicationInstances (list) --

    The order-able replication instances available.

    • (dict) --

      • EngineVersion (string) --

        The version of the replication engine.

      • ReplicationInstanceClass (string) --

        The compute and memory capacity of the replication instance.

        Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge

      • StorageType (string) --

        The type of storage used by the replication instance.

      • MinAllocatedStorage (integer) --

        The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.

      • MaxAllocatedStorage (integer) --

        The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.

      • DefaultAllocatedStorage (integer) --

        The default amount of storage (in gigabytes) that is allocated for the replication instance.

      • IncludedAllocatedStorage (integer) --

        The amount of storage (in gigabytes) that is allocated for the replication instance.

      • AvailabilityZones (list) --

        List of availability zones for this replication instance.

        • (string) --

  • Marker (string) --

    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 .

{'WithoutSettings': 'boolean'}

Returns information about replication tasks for your account in the current region.

See also: AWS API Documentation

Request Syntax

client.describe_replication_tasks(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string',
    WithoutSettings=True|False
)

type Filters

list

param Filters

Filters applied to the describe action.

Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn

• (dict) --

  • Name (string) -- [REQUIRED]

    The name of the filter.

  • Values (list) -- [REQUIRED]

    The filter value.

    • (string) --

type MaxRecords

integer

param MaxRecords

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.

Default: 100

Constraints: Minimum 20, maximum 100.

type Marker

string

param Marker

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 .

type WithoutSettings

boolean

param WithoutSettings

Set this flag to avoid returning setting information. Use this to reduce overhead when settings are too large. Choose TRUE to use this flag, otherwise choose FALSE (default).

rtype

dict

returns

Response Syntax

{
    'Marker': 'string',
    'ReplicationTasks': [
        {
            'ReplicationTaskIdentifier': 'string',
            'SourceEndpointArn': 'string',
            'TargetEndpointArn': 'string',
            'ReplicationInstanceArn': 'string',
            'MigrationType': 'full-load'|'cdc'|'full-load-and-cdc',
            'TableMappings': 'string',
            'ReplicationTaskSettings': 'string',
            'Status': 'string',
            'LastFailureMessage': 'string',
            'StopReason': 'string',
            'ReplicationTaskCreationDate': datetime(2015, 1, 1),
            'ReplicationTaskStartDate': datetime(2015, 1, 1),
            'CdcStartPosition': 'string',
            'CdcStopPosition': 'string',
            'RecoveryCheckpoint': 'string',
            'ReplicationTaskArn': 'string',
            'ReplicationTaskStats': {
                'FullLoadProgressPercent': 123,
                'ElapsedTimeMillis': 123,
                'TablesLoaded': 123,
                'TablesLoading': 123,
                'TablesQueued': 123,
                'TablesErrored': 123
            }
        },
    ]
}

Response Structure

• (dict) --

  • Marker (string) --

    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 .

  • ReplicationTasks (list) --

    A description of the replication tasks.

    • (dict) --

      • ReplicationTaskIdentifier (string) --

        The user-assigned replication task identifier or name.

        Constraints:

        • Must contain from 1 to 255 alphanumeric characters or hyphens.

        • First character must be a letter.

        • Cannot end with a hyphen or contain two consecutive hyphens.

      • SourceEndpointArn (string) --

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

      • TargetEndpointArn (string) --

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

      • ReplicationInstanceArn (string) --

        The Amazon Resource Name (ARN) of the replication instance.

      • MigrationType (string) --

        The type of migration.

      • TableMappings (string) --

        Table mappings specified in the task.

      • ReplicationTaskSettings (string) --

        The settings for the replication task.

      • Status (string) --

        The status of the replication task.

      • LastFailureMessage (string) --

        The last error (failure) message generated for the replication instance.

      • StopReason (string) --

        The reason the replication task was stopped.

      • ReplicationTaskCreationDate (datetime) --

        The date the replication task was created.

      • ReplicationTaskStartDate (datetime) --

        The date the replication task is scheduled to start.

      • CdcStartPosition (string) --

        Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.

        The value can be in date, checkpoint, or LSN/SCN format.

        Date Example: --cdc-start-position “2018-03-08T12:12:12”

        Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"

        LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”

      • CdcStopPosition (string) --

        Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

        Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12”

        Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “

      • RecoveryCheckpoint (string) --

        Indicates the last checkpoint that occurred during a change data capture (CDC) operation. You can provide this value to the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.

      • ReplicationTaskArn (string) --

        The Amazon Resource Name (ARN) of the replication task.

      • ReplicationTaskStats (dict) --

        The statistics for the task, including elapsed time, tables loaded, and table errors.

        • FullLoadProgressPercent (integer) --

          The percent complete for the full load migration task.

        • ElapsedTimeMillis (integer) --

          The elapsed time of the task, in milliseconds.

        • TablesLoaded (integer) --

          The number of tables loaded for this task.

        • TablesLoading (integer) --

          The number of tables currently loading for this task.

        • TablesQueued (integer) --

          The number of tables queued for this task.

        • TablesErrored (integer) --

          The number of errors that have occurred during this task.

{'RedshiftSettings': {'AcceptAnyDate': 'boolean',
                      'AfterConnectScript': 'string',
                      'BucketFolder': 'string',
                      'BucketName': 'string',
                      'ConnectionTimeout': 'integer',
                      'DatabaseName': 'string',
                      'DateFormat': 'string',
                      'EmptyAsNull': 'boolean',
                      'EncryptionMode': 'sse-s3 | sse-kms',
                      'FileTransferUploadStreams': 'integer',
                      'LoadTimeout': 'integer',
                      'MaxFileSize': 'integer',
                      'Password': 'string',
                      'Port': 'integer',
                      'RemoveQuotes': 'boolean',
                      'ReplaceChars': 'string',
                      'ReplaceInvalidChars': 'string',
                      'ServerName': 'string',
                      'ServerSideEncryptionKmsKeyId': 'string',
                      'ServiceAccessRoleArn': 'string',
                      'TimeFormat': 'string',
                      'TrimBlanks': 'boolean',
                      'TruncateColumns': 'boolean',
                      'Username': 'string',
                      'WriteBufferSize': 'integer'},
 'S3Settings': {'CdcInsertsOnly': 'boolean',
                'DataFormat': 'csv | parquet',
                'DataPageSize': 'integer',
                'DictPageSizeLimit': 'integer',
                'EnableStatistics': 'boolean',
                'EncodingType': 'plain | plain-dictionary | rle-dictionary',
                'EncryptionMode': 'sse-s3 | sse-kms',
                'ParquetVersion': 'parquet-1-0 | parquet-2-0',
                'RowGroupLength': 'integer',
                'ServerSideEncryptionKmsKeyId': 'string'}}

{'Endpoint': {'RedshiftSettings': {'AcceptAnyDate': 'boolean',
                                   'AfterConnectScript': 'string',
                                   'BucketFolder': 'string',
                                   'BucketName': 'string',
                                   'ConnectionTimeout': 'integer',
                                   'DatabaseName': 'string',
                                   'DateFormat': 'string',
                                   'EmptyAsNull': 'boolean',
                                   'EncryptionMode': 'sse-s3 | sse-kms',
                                   'FileTransferUploadStreams': 'integer',
                                   'LoadTimeout': 'integer',
                                   'MaxFileSize': 'integer',
                                   'Password': 'string',
                                   'Port': 'integer',
                                   'RemoveQuotes': 'boolean',
                                   'ReplaceChars': 'string',
                                   'ReplaceInvalidChars': 'string',
                                   'ServerName': 'string',
                                   'ServerSideEncryptionKmsKeyId': 'string',
                                   'ServiceAccessRoleArn': 'string',
                                   'TimeFormat': 'string',
                                   'TrimBlanks': 'boolean',
                                   'TruncateColumns': 'boolean',
                                   'Username': 'string',
                                   'WriteBufferSize': 'integer'},
              'S3Settings': {'CdcInsertsOnly': 'boolean',
                             'DataFormat': 'csv | parquet',
                             'DataPageSize': 'integer',
                             'DictPageSizeLimit': 'integer',
                             'EnableStatistics': 'boolean',
                             'EncodingType': 'plain | plain-dictionary | '
                                             'rle-dictionary',
                             'EncryptionMode': 'sse-s3 | sse-kms',
                             'ParquetVersion': 'parquet-1-0 | parquet-2-0',
                             'RowGroupLength': 'integer',
                             'ServerSideEncryptionKmsKeyId': 'string'}}}

Modifies the specified endpoint.

See also: AWS API Documentation

Request Syntax

client.modify_endpoint(
    EndpointArn='string',
    EndpointIdentifier='string',
    EndpointType='source'|'target',
    EngineName='string',
    Username='string',
    Password='string',
    ServerName='string',
    Port=123,
    DatabaseName='string',
    ExtraConnectionAttributes='string',
    CertificateArn='string',
    SslMode='none'|'require'|'verify-ca'|'verify-full',
    ServiceAccessRoleArn='string',
    ExternalTableDefinition='string',
    DynamoDbSettings={
        'ServiceAccessRoleArn': 'string'
    },
    S3Settings={
        'ServiceAccessRoleArn': 'string',
        'ExternalTableDefinition': 'string',
        'CsvRowDelimiter': 'string',
        'CsvDelimiter': 'string',
        'BucketFolder': 'string',
        'BucketName': 'string',
        'CompressionType': 'none'|'gzip',
        'EncryptionMode': 'sse-s3'|'sse-kms',
        'ServerSideEncryptionKmsKeyId': 'string',
        'DataFormat': 'csv'|'parquet',
        'EncodingType': 'plain'|'plain-dictionary'|'rle-dictionary',
        'DictPageSizeLimit': 123,
        'RowGroupLength': 123,
        'DataPageSize': 123,
        'ParquetVersion': 'parquet-1-0'|'parquet-2-0',
        'EnableStatistics': True|False,
        'CdcInsertsOnly': True|False
    },
    DmsTransferSettings={
        'ServiceAccessRoleArn': 'string',
        'BucketName': 'string'
    },
    MongoDbSettings={
        'Username': 'string',
        'Password': 'string',
        'ServerName': 'string',
        'Port': 123,
        'DatabaseName': 'string',
        'AuthType': 'no'|'password',
        'AuthMechanism': 'default'|'mongodb_cr'|'scram_sha_1',
        'NestingLevel': 'none'|'one',
        'ExtractDocId': 'string',
        'DocsToInvestigate': 'string',
        'AuthSource': 'string',
        'KmsKeyId': 'string'
    },
    KinesisSettings={
        'StreamArn': 'string',
        'MessageFormat': 'json',
        'ServiceAccessRoleArn': 'string'
    },
    ElasticsearchSettings={
        'ServiceAccessRoleArn': 'string',
        'EndpointUri': 'string',
        'FullLoadErrorPercentage': 123,
        'ErrorRetryDuration': 123
    },
    RedshiftSettings={
        'AcceptAnyDate': True|False,
        'AfterConnectScript': 'string',
        'BucketFolder': 'string',
        'BucketName': 'string',
        'ConnectionTimeout': 123,
        'DatabaseName': 'string',
        'DateFormat': 'string',
        'EmptyAsNull': True|False,
        'EncryptionMode': 'sse-s3'|'sse-kms',
        'FileTransferUploadStreams': 123,
        'LoadTimeout': 123,
        'MaxFileSize': 123,
        'Password': 'string',
        'Port': 123,
        'RemoveQuotes': True|False,
        'ReplaceInvalidChars': 'string',
        'ReplaceChars': 'string',
        'ServerName': 'string',
        'ServiceAccessRoleArn': 'string',
        'ServerSideEncryptionKmsKeyId': 'string',
        'TimeFormat': 'string',
        'TrimBlanks': True|False,
        'TruncateColumns': True|False,
        'Username': 'string',
        'WriteBufferSize': 123
    }
)

type EndpointArn

string

param EndpointArn

[REQUIRED]

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

type EndpointIdentifier

string

param EndpointIdentifier

The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.

type EndpointType

string

param EndpointType

The type of endpoint.

type EngineName

string

param EngineName

The type of engine for the endpoint. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, sybase, dynamodb, mongodb, and sqlserver.

type Username

string

param Username

The user name to be used to login to the endpoint database.

type Password

string

param Password

The password to be used to login to the endpoint database.

type ServerName

string

param ServerName

The name of the server where the endpoint database resides.

type Port

integer

param Port

The port used by the endpoint database.

type DatabaseName

string

param DatabaseName

The name of the endpoint database.

type ExtraConnectionAttributes

string

param ExtraConnectionAttributes

Additional attributes associated with the connection. To reset this parameter, pass the empty string ("") as an argument.

type CertificateArn

string

param CertificateArn

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

type SslMode

string

param SslMode

The SSL mode to be used.

SSL mode can be one of four values: none, require, verify-ca, verify-full.

The default value is none.

type ServiceAccessRoleArn

string

param ServiceAccessRoleArn

The Amazon Resource Name (ARN) for the service access role you want to use to modify the endpoint.

type ExternalTableDefinition

string

param ExternalTableDefinition

The external table definition.

type DynamoDbSettings

dict

param DynamoDbSettings

Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see Using Object Mapping to Migrate Data to DynamoDB in the AWS Database Migration Service User Guide.

• ServiceAccessRoleArn (string) -- [REQUIRED]

  The Amazon Resource Name (ARN) used by the service access IAM role.

type S3Settings

dict

param S3Settings

Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the AWS Database Migration Service User Guide.

• ServiceAccessRoleArn (string) --

  The Amazon Resource Name (ARN) used by the service access IAM role.

• ExternalTableDefinition (string) --

  The external table definition.

• CsvRowDelimiter (string) --

  The delimiter used to separate rows in the source files. The default is a carriage return (\n ).

• CsvDelimiter (string) --

  The delimiter used to separate columns in the source files. The default is a comma.

• BucketFolder (string) --

  An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path <bucketFolder>/<schema_name>/<table_name>/ . If this parameter is not specified, then the path used is <schema_name>/<table_name>/ .

• BucketName (string) --

  The name of the S3 bucket.

• CompressionType (string) --

  An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed. Applies to both CSV and PARQUET data formats.

• EncryptionMode (string) --

  The type of server side encryption you want to use for your data. This is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (default) or SSE_KMS . To use SSE_S3 , you need an IAM role with permission to allow "arn:aws:s3:::dms-*" to use the following actions:

  • s3:CreateBucket

  • s3:ListBucket

  • s3:DeleteBucket

  • s3:GetBucketLocation

  • s3:GetObject

  • s3:PutObject

  • s3:DeleteObject

  • s3:GetObjectVersion

  • s3:GetBucketPolicy

  • s3:PutBucketPolicy

  • s3:DeleteBucketPolicy

• ServerSideEncryptionKmsKeyId (string) --

  If you are using SSE_KMS for the EncryptionMode , provide the KMS Key ID. The key you use needs an attached policy that enables IAM user permissions and allows use of the key.

  Here is a CLI example: aws dms create-endpoint --endpoint-identifier <value> --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn=<value>,BucketFolder=<value>,BucketName=<value>,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=<value>

• DataFormat (string) --

  The format of the data which you want to use for output. You can choose one of the following:

  • CSV : This is a row-based format with comma-separated values.

  • PARQUET : Apache Parquet is a columnar storage format that features efficient compression and provides faster query response.

• EncodingType (string) --

  The type of encoding you are using: RLE_DICTIONARY (default), PLAIN , or PLAIN_DICTIONARY .

  • RLE_DICTIONARY uses a combination of bit-packing and run-length encoding to store repeated values more efficiently.

  • PLAIN does not use encoding at all. Values are stored as they are.

  • PLAIN_DICTIONARY builds a dictionary of the values encountered in a given column. The dictionary is stored in a dictionary page for each column chunk.

• DictPageSizeLimit (integer) --

  The maximum size of an encoded dictionary page of a column. If the dictionary page exceeds this, this column is stored using an encoding type of PLAIN . Defaults to 1024 * 1024 bytes (1MiB), the maximum size of a dictionary page before it reverts to PLAIN encoding. For PARQUET format only.

• RowGroupLength (integer) --

  The number of rows in a row group. A smaller row group size provides faster reads. But as the number of row groups grows, the slower writes become. Defaults to 10,000 (ten thousand) rows. For PARQUET format only.

  If you choose a value larger than the maximum, RowGroupLength is set to the max row group length in bytes (64 * 1024 * 1024).

• DataPageSize (integer) --

  The size of one data page in bytes. Defaults to 1024 * 1024 bytes (1MiB). For PARQUET format only.

• ParquetVersion (string) --

  The version of Apache Parquet format you want to use: PARQUET_1_0 (default) or PARQUET_2_0 .

• EnableStatistics (boolean) --

  Enables statistics for Parquet pages and rowGroups. Choose TRUE to enable statistics, choose FALSE to disable. Statistics include NULL , DISTINCT , MAX , and MIN values. Defaults to TRUE . For PARQUET format only.

• CdcInsertsOnly (boolean) --

  Option to write only INSERT operations to the comma-separated value (CSV) output files. By default, the first field in a CSV record contains the letter I (insert), U (update) or D (delete) to indicate whether the row was inserted, updated, or deleted at the source database. If cdcInsertsOnly is set to true, then only INSERT s are recorded in the CSV file, without the I annotation on each line. Valid values are TRUE and FALSE .

type DmsTransferSettings

dict

param DmsTransferSettings

The settings in JSON format for the DMS transfer type of source endpoint.

Attributes include the following:

• serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.

• BucketName - The name of the S3 bucket to use.

• compressionType - An optional parameter to use GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.

Shorthand syntax: ServiceAccessRoleArn=string ,BucketName=string,CompressionType=string

JSON syntax:

{ "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }

• ServiceAccessRoleArn (string) --

  The IAM role that has permission to access the Amazon S3 bucket.

• BucketName (string) --

  The name of the S3 bucket to use.

type MongoDbSettings

dict

param MongoDbSettings

Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in Using MongoDB as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.

• Username (string) --

  The user name you use to access the MongoDB source endpoint.

• Password (string) --

  The password for the user account you use to access the MongoDB source endpoint.

• ServerName (string) --

  The name of the server on the MongoDB source endpoint.

• Port (integer) --

  The port value for the MongoDB source endpoint.

• DatabaseName (string) --

  The database name on the MongoDB source endpoint.

• AuthType (string) --

  The authentication type you use to access the MongoDB source endpoint.

  Valid values: NO, PASSWORD

  When NO is selected, user name and password parameters are not used and can be empty.

• AuthMechanism (string) --

  The authentication mechanism you use to access the MongoDB source endpoint.

  Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1

  DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.

• NestingLevel (string) --

  Specifies either document or table mode.

  Valid values: NONE, ONE

  Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.

• ExtractDocId (string) --

  Specifies the document ID. Use this attribute when NestingLevel is set to NONE.

  Default value is false.

• DocsToInvestigate (string) --

  Indicates the number of documents to preview to determine the document organization. Use this attribute when NestingLevel is set to ONE.

  Must be a positive value greater than 0. Default value is 1000.

• AuthSource (string) --

  The MongoDB database name. This attribute is not used when authType=NO .

  The default is admin.

• KmsKeyId (string) --

  The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

type KinesisSettings

dict

param KinesisSettings

Settings in JSON format for the target Amazon Kinesis Data Streams endpoint. For more information about the available settings, see `Using Object Mapping to Migrate Data to a Kinesis Data Stream <https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping >`__ in the AWS Database Migration User Guide.

• StreamArn (string) --

  The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.

• MessageFormat (string) --

  The output format for the records created on the endpoint. The message format is JSON .

• ServiceAccessRoleArn (string) --

  The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Amazon Kinesis data stream.

type ElasticsearchSettings

dict

param ElasticsearchSettings

Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in the AWS Database Migration User Guide.

• ServiceAccessRoleArn (string) -- [REQUIRED]

  The Amazon Resource Name (ARN) used by service to access the IAM role.

• EndpointUri (string) -- [REQUIRED]

  The endpoint for the ElasticSearch cluster.

• FullLoadErrorPercentage (integer) --

  The maximum percentage of records that can fail to be written before a full load operation stops.

• ErrorRetryDuration (integer) --

  The maximum number of seconds that DMS retries failed API requests to the Elasticsearch cluster.

type RedshiftSettings

dict

param RedshiftSettings

• AcceptAnyDate (boolean) --

  Allows any date format, including invalid formats such as 00/00/00 00:00:00, to be loaded without generating an error. You can choose TRUE or FALSE (default).

  This parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with the DATEFORMAT parameter. If the date format for the data does not match the DATEFORMAT specification, Amazon Redshift inserts a NULL value into that field.

• AfterConnectScript (string) --

  Code to run after connecting. This should be the code, not a filename.

• BucketFolder (string) --

  The location where the CSV files are stored before being uploaded to the S3 bucket.

• BucketName (string) --

  The name of the S3 bucket you want to use

• ConnectionTimeout (integer) --

  Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.

• DatabaseName (string) --

  The name of the Amazon Redshift data warehouse (service) you are working with.

• DateFormat (string) --

  The date format you are using. Valid values are auto (case-sensitive), your date format string enclosed in quotes, or NULL. If this is left unset (NULL), it defaults to a format of 'YYYY-MM-DD'. Using auto recognizes most strings, even some that are not supported when you use a date format string.

  If your date and time values use formats different from each other, set this to auto .

• EmptyAsNull (boolean) --

  Specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL. A value of TRUE sets empty CHAR and VARCHAR fields to null. The default is FALSE.

• EncryptionMode (string) --

  The type of server side encryption you want to use for your data. This is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (default) or SSE_KMS. To use SSE_S3, create an IAM role with a policy that allows "arn:aws:s3:::*" to use the following actions: "s3:PutObject", "s3:ListBucket" .

• FileTransferUploadStreams (integer) --

  Specifies the number of threads used to upload a single file. This accepts a value between 1 and 64. It defaults to 10.

• LoadTimeout (integer) --

  Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you begin loading.

• MaxFileSize (integer) --

  Specifies the maximum size (in KB) of any CSV file used to transfer data to Amazon Redshift. This accepts a value between 1 and 1048576. It defaults to 32768 KB (32 MB).

• Password (string) --

  The password for the user named in the username property.

• Port (integer) --

  The port number for Amazon Redshift. The default value is 5439.

• RemoveQuotes (boolean) --

  Removes surrounding quotation marks from strings in the incoming data. All characters within the quotation marks, including delimiters, are retained. Choose TRUE to remove quotation marks. The default is FALSE.

• ReplaceInvalidChars (string) --

  A list of chars you want to replace. Use with ReplaceChars .

• ReplaceChars (string) --

  Replaces invalid characters specified in ReplaceInvalidChars , substituting the specified value instead. The default is "?".

• ServerName (string) --

  The name of the Amazon Redshift cluster you are using.

• ServiceAccessRoleArn (string) --

  The ARN of the role that has access to the Redshift service.

• ServerSideEncryptionKmsKeyId (string) --

  If you are using SSE_KMS for the EncryptionMode , provide the KMS Key ID. The key you use needs an attached policy that enables IAM user permissions and allows use of the key.

• TimeFormat (string) --

  The time format you want to use. Valid values are auto (case-sensitive), 'timeformat_string', 'epochsecs', or 'epochmillisecs'. It defaults to 10. Using auto recognizes most strings, even some that are not supported when you use a time format string.

  If your date and time values use formats different from each other, set this to auto .

• TrimBlanks (boolean) --

  Removes the trailing white space characters from a VARCHAR string. This parameter applies only to columns with a VARCHAR data type. Choose TRUE to remove unneeded white space. The default is FALSE.

• TruncateColumns (boolean) --

  Truncates data in columns to the appropriate number of characters, so that it fits in the column. Applies only to columns with a VARCHAR or CHAR data type, and rows with a size of 4 MB or less. Choose TRUE to truncate data. The default is FALSE.

• Username (string) --

  An Amazon Redshift user name for a registered user.

• WriteBufferSize (integer) --

  The size of the write buffer to use in rows. Valid values range from 1 to 2048. Defaults to 1024. Use this setting to tune performance.

rtype

dict

returns

Response Syntax

{
    'Endpoint': {
        'EndpointIdentifier': 'string',
        'EndpointType': 'source'|'target',
        'EngineName': 'string',
        'EngineDisplayName': 'string',
        'Username': 'string',
        'ServerName': 'string',
        'Port': 123,
        'DatabaseName': 'string',
        'ExtraConnectionAttributes': 'string',
        'Status': 'string',
        'KmsKeyId': 'string',
        'EndpointArn': 'string',
        'CertificateArn': 'string',
        'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
        'ServiceAccessRoleArn': 'string',
        'ExternalTableDefinition': 'string',
        'ExternalId': 'string',
        'DynamoDbSettings': {
            'ServiceAccessRoleArn': 'string'
        },
        'S3Settings': {
            'ServiceAccessRoleArn': 'string',
            'ExternalTableDefinition': 'string',
            'CsvRowDelimiter': 'string',
            'CsvDelimiter': 'string',
            'BucketFolder': 'string',
            'BucketName': 'string',
            'CompressionType': 'none'|'gzip',
            'EncryptionMode': 'sse-s3'|'sse-kms',
            'ServerSideEncryptionKmsKeyId': 'string',
            'DataFormat': 'csv'|'parquet',
            'EncodingType': 'plain'|'plain-dictionary'|'rle-dictionary',
            'DictPageSizeLimit': 123,
            'RowGroupLength': 123,
            'DataPageSize': 123,
            'ParquetVersion': 'parquet-1-0'|'parquet-2-0',
            'EnableStatistics': True|False,
            'CdcInsertsOnly': True|False
        },
        'DmsTransferSettings': {
            'ServiceAccessRoleArn': 'string',
            'BucketName': 'string'
        },
        'MongoDbSettings': {
            'Username': 'string',
            'Password': 'string',
            'ServerName': 'string',
            'Port': 123,
            'DatabaseName': 'string',
            'AuthType': 'no'|'password',
            'AuthMechanism': 'default'|'mongodb_cr'|'scram_sha_1',
            'NestingLevel': 'none'|'one',
            'ExtractDocId': 'string',
            'DocsToInvestigate': 'string',
            'AuthSource': 'string',
            'KmsKeyId': 'string'
        },
        'KinesisSettings': {
            'StreamArn': 'string',
            'MessageFormat': 'json',
            'ServiceAccessRoleArn': 'string'
        },
        'ElasticsearchSettings': {
            'ServiceAccessRoleArn': 'string',
            'EndpointUri': 'string',
            'FullLoadErrorPercentage': 123,
            'ErrorRetryDuration': 123
        },
        'RedshiftSettings': {
            'AcceptAnyDate': True|False,
            'AfterConnectScript': 'string',
            'BucketFolder': 'string',
            'BucketName': 'string',
            'ConnectionTimeout': 123,
            'DatabaseName': 'string',
            'DateFormat': 'string',
            'EmptyAsNull': True|False,
            'EncryptionMode': 'sse-s3'|'sse-kms',
            'FileTransferUploadStreams': 123,
            'LoadTimeout': 123,
            'MaxFileSize': 123,
            'Password': 'string',
            'Port': 123,
            'RemoveQuotes': True|False,
            'ReplaceInvalidChars': 'string',
            'ReplaceChars': 'string',
            'ServerName': 'string',
            'ServiceAccessRoleArn': 'string',
            'ServerSideEncryptionKmsKeyId': 'string',
            'TimeFormat': 'string',
            'TrimBlanks': True|False,
            'TruncateColumns': True|False,
            'Username': 'string',
            'WriteBufferSize': 123
        }
    }
}

Response Structure

• (dict) --

  • Endpoint (dict) --

    The modified endpoint.

    • EndpointIdentifier (string) --

      The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.

    • EndpointType (string) --

      The type of endpoint.

    • EngineName (string) --

      The database engine name. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, sybase, dynamodb, mongodb, and sqlserver.

    • EngineDisplayName (string) --

      The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL."

    • Username (string) --

      The user name used to connect to the endpoint.

    • ServerName (string) --

      The name of the server at the endpoint.

    • Port (integer) --

      The port value used to access the endpoint.

    • DatabaseName (string) --

      The name of the database at the endpoint.

    • ExtraConnectionAttributes (string) --

      Additional connection attributes used to connect to the endpoint.

    • Status (string) --

      The status of the endpoint.

    • KmsKeyId (string) --

      The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

    • EndpointArn (string) --

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

    • CertificateArn (string) --

      The Amazon Resource Name (ARN) used for SSL connection to the endpoint.

    • SslMode (string) --

      The SSL mode used to connect to the endpoint.

      SSL mode can be one of four values: none, require, verify-ca, verify-full.

      The default value is none.

    • ServiceAccessRoleArn (string) --

      The Amazon Resource Name (ARN) used by the service access IAM role.

    • ExternalTableDefinition (string) --

      The external table definition.

    • ExternalId (string) --

      Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account.

    • DynamoDbSettings (dict) --

      The settings for the target DynamoDB database. For more information, see the DynamoDBSettings structure.

      • ServiceAccessRoleArn (string) --

        The Amazon Resource Name (ARN) used by the service access IAM role.

    • S3Settings (dict) --

      The settings for the S3 target endpoint. For more information, see the S3Settings structure.

      • ServiceAccessRoleArn (string) --

        The Amazon Resource Name (ARN) used by the service access IAM role.

      • ExternalTableDefinition (string) --

        The external table definition.

      • CsvRowDelimiter (string) --

        The delimiter used to separate rows in the source files. The default is a carriage return (\n ).

      • CsvDelimiter (string) --

        The delimiter used to separate columns in the source files. The default is a comma.

      • BucketFolder (string) --

        An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path <bucketFolder>/<schema_name>/<table_name>/ . If this parameter is not specified, then the path used is <schema_name>/<table_name>/ .

      • BucketName (string) --

        The name of the S3 bucket.

      • CompressionType (string) --

        An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed. Applies to both CSV and PARQUET data formats.

      • EncryptionMode (string) --

        The type of server side encryption you want to use for your data. This is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (default) or SSE_KMS . To use SSE_S3 , you need an IAM role with permission to allow "arn:aws:s3:::dms-*" to use the following actions:

        • s3:CreateBucket

        • s3:ListBucket

        • s3:DeleteBucket

        • s3:GetBucketLocation

        • s3:GetObject

        • s3:PutObject

        • s3:DeleteObject

        • s3:GetObjectVersion

        • s3:GetBucketPolicy

        • s3:PutBucketPolicy

        • s3:DeleteBucketPolicy

      • ServerSideEncryptionKmsKeyId (string) --

        If you are using SSE_KMS for the EncryptionMode , provide the KMS Key ID. The key you use needs an attached policy that enables IAM user permissions and allows use of the key.

        Here is a CLI example: aws dms create-endpoint --endpoint-identifier <value> --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn=<value>,BucketFolder=<value>,BucketName=<value>,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=<value>

      • DataFormat (string) --

        The format of the data which you want to use for output. You can choose one of the following:

        • CSV : This is a row-based format with comma-separated values.

        • PARQUET : Apache Parquet is a columnar storage format that features efficient compression and provides faster query response.

      • EncodingType (string) --

        The type of encoding you are using: RLE_DICTIONARY (default), PLAIN , or PLAIN_DICTIONARY .

        • RLE_DICTIONARY uses a combination of bit-packing and run-length encoding to store repeated values more efficiently.

        • PLAIN does not use encoding at all. Values are stored as they are.

        • PLAIN_DICTIONARY builds a dictionary of the values encountered in a given column. The dictionary is stored in a dictionary page for each column chunk.

      • DictPageSizeLimit (integer) --

        The maximum size of an encoded dictionary page of a column. If the dictionary page exceeds this, this column is stored using an encoding type of PLAIN . Defaults to 1024 * 1024 bytes (1MiB), the maximum size of a dictionary page before it reverts to PLAIN encoding. For PARQUET format only.

      • RowGroupLength (integer) --

        The number of rows in a row group. A smaller row group size provides faster reads. But as the number of row groups grows, the slower writes become. Defaults to 10,000 (ten thousand) rows. For PARQUET format only.

        If you choose a value larger than the maximum, RowGroupLength is set to the max row group length in bytes (64 * 1024 * 1024).

      • DataPageSize (integer) --

        The size of one data page in bytes. Defaults to 1024 * 1024 bytes (1MiB). For PARQUET format only.

      • ParquetVersion (string) --

        The version of Apache Parquet format you want to use: PARQUET_1_0 (default) or PARQUET_2_0 .

      • EnableStatistics (boolean) --

        Enables statistics for Parquet pages and rowGroups. Choose TRUE to enable statistics, choose FALSE to disable. Statistics include NULL , DISTINCT , MAX , and MIN values. Defaults to TRUE . For PARQUET format only.

      • CdcInsertsOnly (boolean) --

        Option to write only INSERT operations to the comma-separated value (CSV) output files. By default, the first field in a CSV record contains the letter I (insert), U (update) or D (delete) to indicate whether the row was inserted, updated, or deleted at the source database. If cdcInsertsOnly is set to true, then only INSERT s are recorded in the CSV file, without the I annotation on each line. Valid values are TRUE and FALSE .

    • DmsTransferSettings (dict) --

      The settings in JSON format for the DMS transfer type of source endpoint.

      Possible attributes include the following:

      • serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.

      • bucketName - The name of the S3 bucket to use.

      • compressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this value.

      Shorthand syntax for these attributes is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string

      JSON syntax for these attributes is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }

      • ServiceAccessRoleArn (string) --

        The IAM role that has permission to access the Amazon S3 bucket.

      • BucketName (string) --

        The name of the S3 bucket to use.

    • MongoDbSettings (dict) --

      The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.

      • Username (string) --

        The user name you use to access the MongoDB source endpoint.

      • Password (string) --

        The password for the user account you use to access the MongoDB source endpoint.

      • ServerName (string) --

        The name of the server on the MongoDB source endpoint.

      • Port (integer) --

        The port value for the MongoDB source endpoint.

      • DatabaseName (string) --

        The database name on the MongoDB source endpoint.

      • AuthType (string) --

        The authentication type you use to access the MongoDB source endpoint.

        Valid values: NO, PASSWORD

        When NO is selected, user name and password parameters are not used and can be empty.

      • AuthMechanism (string) --

        The authentication mechanism you use to access the MongoDB source endpoint.

        Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1

        DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.

      • NestingLevel (string) --

        Specifies either document or table mode.

        Valid values: NONE, ONE

        Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.

      • ExtractDocId (string) --

        Specifies the document ID. Use this attribute when NestingLevel is set to NONE.

        Default value is false.

      • DocsToInvestigate (string) --

        Indicates the number of documents to preview to determine the document organization. Use this attribute when NestingLevel is set to ONE.

        Must be a positive value greater than 0. Default value is 1000.

      • AuthSource (string) --

        The MongoDB database name. This attribute is not used when authType=NO .

        The default is admin.

      • KmsKeyId (string) --

        The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

    • KinesisSettings (dict) --

      The settings for the Amazon Kinesis source endpoint. For more information, see the KinesisSettings structure.

      • StreamArn (string) --

        The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.

      • MessageFormat (string) --

        The output format for the records created on the endpoint. The message format is JSON .

      • ServiceAccessRoleArn (string) --

        The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Amazon Kinesis data stream.

    • ElasticsearchSettings (dict) --

      The settings for the Elasticsearch source endpoint. For more information, see the ElasticsearchSettings structure.

      • ServiceAccessRoleArn (string) --

        The Amazon Resource Name (ARN) used by service to access the IAM role.

      • EndpointUri (string) --

        The endpoint for the ElasticSearch cluster.

      • FullLoadErrorPercentage (integer) --

        The maximum percentage of records that can fail to be written before a full load operation stops.

      • ErrorRetryDuration (integer) --

        The maximum number of seconds that DMS retries failed API requests to the Elasticsearch cluster.

    • RedshiftSettings (dict) --

      Settings for the Amazon Redshift endpoint

      • AcceptAnyDate (boolean) --

        Allows any date format, including invalid formats such as 00/00/00 00:00:00, to be loaded without generating an error. You can choose TRUE or FALSE (default).

        This parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with the DATEFORMAT parameter. If the date format for the data does not match the DATEFORMAT specification, Amazon Redshift inserts a NULL value into that field.

      • AfterConnectScript (string) --

        Code to run after connecting. This should be the code, not a filename.

      • BucketFolder (string) --

        The location where the CSV files are stored before being uploaded to the S3 bucket.

      • BucketName (string) --

        The name of the S3 bucket you want to use

      • ConnectionTimeout (integer) --

        Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.

      • DatabaseName (string) --

        The name of the Amazon Redshift data warehouse (service) you are working with.

      • DateFormat (string) --

        The date format you are using. Valid values are auto (case-sensitive), your date format string enclosed in quotes, or NULL. If this is left unset (NULL), it defaults to a format of 'YYYY-MM-DD'. Using auto recognizes most strings, even some that are not supported when you use a date format string.

        If your date and time values use formats different from each other, set this to auto .

      • EmptyAsNull (boolean) --

        Specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL. A value of TRUE sets empty CHAR and VARCHAR fields to null. The default is FALSE.

      • EncryptionMode (string) --

        The type of server side encryption you want to use for your data. This is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (default) or SSE_KMS. To use SSE_S3, create an IAM role with a policy that allows "arn:aws:s3:::*" to use the following actions: "s3:PutObject", "s3:ListBucket" .

      • FileTransferUploadStreams (integer) --

        Specifies the number of threads used to upload a single file. This accepts a value between 1 and 64. It defaults to 10.

      • LoadTimeout (integer) --

        Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you begin loading.

      • MaxFileSize (integer) --

        Specifies the maximum size (in KB) of any CSV file used to transfer data to Amazon Redshift. This accepts a value between 1 and 1048576. It defaults to 32768 KB (32 MB).

      • Password (string) --

        The password for the user named in the username property.

      • Port (integer) --

        The port number for Amazon Redshift. The default value is 5439.

      • RemoveQuotes (boolean) --

        Removes surrounding quotation marks from strings in the incoming data. All characters within the quotation marks, including delimiters, are retained. Choose TRUE to remove quotation marks. The default is FALSE.

      • ReplaceInvalidChars (string) --

        A list of chars you want to replace. Use with ReplaceChars .

      • ReplaceChars (string) --

        Replaces invalid characters specified in ReplaceInvalidChars , substituting the specified value instead. The default is "?".

      • ServerName (string) --

        The name of the Amazon Redshift cluster you are using.

      • ServiceAccessRoleArn (string) --

        The ARN of the role that has access to the Redshift service.

      • ServerSideEncryptionKmsKeyId (string) --

        If you are using SSE_KMS for the EncryptionMode , provide the KMS Key ID. The key you use needs an attached policy that enables IAM user permissions and allows use of the key.

      • TimeFormat (string) --

        The time format you want to use. Valid values are auto (case-sensitive), 'timeformat_string', 'epochsecs', or 'epochmillisecs'. It defaults to 10. Using auto recognizes most strings, even some that are not supported when you use a time format string.

        If your date and time values use formats different from each other, set this to auto .

      • TrimBlanks (boolean) --

        Removes the trailing white space characters from a VARCHAR string. This parameter applies only to columns with a VARCHAR data type. Choose TRUE to remove unneeded white space. The default is FALSE.

      • TruncateColumns (boolean) --

        Truncates data in columns to the appropriate number of characters, so that it fits in the column. Applies only to columns with a VARCHAR or CHAR data type, and rows with a size of 4 MB or less. Choose TRUE to truncate data. The default is FALSE.

      • Username (string) --

        An Amazon Redshift user name for a registered user.

      • WriteBufferSize (integer) --

        The size of the write buffer to use in rows. Valid values range from 1 to 2048. Defaults to 1024. Use this setting to tune performance.