Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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
- upgradeAppliedSchema :: Text -> Text -> UpgradeAppliedSchema
- data UpgradeAppliedSchema
- uasDryRun :: Lens' UpgradeAppliedSchema (Maybe Bool)
- uasPublishedSchemaARN :: Lens' UpgradeAppliedSchema Text
- uasDirectoryARN :: Lens' UpgradeAppliedSchema Text
- upgradeAppliedSchemaResponse :: Int -> UpgradeAppliedSchemaResponse
- data UpgradeAppliedSchemaResponse
- uasrsDirectoryARN :: Lens' UpgradeAppliedSchemaResponse (Maybe Text)
- uasrsUpgradedSchemaARN :: Lens' UpgradeAppliedSchemaResponse (Maybe Text)
- uasrsResponseStatus :: Lens' UpgradeAppliedSchemaResponse Int
Creating a Request
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 Source #
See: upgradeAppliedSchema
smart constructor.
Instances
Request Lenses
uasDryRun :: 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.
uasPublishedSchemaARN :: Lens' UpgradeAppliedSchema Text Source #
The revision of the published schema to upgrade the directory to.
uasDirectoryARN :: Lens' UpgradeAppliedSchema Text Source #
The ARN for the directory to which the upgraded schema will be applied.
Destructuring the Response
upgradeAppliedSchemaResponse Source #
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 Source #
See: upgradeAppliedSchemaResponse
smart constructor.
Instances
Response Lenses
uasrsDirectoryARN :: Lens' UpgradeAppliedSchemaResponse (Maybe Text) Source #
The ARN of the directory that is returned as part of the response.
uasrsUpgradedSchemaARN :: Lens' UpgradeAppliedSchemaResponse (Maybe Text) Source #
The ARN of the upgraded schema that is returned as part of the response.
uasrsResponseStatus :: Lens' UpgradeAppliedSchemaResponse Int Source #
- - | The response status code.