AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginUpgradeAppliedSchema and EndUpgradeAppliedSchema.

Namespace: Amazon.CloudDirectory
Assembly: AWSSDK.CloudDirectory.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<UpgradeAppliedSchemaResponse> UpgradeAppliedSchemaAsync(
         UpgradeAppliedSchemaRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.CloudDirectory.Model.UpgradeAppliedSchemaRequest

Container for the necessary parameters to execute the UpgradeAppliedSchema service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the UpgradeAppliedSchema service method, as returned by CloudDirectory.

Exceptions

ExceptionCondition
AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
IncompatibleSchemaException Indicates a failure occurred while performing a check for backward compatibility between the specified schema and the schema that is currently applied to the directory.
InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
InvalidArnException Indicates that the provided ARN value is not valid.
InvalidAttachmentException Indicates that an attempt to make an attachment was invalid. For example, attaching two nodes with a link type that is not applicable to the nodes or attempting to apply a schema to a directory a second time.
ResourceNotFoundException The specified resource could not be found.
RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
SchemaAlreadyExistsException Indicates that a schema could not be created due to a naming conflict. Please select a different name and then try again.
ValidationException Indicates that your request is malformed in some manner. See the exception message.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also