libZSservicesZSamazonka-glueZSamazonka-glue
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Glue.GetPartitions

Description

Retrieves information about the partitions in a table.

This operation returns paginated results.

Synopsis

Creating a Request

data GetPartitions Source #

See: newGetPartitions smart constructor.

Constructors

GetPartitions' 

Fields

  • catalogId :: Maybe Text

    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.

  • excludeColumnSchema :: Maybe Bool

    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.

  • nextToken :: Maybe Text

    A continuation token, if this is not the first call to retrieve these partitions.

  • expression :: Maybe Text

    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:

  • segment :: Maybe Segment

    The segment of the table's partitions to scan in this request.

  • maxResults :: Maybe Natural

    The maximum number of partitions to return in a single response.

  • databaseName :: Text

    The name of the catalog database where the partitions reside.

  • tableName :: Text

    The name of the partitions' table.

Instances

Instances details
Eq GetPartitions Source # 
Instance details

Defined in Amazonka.Glue.GetPartitions

Read GetPartitions Source # 
Instance details

Defined in Amazonka.Glue.GetPartitions

Show GetPartitions Source # 
Instance details

Defined in Amazonka.Glue.GetPartitions

Generic GetPartitions Source # 
Instance details

Defined in Amazonka.Glue.GetPartitions

Associated Types

type Rep GetPartitions :: Type -> Type #

NFData GetPartitions Source # 
Instance details

Defined in Amazonka.Glue.GetPartitions

Methods

rnf :: GetPartitions -> () #

Hashable GetPartitions Source # 
Instance details

Defined in Amazonka.Glue.GetPartitions

ToJSON GetPartitions Source # 
Instance details

Defined in Amazonka.Glue.GetPartitions

AWSPager GetPartitions Source # 
Instance details

Defined in Amazonka.Glue.GetPartitions

AWSRequest GetPartitions Source # 
Instance details

Defined in Amazonka.Glue.GetPartitions

Associated Types

type AWSResponse GetPartitions #

ToHeaders GetPartitions Source # 
Instance details

Defined in Amazonka.Glue.GetPartitions

ToPath GetPartitions Source # 
Instance details

Defined in Amazonka.Glue.GetPartitions

ToQuery GetPartitions Source # 
Instance details

Defined in Amazonka.Glue.GetPartitions

type Rep GetPartitions Source # 
Instance details

Defined in Amazonka.Glue.GetPartitions

type AWSResponse GetPartitions Source # 
Instance details

Defined in Amazonka.Glue.GetPartitions

newGetPartitions Source #

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.

Constructors

GetPartitionsResponse' 

Fields

Instances

Instances details
Eq GetPartitionsResponse Source # 
Instance details

Defined in Amazonka.Glue.GetPartitions

Read GetPartitionsResponse Source # 
Instance details

Defined in Amazonka.Glue.GetPartitions

Show GetPartitionsResponse Source # 
Instance details

Defined in Amazonka.Glue.GetPartitions

Generic GetPartitionsResponse Source # 
Instance details

Defined in Amazonka.Glue.GetPartitions

Associated Types

type Rep GetPartitionsResponse :: Type -> Type #

NFData GetPartitionsResponse Source # 
Instance details

Defined in Amazonka.Glue.GetPartitions

Methods

rnf :: GetPartitionsResponse -> () #

type Rep GetPartitionsResponse Source # 
Instance details

Defined in Amazonka.Glue.GetPartitions

type Rep GetPartitionsResponse = D1 ('MetaData "GetPartitionsResponse" "Amazonka.Glue.GetPartitions" "libZSservicesZSamazonka-glueZSamazonka-glue" 'False) (C1 ('MetaCons "GetPartitionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "partitions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Partition])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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_nextToken :: Lens' GetPartitionsResponse (Maybe Text) Source #

A continuation token, if the returned list of partitions does not include the last one.