Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetPartitionIndexes

Retrieves the partition indexes associated with a table.

Request Syntax


{
   "CatalogId": "string",
   "DatabaseName": "string",
   "NextToken": "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.

CatalogId

The catalog ID where the table resides.

Type: String

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

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

Required: No

DatabaseName

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

Type: String

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

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

Required: Yes

NextToken

A continuation token, included if this is a continuation call.

Type: String

Required: No

TableName

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

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


{
   "NextToken": "string",
   "PartitionIndexDescriptorList": [ 
      { 
         "BackfillErrors": [ 
            { 
               "Code": "string",
               "Partitions": [ 
                  { 
                     "Values": [ "string" ]
                  }
               ]
            }
         ],
         "IndexName": "string",
         "IndexStatus": "string",
         "Keys": [ 
            { 
               "Name": "string",
               "Type": "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.

NextToken

A continuation token, present if the current list segment is not the last.

Type: String

PartitionIndexDescriptorList

A list of index descriptors.

Type: Array of PartitionIndexDescriptor objects

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

The CreatePartitions API was called on a table that has indexes enabled.

HTTP Status Code: 400

EntityNotFoundException

A specified entity does not exist

HTTP Status Code: 400

InternalServiceException

An internal service error occurred.

HTTP Status Code: 500

InvalidInputException

The input provided was not valid.

HTTP Status Code: 400

OperationTimeoutException

The operation timed out.

HTTP Status Code: 400