docdb_describe_global_clusters function

Returns information about Amazon DocumentDB global clusters

Returns information about Amazon DocumentDB global clusters

Returns information about Amazon DocumentDB global clusters. This API supports pagination.

See https://www.paws-r-sdk.com/docs/docdb_describe_global_clusters/ for full documentation.

docdb_describe_global_clusters( GlobalClusterIdentifier = NULL, Filters = NULL, MaxRecords = NULL, Marker = NULL )

Arguments

  • GlobalClusterIdentifier: The user-supplied cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case-sensitive.

  • Filters: A filter that specifies one or more global DB clusters to describe.

    Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.

  • MaxRecords: 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 you can retrieve the remaining results.

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

  • Maintainer: Dyfan Jones
  • License: Apache License (>= 2.0)
  • Last published: 2025-03-14

Downloads (last 30 days):