Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetDataCellsFilter

Returns a data cells filter.

Request Syntax


{
   "DatabaseName": "string",
   "Name": "string",
   "TableCatalogId": "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.

DatabaseName

A database in the AWS Glue Data Catalog.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: Yes

Name

The name given by the user to the data filter cell.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: Yes

TableCatalogId

The ID of the catalog to which the table belongs.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: Yes

TableName

A table in the database.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: Yes

Response Syntax


{
   "DataCellsFilter": { 
      "ColumnNames": [ "string" ],
      "ColumnWildcard": { 
         "ExcludedColumnNames": [ "string" ]
      },
      "DatabaseName": "string",
      "Name": "string",
      "RowFilter": { 
         "AllRowsWildcard": { 
         },
         "FilterExpression": "string"
      },
      "TableCatalogId": "string",
      "TableName": "string",
      "VersionId": "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.

DataCellsFilter

A structure that describes certain columns on certain rows.

Type: DataCellsFilter 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.

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.

Message: A message describing the problem.

HTTP Status Code: 400

OperationTimeoutException

The operation timed out.

Message: A message describing the problem.

HTTP Status Code: 400