Amazonka.OpenSearchServerless.Types.CollectionSummary

Documentation

data CollectionSummary

Details about each OpenSearch Serverless collection.

See: newCollectionSummary smart constructor.

Constructors

CollectionSummary'

Fields

• arn :: Maybe Text

  The Amazon Resource Name (ARN) of the collection.

• id :: Maybe Text

  The unique identifier of the collection.

• name :: Maybe Text

  The name of the collection.

• status :: Maybe CollectionStatus

  The current status of the collection.

Instances

FromJSON CollectionSummary

Defined in Amazonka.OpenSearchServerless.Types.CollectionSummary

Methods

parseJSON :: Value -> Parser CollectionSummary

parseJSONList :: Value -> Parser [CollectionSummary]

Generic CollectionSummary

Defined in Amazonka.OpenSearchServerless.Types.CollectionSummary

Associated Types

type Rep CollectionSummary :: Type -> Type

Methods

from :: CollectionSummary -> Rep CollectionSummary x

to :: Rep CollectionSummary x -> CollectionSummary

Read CollectionSummary

Defined in Amazonka.OpenSearchServerless.Types.CollectionSummary

Methods

readsPrec :: Int -> ReadS CollectionSummary

readList :: ReadS [CollectionSummary]

readPrec :: ReadPrec CollectionSummary

readListPrec :: ReadPrec [CollectionSummary]

Show CollectionSummary

Defined in Amazonka.OpenSearchServerless.Types.CollectionSummary

Methods

showsPrec :: Int -> CollectionSummary -> ShowS

show :: CollectionSummary -> String

showList :: [CollectionSummary] -> ShowS

NFData CollectionSummary

Defined in Amazonka.OpenSearchServerless.Types.CollectionSummary

Methods

rnf :: CollectionSummary -> ()

Eq CollectionSummary

Defined in Amazonka.OpenSearchServerless.Types.CollectionSummary

Methods

(==) :: CollectionSummary -> CollectionSummary -> Bool

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

Hashable CollectionSummary

Defined in Amazonka.OpenSearchServerless.Types.CollectionSummary

Methods

hashWithSalt :: Int -> CollectionSummary -> Int

hash :: CollectionSummary -> Int

type Rep CollectionSummary

Defined in Amazonka.OpenSearchServerless.Types.CollectionSummary

type Rep CollectionSummary = D1 ('MetaData "CollectionSummary" "Amazonka.OpenSearchServerless.Types.CollectionSummary" "amazonka-opensearchserverless-2.0-HnbMYszmsxrAMKjbvSoFws" 'False) (C1 ('MetaCons "CollectionSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CollectionStatus)))))

newCollectionSummary :: CollectionSummary

Create a value of CollectionSummary 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:arn:CollectionSummary', collectionSummary_arn - The Amazon Resource Name (ARN) of the collection.

$sel:id:CollectionSummary', collectionSummary_id - The unique identifier of the collection.

$sel:name:CollectionSummary', collectionSummary_name - The name of the collection.

$sel:status:CollectionSummary', collectionSummary_status - The current status of the collection.

collectionSummary_arn :: Lens' CollectionSummary (Maybe Text)

The Amazon Resource Name (ARN) of the collection.

collectionSummary_id :: Lens' CollectionSummary (Maybe Text)

The unique identifier of the collection.

collectionSummary_name :: Lens' CollectionSummary (Maybe Text)

The name of the collection.

collectionSummary_status :: Lens' CollectionSummary (Maybe CollectionStatus)

The current status of the collection.