Skip to content

describe_orderable_replication_instances

describe_orderable_replication_instances(
    *,
    config_overrides: Optional[DatabaseMigrationServiceClientConfig] = None,
    max_records: Optional[IntegerOptional] = None,
    marker: Optional[String] = None,
) -> DescribeOrderableReplicationInstancesResponse

Returns information about the replication instance types that can be created in the specified region.

Parameters:

  • max_records (Optional[IntegerOptional], default: None ) –

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: Minimum 20, maximum 100.

  • marker (Optional[String], default: None ) –

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Raises:

Examples:

Describe orderable replication instances Returns information about the replication instance types that can be created in the specified region.

>>> client.describe_orderable_replication_instances(max_records=123, marker='')
Source code in docs_src/capo_database_migration_service/_services/database_migration_service.py
def describe_orderable_replication_instances(
    self,
    *,
    config_overrides: Optional[DatabaseMigrationServiceClientConfig] = None,
    max_records: Optional[
        "capo_database_migration_service.types.integer_optional.IntegerOptional"
    ] = None,
    marker: Optional["capo_database_migration_service.types.string.String"] = None,
) -> "capo_database_migration_service.types.describe_orderable_replication_instances_response.DescribeOrderableReplicationInstancesResponse":
    """<p>Returns information about the replication instance types that can be created in the specified region.</p>

    Args:
        max_records: <p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>
        marker: <p> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>

    Raises:
        capo_database_migration_service.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Describe orderable replication instances
        Returns information about the replication instance types that can be created in the specified region.

        >>> client.describe_orderable_replication_instances(max_records=123, marker='')
    """

    def _handler(
        req: "OperationRequest[capo_database_migration_service.types.describe_orderable_replication_instances_message.DescribeOrderableReplicationInstancesMessage]",
    ) -> OperationResponse[
        "capo_database_migration_service.types.describe_orderable_replication_instances_response.DescribeOrderableReplicationInstancesResponse"
    ]:
        import capo_database_migration_service._operations.amazon_dm_sv20160101.describe_orderable_replication_instances

        output, http_response = (
            capo_database_migration_service._operations.amazon_dm_sv20160101.describe_orderable_replication_instances.describe_orderable_replication_instances(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeOrderableReplicationInstances")
    )
    input_: capo_database_migration_service.types.describe_orderable_replication_instances_message.DescribeOrderableReplicationInstancesMessage = {}
    if max_records is not None:
        input_["max_records"] = max_records
    if marker is not None:
        input_["marker"] = marker

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