describe_global_clusters ¶

def describe_global_clusters(
    self,
    *,
    config_overrides: Optional[NeptuneClientConfig] = None,
    global_cluster_identifier: Optional[
        "capo_neptune.types.global_cluster_identifier.GlobalClusterIdentifier"
    ] = None,
    max_records: Optional[
        "capo_neptune.types.integer_optional.IntegerOptional"
    ] = None,
    marker: Optional["capo_neptune.types.string.String"] = None,
) -> "capo_neptune.types.global_clusters_message.GlobalClustersMessage":
    """<p>Returns information about Neptune global database clusters. This API supports pagination.</p>

    Args:
        global_cluster_identifier: <p>The user-supplied DB cluster identifier. If this parameter is specified, only information about the specified DB cluster is returned. This parameter is not case-sensitive.</p> <p>Constraints: If supplied, must match an existing DB cluster identifier.</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 marker token is included in the response that you can use to retrieve the remaining results.</p> <p>Default: <code>100</code> </p> <p>Constraints: Minimum 20, maximum 100.</p>
        marker: <p>(<i>Optional</i>) A pagination token returned by a previous call to <code>DescribeGlobalClusters</code>. If this parameter is specified, the response will only include records beyond the marker, up to the number specified by <code>MaxRecords</code>.</p>

    Raises:
        capo_neptune.errors.global_cluster_not_found_fault.GlobalClusterNotFoundFault: <p>The <code>GlobalClusterIdentifier</code> doesn't refer to an existing global database cluster. </p>
        capo_neptune.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_neptune.types.describe_global_clusters_message.DescribeGlobalClustersMessage]",
    ) -> OperationResponse[
        "capo_neptune.types.global_clusters_message.GlobalClustersMessage"
    ]:
        import capo_neptune._operations.amazon_rd_sv19.describe_global_clusters

        output, http_response = (
            capo_neptune._operations.amazon_rd_sv19.describe_global_clusters.describe_global_clusters(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeGlobalClusters")
    )
    input_: capo_neptune.types.describe_global_clusters_message.DescribeGlobalClustersMessage = {}
    if global_cluster_identifier is not None:
        input_["global_cluster_identifier"] = global_cluster_identifier
    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