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.CloudDirectory.UpgradePublishedSchema

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

data UpgradePublishedSchema = UpgradePublishedSchema' {
- dryRun :: Maybe Bool
- developmentSchemaArn :: Text
- publishedSchemaArn :: Text
- minorVersion :: Text
}
newUpgradePublishedSchema :: Text -> Text -> Text -> UpgradePublishedSchema
upgradePublishedSchema_dryRun :: Lens' UpgradePublishedSchema (Maybe Bool)
upgradePublishedSchema_developmentSchemaArn :: Lens' UpgradePublishedSchema Text
upgradePublishedSchema_publishedSchemaArn :: Lens' UpgradePublishedSchema Text
upgradePublishedSchema_minorVersion :: Lens' UpgradePublishedSchema Text
data UpgradePublishedSchemaResponse = UpgradePublishedSchemaResponse' {
- upgradedSchemaArn :: Maybe Text
- httpStatus :: Int
}
newUpgradePublishedSchemaResponse :: Int -> UpgradePublishedSchemaResponse
upgradePublishedSchemaResponse_upgradedSchemaArn :: Lens' UpgradePublishedSchemaResponse (Maybe Text)
upgradePublishedSchemaResponse_httpStatus :: Lens' UpgradePublishedSchemaResponse Int

Creating a Request

data UpgradePublishedSchema Source #

See: newUpgradePublishedSchema smart constructor.

Constructors

UpgradePublishedSchema'

Fields

dryRun :: 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.
developmentSchemaArn :: Text
The ARN of the development schema with the changes used for the upgrade.
publishedSchemaArn :: Text
The ARN of the published schema to be upgraded.
minorVersion :: Text
Identifies the minor version of the published schema that will be created. This parameter is NOT optional.

Instances

Instances details

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

newUpgradePublishedSchema Source #

Arguments

:: Text	`$sel:developmentSchemaArn:UpgradePublishedSchema'`
-> Text	`$sel:publishedSchemaArn:UpgradePublishedSchema'`
-> Text	`$sel:minorVersion:UpgradePublishedSchema'`
-> UpgradePublishedSchema

Create a value of UpgradePublishedSchema 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:dryRun:UpgradePublishedSchema', upgradePublishedSchema_dryRun - 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.

$sel:developmentSchemaArn:UpgradePublishedSchema', upgradePublishedSchema_developmentSchemaArn - The ARN of the development schema with the changes used for the upgrade.

$sel:publishedSchemaArn:UpgradePublishedSchema', upgradePublishedSchema_publishedSchemaArn - The ARN of the published schema to be upgraded.

$sel:minorVersion:UpgradePublishedSchema', upgradePublishedSchema_minorVersion - Identifies the minor version of the published schema that will be created. This parameter is NOT optional.

Request Lenses

upgradePublishedSchema_dryRun :: Lens' UpgradePublishedSchema (Maybe Bool) Source #

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.

upgradePublishedSchema_developmentSchemaArn :: Lens' UpgradePublishedSchema Text Source #

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

upgradePublishedSchema_publishedSchemaArn :: Lens' UpgradePublishedSchema Text Source #

The ARN of the published schema to be upgraded.

upgradePublishedSchema_minorVersion :: Lens' UpgradePublishedSchema Text Source #

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

Destructuring the Response

data UpgradePublishedSchemaResponse Source #

See: newUpgradePublishedSchemaResponse smart constructor.

Constructors

UpgradePublishedSchemaResponse'
Fields upgradedSchemaArn :: Maybe Text The ARN of the upgraded schema that is returned as part of the response. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpgradePublishedSchemaResponse Source #
Instance details Defined in Amazonka.CloudDirectory.UpgradePublishedSchema Associated Types type Rep UpgradePublishedSchemaResponse :: Type -> Type # Methods from :: UpgradePublishedSchemaResponse -> Rep UpgradePublishedSchemaResponse x # to :: Rep UpgradePublishedSchemaResponse x -> UpgradePublishedSchemaResponse #
Read UpgradePublishedSchemaResponse Source #
Instance details Defined in Amazonka.CloudDirectory.UpgradePublishedSchema Methods readsPrec :: Int -> ReadS UpgradePublishedSchemaResponse # readList :: ReadS [UpgradePublishedSchemaResponse] # readPrec :: ReadPrec UpgradePublishedSchemaResponse # readListPrec :: ReadPrec [UpgradePublishedSchemaResponse] #
Show UpgradePublishedSchemaResponse Source #
Instance details Defined in Amazonka.CloudDirectory.UpgradePublishedSchema Methods showsPrec :: Int -> UpgradePublishedSchemaResponse -> ShowS # show :: UpgradePublishedSchemaResponse -> String # showList :: [UpgradePublishedSchemaResponse] -> ShowS #
NFData UpgradePublishedSchemaResponse Source #
Instance details Defined in Amazonka.CloudDirectory.UpgradePublishedSchema Methods rnf :: UpgradePublishedSchemaResponse -> () #
Eq UpgradePublishedSchemaResponse Source #
Instance details Defined in Amazonka.CloudDirectory.UpgradePublishedSchema Methods (==) :: UpgradePublishedSchemaResponse -> UpgradePublishedSchemaResponse -> Bool # (/=) :: UpgradePublishedSchemaResponse -> UpgradePublishedSchemaResponse -> Bool #
type Rep UpgradePublishedSchemaResponse Source #
Instance details Defined in Amazonka.CloudDirectory.UpgradePublishedSchema type Rep UpgradePublishedSchemaResponse = D1 ('MetaData "UpgradePublishedSchemaResponse" "Amazonka.CloudDirectory.UpgradePublishedSchema" "amazonka-clouddirectory-2.0-JYRSwrX5Vm289hhbSwe2zQ" 'False) (C1 ('MetaCons "UpgradePublishedSchemaResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "upgradedSchemaArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpgradePublishedSchemaResponse Source #

Arguments

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

Create a value of UpgradePublishedSchemaResponse 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:upgradedSchemaArn:UpgradePublishedSchemaResponse', upgradePublishedSchemaResponse_upgradedSchemaArn - The ARN of the upgraded schema that is returned as part of the response.

$sel:httpStatus:UpgradePublishedSchemaResponse', upgradePublishedSchemaResponse_httpStatus - The response's http status code.

Response Lenses

upgradePublishedSchemaResponse_upgradedSchemaArn :: Lens' UpgradePublishedSchemaResponse (Maybe Text) Source #

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

upgradePublishedSchemaResponse_httpStatus :: Lens' UpgradePublishedSchemaResponse Int Source #

The response's http status code.