modify_custom_db_engine_version ¶

def modify_custom_db_engine_version(
    self,
    *,
    config_overrides: Optional[RDSClientConfig] = None,
    engine: Optional["capo_rds.types.custom_engine_name.CustomEngineName"] = None,
    engine_version: Optional[
        "capo_rds.types.custom_engine_version.CustomEngineVersion"
    ] = None,
    description: Optional["capo_rds.types.description.Description"] = None,
    status: Optional[
        "capo_rds.types.custom_engine_version_status.CustomEngineVersionStatus"
    ] = None,
) -> "capo_rds.types.db_engine_version.DBEngineVersion":
    """<p>Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling <code>DescribeDBEngineVersions</code>.</p> <note> <p>The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the <code>ModifyCustomDbEngineVersion</code> event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the <code>ModifyCustomDbEngineVersion</code> event.</p> </note> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.modify">Modifying CEV status</a> in the <i>Amazon RDS User Guide</i>.</p>

    Args:
        engine: <p>The database engine.</p> <p>RDS Custom for Oracle supports the following values:</p> <ul> <li> <p> <code>custom-oracle-ee</code> </p> </li> <li> <p> <code>custom-oracle-ee-cdb</code> </p> </li> <li> <p> <code>custom-oracle-se2</code> </p> </li> <li> <p> <code>custom-oracle-se2-cdb</code> </p> </li> </ul> <p>RDS Custom for SQL Server supports the following values:</p> <ul> <li> <p> <code>custom-sqlserver-ee</code> </p> </li> <li> <p> <code>custom-sqlserver-se</code> </p> </li> <li> <p> <code>custom-sqlserver-web</code> </p> </li> <li> <p> <code>custom-sqlserver-dev</code> </p> </li> </ul> <p>RDS for SQL Server supports the following values:</p> <ul> <li> <p> <code>sqlserver-ee</code> (Bring Your Own Media)</p> </li> <li> <p> <code>sqlserver-se</code> (Bring Your Own Media)</p> </li> <li> <p> <code>sqlserver-dev-ee</code> </p> </li> </ul>
        engine_version: <p>The custom engine version (CEV) that you want to modify. This option is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of <code>Engine</code> and <code>EngineVersion</code> is unique per customer per Amazon Web Services Region.</p>
        description: <p>An optional description of your CEV.</p>
        status: <p>The availability status to be assigned to the CEV. Valid values are as follows:</p> <dl> <dt>available</dt> <dd> <p>You can use this CEV to create a new RDS Custom DB instance.</p> </dd> <dt>inactive</dt> <dd> <p>You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. You can't patch or create new instances with this CEV.</p> </dd> </dl> <p>You can change any status to any status. A typical reason to change status is to prevent the accidental use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status of your CEV from <code>available</code> to <code>inactive</code>, and from <code>inactive</code> back to <code>available</code>. To change the availability status of the CEV, it must not currently be in use by an RDS Custom instance, snapshot, or automated backup.</p>

    Raises:
        capo_rds.errors.custom_db_engine_version_not_found_fault.CustomDBEngineVersionNotFoundFault: <p>The specified CEV was not found.</p>
        capo_rds.errors.invalid_custom_db_engine_version_state_fault.InvalidCustomDBEngineVersionStateFault: <p>You can't delete the CEV.</p>
        capo_rds.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_rds.types.modify_custom_db_engine_version_message.ModifyCustomDBEngineVersionMessage]",
    ) -> OperationResponse["capo_rds.types.db_engine_version.DBEngineVersion"]:
        import capo_rds._operations.amazon_rd_sv19.modify_custom_db_engine_version

        output, http_response = (
            capo_rds._operations.amazon_rd_sv19.modify_custom_db_engine_version.modify_custom_db_engine_version(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ModifyCustomDBEngineVersion")
    )
    input_: capo_rds.types.modify_custom_db_engine_version_message.ModifyCustomDBEngineVersionMessage = {}
    if engine is not None:
        input_["engine"] = engine
    if engine_version is not None:
        input_["engine_version"] = engine_version
    if description is not None:
        input_["description"] = description
    if status is not None:
        input_["status"] = status

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