Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.OpenSearchServerless.Types.CollectionDetail

Description

Synopsis

data CollectionDetail = CollectionDetail' {
- arn :: Maybe Text
- collectionEndpoint :: Maybe Text
- createdDate :: Maybe Integer
- dashboardEndpoint :: Maybe Text
- description :: Maybe Text
- id :: Maybe Text
- kmsKeyArn :: Maybe Text
- lastModifiedDate :: Maybe Integer
- name :: Maybe Text
- status :: Maybe CollectionStatus
- type' :: Maybe CollectionType
}
newCollectionDetail :: CollectionDetail
collectionDetail_arn :: Lens' CollectionDetail (Maybe Text)
collectionDetail_collectionEndpoint :: Lens' CollectionDetail (Maybe Text)
collectionDetail_createdDate :: Lens' CollectionDetail (Maybe Integer)
collectionDetail_dashboardEndpoint :: Lens' CollectionDetail (Maybe Text)
collectionDetail_description :: Lens' CollectionDetail (Maybe Text)
collectionDetail_id :: Lens' CollectionDetail (Maybe Text)
collectionDetail_kmsKeyArn :: Lens' CollectionDetail (Maybe Text)
collectionDetail_lastModifiedDate :: Lens' CollectionDetail (Maybe Integer)
collectionDetail_name :: Lens' CollectionDetail (Maybe Text)
collectionDetail_status :: Lens' CollectionDetail (Maybe CollectionStatus)
collectionDetail_type :: Lens' CollectionDetail (Maybe CollectionType)

Documentation

data CollectionDetail Source #

Details about each OpenSearch Serverless collection, including the collection endpoint and the OpenSearch Dashboards endpoint.

See: newCollectionDetail smart constructor.

Constructors

CollectionDetail'

Fields

arn :: Maybe Text
The Amazon Resource Name (ARN) of the collection.
collectionEndpoint :: Maybe Text
Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.
createdDate :: Maybe Integer
The Epoch time when the collection was created.
dashboardEndpoint :: Maybe Text
Collection-specific endpoint used to access OpenSearch Dashboards.
description :: Maybe Text
A description of the collection.
id :: Maybe Text
A unique identifier for the collection.
kmsKeyArn :: Maybe Text
The ARN of the Amazon Web Services KMS key used to encrypt the collection.
lastModifiedDate :: Maybe Integer
The date and time when the collection was last modified.
name :: Maybe Text
The name of the collection.
status :: Maybe CollectionStatus
The current status of the collection.
type' :: Maybe CollectionType
The type of collection.

Instances

Instances details

FromJSON CollectionDetail Source #
Instance details Defined in Amazonka.OpenSearchServerless.Types.CollectionDetail Methods parseJSON :: Value -> Parser CollectionDetail # parseJSONList :: Value -> Parser [CollectionDetail] #
Generic CollectionDetail Source #
Instance details Defined in Amazonka.OpenSearchServerless.Types.CollectionDetail Associated Types type Rep CollectionDetail :: Type -> Type # Methods from :: CollectionDetail -> Rep CollectionDetail x # to :: Rep CollectionDetail x -> CollectionDetail #
Read CollectionDetail Source #
Instance details Defined in Amazonka.OpenSearchServerless.Types.CollectionDetail Methods readsPrec :: Int -> ReadS CollectionDetail # readList :: ReadS [CollectionDetail] # readPrec :: ReadPrec CollectionDetail # readListPrec :: ReadPrec [CollectionDetail] #
Show CollectionDetail Source #
Instance details Defined in Amazonka.OpenSearchServerless.Types.CollectionDetail Methods showsPrec :: Int -> CollectionDetail -> ShowS # show :: CollectionDetail -> String # showList :: [CollectionDetail] -> ShowS #
NFData CollectionDetail Source #
Instance details Defined in Amazonka.OpenSearchServerless.Types.CollectionDetail Methods rnf :: CollectionDetail -> () #
Eq CollectionDetail Source #
Instance details Defined in Amazonka.OpenSearchServerless.Types.CollectionDetail Methods (==) :: CollectionDetail -> CollectionDetail -> Bool # (/=) :: CollectionDetail -> CollectionDetail -> Bool #
Hashable CollectionDetail Source #
Instance details Defined in Amazonka.OpenSearchServerless.Types.CollectionDetail Methods hashWithSalt :: Int -> CollectionDetail -> Int # hash :: CollectionDetail -> Int #
type Rep CollectionDetail Source #
Instance details Defined in Amazonka.OpenSearchServerless.Types.CollectionDetail type Rep CollectionDetail = D1 ('MetaData "CollectionDetail" "Amazonka.OpenSearchServerless.Types.CollectionDetail" "amazonka-opensearchserverless-2.0-HnbMYszmsxrAMKjbvSoFws" 'False) (C1 ('MetaCons "CollectionDetail'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "collectionEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: (S1 ('MetaSel ('Just "dashboardEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "kmsKeyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CollectionStatus)) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CollectionType)))))))

newCollectionDetail :: CollectionDetail Source #

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

$sel:collectionEndpoint:CollectionDetail', collectionDetail_collectionEndpoint - Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.

$sel:createdDate:CollectionDetail', collectionDetail_createdDate - The Epoch time when the collection was created.

$sel:dashboardEndpoint:CollectionDetail', collectionDetail_dashboardEndpoint - Collection-specific endpoint used to access OpenSearch Dashboards.

$sel:description:CollectionDetail', collectionDetail_description - A description of the collection.

$sel:id:CollectionDetail', collectionDetail_id - A unique identifier for the collection.

$sel:kmsKeyArn:CollectionDetail', collectionDetail_kmsKeyArn - The ARN of the Amazon Web Services KMS key used to encrypt the collection.

$sel:lastModifiedDate:CollectionDetail', collectionDetail_lastModifiedDate - The date and time when the collection was last modified.

$sel:name:CollectionDetail', collectionDetail_name - The name of the collection.

$sel:status:CollectionDetail', collectionDetail_status - The current status of the collection.

$sel:type':CollectionDetail', collectionDetail_type - The type of collection.

collectionDetail_arn :: Lens' CollectionDetail (Maybe Text) Source #

The Amazon Resource Name (ARN) of the collection.

collectionDetail_collectionEndpoint :: Lens' CollectionDetail (Maybe Text) Source #

Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.

collectionDetail_createdDate :: Lens' CollectionDetail (Maybe Integer) Source #

The Epoch time when the collection was created.

collectionDetail_dashboardEndpoint :: Lens' CollectionDetail (Maybe Text) Source #

Collection-specific endpoint used to access OpenSearch Dashboards.

collectionDetail_description :: Lens' CollectionDetail (Maybe Text) Source #

A description of the collection.

collectionDetail_id :: Lens' CollectionDetail (Maybe Text) Source #

A unique identifier for the collection.

collectionDetail_kmsKeyArn :: Lens' CollectionDetail (Maybe Text) Source #

The ARN of the Amazon Web Services KMS key used to encrypt the collection.

collectionDetail_lastModifiedDate :: Lens' CollectionDetail (Maybe Integer) Source #

The date and time when the collection was last modified.

collectionDetail_name :: Lens' CollectionDetail (Maybe Text) Source #

The name of the collection.

collectionDetail_status :: Lens' CollectionDetail (Maybe CollectionStatus) Source #

The current status of the collection.

collectionDetail_type :: Lens' CollectionDetail (Maybe CollectionType) Source #

The type of collection.