Amazonka.DynamoDB.Types.Projection

Documentation

data Projection

Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

See: newProjection smart constructor.

Constructors

Projection'

Fields

• nonKeyAttributes :: Maybe (NonEmpty Text)

  Represents the non-key attribute names which will be projected into the index.

  For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

• projectionType :: Maybe ProjectionType

  The set of attributes that are projected into the index:

  • KEYS_ONLY - Only the index and primary keys are projected into the index.
  • INCLUDE - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.
  • ALL - All of the table attributes are projected into the index.

Instances

FromJSON Projection

Defined in Amazonka.DynamoDB.Types.Projection

Methods

parseJSON :: Value -> Parser Projection

parseJSONList :: Value -> Parser [Projection]

ToJSON Projection

Defined in Amazonka.DynamoDB.Types.Projection

Methods

toJSON :: Projection -> Value

toEncoding :: Projection -> Encoding

toJSONList :: [Projection] -> Value

toEncodingList :: [Projection] -> Encoding

Generic Projection

Defined in Amazonka.DynamoDB.Types.Projection

Associated Types

type Rep Projection :: Type -> Type

Methods

from :: Projection -> Rep Projection x

to :: Rep Projection x -> Projection

Read Projection

Defined in Amazonka.DynamoDB.Types.Projection

Methods

readsPrec :: Int -> ReadS Projection

readList :: ReadS [Projection]

readPrec :: ReadPrec Projection

readListPrec :: ReadPrec [Projection]

Show Projection

Defined in Amazonka.DynamoDB.Types.Projection

Methods

showsPrec :: Int -> Projection -> ShowS

show :: Projection -> String

showList :: [Projection] -> ShowS

NFData Projection

Defined in Amazonka.DynamoDB.Types.Projection

Methods

rnf :: Projection -> ()

Eq Projection

Defined in Amazonka.DynamoDB.Types.Projection

Methods

(==) :: Projection -> Projection -> Bool

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

Hashable Projection

Defined in Amazonka.DynamoDB.Types.Projection

Methods

hashWithSalt :: Int -> Projection -> Int

hash :: Projection -> Int

type Rep Projection

Defined in Amazonka.DynamoDB.Types.Projection

type Rep Projection = D1 ('MetaData "Projection" "Amazonka.DynamoDB.Types.Projection" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "Projection'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nonKeyAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "projectionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProjectionType))))

newProjection :: Projection

Create a value of Projection 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:nonKeyAttributes:Projection', projection_nonKeyAttributes - Represents the non-key attribute names which will be projected into the index.

For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

$sel:projectionType:Projection', projection_projectionType - The set of attributes that are projected into the index:

• KEYS_ONLY - Only the index and primary keys are projected into the index.
• INCLUDE - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.
• ALL - All of the table attributes are projected into the index.

projection_nonKeyAttributes :: Lens' Projection (Maybe (NonEmpty Text))

Represents the non-key attribute names which will be projected into the index.

For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

projection_projectionType :: Lens' Projection (Maybe ProjectionType)

The set of attributes that are projected into the index:

• KEYS_ONLY - Only the index and primary keys are projected into the index.
• INCLUDE - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.
• ALL - All of the table attributes are projected into the index.