DescribeGlobalClusters¶

class DocDB.Paginator.DescribeGlobalClusters¶

paginator = client.get_paginator('describe_global_clusters')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from DocDB.Client.describe_global_clusters().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    GlobalClusterIdentifier='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

GlobalClusterIdentifier (string) -- 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 (list) --
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.
- (dict) --
  A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
  
  Wildcards are not supported in filters.
  - Name (string) -- [REQUIRED]
    The name of the filter. Filter names are case sensitive.
  - Values (list) -- [REQUIRED]
    One or more filter values. Filter values are case sensitive.
    - (string) --
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'GlobalClusters': [
        {
            'GlobalClusterIdentifier': 'string',
            'GlobalClusterResourceId': 'string',
            'GlobalClusterArn': 'string',
            'Status': 'string',
            'Engine': 'string',
            'EngineVersion': 'string',
            'DatabaseName': 'string',
            'StorageEncrypted': True|False,
            'DeletionProtection': True|False,
            'GlobalClusterMembers': [
                {
                    'DBClusterArn': 'string',
                    'Readers': [
                        'string',
                    ],
                    'IsWriter': True|False
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- GlobalClusters (list) --
  - (dict) --
    
    A data type representing an Amazon DocumentDB global cluster.
    - GlobalClusterIdentifier (string) --
      
      Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.
    - GlobalClusterResourceId (string) --
      
      The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the cluster is accessed.
    - GlobalClusterArn (string) --
      
      The Amazon Resource Name (ARN) for the global cluster.
    - Status (string) --
      
      Specifies the current state of this global cluster.
    - Engine (string) --
      
      The Amazon DocumentDB database engine used by the global cluster.
    - EngineVersion (string) --
      
      Indicates the database engine version.
    - DatabaseName (string) --
      
      The default database name within the new global cluster.
    - StorageEncrypted (boolean) --
      
      The storage encryption setting for the global cluster.
    - DeletionProtection (boolean) --
      
      The deletion protection setting for the new global cluster.
    - GlobalClusterMembers (list) --
      
      The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.
      - (dict) --
        
        A data structure with information about any primary and secondary clusters associated with an Amazon DocumentDB global clusters.
        
        DBClusterArn (string) --
        
        The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster.
        
        Readers (list) --
        
        The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global cluster.
        
        (string) --
        
        IsWriter (boolean) --
        
        Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, has read-write capability) for the Amazon DocumentDB global cluster with which it is associated.
- NextToken (string) --
  
  A token to resume pagination.

Table Of Contents

DescribeGlobalClusters¶