Network.AWS.CloudDirectory.UpgradeAppliedSchema

Upgrades a single directory in-place using the PublishedSchemaArn with schema updates found in MinorVersion . Backwards-compatible minor version upgrades are instantaneously available for readers on all objects in the directory. Note: This is a synchronous API call and upgrades only one schema on a given directory per call. To upgrade multiple directories from one schema, you would need to call this API on each directory.

Creating a Request

upgradeAppliedSchema

Arguments

:: Text

uasPublishedSchemaARN

-> Text

uasDirectoryARN

-> UpgradeAppliedSchema

Creates a value of UpgradeAppliedSchema with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• uasDryRun - Used for testing whether the major version schemas are backward compatible or not. If schema compatibility fails, an exception would be thrown else the call would succeed but no changes will be saved. This parameter is optional.
• uasPublishedSchemaARN - The revision of the published schema to upgrade the directory to.
• uasDirectoryARN - The ARN for the directory to which the upgraded schema will be applied.

data UpgradeAppliedSchema

See: upgradeAppliedSchema smart constructor.

Instances

Eq UpgradeAppliedSchema

Methods

(==) :: UpgradeAppliedSchema -> UpgradeAppliedSchema -> Bool

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

Data UpgradeAppliedSchema

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpgradeAppliedSchema -> c UpgradeAppliedSchema

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpgradeAppliedSchema

toConstr :: UpgradeAppliedSchema -> Constr

dataTypeOf :: UpgradeAppliedSchema -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpgradeAppliedSchema)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpgradeAppliedSchema)

gmapT :: (forall b. Data b => b -> b) -> UpgradeAppliedSchema -> UpgradeAppliedSchema

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpgradeAppliedSchema -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpgradeAppliedSchema -> r

gmapQ :: (forall d. Data d => d -> u) -> UpgradeAppliedSchema -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpgradeAppliedSchema -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpgradeAppliedSchema -> m UpgradeAppliedSchema

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpgradeAppliedSchema -> m UpgradeAppliedSchema

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpgradeAppliedSchema -> m UpgradeAppliedSchema

Read UpgradeAppliedSchema

Methods

readsPrec :: Int -> ReadS UpgradeAppliedSchema

readList :: ReadS [UpgradeAppliedSchema]

readPrec :: ReadPrec UpgradeAppliedSchema

readListPrec :: ReadPrec [UpgradeAppliedSchema]

Show UpgradeAppliedSchema

Methods

showsPrec :: Int -> UpgradeAppliedSchema -> ShowS

show :: UpgradeAppliedSchema -> String

showList :: [UpgradeAppliedSchema] -> ShowS

Generic UpgradeAppliedSchema

Associated Types

type Rep UpgradeAppliedSchema :: * -> *

Methods

from :: UpgradeAppliedSchema -> Rep UpgradeAppliedSchema x

to :: Rep UpgradeAppliedSchema x -> UpgradeAppliedSchema

Hashable UpgradeAppliedSchema

Methods

hashWithSalt :: Int -> UpgradeAppliedSchema -> Int

hash :: UpgradeAppliedSchema -> Int

ToJSON UpgradeAppliedSchema

Methods

toJSON :: UpgradeAppliedSchema -> Value

toEncoding :: UpgradeAppliedSchema -> Encoding

toJSONList :: [UpgradeAppliedSchema] -> Value

toEncodingList :: [UpgradeAppliedSchema] -> Encoding

NFData UpgradeAppliedSchema

Methods

rnf :: UpgradeAppliedSchema -> ()

AWSRequest UpgradeAppliedSchema

Associated Types

type Rs UpgradeAppliedSchema :: *

Methods

request :: UpgradeAppliedSchema -> Request UpgradeAppliedSchema

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * UpgradeAppliedSchema -> ClientResponse -> m (Response UpgradeAppliedSchema)

ToHeaders UpgradeAppliedSchema

Methods

toHeaders :: UpgradeAppliedSchema -> [Header]

ToPath UpgradeAppliedSchema

Methods

toPath :: UpgradeAppliedSchema -> ByteString

ToQuery UpgradeAppliedSchema

Methods

toQuery :: UpgradeAppliedSchema -> QueryString

type Rep UpgradeAppliedSchema

type Rep UpgradeAppliedSchema = D1 * (MetaData "UpgradeAppliedSchema" "Network.AWS.CloudDirectory.UpgradeAppliedSchema" "amazonka-clouddirectory-1.6.0-8IFjLCYNMx175Dinq6Lqlq" False) (C1 * (MetaCons "UpgradeAppliedSchema'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_uasDryRun") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) ((:*:) * (S1 * (MetaSel (Just Symbol "_uasPublishedSchemaARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_uasDirectoryARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))

type Rs UpgradeAppliedSchema

type Rs UpgradeAppliedSchema = UpgradeAppliedSchemaResponse

Request Lenses

uasDryRun :: Lens' UpgradeAppliedSchema (Maybe Bool)

Used for testing whether the major version schemas are backward compatible or not. If schema compatibility fails, an exception would be thrown else the call would succeed but no changes will be saved. This parameter is optional.

uasPublishedSchemaARN :: Lens' UpgradeAppliedSchema Text

The revision of the published schema to upgrade the directory to.

uasDirectoryARN :: Lens' UpgradeAppliedSchema Text

The ARN for the directory to which the upgraded schema will be applied.

Destructuring the Response

upgradeAppliedSchemaResponse

Arguments

:: Int

uasrsResponseStatus

-> UpgradeAppliedSchemaResponse

Creates a value of UpgradeAppliedSchemaResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• uasrsDirectoryARN - The ARN of the directory that is returned as part of the response.
• uasrsUpgradedSchemaARN - The ARN of the upgraded schema that is returned as part of the response.
• uasrsResponseStatus - -- | The response status code.

data UpgradeAppliedSchemaResponse

See: upgradeAppliedSchemaResponse smart constructor.

Instances

Eq UpgradeAppliedSchemaResponse

Methods

(==) :: UpgradeAppliedSchemaResponse -> UpgradeAppliedSchemaResponse -> Bool

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

Data UpgradeAppliedSchemaResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpgradeAppliedSchemaResponse -> c UpgradeAppliedSchemaResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpgradeAppliedSchemaResponse

toConstr :: UpgradeAppliedSchemaResponse -> Constr

dataTypeOf :: UpgradeAppliedSchemaResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpgradeAppliedSchemaResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpgradeAppliedSchemaResponse)

gmapT :: (forall b. Data b => b -> b) -> UpgradeAppliedSchemaResponse -> UpgradeAppliedSchemaResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpgradeAppliedSchemaResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpgradeAppliedSchemaResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> UpgradeAppliedSchemaResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpgradeAppliedSchemaResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpgradeAppliedSchemaResponse -> m UpgradeAppliedSchemaResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpgradeAppliedSchemaResponse -> m UpgradeAppliedSchemaResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpgradeAppliedSchemaResponse -> m UpgradeAppliedSchemaResponse

Read UpgradeAppliedSchemaResponse

Methods

readsPrec :: Int -> ReadS UpgradeAppliedSchemaResponse

readList :: ReadS [UpgradeAppliedSchemaResponse]

readPrec :: ReadPrec UpgradeAppliedSchemaResponse

readListPrec :: ReadPrec [UpgradeAppliedSchemaResponse]

Show UpgradeAppliedSchemaResponse

Methods

showsPrec :: Int -> UpgradeAppliedSchemaResponse -> ShowS

show :: UpgradeAppliedSchemaResponse -> String

showList :: [UpgradeAppliedSchemaResponse] -> ShowS

Generic UpgradeAppliedSchemaResponse

Associated Types

type Rep UpgradeAppliedSchemaResponse :: * -> *

Methods

from :: UpgradeAppliedSchemaResponse -> Rep UpgradeAppliedSchemaResponse x

to :: Rep UpgradeAppliedSchemaResponse x -> UpgradeAppliedSchemaResponse

NFData UpgradeAppliedSchemaResponse

Methods

rnf :: UpgradeAppliedSchemaResponse -> ()

type Rep UpgradeAppliedSchemaResponse

type Rep UpgradeAppliedSchemaResponse = D1 * (MetaData "UpgradeAppliedSchemaResponse" "Network.AWS.CloudDirectory.UpgradeAppliedSchema" "amazonka-clouddirectory-1.6.0-8IFjLCYNMx175Dinq6Lqlq" False) (C1 * (MetaCons "UpgradeAppliedSchemaResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_uasrsDirectoryARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_uasrsUpgradedSchemaARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_uasrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

uasrsDirectoryARN :: Lens' UpgradeAppliedSchemaResponse (Maybe Text)

The ARN of the directory that is returned as part of the response.

uasrsUpgradedSchemaARN :: Lens' UpgradeAppliedSchemaResponse (Maybe Text)

The ARN of the upgraded schema that is returned as part of the response.

uasrsResponseStatus :: Lens' UpgradeAppliedSchemaResponse Int

• - | The response status code.