describe_global_replication_groups ¶

def describe_global_replication_groups(
    self,
    *,
    config_overrides: Optional[ElastiCacheClientConfig] = None,
    global_replication_group_id: Optional[
        "capo_elasticache.types.string.String"
    ] = None,
    max_records: Optional[
        "capo_elasticache.types.integer_optional.IntegerOptional"
    ] = None,
    marker: Optional["capo_elasticache.types.string.String"] = None,
    show_member_info: Optional[
        "capo_elasticache.types.boolean_optional.BooleanOptional"
    ] = None,
) -> "capo_elasticache.types.describe_global_replication_groups_result.DescribeGlobalReplicationGroupsResult":
    """<p>Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores. </p>

    Args:
        global_replication_group_id: <p>The name of the Global datastore</p>
        max_records: <p>The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. </p>
        marker: <p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>
        show_member_info: <p>Returns the list of members that comprise the Global datastore.</p>

    Raises:
        capo_elasticache.errors.global_replication_group_not_found_fault.GlobalReplicationGroupNotFoundFault: <p>The Global datastore does not exist</p>
        capo_elasticache.errors.invalid_parameter_combination_exception.InvalidParameterCombinationException: <p>Two or more incompatible parameters were specified.</p>
        capo_elasticache.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>The value for a parameter is invalid.</p>
        capo_elasticache.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_elasticache.types.describe_global_replication_groups_message.DescribeGlobalReplicationGroupsMessage]",
    ) -> OperationResponse[
        "capo_elasticache.types.describe_global_replication_groups_result.DescribeGlobalReplicationGroupsResult"
    ]:
        import capo_elasticache._operations.amazon_elasti_cache_v9.describe_global_replication_groups

        output, http_response = (
            capo_elasticache._operations.amazon_elasti_cache_v9.describe_global_replication_groups.describe_global_replication_groups(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeGlobalReplicationGroups")
    )
    input_: capo_elasticache.types.describe_global_replication_groups_message.DescribeGlobalReplicationGroupsMessage = {}
    if global_replication_group_id is not None:
        input_["global_replication_group_id"] = global_replication_group_id
    if max_records is not None:
        input_["max_records"] = max_records
    if marker is not None:
        input_["marker"] = marker
    if show_member_info is not None:
        input_["show_member_info"] = show_member_info

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