libZSservicesZSamazonka-clouddirectoryZSamazonka-clouddirectory
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CloudDirectory.UpgradeAppliedSchema

Description

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.

Synopsis

Creating a Request

data UpgradeAppliedSchema Source #

See: newUpgradeAppliedSchema smart constructor.

Constructors

UpgradeAppliedSchema' 

Fields

  • dryRun :: 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.

  • publishedSchemaArn :: Text

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

  • directoryArn :: Text

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

Instances

Instances details
Eq UpgradeAppliedSchema Source # 
Instance details

Defined in Amazonka.CloudDirectory.UpgradeAppliedSchema

Methods

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

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

Read UpgradeAppliedSchema Source # 
Instance details

Defined in Amazonka.CloudDirectory.UpgradeAppliedSchema

Methods

readsPrec :: Int -> ReadS UpgradeAppliedSchema #

readList :: ReadS [UpgradeAppliedSchema] #

readPrec :: ReadPrec UpgradeAppliedSchema #

readListPrec :: ReadPrec [UpgradeAppliedSchema] #

Show UpgradeAppliedSchema Source # 
Instance details

Defined in Amazonka.CloudDirectory.UpgradeAppliedSchema

Methods

showsPrec :: Int -> UpgradeAppliedSchema -> ShowS #

show :: UpgradeAppliedSchema -> String #

showList :: [UpgradeAppliedSchema] -> ShowS #

Generic UpgradeAppliedSchema Source # 
Instance details

Defined in Amazonka.CloudDirectory.UpgradeAppliedSchema

Associated Types

type Rep UpgradeAppliedSchema :: Type -> Type #

Methods

from :: UpgradeAppliedSchema -> Rep UpgradeAppliedSchema x #

to :: Rep UpgradeAppliedSchema x -> UpgradeAppliedSchema #

NFData UpgradeAppliedSchema Source # 
Instance details

Defined in Amazonka.CloudDirectory.UpgradeAppliedSchema

Methods

rnf :: UpgradeAppliedSchema -> () #

Hashable UpgradeAppliedSchema Source # 
Instance details

Defined in Amazonka.CloudDirectory.UpgradeAppliedSchema

Methods

hashWithSalt :: Int -> UpgradeAppliedSchema -> Int #

hash :: UpgradeAppliedSchema -> Int #

ToJSON UpgradeAppliedSchema Source # 
Instance details

Defined in Amazonka.CloudDirectory.UpgradeAppliedSchema

Methods

toJSON :: UpgradeAppliedSchema -> Value #

toEncoding :: UpgradeAppliedSchema -> Encoding #

toJSONList :: [UpgradeAppliedSchema] -> Value #

toEncodingList :: [UpgradeAppliedSchema] -> Encoding #

AWSRequest UpgradeAppliedSchema Source # 
Instance details

Defined in Amazonka.CloudDirectory.UpgradeAppliedSchema

Associated Types

type AWSResponse UpgradeAppliedSchema #

Methods

request :: UpgradeAppliedSchema -> Request UpgradeAppliedSchema #

response :: MonadResource m => Logger -> Service -> Proxy UpgradeAppliedSchema -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpgradeAppliedSchema))) #

ToHeaders UpgradeAppliedSchema Source # 
Instance details

Defined in Amazonka.CloudDirectory.UpgradeAppliedSchema

Methods

toHeaders :: UpgradeAppliedSchema -> [Header] #

ToPath UpgradeAppliedSchema Source # 
Instance details

Defined in Amazonka.CloudDirectory.UpgradeAppliedSchema

Methods

toPath :: UpgradeAppliedSchema -> ByteString #

ToQuery UpgradeAppliedSchema Source # 
Instance details

Defined in Amazonka.CloudDirectory.UpgradeAppliedSchema

Methods

toQuery :: UpgradeAppliedSchema -> QueryString #

type Rep UpgradeAppliedSchema Source # 
Instance details

Defined in Amazonka.CloudDirectory.UpgradeAppliedSchema

type Rep UpgradeAppliedSchema = D1 ('MetaData "UpgradeAppliedSchema" "Amazonka.CloudDirectory.UpgradeAppliedSchema" "libZSservicesZSamazonka-clouddirectoryZSamazonka-clouddirectory" 'False) (C1 ('MetaCons "UpgradeAppliedSchema'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "publishedSchemaArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "directoryArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse UpgradeAppliedSchema Source # 
Instance details

Defined in Amazonka.CloudDirectory.UpgradeAppliedSchema

type AWSResponse UpgradeAppliedSchema = UpgradeAppliedSchemaResponse

newUpgradeAppliedSchema Source #

Arguments

:: Text

$sel:publishedSchemaArn:UpgradeAppliedSchema'

-> Text

$sel:directoryArn:UpgradeAppliedSchema'

-> UpgradeAppliedSchema 

Create a value of UpgradeAppliedSchema 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:UpgradeAppliedSchema', upgradeAppliedSchema_dryRun - 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.

$sel:publishedSchemaArn:UpgradeAppliedSchema', upgradeAppliedSchema_publishedSchemaArn - The revision of the published schema to upgrade the directory to.

$sel:directoryArn:UpgradeAppliedSchema', upgradeAppliedSchema_directoryArn - The ARN for the directory to which the upgraded schema will be applied.

Request Lenses

upgradeAppliedSchema_dryRun :: Lens' UpgradeAppliedSchema (Maybe Bool) Source #

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.

upgradeAppliedSchema_publishedSchemaArn :: Lens' UpgradeAppliedSchema Text Source #

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

upgradeAppliedSchema_directoryArn :: Lens' UpgradeAppliedSchema Text Source #

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

Destructuring the Response

data UpgradeAppliedSchemaResponse Source #

See: newUpgradeAppliedSchemaResponse smart constructor.

Constructors

UpgradeAppliedSchemaResponse' 

Fields

Instances

Instances details
Eq UpgradeAppliedSchemaResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.UpgradeAppliedSchema

Methods

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

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

Read UpgradeAppliedSchemaResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.UpgradeAppliedSchema

Methods

readsPrec :: Int -> ReadS UpgradeAppliedSchemaResponse #

readList :: ReadS [UpgradeAppliedSchemaResponse] #

readPrec :: ReadPrec UpgradeAppliedSchemaResponse #

readListPrec :: ReadPrec [UpgradeAppliedSchemaResponse] #

Show UpgradeAppliedSchemaResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.UpgradeAppliedSchema

Methods

showsPrec :: Int -> UpgradeAppliedSchemaResponse -> ShowS #

show :: UpgradeAppliedSchemaResponse -> String #

showList :: [UpgradeAppliedSchemaResponse] -> ShowS #

Generic UpgradeAppliedSchemaResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.UpgradeAppliedSchema

Associated Types

type Rep UpgradeAppliedSchemaResponse :: Type -> Type #

Methods

from :: UpgradeAppliedSchemaResponse -> Rep UpgradeAppliedSchemaResponse x #

to :: Rep UpgradeAppliedSchemaResponse x -> UpgradeAppliedSchemaResponse #

NFData UpgradeAppliedSchemaResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.UpgradeAppliedSchema

Methods

rnf :: UpgradeAppliedSchemaResponse -> () #

type Rep UpgradeAppliedSchemaResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.UpgradeAppliedSchema

type Rep UpgradeAppliedSchemaResponse = D1 ('MetaData "UpgradeAppliedSchemaResponse" "Amazonka.CloudDirectory.UpgradeAppliedSchema" "libZSservicesZSamazonka-clouddirectoryZSamazonka-clouddirectory" 'False) (C1 ('MetaCons "UpgradeAppliedSchemaResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "directoryArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "upgradedSchemaArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newUpgradeAppliedSchemaResponse Source #

Arguments

:: Int

$sel:httpStatus:UpgradeAppliedSchemaResponse'

-> UpgradeAppliedSchemaResponse 

Create a value of UpgradeAppliedSchemaResponse 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:directoryArn:UpgradeAppliedSchema', upgradeAppliedSchemaResponse_directoryArn - The ARN of the directory that is returned as part of the response.

$sel:upgradedSchemaArn:UpgradeAppliedSchemaResponse', upgradeAppliedSchemaResponse_upgradedSchemaArn - The ARN of the upgraded schema that is returned as part of the response.

$sel:httpStatus:UpgradeAppliedSchemaResponse', upgradeAppliedSchemaResponse_httpStatus - The response's http status code.

Response Lenses

upgradeAppliedSchemaResponse_directoryArn :: Lens' UpgradeAppliedSchemaResponse (Maybe Text) Source #

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

upgradeAppliedSchemaResponse_upgradedSchemaArn :: Lens' UpgradeAppliedSchemaResponse (Maybe Text) Source #

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

upgradeAppliedSchemaResponse_httpStatus :: Lens' UpgradeAppliedSchemaResponse Int Source #

The response's http status code.