GetIntegrationTableProperties
This API is used to retrieve optional override properties for the tables that need to be replicated. These properties can include properties for filtering and partition for source and target tables.
Request Syntax
{
"ResourceArn": "string",
"TableName": "string"
}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.
- ResourceArn
-
The Amazon Resource Name (ARN) of the target table for which to retrieve integration table properties. Currently, this API only supports retrieving properties for target tables, and the provided ARN should be the ARN of the target table in the AWS Glue Data Catalog. Support for retrieving integration table properties for source connections (using the connection ARN) is not yet implemented and will be added in a future release.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes
- TableName
-
The name of the table to be replicated.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes
Response Syntax
{
"ResourceArn": "string",
"SourceTableConfig": {
"Fields": [ "string" ],
"FilterPredicate": "string",
"PrimaryKey": [ "string" ],
"RecordUpdateField": "string"
},
"TableName": "string",
"TargetTableConfig": {
"PartitionSpec": [
{
"ConversionSpec": "string",
"FieldName": "string",
"FunctionSpec": "string"
}
],
"TargetTableName": "string",
"UnnestSpec": "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.
- ResourceArn
-
The Amazon Resource Name (ARN) of the target table for which to retrieve integration table properties. Currently, this API only supports retrieving properties for target tables, and the provided ARN should be the ARN of the target table in the AWS Glue Data Catalog. Support for retrieving integration table properties for source connections (using the connection ARN) is not yet implemented and will be added in a future release.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
- SourceTableConfig
-
A structure for the source table configuration.
Type: SourceTableConfig object
- TableName
-
The name of the table to be replicated.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
- TargetTableConfig
-
A structure for the target table configuration.
Type: TargetTableConfig object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Access to a resource was denied.
- Message
-
A message describing the problem.
HTTP Status Code: 400
- EntityNotFoundException
-
A specified entity does not exist
- FromFederationSource
-
Indicates whether or not the exception relates to a federated source.
- Message
-
A message describing the problem.
HTTP Status Code: 400
- InternalServerException
-
An internal server error occurred.
- Message
-
A message describing the problem.
HTTP Status Code: 400
- InternalServiceException
-
An internal service error occurred.
- Message
-
A message describing the problem.
HTTP Status Code: 500
- InvalidInputException
-
The input provided was not valid.
- FromFederationSource
-
Indicates whether or not the exception relates to a federated source.
- Message
-
A message describing the problem.
HTTP Status Code: 400
- ResourceNotFoundException
-
The resource could not be found.
- Message
-
A message describing the problem.
HTTP Status Code: 400
- ValidationException
-
A value could not be validated.
- Message
-
A message describing the problem.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
