Amazonka.Glue.Types.PartitionIndexDescriptor

Documentation

data PartitionIndexDescriptor

A descriptor for a partition index in a table.

See: newPartitionIndexDescriptor smart constructor.

Constructors

PartitionIndexDescriptor'

Fields

• backfillErrors :: Maybe [BackfillError]

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

• indexName :: Text

  The name of the partition index.

• keys :: NonEmpty KeySchemaElement

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

• indexStatus :: PartitionIndexStatus

  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.

Instances

FromJSON PartitionIndexDescriptor

Defined in Amazonka.Glue.Types.PartitionIndexDescriptor

Methods

parseJSON :: Value -> Parser PartitionIndexDescriptor

parseJSONList :: Value -> Parser [PartitionIndexDescriptor]

Generic PartitionIndexDescriptor

Defined in Amazonka.Glue.Types.PartitionIndexDescriptor

Associated Types

type Rep PartitionIndexDescriptor :: Type -> Type

Methods

from :: PartitionIndexDescriptor -> Rep PartitionIndexDescriptor x

to :: Rep PartitionIndexDescriptor x -> PartitionIndexDescriptor

Read PartitionIndexDescriptor

Defined in Amazonka.Glue.Types.PartitionIndexDescriptor

Methods

readsPrec :: Int -> ReadS PartitionIndexDescriptor

readList :: ReadS [PartitionIndexDescriptor]

readPrec :: ReadPrec PartitionIndexDescriptor

readListPrec :: ReadPrec [PartitionIndexDescriptor]

Show PartitionIndexDescriptor

Defined in Amazonka.Glue.Types.PartitionIndexDescriptor

Methods

showsPrec :: Int -> PartitionIndexDescriptor -> ShowS

show :: PartitionIndexDescriptor -> String

showList :: [PartitionIndexDescriptor] -> ShowS

NFData PartitionIndexDescriptor

Defined in Amazonka.Glue.Types.PartitionIndexDescriptor

Methods

rnf :: PartitionIndexDescriptor -> ()

Eq PartitionIndexDescriptor

Defined in Amazonka.Glue.Types.PartitionIndexDescriptor

Methods

(==) :: PartitionIndexDescriptor -> PartitionIndexDescriptor -> Bool

(/=) :: PartitionIndexDescriptor -> PartitionIndexDescriptor -> Bool

Hashable PartitionIndexDescriptor

Defined in Amazonka.Glue.Types.PartitionIndexDescriptor

Methods

hashWithSalt :: Int -> PartitionIndexDescriptor -> Int

hash :: PartitionIndexDescriptor -> Int

type Rep PartitionIndexDescriptor

Defined in Amazonka.Glue.Types.PartitionIndexDescriptor

type Rep PartitionIndexDescriptor = D1 ('MetaData "PartitionIndexDescriptor" "Amazonka.Glue.Types.PartitionIndexDescriptor" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "PartitionIndexDescriptor'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "backfillErrors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BackfillError])) :*: S1 ('MetaSel ('Just "indexName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "keys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty KeySchemaElement)) :*: S1 ('MetaSel ('Just "indexStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PartitionIndexStatus))))

newPartitionIndexDescriptor

Arguments

:: Text

$sel:indexName:PartitionIndexDescriptor'

-> NonEmpty KeySchemaElement

$sel:keys:PartitionIndexDescriptor'

-> PartitionIndexStatus

$sel:indexStatus:PartitionIndexDescriptor'

-> PartitionIndexDescriptor

Create a value of PartitionIndexDescriptor 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:backfillErrors:PartitionIndexDescriptor', partitionIndexDescriptor_backfillErrors - A list of errors that can occur when registering partition indexes for an existing table.

$sel:indexName:PartitionIndexDescriptor', partitionIndexDescriptor_indexName - The name of the partition index.

$sel:keys:PartitionIndexDescriptor', partitionIndexDescriptor_keys - A list of one or more keys, as KeySchemaElement structures, for the partition index.

$sel:indexStatus:PartitionIndexDescriptor', partitionIndexDescriptor_indexStatus - 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.

partitionIndexDescriptor_backfillErrors :: Lens' PartitionIndexDescriptor (Maybe [BackfillError])

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

partitionIndexDescriptor_indexName :: Lens' PartitionIndexDescriptor Text

The name of the partition index.

partitionIndexDescriptor_keys :: Lens' PartitionIndexDescriptor (NonEmpty KeySchemaElement)

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

partitionIndexDescriptor_indexStatus :: Lens' PartitionIndexDescriptor PartitionIndexStatus

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.