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.ResourceExplorer2.GetIndex

Contents

Creating a Request
Destructuring the Response
Response Lenses

Description

Retrieves details about the Amazon Web Services Resource Explorer index in the Amazon Web Services Region in which you invoked the operation.

Synopsis

data GetIndex = GetIndex' {
}
newGetIndex :: GetIndex
data GetIndexResponse = GetIndexResponse' {
- arn :: Maybe Text
- createdAt :: Maybe ISO8601
- lastUpdatedAt :: Maybe ISO8601
- replicatingFrom :: Maybe [Text]
- replicatingTo :: Maybe [Text]
- state :: Maybe IndexState
- tags :: Maybe (HashMap Text Text)
- type' :: Maybe IndexType
- httpStatus :: Int
}
newGetIndexResponse :: Int -> GetIndexResponse
getIndexResponse_arn :: Lens' GetIndexResponse (Maybe Text)
getIndexResponse_createdAt :: Lens' GetIndexResponse (Maybe UTCTime)
getIndexResponse_lastUpdatedAt :: Lens' GetIndexResponse (Maybe UTCTime)
getIndexResponse_replicatingFrom :: Lens' GetIndexResponse (Maybe [Text])
getIndexResponse_replicatingTo :: Lens' GetIndexResponse (Maybe [Text])
getIndexResponse_state :: Lens' GetIndexResponse (Maybe IndexState)
getIndexResponse_tags :: Lens' GetIndexResponse (Maybe (HashMap Text Text))
getIndexResponse_type :: Lens' GetIndexResponse (Maybe IndexType)
getIndexResponse_httpStatus :: Lens' GetIndexResponse Int

Creating a Request

data GetIndex Source #

See: newGetIndex smart constructor.

Constructors

GetIndex'

Instances

Instances details

ToJSON GetIndex Source #
Instance details Defined in Amazonka.ResourceExplorer2.GetIndex Methods toJSON :: GetIndex -> Value # toEncoding :: GetIndex -> Encoding # toJSONList :: [GetIndex] -> Value # toEncodingList :: [GetIndex] -> Encoding #
ToHeaders GetIndex Source #
Instance details Defined in Amazonka.ResourceExplorer2.GetIndex Methods toHeaders :: GetIndex -> [Header] #
ToPath GetIndex Source #
Instance details Defined in Amazonka.ResourceExplorer2.GetIndex Methods toPath :: GetIndex -> ByteString #
ToQuery GetIndex Source #
Instance details Defined in Amazonka.ResourceExplorer2.GetIndex Methods toQuery :: GetIndex -> QueryString #
AWSRequest GetIndex Source #
Instance details Defined in Amazonka.ResourceExplorer2.GetIndex Associated Types type AWSResponse GetIndex # Methods request :: (Service -> Service) -> GetIndex -> Request GetIndex # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetIndex -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetIndex))) #
Generic GetIndex Source #
Instance details Defined in Amazonka.ResourceExplorer2.GetIndex Associated Types type Rep GetIndex :: Type -> Type # Methods from :: GetIndex -> Rep GetIndex x # to :: Rep GetIndex x -> GetIndex #
Read GetIndex Source #
Instance details Defined in Amazonka.ResourceExplorer2.GetIndex Methods readsPrec :: Int -> ReadS GetIndex # readList :: ReadS [GetIndex] # readPrec :: ReadPrec GetIndex # readListPrec :: ReadPrec [GetIndex] #
Show GetIndex Source #
Instance details Defined in Amazonka.ResourceExplorer2.GetIndex Methods showsPrec :: Int -> GetIndex -> ShowS # show :: GetIndex -> String # showList :: [GetIndex] -> ShowS #
NFData GetIndex Source #
Instance details Defined in Amazonka.ResourceExplorer2.GetIndex Methods rnf :: GetIndex -> () #
Eq GetIndex Source #
Instance details Defined in Amazonka.ResourceExplorer2.GetIndex Methods (==) :: GetIndex -> GetIndex -> Bool # (/=) :: GetIndex -> GetIndex -> Bool #
Hashable GetIndex Source #
Instance details Defined in Amazonka.ResourceExplorer2.GetIndex Methods hashWithSalt :: Int -> GetIndex -> Int # hash :: GetIndex -> Int #
type AWSResponse GetIndex Source #
Instance details Defined in Amazonka.ResourceExplorer2.GetIndex type AWSResponse GetIndex = GetIndexResponse
type Rep GetIndex Source #
Instance details Defined in Amazonka.ResourceExplorer2.GetIndex type Rep GetIndex = D1 ('MetaData "GetIndex" "Amazonka.ResourceExplorer2.GetIndex" "amazonka-resource-explorer-v2-2.0-DYDynTzMYCcKX3QLWjH6Yt" 'False) (C1 ('MetaCons "GetIndex'" 'PrefixI 'False) (U1 :: Type -> Type))

newGetIndex :: GetIndex Source #

Create a value of GetIndex with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

Destructuring the Response

data GetIndexResponse Source #

See: newGetIndexResponse smart constructor.

Constructors

GetIndexResponse'

Fields

arn :: Maybe Text
The Amazon resource name (ARN) of the index.
createdAt :: Maybe ISO8601
The date and time when the index was originally created.
lastUpdatedAt :: Maybe ISO8601
The date and time when the index was last updated.
replicatingFrom :: Maybe [Text]
This response value is present only if this index is Type=AGGREGATOR.
A list of the Amazon Web Services Regions that replicate their content to the index in this Region.
replicatingTo :: Maybe [Text]
This response value is present only if this index is Type=LOCAL.
The Amazon Web Services Region that contains the aggregator index, if one exists. If an aggregator index does exist then the Region in which you called this operation replicates its index information to the Region specified in this response value.
state :: Maybe IndexState
The current state of the index in this Amazon Web Services Region.
tags :: Maybe (HashMap Text Text)
Tag key and value pairs that are attached to the index.
type' :: Maybe IndexType
The type of the index in this Region. For information about the aggregator index and how it differs from a local index, see Turning on cross-Region search by creating an aggregator index.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetIndexResponse Source #
Instance details Defined in Amazonka.ResourceExplorer2.GetIndex Associated Types type Rep GetIndexResponse :: Type -> Type # Methods from :: GetIndexResponse -> Rep GetIndexResponse x # to :: Rep GetIndexResponse x -> GetIndexResponse #
Read GetIndexResponse Source #
Instance details Defined in Amazonka.ResourceExplorer2.GetIndex Methods readsPrec :: Int -> ReadS GetIndexResponse # readList :: ReadS [GetIndexResponse] # readPrec :: ReadPrec GetIndexResponse # readListPrec :: ReadPrec [GetIndexResponse] #
Show GetIndexResponse Source #
Instance details Defined in Amazonka.ResourceExplorer2.GetIndex Methods showsPrec :: Int -> GetIndexResponse -> ShowS # show :: GetIndexResponse -> String # showList :: [GetIndexResponse] -> ShowS #
NFData GetIndexResponse Source #
Instance details Defined in Amazonka.ResourceExplorer2.GetIndex Methods rnf :: GetIndexResponse -> () #
Eq GetIndexResponse Source #
Instance details Defined in Amazonka.ResourceExplorer2.GetIndex Methods (==) :: GetIndexResponse -> GetIndexResponse -> Bool # (/=) :: GetIndexResponse -> GetIndexResponse -> Bool #
type Rep GetIndexResponse Source #
Instance details Defined in Amazonka.ResourceExplorer2.GetIndex type Rep GetIndexResponse = D1 ('MetaData "GetIndexResponse" "Amazonka.ResourceExplorer2.GetIndex" "amazonka-resource-explorer-v2-2.0-DYDynTzMYCcKX3QLWjH6Yt" 'False) (C1 ('MetaCons "GetIndexResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :: (S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "replicatingFrom") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: ((S1 ('MetaSel ('Just "replicatingTo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IndexState))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IndexType)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newGetIndexResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetIndexResponse'`
-> GetIndexResponse

Create a value of GetIndexResponse 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:

GetIndexResponse, getIndexResponse_arn - The Amazon resource name (ARN) of the index.

$sel:createdAt:GetIndexResponse', getIndexResponse_createdAt - The date and time when the index was originally created.

GetIndexResponse, getIndexResponse_lastUpdatedAt - The date and time when the index was last updated.

$sel:replicatingFrom:GetIndexResponse', getIndexResponse_replicatingFrom - This response value is present only if this index is Type=AGGREGATOR.

A list of the Amazon Web Services Regions that replicate their content to the index in this Region.

$sel:replicatingTo:GetIndexResponse', getIndexResponse_replicatingTo - This response value is present only if this index is Type=LOCAL.

The Amazon Web Services Region that contains the aggregator index, if one exists. If an aggregator index does exist then the Region in which you called this operation replicates its index information to the Region specified in this response value.

$sel:state:GetIndexResponse', getIndexResponse_state - The current state of the index in this Amazon Web Services Region.

$sel:tags:GetIndexResponse', getIndexResponse_tags - Tag key and value pairs that are attached to the index.

GetIndexResponse, getIndexResponse_type - The type of the index in this Region. For information about the aggregator index and how it differs from a local index, see Turning on cross-Region search by creating an aggregator index.

$sel:httpStatus:GetIndexResponse', getIndexResponse_httpStatus - The response's http status code.

Response Lenses

getIndexResponse_arn :: Lens' GetIndexResponse (Maybe Text) Source #

The Amazon resource name (ARN) of the index.

getIndexResponse_createdAt :: Lens' GetIndexResponse (Maybe UTCTime) Source #

The date and time when the index was originally created.

getIndexResponse_lastUpdatedAt :: Lens' GetIndexResponse (Maybe UTCTime) Source #

The date and time when the index was last updated.

getIndexResponse_replicatingFrom :: Lens' GetIndexResponse (Maybe [Text]) Source #

This response value is present only if this index is Type=AGGREGATOR.

A list of the Amazon Web Services Regions that replicate their content to the index in this Region.

getIndexResponse_replicatingTo :: Lens' GetIndexResponse (Maybe [Text]) Source #

This response value is present only if this index is Type=LOCAL.

The Amazon Web Services Region that contains the aggregator index, if one exists. If an aggregator index does exist then the Region in which you called this operation replicates its index information to the Region specified in this response value.

getIndexResponse_state :: Lens' GetIndexResponse (Maybe IndexState) Source #

The current state of the index in this Amazon Web Services Region.

getIndexResponse_tags :: Lens' GetIndexResponse (Maybe (HashMap Text Text)) Source #

Tag key and value pairs that are attached to the index.

getIndexResponse_type :: Lens' GetIndexResponse (Maybe IndexType) Source #

The type of the index in this Region. For information about the aggregator index and how it differs from a local index, see Turning on cross-Region search by creating an aggregator index.

getIndexResponse_httpStatus :: Lens' GetIndexResponse Int Source #

The response's http status code.