DescribeEndpointSettings
Returns information about the possible endpoint settings available when you create an endpoint for a specific database engine.
Request Syntax
{
"EngineName": "string
",
"Marker": "string
",
"MaxRecords": number
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- EngineName
-
The database engine used for your source or target endpoint.
Type: String
Required: Yes
- 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: String
Required: No
- 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.Type: Integer
Required: No
Response Syntax
{
"EndpointSettings": [
{
"Applicability": "string",
"DefaultValue": "string",
"EnumValues": [ "string" ],
"IntValueMax": number,
"IntValueMin": number,
"Name": "string",
"Sensitive": boolean,
"Type": "string",
"Units": "string"
}
],
"Marker": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- EndpointSettings
-
Descriptions of the endpoint settings available for your source or target database engine.
Type: Array of EndpointSetting objects
- 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: String
Errors
For information about the errors that are common to all actions, see Common Errors.
Examples
Example
This example illustrates one usage of DescribeEndpointSettings.
Sample Request
POST / HTTP/1.1
Host: dms.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256
Credential=<Credential>,
SignedHeaders=contenttype;date;host;user-
agent;x-amz-date;x-amz-target;x-amzn-
requestid,Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
X-Amz-Target: AmazonDMSv20160101.DescribeEndpointSettings
{
"Filters":[
{
"Name":"engine-name",
"Values":[
"sqlserver"
]
}
],
"MaxRecords":0,
"Marker":""
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>
{
"EndpointSettings": [
{
"Name": "BcpPacketSize",
"Type": "integer",
"Sensitive": false,
"Applicability": "TARGET_ONLY",
"IntValueMin": 1,
"IntValueMax": 100000
},
{
"Name": "ControlTablesFileGroup",
"Type": "string",
"Sensitive": false
},
{
"Name": "DatabaseName",
"Type": "string",
"Sensitive": false
},
{
"Name": "Password",
"Type": "string",
"Sensitive": true
},
{
"Name": "Port",
"Type": "integer",
"Sensitive": false
},
{
"Name": "QuerySingleAlwaysOnNode",
"Type": "boolean",
"Sensitive": false
},
{
"Name": "ReadBackupOnly",
"Type": "boolean",
"Sensitive": false,
"Applicability": "SOURCE_ONLY"
},
{
"Name": "SafeguardPolicy",
"Type": "enum",
"EnumValues": [
"rely-on-sql-server-replication-agent",
"exclusive-automatic-truncation",
"shared-automatic-truncation"
],
"Sensitive": false,
"Applicability": "SOURCE_ONLY"
},
{
"Name": "SecretsManagerAccessRoleArn",
"Type": "string",
"Sensitive": false
},
{
"Name": "SecretsManagerSecretId",
"Type": "string",
"Sensitive": false
},
{
"Name": "ServerName",
"Type": "string",
"Sensitive": false
},
{
"Name": "UseBcpFullLoad",
"Type": "boolean",
"Sensitive": false,
"Applicability": "TARGET_ONLY"
},
{
"Name": "UseThirdPartyBackupDevice",
"Type": "boolean",
"Sensitive": false
},
{
"Name": "Username",
"Type": "string",
"Sensitive": false
}
]
}
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: