Network.AWS.CloudDirectory.UpgradePublishedSchema

Upgrades a published schema under a new minor version revision using the current contents of DevelopmentSchemaArn .

Creating a Request

upgradePublishedSchema

Arguments

:: Text

upsDevelopmentSchemaARN

-> Text

upsPublishedSchemaARN

-> Text

upsMinorVersion

-> UpgradePublishedSchema

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

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

• upsDryRun - Used for testing whether the Development schema provided is backwards compatible, or not, with the publish schema provided by the user to be upgraded. If schema compatibility fails, an exception would be thrown else the call would succeed. This parameter is optional and defaults to false.
• upsDevelopmentSchemaARN - The ARN of the development schema with the changes used for the upgrade.
• upsPublishedSchemaARN - The ARN of the published schema to be upgraded.
• upsMinorVersion - Identifies the minor version of the published schema that will be created. This parameter is NOT optional.

data UpgradePublishedSchema

See: upgradePublishedSchema smart constructor.

Instances

Eq UpgradePublishedSchema

Methods

(==) :: UpgradePublishedSchema -> UpgradePublishedSchema -> Bool

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

Data UpgradePublishedSchema

Methods

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

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

toConstr :: UpgradePublishedSchema -> Constr

dataTypeOf :: UpgradePublishedSchema -> DataType

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

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

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

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

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

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

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

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

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

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

Read UpgradePublishedSchema

Methods

readsPrec :: Int -> ReadS UpgradePublishedSchema

readList :: ReadS [UpgradePublishedSchema]

readPrec :: ReadPrec UpgradePublishedSchema

readListPrec :: ReadPrec [UpgradePublishedSchema]

Show UpgradePublishedSchema

Methods

showsPrec :: Int -> UpgradePublishedSchema -> ShowS

show :: UpgradePublishedSchema -> String

showList :: [UpgradePublishedSchema] -> ShowS

Generic UpgradePublishedSchema

Associated Types

type Rep UpgradePublishedSchema :: * -> *

Methods

from :: UpgradePublishedSchema -> Rep UpgradePublishedSchema x

to :: Rep UpgradePublishedSchema x -> UpgradePublishedSchema

Hashable UpgradePublishedSchema

Methods

hashWithSalt :: Int -> UpgradePublishedSchema -> Int

hash :: UpgradePublishedSchema -> Int

ToJSON UpgradePublishedSchema

Methods

toJSON :: UpgradePublishedSchema -> Value

toEncoding :: UpgradePublishedSchema -> Encoding

toJSONList :: [UpgradePublishedSchema] -> Value

toEncodingList :: [UpgradePublishedSchema] -> Encoding

NFData UpgradePublishedSchema

Methods

rnf :: UpgradePublishedSchema -> ()

AWSRequest UpgradePublishedSchema

Associated Types

type Rs UpgradePublishedSchema :: *

Methods

request :: UpgradePublishedSchema -> Request UpgradePublishedSchema

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

ToHeaders UpgradePublishedSchema

Methods

toHeaders :: UpgradePublishedSchema -> [Header]

ToPath UpgradePublishedSchema

Methods

toPath :: UpgradePublishedSchema -> ByteString

ToQuery UpgradePublishedSchema

Methods

toQuery :: UpgradePublishedSchema -> QueryString

type Rep UpgradePublishedSchema

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

type Rs UpgradePublishedSchema

type Rs UpgradePublishedSchema = UpgradePublishedSchemaResponse

Request Lenses

upsDryRun :: Lens' UpgradePublishedSchema (Maybe Bool)

Used for testing whether the Development schema provided is backwards compatible, or not, with the publish schema provided by the user to be upgraded. If schema compatibility fails, an exception would be thrown else the call would succeed. This parameter is optional and defaults to false.

upsDevelopmentSchemaARN :: Lens' UpgradePublishedSchema Text

The ARN of the development schema with the changes used for the upgrade.

upsPublishedSchemaARN :: Lens' UpgradePublishedSchema Text

The ARN of the published schema to be upgraded.

upsMinorVersion :: Lens' UpgradePublishedSchema Text

Identifies the minor version of the published schema that will be created. This parameter is NOT optional.

Destructuring the Response

upgradePublishedSchemaResponse

Arguments

:: Int

upsrsResponseStatus

-> UpgradePublishedSchemaResponse

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

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

• upsrsUpgradedSchemaARN - The ARN of the upgraded schema that is returned as part of the response.
• upsrsResponseStatus - -- | The response status code.

data UpgradePublishedSchemaResponse

See: upgradePublishedSchemaResponse smart constructor.

Instances

Eq UpgradePublishedSchemaResponse

Methods

(==) :: UpgradePublishedSchemaResponse -> UpgradePublishedSchemaResponse -> Bool

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

Data UpgradePublishedSchemaResponse

Methods

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

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

toConstr :: UpgradePublishedSchemaResponse -> Constr

dataTypeOf :: UpgradePublishedSchemaResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read UpgradePublishedSchemaResponse

Methods

readsPrec :: Int -> ReadS UpgradePublishedSchemaResponse

readList :: ReadS [UpgradePublishedSchemaResponse]

readPrec :: ReadPrec UpgradePublishedSchemaResponse

readListPrec :: ReadPrec [UpgradePublishedSchemaResponse]

Show UpgradePublishedSchemaResponse

Methods

showsPrec :: Int -> UpgradePublishedSchemaResponse -> ShowS

show :: UpgradePublishedSchemaResponse -> String

showList :: [UpgradePublishedSchemaResponse] -> ShowS

Generic UpgradePublishedSchemaResponse

Associated Types

type Rep UpgradePublishedSchemaResponse :: * -> *

Methods

from :: UpgradePublishedSchemaResponse -> Rep UpgradePublishedSchemaResponse x

to :: Rep UpgradePublishedSchemaResponse x -> UpgradePublishedSchemaResponse

NFData UpgradePublishedSchemaResponse

Methods

rnf :: UpgradePublishedSchemaResponse -> ()

type Rep UpgradePublishedSchemaResponse

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

Response Lenses

upsrsUpgradedSchemaARN :: Lens' UpgradePublishedSchemaResponse (Maybe Text)

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

upsrsResponseStatus :: Lens' UpgradePublishedSchemaResponse Int

• - | The response status code.