get_deployments

SagemakerEdgeManager.Client.get_deployments(**kwargs)

Use to get the active deployments from a device.

See also: AWS API Documentation

Request Syntax

response = client.get_deployments(
    DeviceName='string',
    DeviceFleetName='string'
)

Parameters

• DeviceName (string) --

  [REQUIRED]

  The unique name of the device you want to get the configuration of active deployments from.

• DeviceFleetName (string) --

  [REQUIRED]

  The name of the fleet that the device belongs to.

Return type

dict

Returns

Response Syntax

{
    'Deployments': [
        {
            'DeploymentName': 'string',
            'Type': 'Model',
            'FailureHandlingPolicy': 'ROLLBACK_ON_FAILURE'|'DO_NOTHING',
            'Definitions': [
                {
                    'ModelHandle': 'string',
                    'S3Url': 'string',
                    'Checksum': {
                        'Type': 'SHA1',
                        'Sum': 'string'
                    },
                    'State': 'DEPLOY'|'UNDEPLOY'
                },
            ]
        },
    ]
}

Response Structure

• (dict) --

  • Deployments (list) --

    Returns a list of the configurations of the active deployments on the device.

    • (dict) --

      Information about a deployment on an edge device that is registered with SageMaker Edge Manager.

      • DeploymentName (string) --

        The name and unique ID of the deployment.

      • Type (string) --

        The type of the deployment.

      • FailureHandlingPolicy (string) --

        Determines whether to rollback to previous configuration if deployment fails.

      • Definitions (list) --

        Returns a list of Definition objects.

        • (dict) --

          • ModelHandle (string) --

            The unique model handle.

          • S3Url (string) --

            The absolute S3 location of the model.

          • Checksum (dict) --

            The checksum information of the model.

            • Type (string) --

              The type of the checksum.

            • Sum (string) --

              The checksum of the model.

          • State (string) --

            The desired state of the model.

Exceptions

• SagemakerEdgeManager.Client.exceptions.InternalServiceException