API Actions: AlterS3Replication

API Actions: AlterS3Replication

 

Request Syntax for AccessType = AccessKeys:

XML

POST /api/AlterS3Replication HTTP/1.1
Host: use.your.host.name:82
X-Amz-Content-Sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
Content-Type: application/xml
X-Amz-Date: 20171115T202130Z
Authorization: AWS4-HMAC-SHA256 Credential= UQOPWUVNBALABCABCABC/20171115/us-east-1/cloudbasic/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-content-sha256;x-amz-date, Signature=995374189c189e8e68ed3de82c1764ca11971711fb5179eeab2b19edd883dd74
 
<?xml version="1.0" encoding="utf-8"?>
<AlterS3ReplicationRequest>
    <ReplicationId>594ed5c8-e0aa-4fd0-987f-fcfd2aaf1763</ReplicationId>
	<SourceConnectionString>Data Source=your-source-db-server;Initial Catalog=TestDBAll_1;Persist Security Info=False;User ID=user-name;Password=******</SourceConnectionString>	  
	<DestinationConnectionString>Data Source=your-source-db-server;Initial Catalog=TestDBAll_1;Persist Security Info=False;User ID=user-name;Password=******</DestinationConnectionString>	  
	<DataReplication>true</DataReplication>
	<SchemaReplication>false</SchemaReplication>
	<ParallelTablesLimit>20</ParallelTablesLimit>
	<ChangeTrackingBatchLimit>100000</ChangeTrackingBatchLimit>
	<CtProcessTimeoutInMinutes>60</CtProcessTimeoutInMinutes>
	<SerializedCtProcessTimeoutInMinutes>60</SerilizedCtProcessTimeoutInMinutes>
	<AutoSerializedCtProcessTimeoutInMinutes>60</AutoSerializedCtProcessTimeoutInMinutes>
	<IsContinuous>false</IsContinuous>
	<RepeatIntervalInMinutes>5</RepeatIntervalInMinutes> 
	<ScheduleIntervalTimeFrom>12:20:00 AM</ScheduleIntervalTimeFrom>
	<ScheduleIntervalTimeTo>11:59:59 PM</ScheduleIntervalTimeTo>
	<IsLogErrorsOnly>false</IsLogErrorsOnly>
        <AlertOnSuccessfulTableSchemaChanges>true</AlertOnSuccessfulTableSchemaChanges> <!-- 12.211 and above -- activates info alerts to report successfully applied table schema changes which results into S3 file schema changes -->
	<TablesToInclude>[dbo].[Departments],[dbo].[Managers]</TablesToInclude> 
        <MaskedColumnsList>[dbo].[Departments].[SecretKey],[dbo].[Managers].[SSN]</MaskedColumnsList> <!-- 12.243 and above -- 
	<S3DataLake>
		<AccessType>AccessKey</AccessType> 
		<AccessKey>AKIAIK5IR2D555AV4RFA</AccessKey>
		<SecretKey>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</SecretKey>
		<BucketName>cbr-test</BucketName>
		<BucketFolderName>/SCD/11232017/TestDBAll_1</BucketFolderName>
		<RetentionDays>5</RetentionDays>
		<Delimiter>$|</Delimiter>
		<RegionEndpoint>us-east-1</RegionEndpoint>
		<ScdType>Type2</ScdType> <!-- Type1, Type2 -->
		<FolderStructure>OneFolderPerTablePerYearMonthDayHour</FolderStructure> <!-- OneFolderPerExportProcessRun,OneFolderPerTable,OneFolderPerTablePerDay,OneFolderPerTablePerDayWithAppending,OneFolderPerTablePerYearMonthDay,OneFolderPerTablePerYearMonthDayHour -->
		<FolderNamingFormat>KeyEqualValue</FolderNamingFormat> <!-- Default, DayHourEqualValue [12.204 and above], KeyEqualValue (applicable to FolderStructure in (OneFolderPerTablePerYearMonthDay, OneFolderPerTablePerYearMonthDayHour) only -->                
                <FileFormat>Parquet</FileFormat> <!-- JSON, CSV, Parquet -->
                <CSVFileExtension>csv</CSVFileExtension> <!-- 12.207 or above. Applicable to FileFormat=CSV only. Default='csv', allows specifying of custom file extension such as "dat" -->
                <Delimiter>TAB</Delimiter> <!-- applicable to FileFormat=CSV only, standard delimiters to be selected are ASC30, ASC31, TAB -->
                <JsonExportType>Line</JsonExportType> <!-- Document, Line (applicable to FileFormat=JSON only) --> 
                <Compression>Snappy</Compression> <!-- None, Gzip, Bzip2, Snappy --> 
                <AddTableSchemaPrefix>false</AddTableSchemaPrefix> 
                <ConvertDataTypesToString>false</ConvertDataTypesToString> 
        </S3DataLake> 
        <ReseedingSchedule> 
                <NoPkTablesToInclude>[dbo].[NoPkTable1], [dbo].[NoPkTable2]</NoPkTablesToInclude> 
                <PkTablesToInclude>[dbo].[PkTable1], [dbo].[PkTable2]</PkTablesToInclude> 
                <FromTime>12:00:00 AM</FromTime> <ToTime>11:59:59 PM</ToTime> 
        <RepeatIntervalInMinutes>120</RepeatIntervalInMinutes> 
</ReseedingSchedule> 
</AlterS3ReplicationRequest>

JSON

POST /api/AlterS3Replication HTTP/1.1
Host: use.your.host.name:82
X-Amz-Content-Sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
Content-Type: application/json
X-Amz-Date: 20171115T202130Z
Authorization: AWS4-HMAC-SHA256 Credential= UQOPWUVNBALABCABCABC/20171115/us-east-1/cloudbasic/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-content-sha256;x-amz-date, Signature=995374189c189e8e68ed3de82c1764ca11971711fb5179eeab2b19edd883dd74
 
{
	"replicationId": 594ed5c8-e0aa-4fd0-987f-fcfd2aaf1763,
	"sourceConnectionString": "Data Source=your-source-db-server;Initial Catalog=TestDBAll_1;Persist Security Info=False;User ID=user-name;Password=*******",
	"destinationConnectionString": "Data Source=your-source-db-server;Initial Catalog=TestDBAll_1;Persist Security Info=False;User ID=user-name;Password=*******",
	"dataReplication": "true",
	"schemaReplication": "false",
	"parallelTablesLimit": "20",
	"changeTrackingBatchLimit": "100000",
	"ctProcessTimeoutInMinutes": "60",
	"serializedCtProcessTimeoutInMinutes": "60",
	"autoSerializedCtProcessTimeoutInMinutes": "60",
	"isContinuous": "false",
	"repeatIntervalInMinutes": "5",
	"scheduleIntervalTimeFrom": "12:20:00 AM",
	"scheduleIntervalTimeTo": "11:59:59 PM",
	"isLogErrorsOnly": "false",
        "alertOnSuccessfulTableSchemaChanges": "true"  -- 12.211 and above -- activates info alerts to report successfully applied table schema changes, which results into S3 file schema changes
	"s3DataLake": {
		"accessType": "AccessKey",
		"accessKey": "AKIAIK5IR2D555AV4RFA",
		"secretKey": "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",
		"bucketName": "cbr-test",
		"bucketFolderName": "/SCD/11232017/TestDBAll_1",
		"regionEndpoint": "us-east-1",
		"retentionDays": 5,
		"scdType": "Type2",
		"delimiter": "$|",
		"folderStructure":"OneFolderPerTablePerYearMonthDayHour", -- OneFolderPerExportProcessRun,OneFolderPerTable,OneFolderPerTablePerDay,OneFolderPerTablePerDayWithAppending,OneFolderPerTablePerYearMonthDay,OneFolderPerTablePerYearMonthDayHour
                "folderNamingFormat: "KeyEqualValue", -- Default, DayHourEqualValue [12.204 and above], KeyEqualValue (applicable to FolderStructure in (OneFolderPerTablePerYearMonthDay, OneFolderPerTablePerYearMonthDayHour) only 
		"fileFormat": "Parquet",
                "csvFileExtension": "csv" -- 12.207 or above. Applicable to FileFormat=CSV only. Default='csv', allows specifying of custom file extension such as "dat"
		"jsonExportType": "Line",
		"compression": "Snappy",
                "addTableSchemaPrefix": false,
                "convertDataTypesToString": false}, "tablesToInclude": "[dbo].[Departments],[dbo].[Managers]", "reseedingSchedule": { "noPkTablesToInclude": "[dbo].[NoPkTable]", "pkTablesToInclude": null, "fromTime": "10:00:00 AM", "toTime": "10:59:59 PM", "repeatIntervalInMinutes": "100" } }

 

Request Syntax for AccessType = IAMRole:

XML

POST /api/AlterS3Replication HTTP/1.1
Host: use.your.host.name:82
X-Amz-Content-Sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
Content-Type: application/xml
X-Amz-Date: 20171115T202130Z
Authorization: AWS4-HMAC-SHA256 Credential= UQOPWUVNBALABCABCABC/20171115/us-east-1/cloudbasic/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-content-sha256;x-amz-date, Signature=995374189c189e8e68ed3de82c1764ca11971711fb5179eeab2b19edd883dd74
 
<?xml version="1.0" encoding="utf-8"?>
<AlterS3ReplicationRequest>
	<ReplicationId>594ed5c8-e0aa-4fd0-987f-fcfd2aaf1763</ReplicationId>
	<SourceConnectionString>Data Source=your-source-db-server;Initial Catalog=TestDBAll_1;Persist Security Info=False;User ID=user-name;Password=******</SourceConnectionString>	  
	<DestinationConnectionString>Data Source=your-source-db-server;Initial Catalog=TestDBAll_1;Persist Security Info=False;User ID=user-name;Password=******</DestinationConnectionString>	  
	<DataReplication>true</DataReplication>
	<SchemaReplication>false</SchemaReplication>
	<ParallelTablesLimit>20</ParallelTablesLimit>
	<ChangeTrackingBatchLimit>100000</ChangeTrackingBatchLimit>
	<CtProcessTimeoutInMinutes>60</CtProcessTimeoutInMinutes>
	<SerializedCtProcessTimeoutInMinutes>60</SerilizedCtProcessTimeoutInMinutesSerialize>
	<AutoSerializedCtProcessTimeoutInMinutes>60</AutoSerializedCtProcessTimeoutInMinutes>
	<IsContinuous>false</IsContinuous>
	<RepeatIntervalInMinutes>5</RepeatIntervalInMinutes> 
	<ScheduleIntervalTimeFrom>12:20:00 AM</ScheduleIntervalTimeFrom>
	<ScheduleIntervalTimeTo>11:59:59 PM</ScheduleIntervalTimeTo>
	<IsLogErrorsOnly>false</IsLogErrorsOnly>
	<TablesToInclude>[dbo].[Departments],[dbo].[Managers]</TablesToInclude> 
	<S3DataLake>
		<AccessType>IAMRole</AccessType> 
		<AccountId>AKIAIK5IR2D555AV4RFA</AccountId>
		<RoleName>XrMEaWGywbZtPbtWm1TBmwUxkV5Ovm6tJEsuy+4X</RoleName>
		<BucketName>cbr-test</BucketName>
		<BucketFolderName>/SCD/11232017/TestDBAll_1</BucketFolderName>
		<RetentionDays>5</RetentionDays>
		<Delimiter>$|</Delimiter>
		<RegionEndpoint>us-east-1</RegionEndpoint>
		<ScdType>Type2</ScdType> <!-- Type1, Type2 --> 
                <FolderStructure>OneFolderPerTablePerYearMonthDayHour</FolderStructure> <!-- OneFolderPerExportProcessRun,OneFolderPerTable,OneFolderPerTablePerDay,OneFolderPerTablePerDayWithAppending,OneFolderPerTablePerYearMonthDay,OneFolderPerTablePerYearMonthDayHour --> 
                <FolderNamingFormat>KeyEqualValue</FolderNamingFormat> <!-- Default, DayHourEqualValue [12.204 and above], KeyEqualValue (applicable to FolderStructure in (OneFolderPerTablePerYearMonthDay, OneFolderPerTablePerYearMonthDayHour) only --> 
                <FileFormat>Parquet</FileFormat> <!-- JSON, CSV, Parquet -->
                <CSVFileExtension>csv</CSVFileExtension> <!-- 12.207 or above. Applicable to FileFormat=CSV only. Default='csv', allows specifying of custom file extension such as "dat" --> 
                <Delimiter>TAB</Delimiter> <!-- applicable to FileFormat=CSV only -->
                <JsonExportType>Line</JsonExportType> <!-- Document, Line (applicable to FileFormat=JSON only) --> 
                <Compression>Snappy</Compression> <!-- None, Gzip, Bzip2, Snappy -->
                <AddTableSchemaPrefix>false</AddTableSchemaPrefix>
                <ConvertDataTypesToString>false</ConvertDataTypesToString>
</S3DataLake> <ReseedingSchedule> <NoPkTablesToInclude>[dbo].[NoPkTable1], [dbo].[NoPkTable2]</NoPkTablesToInclude> <PkTablesToInclude>[dbo].[PkTable1], [dbo].[PkTable2]</PkTablesToInclude> <FromTime>12:00:00 AM</FromTime> <ToTime>11:59:59 PM</ToTime> <RepeatIntervalInMinutes>120</RepeatIntervalInMinutes> </ReseedingSchedule> </AlterS3ReplicationRequest>

JSON

POST /api/AlterS3Replication HTTP/1.1
Host: use.your.host.name:82
X-Amz-Content-Sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
Content-Type: application/json
X-Amz-Date: 20171115T202130Z
Authorization: AWS4-HMAC-SHA256 Credential= UQOPWUVNBALABCABCABC/20171115/us-east-1/cloudbasic/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-content-sha256;x-amz-date, Signature=995374189c189e8e68ed3de82c1764ca11971711fb5179eeab2b19edd883dd74
 
{
	"replicationId": 594ed5c8-e0aa-4fd0-987f-fcfd2aaf1763,
	"sourceConnectionString": "Data Source=your-source-db-server;Initial Catalog=TestDBAll_1;Persist Security Info=False;User ID=user-name;Password=*******",
	"destinationConnectionString": "Data Source=your-source-db-server;Initial Catalog=TestDBAll_1;Persist Security Info=False;User ID=user-name;Password=*******",
	"dataReplication": "true",
	"schemaReplication": "false",
	"parallelTablesLimit": "20",
	"changeTrackingBatchLimit": "100000",
	"ctProcessTimeoutInMinutes": "60",
	"serializedCtProcessTimeoutInMinutes": "60",
	"autoSerializedCtProcessTimeoutInMinutes": "60",
	"isContinuous": "false",
	"repeatIntervalInMinutes": "5",
	"scheduleIntervalTimeFrom": "12:20:00 AM",
	"scheduleIntervalTimeTo": "11:59:59 PM",
	"isLogErrorsOnly": "false",
	"s3DataLake": {
		"accessType": "IAMRole",
		"accountId": "AKIAIK5IR2D555AV4RFA",
		"roleName": "XrMEaWGywbZtPbtWm1TBmwUxkV5Ovm6tJEsuy+4X",
		"bucketName": "cbr-test",
		"bucketFolderName": "/SCD/Type2",
		"regionEndpoint": "us-east-1",
		"retentionDays": 5,
                "scdType": "Type2", 
                "folderStructure": "OneFolderPerTablePerYearMonthDayHour", -- OneFolderPerExportProcessRun,OneFolderPerTable,OneFolderPerTablePerDay,OneFolderPerTablePerDayWithAppending,OneFolderPerTablePerYearMonthDay,OneFolderPerTablePerYearMonthDayHour
                "folderNamingFormat: "KeyEqualValue", -- Default, DayHourEqualValue [12.204 and above], KeyEqualValue (applicable to FolderStructure in (OneFolderPerTablePerYearMonthDay, OneFolderPerTablePerYearMonthDayHour) only
                "fileFormat": "Parquet", 
                "csvFileExtension": "csv" -- 12.207 or above. Applicable to FileFormat=CSV only. Default='csv', allows specifying of custom file extension such as "dat"
                "delimiter": "TAB", 
                "jsonExportType": "Line", 
                "compression": "Snappy", 
                "addTableSchemaPrefix": false, 
                "convertDataTypesToString": false}, 
                "tablesToInclude": "[dbo].[Departments],[dbo].[Managers]", 
                "maskedColumnsList": "[dbo].[Departments].[SecretKey],[dbo].[Managers].[SSN]",
                "reseedingSchedule": { 
                       "noPkTablesToInclude": "[dbo].[NoPkTable]", 
                       "pkTablesToInclude": null, "fromTime": "10:00:00 AM", "toTime": "10:59:59 PM", 
                       "repeatIntervalInMinutes": "100" 
                 } 
        }
}

 

Request Parameters

> <!-- 12.211 and above --

Parameter Description Required
ReplicationId The ReplicationID returned in the CreateReplication response. Yes
Type: String
Default: None
SourceConnectionString Pass this tag only if altering source connection string; i.e. changing login and/or password. No
Type: String
Default: None
DestinationConnectionString Pass this tag only if altering destination/replica connection string; i.e. changing login and/or password. No
Type: String
Default: None
DataReplication Pass this tag only if turning off/on the replication.
Important: If need to stop/start all replications, use StopReplicationService/StartReplication instead.		 No
Type: String
Default: None
Valid value: true/ false
SchemaReplication Pass this tag only if turning off/on schema replication. No
Type: String
Default: None
Valid value: true/ false
ParallelTablesLimit Pass this tag only if altering parallel tables limit (max number of tables replicated concurrently; lower number decreases workload on source & destination servers but might increase latency. No
Type: Integer
Default: None
ChangeTrackingBatchLimit Pass this tag only if altering change tracking batch limit (number of records per table extracted at once; default=500,000; this parameter controls workload on source server in case of high volume of changes (i.e. 1mil per min bulkload). No
Type: Integer
Default: 500000
CtProcessTimeoutInMinutes Change Tracking (Ct) Time out (in minutes). If a Ct process runs longer than the specified time (default=30 mins), it will be canceled. If Ct is canceled due to exceeded timeout, next Ct processes will run with doubled previous timeout. If canceled again, timeout will be doubled again. if timeout is exceed 3rd time, then Ct process with be launched without a timeout. Upon successful Ct run, timeout will be adjusted back to the originally specified. No
Type: Integer
Default: 30
SerializedCtProcessTimeoutInMinutes If Serialization (Serialized Replication Execution; parallel replications limit=1; see AlterConfiguration API method's tags SerializeReplications & ParallelDatabaseReplicationsLimit) is activated in UI or via the AlterConfiguration API method (see tag ParallelDatabaseReplicationsLimit), launch next transfer in queue, if this transfer is running for longer than the specified time. Default is 30 minutes. No
Type: Integer
Default: 30
AutoSerializedCtProcessTimeoutInMinutes If Serialization (Serialize Schedule Execution) is system activated (due to server restart in order to avoid server overloading in case of large number of concurrent DB replications), next change tracking replication in the queue will be launched in parallel, if the current process is running for longer than the specified timeout. Default is 30 minutes. No
Type: Integer
Default: 30
IsContinuous CreateReplication sets this value to true by default in order for each DB replication to run continuously with lowest possible latency. If by any reason the replication needs to run in specified intervals (such as to reduce load on primary server), alter this value to false, and specify the interval in RepeatIntervalInMinutes No
Type: String
Default: None
Valid value: true/ false
RepeatIntervalInMinutes Applicable only if IsContinuous=false. Specifies the replication process runs interval if the default continuous replication setup need to be changed (i.e. to reduce load on primary) No
Type: Integer
Default: 30
ScheduleIntervalTimeFrom If the replication process does not have to run 24h, the default schedule start time can be altered No
Type: String
Default: None
ScheduleIntervalTimeTo If the replication process does not have to run 24h, the default schedule end time can be altered. No
Type: String
Default: None
IsLogErrorsOnly By default the continuous replication setup is created to not log runtime log details (only errors/warnings are logged). IsLogErrorsOnly=false will enable detailed runtime logging which can help with identifying performance/latency issues. No
Type: String
Default: None
Valid value: true/ false
AlertOnSuccessfulTableSchemaChanges
(12.211 and above)		 By default the continuous replication setup is created to not generate info alerts notifying of successfully applied schema changes, which result into S3 file structure changes. Set this paradefineparametermeter to True, to activate this type of info alerts. No
Type: String
Default: False
Valid value: true/ false
TablesToInclude List of tables to be included in the replication job:
XML formatted request example:
<TablesToInclude>[dbo].[Departments],[dbo].[Managers]</TablesToInclude>
JSON formatted request example:
"tablesToInclude": "[dbo].[Departments],[dbo].[Managers]"Pass 'All' to include all tables:
XML formatted request sample:
<TablesToInclude>All</TablesToInclude>
JSON formatted request sample:
"tablesToInclude": "All"		 Yes
Type: String
Default: None
S3DataLake
AccessType The type of access can be either AccessKey or IAMRole. Yes
Type: String
Default: None
Valid value: AccessKey/ IAMRole
AccessKey When the AccessType is set to AccessKey this field must contain the AWS AccessKey that the CloudBasic process will use to write to the specified S3 bucket. Yes
Type: String
Default: None
SecretKey When the AccessType is set to AccessKey this field must contain the AWS SecretKey that the CloudBasic process will use to write to the specified S3 bucket. Yes
Type: String
Default: None
AccountId When the AccessType is set to IAMRole this field must contain the AWS AccountID that the CloudBasic process will use to write to the specified S3 bucket. Yes
Type: String
Default: None
RoleName When the AccessType is set to IAMRole this field must contain the AWS RoleName that the CloudBasic process will use to write to the specified S3 bucket. Yes
Type: String
Default: None
BucketName The AWS S3 bucket name that the CloudBasic process will write to. Yes
Type: String
Default: None
BucketFolderName The folder in the AWS S3 bucket where the CloudBasic process will write. Yes
Type: String
Default: None
RetentionDays Number of the change tracking files will be kept for before the CloudBasic process deletes them. Yes
Type: Integer
Default: None
RegionEndpoint The name of the AWS Region where the S3 bucket is located. Yes
Type: String
Default: None
ScdType Slowly changing dimension type. Yes
Type: String
Default: Type1
Valid value: Type1/ Type2
FolderStructure Possible values include:

  • OneFolderFilePerTable (Scd Type 1 only)
  • OneFolderPerTable (multi-files; Scd Type 2 only)
  • OneFolderPerTablePerDay (Scd Type 2 only)
  • OneFolderPerTablePerDayWithAppending (file overwriting; Scd Type 2 only)
  • OneFolderPerExportProcessRun (Scd Type 1 only)
  • OneFolderPerTablePerYearMonthDay (Scd Type 2 only)
  • OneFolderPerTablePerYearMonthDayHour (Scd Type 2 only; version 12.132 and above)
 Yes
Type: String
Default: None
FileFormat Controls the export File Format Yes
Type: String
Default: None
Valid values are:
- JSON
- CSV
- Parquet
Delimiter The ASCII code of the delimiter character to be used if FileFormat=CSV Required if FileFormat=CSV
Type: String
Default: ASC30
Valid value: ASC30, ASC31, TAB; custom character(s), i.e. $|
CSVFileExtension The ASCII code of the delimiter character to be used if FileFormat=CSV Optional, applicable to FileFormat=CSV only
Type: String
Default: csv
Valid value: any valid file extension, i.e. dat, txt
FolderNamingFormat
(Version 12.133 and above)		 Controls folder naming format when SCD=Type2 and FileFormat=OneFolderPerTablePerYearMonthDay or FileFormat=OneFolderPerTablePerYearMonthDayPerHour Required only if SCD=Type2
and
FileFormat in (
OneFolderPerTablePerYearMonthDay,
OneFolderPerTablePerYearMonthDayPerHour
)
Type: String
Default: Default
Valid values are:
- Default (YYYY/DD/MM/HH)
- DayHourEqualValue (day=YYYYMMDD/hour=HH) -- 12.204 and above
- KeyEqualValue (year=YYYY/month=MM/day=DD/hour=HH)
JsonExportType Only applicable when the FileFormat is set to JSON Yes
Type: String
Default: None
Valid values are:
- Document
- Line
Compression Yes
Type: String
Default: None
Valid values are:
- None
- Bzip2
- Gzip
- Snappy (version 12.133 and above)
AddTableSchemaPrefix
(Version 12.132 and above)		 If set to True, table schema prefix (default prefix is dbo_{tablename}.{parquet|json|csv}, resulting from the default table schema dbo.{tablename}) will be added as prefix to the output filename . If tables with same names and different prefixes exist, adding a file prefix would be required to proceed. As new tables can be added at a later time, adding prefix to the output file name is recommended. No
Type: String
Default: true (if upgrading from older version to 12.132 and above, backward compatibility is ensured)
Valid values: true/ false
ConvertDataTypesToString
(Version 12.132 and above)		 If set to True, all decimal types will be converted to string in the output file No
Type: String
Default: false (if upgrading from older version to 12.132 and above, the value will be defaulted to True, to ensure backward compatibility)
Valid values: true/ false
ReseedingSchedule Tables with No Primary Keys Reseeding Schedule List.
Note:
Tables with No Primary Keys (PKs) will be seeded during replication but will not be tracked for changes. If adding PKs is not an option, you can include those tables in the reseeding schedule job for reseeding. See http://GetStarted.cloudbasic.net for more information.
NoPkTablesToInclude The list of tables with no Primary Keys that will be included in the reseeding.
Note:
Any table without a Primary Key (No PK), regardless of whether it is excluded in <tablestoinclude> list or not, can be included here.		 Yes
Type: String
Default: None
PkTablesToInclude The list of tables with Primary Keys that will be included in the reseeding.
Note:
Only tables with Primary Keys (Pk) NOT included in the <tablestoinclude> list can be included here.		 Yes
Type: String
Default: None
FromTime Starting time of the period when the reseeding process is allowed to run. Yes
Type: String
Default: None
ToTime Ending time of the period when the reseeding process is allowed to run. Yes
Type: String
Default: None
RepeatIntervalInMinutes Specifies the frequency of execution of the reseeding process in minutes. Yes
Type: Integer
Default: None

Note:
The tag AddUpdateTimestamp is not applicable to an AlterS3Replication request. A system update timestamps field can be added to Redshift tables only during the initial CreateS3Replication request

 

Request Headers

This implementation uses only request headers that are common to all operations. For more information please see the section Common Request Headers

 

Response Syntax:

HTTP/1.1 200
status: 200

 

Response Parameters

None

 

Error Response Syntax:

XML

HTTP/1.1 400
status: 400
 
<?xml version="1.0" encoding="utf-8"?>
<ErrorResponse> 
	<RequestId>request-id</RequestId> 
	<Errors> 
		<Error>{S3DataLake\BucketName}: Invalid value for BucketName</Error> 
	</Errors> 
</ErrorResponse>

JSON

HTTP/1.1 400
status: 400

{
   "errors": [
       "{S3DataLake\BucketName}: Invalid value for BucketName"
	],
	"requestId": 20
}