:doc:`CodeDeploy <../../codedeploy>` / Client / batch_get_deployment_instances

******************************
batch_get_deployment_instances
******************************



.. py:method:: CodeDeploy.Client.batch_get_deployment_instances(**kwargs)

  

  .. note::

    

    This method works, but is deprecated. Use ``BatchGetDeploymentTargets`` instead.

    

   

  Returns an array of one or more instances associated with a deployment. This method works with EC2/On-premises and Lambda compute platforms. The newer ``BatchGetDeploymentTargets`` works with all compute platforms. The maximum number of instances that can be returned is 25.

  

  .. danger::

        This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.


  

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


  **Request Syntax**
  ::

    response = client.batch_get_deployment_instances(
        deploymentId='string',
        instanceIds=[
            'string',
        ]
    )
    
  :type deploymentId: string
  :param deploymentId: **[REQUIRED]** 

    The unique ID of a deployment.

    

  
  :type instanceIds: list
  :param instanceIds: **[REQUIRED]** 

    The unique IDs of instances used in the deployment. The maximum number of instance IDs you can specify is 25.

    

  
    - *(string) --* 

    

  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'instancesSummary': [
              {
                  'deploymentId': 'string',
                  'instanceId': 'string',
                  'status': 'Pending'|'InProgress'|'Succeeded'|'Failed'|'Skipped'|'Unknown'|'Ready',
                  'lastUpdatedAt': datetime(2015, 1, 1),
                  'lifecycleEvents': [
                      {
                          'lifecycleEventName': 'string',
                          'diagnostics': {
                              'errorCode': 'Success'|'ScriptMissing'|'ScriptNotExecutable'|'ScriptTimedOut'|'ScriptFailed'|'UnknownError',
                              'scriptName': 'string',
                              'message': 'string',
                              'logTail': 'string'
                          },
                          'startTime': datetime(2015, 1, 1),
                          'endTime': datetime(2015, 1, 1),
                          'status': 'Pending'|'InProgress'|'Succeeded'|'Failed'|'Skipped'|'Unknown'
                      },
                  ],
                  'instanceType': 'Blue'|'Green'
              },
          ],
          'errorMessage': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Represents the output of a ``BatchGetDeploymentInstances`` operation.

      
      

      - **instancesSummary** *(list) --* 

        Information about the instance.

        
        

        - *(dict) --* 

          Information about an instance in a deployment.

          
          

          - **deploymentId** *(string) --* 

            The unique ID of a deployment.

            
          

          - **instanceId** *(string) --* 

            The instance ID.

            
          

          - **status** *(string) --* 

            The deployment status for this instance:

             

            
            * ``Pending``: The deployment is pending for this instance.
             
            * ``In Progress``: The deployment is in progress for this instance.
             
            * ``Succeeded``: The deployment has succeeded for this instance.
             
            * ``Failed``: The deployment has failed for this instance.
             
            * ``Skipped``: The deployment has been skipped for this instance.
             
            * ``Unknown``: The deployment status is unknown for this instance.
            

            
          

          - **lastUpdatedAt** *(datetime) --* 

            A timestamp that indicates when the instance information was last updated.

            
          

          - **lifecycleEvents** *(list) --* 

            A list of lifecycle events for this instance.

            
            

            - *(dict) --* 

              Information about a deployment lifecycle event.

              
              

              - **lifecycleEventName** *(string) --* 

                The deployment lifecycle event name, such as ``ApplicationStop``, ``BeforeInstall``, ``AfterInstall``, ``ApplicationStart``, or ``ValidateService``.

                
              

              - **diagnostics** *(dict) --* 

                Diagnostic information about the deployment lifecycle event.

                
                

                - **errorCode** *(string) --* 

                  The associated error code:

                   

                  
                  * Success: The specified script ran.
                   
                  * ScriptMissing: The specified script was not found in the specified location.
                   
                  * ScriptNotExecutable: The specified script is not a recognized executable file type.
                   
                  * ScriptTimedOut: The specified script did not finish running in the specified time period.
                   
                  * ScriptFailed: The specified script failed to run as expected.
                   
                  * UnknownError: The specified script did not run for an unknown reason.
                  

                  
                

                - **scriptName** *(string) --* 

                  The name of the script.

                  
                

                - **message** *(string) --* 

                  The message associated with the error.

                  
                

                - **logTail** *(string) --* 

                  The last portion of the diagnostic log.

                   

                  If available, CodeDeploy returns up to the last 4 KB of the diagnostic log.

                  
            
              

              - **startTime** *(datetime) --* 

                A timestamp that indicates when the deployment lifecycle event started.

                
              

              - **endTime** *(datetime) --* 

                A timestamp that indicates when the deployment lifecycle event ended.

                
              

              - **status** *(string) --* 

                The deployment lifecycle event status:

                 

                
                * Pending: The deployment lifecycle event is pending.
                 
                * InProgress: The deployment lifecycle event is in progress.
                 
                * Succeeded: The deployment lifecycle event ran successfully.
                 
                * Failed: The deployment lifecycle event has failed.
                 
                * Skipped: The deployment lifecycle event has been skipped.
                 
                * Unknown: The deployment lifecycle event is unknown.
                

                
          
        
          

          - **instanceType** *(string) --* 

            Information about which environment an instance belongs to in a blue/green deployment.

             

            
            * BLUE: The instance is part of the original environment.
             
            * GREEN: The instance is part of the replacement environment.
            

            
      
    
      

      - **errorMessage** *(string) --* 

        Information about errors that might have occurred during the API call.

        
  
  **Exceptions**
  
  *   :py:class:`CodeDeploy.Client.exceptions.DeploymentIdRequiredException`

  
  *   :py:class:`CodeDeploy.Client.exceptions.DeploymentDoesNotExistException`

  
  *   :py:class:`CodeDeploy.Client.exceptions.InstanceIdRequiredException`

  
  *   :py:class:`CodeDeploy.Client.exceptions.InvalidDeploymentIdException`

  
  *   :py:class:`CodeDeploy.Client.exceptions.InvalidInstanceNameException`

  
  *   :py:class:`CodeDeploy.Client.exceptions.BatchLimitExceededException`

  
  *   :py:class:`CodeDeploy.Client.exceptions.InvalidComputePlatformException`

  