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.UpdateIndexType

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Changes the type of the index from one of the following types to the other. For more information about indexes and the role they perform in Amazon Web Services Resource Explorer, see Turning on cross-Region search by creating an aggregator index in the Amazon Web Services Resource Explorer User Guide.

AGGREGATOR index type
The index contains information about resources from all Amazon Web Services Regions in the Amazon Web Services account in which you've created a Resource Explorer index. Resource information from all other Regions is replicated to this Region's index.
When you change the index type to AGGREGATOR, Resource Explorer turns on replication of all discovered resource information from the other Amazon Web Services Regions in your account to this index. You can then, from this Region only, perform resource search queries that span all Amazon Web Services Regions in the Amazon Web Services account. Turning on replication from all other Regions is performed by asynchronous background tasks. You can check the status of the asynchronous tasks by using the GetIndex operation. When the asynchronous tasks complete, the Status response of that operation changes from UPDATING to ACTIVE. After that, you can start to see results from other Amazon Web Services Regions in query results. However, it can take several hours for replication from all other Regions to complete.
You can have only one aggregator index per Amazon Web Services account. Before you can promote a different index to be the aggregator index for the account, you must first demote the existing aggregator index to type LOCAL.
LOCAL index type
The index contains information about resources in only the Amazon Web Services Region in which the index exists. If an aggregator index in another Region exists, then information in this local index is replicated to the aggregator index.
When you change the index type to LOCAL, Resource Explorer turns off the replication of resource information from all other Amazon Web Services Regions in the Amazon Web Services account to this Region. The aggregator index remains in the UPDATING state until all replication with other Regions successfully stops. You can check the status of the asynchronous task by using the GetIndex operation. When Resource Explorer successfully stops all replication with other Regions, the Status response of that operation changes from UPDATING to ACTIVE. Separately, the resource information from other Regions that was previously stored in the index is deleted within 30 days by another background task. Until that asynchronous task completes, some results from other Regions can continue to appear in search results.
After you demote an aggregator index to a local index, you must wait 24 hours before you can promote another index to be the new aggregator index for the account.

Synopsis

data UpdateIndexType = UpdateIndexType' {
- arn :: Text
- type' :: IndexType
}
newUpdateIndexType :: Text -> IndexType -> UpdateIndexType
updateIndexType_arn :: Lens' UpdateIndexType Text
updateIndexType_type :: Lens' UpdateIndexType IndexType
data UpdateIndexTypeResponse = UpdateIndexTypeResponse' {
- arn :: Maybe Text
- lastUpdatedAt :: Maybe ISO8601
- state :: Maybe IndexState
- type' :: Maybe IndexType
- httpStatus :: Int
}
newUpdateIndexTypeResponse :: Int -> UpdateIndexTypeResponse
updateIndexTypeResponse_arn :: Lens' UpdateIndexTypeResponse (Maybe Text)
updateIndexTypeResponse_lastUpdatedAt :: Lens' UpdateIndexTypeResponse (Maybe UTCTime)
updateIndexTypeResponse_state :: Lens' UpdateIndexTypeResponse (Maybe IndexState)
updateIndexTypeResponse_type :: Lens' UpdateIndexTypeResponse (Maybe IndexType)
updateIndexTypeResponse_httpStatus :: Lens' UpdateIndexTypeResponse Int

Creating a Request

data UpdateIndexType Source #

See: newUpdateIndexType smart constructor.

Constructors

UpdateIndexType'
Fields arn :: Text The Amazon resource name (ARN) of the index that you want to update. type' :: IndexType The type of the index. To understand the difference between `LOCAL` and `AGGREGATOR`, see Turning on cross-Region search in the Amazon Web Services Resource Explorer User Guide.

Instances

Instances details

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

newUpdateIndexType Source #

Arguments

:: Text	`UpdateIndexType`
-> IndexType	`UpdateIndexType`
-> UpdateIndexType

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

UpdateIndexType, updateIndexType_arn - The Amazon resource name (ARN) of the index that you want to update.

UpdateIndexType, updateIndexType_type - The type of the index. To understand the difference between LOCAL and AGGREGATOR, see Turning on cross-Region search in the Amazon Web Services Resource Explorer User Guide.

Request Lenses

updateIndexType_arn :: Lens' UpdateIndexType Text Source #

The Amazon resource name (ARN) of the index that you want to update.

updateIndexType_type :: Lens' UpdateIndexType IndexType Source #

The type of the index. To understand the difference between LOCAL and AGGREGATOR, see Turning on cross-Region search in the Amazon Web Services Resource Explorer User Guide.

Destructuring the Response

data UpdateIndexTypeResponse Source #

See: newUpdateIndexTypeResponse smart constructor.

Constructors

UpdateIndexTypeResponse'

Fields

arn :: Maybe Text
The Amazon resource name (ARN) of the index that you updated.
lastUpdatedAt :: Maybe ISO8601
The date and timestamp when the index was last updated.
state :: Maybe IndexState
Indicates the state of the request to update the index. This operation is asynchronous. Call the GetIndex operation to check for changes.
type' :: Maybe IndexType
Specifies the type of the specified index after the operation completes.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newUpdateIndexTypeResponse Source #

Arguments

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

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

UpdateIndexType, updateIndexTypeResponse_arn - The Amazon resource name (ARN) of the index that you updated.

UpdateIndexTypeResponse, updateIndexTypeResponse_lastUpdatedAt - The date and timestamp when the index was last updated.

$sel:state:UpdateIndexTypeResponse', updateIndexTypeResponse_state - Indicates the state of the request to update the index. This operation is asynchronous. Call the GetIndex operation to check for changes.

UpdateIndexType, updateIndexTypeResponse_type - Specifies the type of the specified index after the operation completes.

$sel:httpStatus:UpdateIndexTypeResponse', updateIndexTypeResponse_httpStatus - The response's http status code.

Response Lenses

updateIndexTypeResponse_arn :: Lens' UpdateIndexTypeResponse (Maybe Text) Source #

The Amazon resource name (ARN) of the index that you updated.

updateIndexTypeResponse_lastUpdatedAt :: Lens' UpdateIndexTypeResponse (Maybe UTCTime) Source #

The date and timestamp when the index was last updated.

updateIndexTypeResponse_state :: Lens' UpdateIndexTypeResponse (Maybe IndexState) Source #

Indicates the state of the request to update the index. This operation is asynchronous. Call the GetIndex operation to check for changes.

updateIndexTypeResponse_type :: Lens' UpdateIndexTypeResponse (Maybe IndexType) Source #

Specifies the type of the specified index after the operation completes.

updateIndexTypeResponse_httpStatus :: Lens' UpdateIndexTypeResponse Int Source #

The response's http status code.