SageMaker / Client / list_stage_devices

list_stage_devices#

SageMaker.Client.list_stage_devices(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

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

  • NextToken (string) – The response from the last list when returning a list large enough to neeed tokening.

  • MaxResults (integer) – The maximum number of requests to select.

  • EdgeDeploymentPlanName (string) –

    [REQUIRED]

    The name of the edge deployment plan.

  • ExcludeDevicesDeployedInOtherStage (boolean) – Toggle for excluding devices deployed in other stages.

  • StageName (string) –

    [REQUIRED]

    The name of the stage in the deployment.

Return type:

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.