GetPartitionIndexes

class Glue.Paginator.GetPartitionIndexes

paginator = client.get_paginator('get_partition_indexes')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Glue.Client.get_partition_indexes().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    CatalogId='string',
    DatabaseName='string',
    TableName='string',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)

Parameters

• CatalogId (string) -- The catalog ID where the table resides.
• DatabaseName (string) --

  [REQUIRED]

  Specifies the name of a database from which you want to retrieve partition indexes.

• TableName (string) --

  [REQUIRED]

  Specifies the name of a table for which you want to retrieve the partition indexes.

• PaginationConfig (dict) --

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'PartitionIndexDescriptorList': [
        {
            'IndexName': 'string',
            'Keys': [
                {
                    'Name': 'string',
                    'Type': 'string'
                },
            ],
            'IndexStatus': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED',
            'BackfillErrors': [
                {
                    'Code': 'ENCRYPTED_PARTITION_ERROR'|'INTERNAL_ERROR'|'INVALID_PARTITION_TYPE_DATA_ERROR'|'MISSING_PARTITION_VALUE_ERROR'|'UNSUPPORTED_PARTITION_CHARACTER_ERROR',
                    'Partitions': [
                        {
                            'Values': [
                                'string',
                            ]
                        },
                    ]
                },
            ]
        },
    ],

}

Response Structure

• (dict) --

  • PartitionIndexDescriptorList (list) --

    A list of index descriptors.

    • (dict) --

      A descriptor for a partition index in a table.

      • IndexName (string) --

        The name of the partition index.

      • Keys (list) --

        A list of one or more keys, as KeySchemaElement structures, for the partition index.

        • (dict) --

          A partition key pair consisting of a name and a type.

          • Name (string) --

            The name of a partition key.

          • Type (string) --

            The type of a partition key.

      • IndexStatus (string) --

        The status of the partition index.

        The possible statuses are:

        • CREATING: The index is being created. When an index is in a CREATING state, the index or its table cannot be deleted.
        • ACTIVE: The index creation succeeds.
        • FAILED: The index creation fails.
        • DELETING: The index is deleted from the list of indexes.

      • BackfillErrors (list) --

        A list of errors that can occur when registering partition indexes for an existing table.

        • (dict) --

          A list of errors that can occur when registering partition indexes for an existing table.

          These errors give the details about why an index registration failed and provide a limited number of partitions in the response, so that you can fix the partitions at fault and try registering the index again. The most common set of errors that can occur are categorized as follows:

          • EncryptedPartitionError: The partitions are encrypted.
          • InvalidPartitionTypeDataError: The partition value doesn't match the data type for that partition column.
          • MissingPartitionValueError: The partitions are encrypted.
          • UnsupportedPartitionCharacterError: Characters inside the partition value are not supported. For example: U+0000 , U+0001, U+0002.
          • InternalError: Any error which does not belong to other error codes.

          • Code (string) --

            The error code for an error that occurred when registering partition indexes for an existing table.

          • Partitions (list) --

            A list of a limited number of partitions in the response.

            • (dict) --

              Contains a list of values defining partitions.

              • Values (list) --

                The list of values.

                • (string) --