:doc:`CodeDeploy <../../codedeploy>` / Waiter / DeploymentSuccessful

********************
DeploymentSuccessful
********************



.. py:class:: CodeDeploy.Waiter.DeploymentSuccessful

  ::

    
    waiter = client.get_waiter('deployment_successful')

  
  

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

    Polls :py:meth:`CodeDeploy.Client.get_deployment` every 15 seconds until a successful state is reached. An error is raised after 120 failed checks.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/codedeploy-2014-10-06/GetDeployment>`_    


    **Request Syntax**
    ::

      waiter.wait(
          deploymentId='string',
          WaiterConfig={
              'Delay': 123,
              'MaxAttempts': 123
          }
      )
      
    :type deploymentId: string
    :param deploymentId: **[REQUIRED]** 

      The unique ID of a deployment associated with the user or Amazon Web Services account.

      

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

        

      
    
    
    :returns: None