Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Retrieves information about the partitions in a table.
This operation returns paginated results.
Synopsis
- data GetPartitions = GetPartitions' {}
- newGetPartitions :: Text -> Text -> GetPartitions
- getPartitions_catalogId :: Lens' GetPartitions (Maybe Text)
- getPartitions_excludeColumnSchema :: Lens' GetPartitions (Maybe Bool)
- getPartitions_nextToken :: Lens' GetPartitions (Maybe Text)
- getPartitions_expression :: Lens' GetPartitions (Maybe Text)
- getPartitions_segment :: Lens' GetPartitions (Maybe Segment)
- getPartitions_maxResults :: Lens' GetPartitions (Maybe Natural)
- getPartitions_databaseName :: Lens' GetPartitions Text
- getPartitions_tableName :: Lens' GetPartitions Text
- data GetPartitionsResponse = GetPartitionsResponse' {
- partitions :: Maybe [Partition]
- nextToken :: Maybe Text
- httpStatus :: Int
- newGetPartitionsResponse :: Int -> GetPartitionsResponse
- getPartitionsResponse_partitions :: Lens' GetPartitionsResponse (Maybe [Partition])
- getPartitionsResponse_nextToken :: Lens' GetPartitionsResponse (Maybe Text)
- getPartitionsResponse_httpStatus :: Lens' GetPartitionsResponse Int
Creating a Request
data GetPartitions Source #
See: newGetPartitions
smart constructor.
GetPartitions' | |
|
Instances
Create a value of GetPartitions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:catalogId:GetPartitions'
, getPartitions_catalogId
- The ID of the Data Catalog where the partitions in question reside. If
none is provided, the Amazon Web Services account ID is used by default.
$sel:excludeColumnSchema:GetPartitions'
, getPartitions_excludeColumnSchema
- When true, specifies not returning the partition column schema. Useful
when you are interested only in other partition attributes such as
partition values or location. This approach avoids the problem of a
large response by not returning duplicate data.
$sel:nextToken:GetPartitions'
, getPartitions_nextToken
- A continuation token, if this is not the first call to retrieve these
partitions.
$sel:expression:GetPartitions'
, getPartitions_expression
- An expression that filters the partitions to be returned.
The expression uses SQL syntax similar to the SQL WHERE
filter clause.
The SQL statement parser
JSQLParser parses the
expression.
Operators: The following are the operators that you can use in the
Expression
API call:
- =
- Checks whether the values of the two operands are equal; if yes,
then the condition becomes true.
Example: Assume 'variable a' holds 10 and 'variable b' holds 20.
(a = b) is not true.
- < >
- Checks whether the values of two operands are equal; if the values
are not equal, then the condition becomes true.
Example: (a < > b) is true.
- >
- Checks whether the value of the left operand is greater than the
value of the right operand; if yes, then the condition becomes true.
Example: (a > b) is not true.
- <
- Checks whether the value of the left operand is less than the value
of the right operand; if yes, then the condition becomes true.
Example: (a < b) is true.
- >=
- Checks whether the value of the left operand is greater than or
equal to the value of the right operand; if yes, then the condition
becomes true.
Example: (a >= b) is not true.
- <=
- Checks whether the value of the left operand is less than or equal
to the value of the right operand; if yes, then the condition
becomes true.
Example: (a <= b) is true.
- AND, OR, IN, BETWEEN, LIKE, NOT, IS NULL
- Logical operators.
Supported Partition Key Types: The following are the supported partition keys.
string
date
timestamp
int
bigint
long
tinyint
smallint
decimal
If an type is encountered that is not valid, an exception is thrown.
The following list shows the valid operators on each type. When you
define a crawler, the partitionKey
type is created as a STRING
, to
be compatible with the catalog partitions.
Sample API Call:
$sel:segment:GetPartitions'
, getPartitions_segment
- The segment of the table's partitions to scan in this request.
$sel:maxResults:GetPartitions'
, getPartitions_maxResults
- The maximum number of partitions to return in a single response.
$sel:databaseName:GetPartitions'
, getPartitions_databaseName
- The name of the catalog database where the partitions reside.
$sel:tableName:GetPartitions'
, getPartitions_tableName
- The name of the partitions' table.
Request Lenses
getPartitions_catalogId :: Lens' GetPartitions (Maybe Text) Source #
The ID of the Data Catalog where the partitions in question reside. If none is provided, the Amazon Web Services account ID is used by default.
getPartitions_excludeColumnSchema :: Lens' GetPartitions (Maybe Bool) Source #
When true, specifies not returning the partition column schema. Useful when you are interested only in other partition attributes such as partition values or location. This approach avoids the problem of a large response by not returning duplicate data.
getPartitions_nextToken :: Lens' GetPartitions (Maybe Text) Source #
A continuation token, if this is not the first call to retrieve these partitions.
getPartitions_expression :: Lens' GetPartitions (Maybe Text) Source #
An expression that filters the partitions to be returned.
The expression uses SQL syntax similar to the SQL WHERE
filter clause.
The SQL statement parser
JSQLParser parses the
expression.
Operators: The following are the operators that you can use in the
Expression
API call:
- =
- Checks whether the values of the two operands are equal; if yes,
then the condition becomes true.
Example: Assume 'variable a' holds 10 and 'variable b' holds 20.
(a = b) is not true.
- < >
- Checks whether the values of two operands are equal; if the values
are not equal, then the condition becomes true.
Example: (a < > b) is true.
- >
- Checks whether the value of the left operand is greater than the
value of the right operand; if yes, then the condition becomes true.
Example: (a > b) is not true.
- <
- Checks whether the value of the left operand is less than the value
of the right operand; if yes, then the condition becomes true.
Example: (a < b) is true.
- >=
- Checks whether the value of the left operand is greater than or
equal to the value of the right operand; if yes, then the condition
becomes true.
Example: (a >= b) is not true.
- <=
- Checks whether the value of the left operand is less than or equal
to the value of the right operand; if yes, then the condition
becomes true.
Example: (a <= b) is true.
- AND, OR, IN, BETWEEN, LIKE, NOT, IS NULL
- Logical operators.
Supported Partition Key Types: The following are the supported partition keys.
string
date
timestamp
int
bigint
long
tinyint
smallint
decimal
If an type is encountered that is not valid, an exception is thrown.
The following list shows the valid operators on each type. When you
define a crawler, the partitionKey
type is created as a STRING
, to
be compatible with the catalog partitions.
Sample API Call:
getPartitions_segment :: Lens' GetPartitions (Maybe Segment) Source #
The segment of the table's partitions to scan in this request.
getPartitions_maxResults :: Lens' GetPartitions (Maybe Natural) Source #
The maximum number of partitions to return in a single response.
getPartitions_databaseName :: Lens' GetPartitions Text Source #
The name of the catalog database where the partitions reside.
getPartitions_tableName :: Lens' GetPartitions Text Source #
The name of the partitions' table.
Destructuring the Response
data GetPartitionsResponse Source #
See: newGetPartitionsResponse
smart constructor.
GetPartitionsResponse' | |
|
Instances
newGetPartitionsResponse Source #
Create a value of GetPartitionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:partitions:GetPartitionsResponse'
, getPartitionsResponse_partitions
- A list of requested partitions.
$sel:nextToken:GetPartitions'
, getPartitionsResponse_nextToken
- A continuation token, if the returned list of partitions does not
include the last one.
$sel:httpStatus:GetPartitionsResponse'
, getPartitionsResponse_httpStatus
- The response's http status code.
Response Lenses
getPartitionsResponse_partitions :: Lens' GetPartitionsResponse (Maybe [Partition]) Source #
A list of requested partitions.
getPartitionsResponse_nextToken :: Lens' GetPartitionsResponse (Maybe Text) Source #
A continuation token, if the returned list of partitions does not include the last one.
getPartitionsResponse_httpStatus :: Lens' GetPartitionsResponse Int Source #
The response's http status code.