:doc:`ElasticBeanstalk <../../elasticbeanstalk>` / Waiter / EnvironmentTerminated

*********************
EnvironmentTerminated
*********************



.. py:class:: ElasticBeanstalk.Waiter.EnvironmentTerminated

  ::

    
    waiter = client.get_waiter('environment_terminated')

  
  

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

    Polls :py:meth:`ElasticBeanstalk.Client.describe_environments` every 20 seconds until a successful state is reached. An error is raised after 20 failed checks.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DescribeEnvironments>`_    


    **Request Syntax**
    ::

      waiter.wait(
          ApplicationName='string',
          VersionLabel='string',
          EnvironmentIds=[
              'string',
          ],
          EnvironmentNames=[
              'string',
          ],
          IncludeDeleted=True|False,
          IncludedDeletedBackTo=datetime(2015, 1, 1),
          MaxRecords=123,
          NextToken='string',
          WaiterConfig={
              'Delay': 123,
              'MaxAttempts': 123
          }
      )
      
    :type ApplicationName: string
    :param ApplicationName: 

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

      

    
    :type VersionLabel: string
    :param VersionLabel: 

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

      

    
    :type EnvironmentIds: list
    :param EnvironmentIds: 

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

      

    
      - *(string) --* 

      
  
    :type EnvironmentNames: list
    :param EnvironmentNames: 

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

      

    
      - *(string) --* 

      
  
    :type IncludeDeleted: boolean
    :param IncludeDeleted: 

      Indicates whether to include deleted environments:

       

      ``true``: Environments that have been deleted after ``IncludedDeletedBackTo`` are displayed.

       

      ``false``: Do not include deleted environments.

      

    
    :type IncludedDeletedBackTo: datetime
    :param IncludedDeletedBackTo: 

      If specified when ``IncludeDeleted`` is set to ``true``, then environments deleted after this date are displayed.

      

    
    :type MaxRecords: integer
    :param MaxRecords: 

      For a paginated request. Specify a maximum number of environments to include in each response.

       

      If no ``MaxRecords`` is specified, all available environments are retrieved in a single response.

      

    
    :type NextToken: string
    :param NextToken: 

      For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.

       

      If no ``NextToken`` is specified, the first page is retrieved.

      

    
    :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: 20

        

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

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

        

      
    
    
    :returns: None