SageMaker / Paginator / ListStageDevices

ListStageDevices

class SageMaker.Paginator.ListStageDevices

paginator = client.get_paginator('list_stage_devices')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SageMaker.Client.list_stage_devices().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    EdgeDeploymentPlanName='string',
    ExcludeDevicesDeployedInOtherStage=True|False,
    StageName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• 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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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)
        },
    ],

}

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.