Provides details on replication progress by returning status information for one or more provisioned DMS Serverless replications.
Parameters:
-
filters
(Optional[FilterList], default:
None
)
–
Filters applied to the replications.
Valid filter names: replication-config-arn | replication-config-id
-
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.
-
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:
Source code in docs_src/capo_database_migration_service/_services/database_migration_service.py
| def describe_replications(
self,
*,
config_overrides: Optional[DatabaseMigrationServiceClientConfig] = None,
filters: Optional[
"capo_database_migration_service.types.filter_list.FilterList"
] = 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_replications_response.DescribeReplicationsResponse":
"""<p>Provides details on replication progress by returning status information for one or more provisioned DMS Serverless replications.</p>
Args:
filters: <p>Filters applied to the replications.</p> <p> Valid filter names: <code>replication-config-arn</code> | <code>replication-config-id</code> </p>
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>
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.resource_not_found_fault.ResourceNotFoundFault: <p>The resource could not be found.</p>
capo_database_migration_service.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_database_migration_service.types.describe_replications_message.DescribeReplicationsMessage]",
) -> OperationResponse[
"capo_database_migration_service.types.describe_replications_response.DescribeReplicationsResponse"
]:
import capo_database_migration_service._operations.amazon_dm_sv20160101.describe_replications
output, http_response = (
capo_database_migration_service._operations.amazon_dm_sv20160101.describe_replications.describe_replications(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeReplications")
)
input_: capo_database_migration_service.types.describe_replications_message.DescribeReplicationsMessage = {}
if filters is not None:
input_["filters"] = filters
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
|