upgrade_applied_schema ¶

def upgrade_applied_schema(
    self,
    published_schema_arn: "capo_clouddirectory.types.arn.Arn",
    directory_arn: "capo_clouddirectory.types.arn.Arn",
    *,
    config_overrides: Optional[CloudDirectoryClientConfig] = None,
    dry_run: Optional["capo_clouddirectory.types.bool.Bool"] = None,
) -> "capo_clouddirectory.types.upgrade_applied_schema_response.UpgradeAppliedSchemaResponse":
    """<p>Upgrades a single directory in-place using the <code>PublishedSchemaArn</code> with schema updates found in <code>MinorVersion</code>. 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.</p>

    Args:
        published_schema_arn: <p>The revision of the published schema to upgrade the directory to.</p>
        directory_arn: <p>The ARN for the directory to which the upgraded schema will be applied.</p>
        dry_run: <p>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.</p>

    Raises:
        capo_clouddirectory.errors.access_denied_exception.AccessDeniedException: <p>Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling <a>ListDirectories</a> and check your permissions.</p>
        capo_clouddirectory.errors.incompatible_schema_exception.IncompatibleSchemaException: <p>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.</p>
        capo_clouddirectory.errors.internal_service_exception.InternalServiceException: <p>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 <a href="http://status.aws.amazon.com/">AWS Service Health Dashboard</a> site to see if there are any operational issues with the service.</p>
        capo_clouddirectory.errors.invalid_arn_exception.InvalidArnException: <p>Indicates that the provided ARN value is not valid.</p>
        capo_clouddirectory.errors.invalid_attachment_exception.InvalidAttachmentException: <p>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.</p>
        capo_clouddirectory.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource could not be found.</p>
        capo_clouddirectory.errors.retryable_conflict_exception.RetryableConflictException: <p>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.</p>
        capo_clouddirectory.errors.schema_already_exists_exception.SchemaAlreadyExistsException: <p>Indicates that a schema could not be created due to a naming conflict. Please select a different name and then try again.</p>
        capo_clouddirectory.errors.validation_exception.ValidationException: <p>Indicates that your request is malformed in some manner. See the exception message.</p>
        capo_clouddirectory.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_clouddirectory.types.upgrade_applied_schema_request.UpgradeAppliedSchemaRequest]",
    ) -> OperationResponse[
        "capo_clouddirectory.types.upgrade_applied_schema_response.UpgradeAppliedSchemaResponse"
    ]:
        import capo_clouddirectory._operations.amazon_cloud_directory_20170111.upgrade_applied_schema

        output, http_response = (
            capo_clouddirectory._operations.amazon_cloud_directory_20170111.upgrade_applied_schema.upgrade_applied_schema(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpgradeAppliedSchema")
    )
    input_: capo_clouddirectory.types.upgrade_applied_schema_request.UpgradeAppliedSchemaRequest = {
        "published_schema_arn": published_schema_arn,
        "directory_arn": directory_arn,
    }
    if dry_run is not None:
        input_["dry_run"] = dry_run

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output