:doc:`ElastiCache <../../elasticache>` / Waiter / ReplicationGroupAvailable

*************************
ReplicationGroupAvailable
*************************



.. py:class:: ElastiCache.Waiter.ReplicationGroupAvailable

  ::

    
    waiter = client.get_waiter('replication_group_available')

  
  

  .. py:method:: wait(**kwargs)

    Polls :py:meth:`ElastiCache.Client.describe_replication_groups` every 15 seconds until a successful state is reached. An error is raised after 40 failed checks.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeReplicationGroups>`_    


    **Request Syntax**
    ::

      waiter.wait(
          ReplicationGroupId='string',
          MaxRecords=123,
          Marker='string',
          WaiterConfig={
              'Delay': 123,
              'MaxAttempts': 123
          }
      )
      
    :type ReplicationGroupId: string
    :param ReplicationGroupId: 

      The identifier for the replication group to be described. This parameter is not case sensitive.

       

      If you do not specify this parameter, information about all replication groups is returned.

      

    
    :type MaxRecords: integer
    :param MaxRecords: 

      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.

       

      Default: 100

       

      Constraints: minimum 20; maximum 100.

      

    
    :type Marker: string
    :param Marker: 

      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 ``MaxRecords``.

      

    
    :type WaiterConfig: dict
    :param WaiterConfig: 

      A dictionary that provides parameters to control waiting behavior.

      

    
      - **Delay** *(integer) --* 

        The amount of time in seconds to wait between attempts. Default: 15

        

      
      - **MaxAttempts** *(integer) --* 

        The maximum number of attempts to be made. Default: 40

        

      
    
    
    :returns: None