describe_valid_db_instance_modifications ¶

describe_valid_db_instance_modifications(
    *,
    config_overrides: Optional[RDSClientConfig] = None,
    db_instance_identifier: Optional[String] = None,
) -> DescribeValidDBInstanceModificationsResult

You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.

This command doesn't apply to RDS Custom.

Parameters:

db_instance_identifier (Optional[String], default: None ) –

The customer identifier or the ARN of your DB instance.

Raises:

DBInstanceNotFoundFault –

DBInstanceIdentifier doesn't refer to an existing DB instance.
InvalidDBInstanceStateFault –

The DB instance isn't in a valid state.
UnknownServiceError –

The service returned an error code this client does not model.

Examples:

To describe valid modifications for a DB instance The following example retrieves details about the valid modifications for the specified DB instance.

>>> client.describe_valid_db_instance_modifications(db_instance_identifier='database-test1')

Source code in docs_src/capo_rds/_services/rds.py

def describe_valid_db_instance_modifications(
    self,
    *,
    config_overrides: Optional[RDSClientConfig] = None,
    db_instance_identifier: Optional["capo_rds.types.string.String"] = None,
) -> "capo_rds.types.describe_valid_db_instance_modifications_result.DescribeValidDBInstanceModificationsResult":
    """<p>You can call <code>DescribeValidDBInstanceModifications</code> to learn what modifications you can make to your DB instance. You can use this information when you call <code>ModifyDBInstance</code>.</p> <p>This command doesn't apply to RDS Custom.</p>

    Args:
        db_instance_identifier: <p>The customer identifier or the ARN of your DB instance.</p>

    Raises:
        capo_rds.errors.db_instance_not_found_fault.DBInstanceNotFoundFault: <p> <code>DBInstanceIdentifier</code> doesn't refer to an existing DB instance.</p>
        capo_rds.errors.invalid_db_instance_state_fault.InvalidDBInstanceStateFault: <p>The DB instance isn't in a valid state.</p>
        capo_rds.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To describe valid modifications for a DB instance
        The following example retrieves details about the valid modifications for the specified DB instance.

        >>> client.describe_valid_db_instance_modifications(db_instance_identifier='database-test1')
    """

    def _handler(
        req: "OperationRequest[capo_rds.types.describe_valid_db_instance_modifications_message.DescribeValidDBInstanceModificationsMessage]",
    ) -> OperationResponse[
        "capo_rds.types.describe_valid_db_instance_modifications_result.DescribeValidDBInstanceModificationsResult"
    ]:
        import capo_rds._operations.amazon_rd_sv19.describe_valid_db_instance_modifications

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeValidDBInstanceModifications")
    )
    input_: capo_rds.types.describe_valid_db_instance_modifications_message.DescribeValidDBInstanceModificationsMessage = {}
    if db_instance_identifier is not None:
        input_["db_instance_identifier"] = db_instance_identifier

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