:doc:`SageMaker <../../sagemaker>` / Client / list_stage_devices

******************
list_stage_devices
******************



.. py:method:: SageMaker.Client.list_stage_devices(**kwargs)

  

  Lists devices allocated to the stage, containing detailed device information and deployment status.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListStageDevices>`_  


  **Request Syntax**
  ::

    response = client.list_stage_devices(
        NextToken='string',
        MaxResults=123,
        EdgeDeploymentPlanName='string',
        ExcludeDevicesDeployedInOtherStage=True|False,
        StageName='string'
    )
    
  :type NextToken: string
  :param NextToken: 

    The response from the last list when returning a list large enough to neeed tokening.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of requests to select.

    

  
  :type EdgeDeploymentPlanName: string
  :param EdgeDeploymentPlanName: **[REQUIRED]** 

    The name of the edge deployment plan.

    

  
  :type ExcludeDevicesDeployedInOtherStage: boolean
  :param ExcludeDevicesDeployedInOtherStage: 

    Toggle for excluding devices deployed in other stages.

    

  
  :type StageName: string
  :param StageName: **[REQUIRED]** 

    The name of the stage in the deployment.

    

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

    
    ::

      {
          'DeviceDeploymentSummaries': [
              {
                  'EdgeDeploymentPlanArn': 'string',
                  'EdgeDeploymentPlanName': 'string',
                  'StageName': 'string',
                  'DeployedStageName': 'string',
                  'DeviceFleetName': 'string',
                  'DeviceName': 'string',
                  'DeviceArn': 'string',
                  'DeviceDeploymentStatus': 'READYTODEPLOY'|'INPROGRESS'|'DEPLOYED'|'FAILED'|'STOPPING'|'STOPPED',
                  'DeviceDeploymentStatusMessage': 'string',
                  'Description': 'string',
                  'DeploymentStartTime': datetime(2015, 1, 1)
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **DeviceDeploymentSummaries** *(list) --* 

        List of summaries of devices allocated to the stage.

        
        

        - *(dict) --* 

          Contains information summarizing device details and deployment status.

          
          

          - **EdgeDeploymentPlanArn** *(string) --* 

            The ARN of the edge deployment plan.

            
          

          - **EdgeDeploymentPlanName** *(string) --* 

            The name of the edge deployment plan.

            
          

          - **StageName** *(string) --* 

            The name of the stage in the edge deployment plan.

            
          

          - **DeployedStageName** *(string) --* 

            The name of the deployed stage.

            
          

          - **DeviceFleetName** *(string) --* 

            The name of the fleet to which the device belongs to.

            
          

          - **DeviceName** *(string) --* 

            The name of the device.

            
          

          - **DeviceArn** *(string) --* 

            The ARN of the device.

            
          

          - **DeviceDeploymentStatus** *(string) --* 

            The deployment status of the device.

            
          

          - **DeviceDeploymentStatusMessage** *(string) --* 

            The detailed error message for the deployoment status result.

            
          

          - **Description** *(string) --* 

            The description of the device.

            
          

          - **DeploymentStartTime** *(datetime) --* 

            The time when the deployment on the device started.

            
      
    
      

      - **NextToken** *(string) --* 

        The token to use when calling the next page of results.

        
  