SageMaker / Client / register_devices

register_devices

SageMaker.Client.register_devices(**kwargs)

Register devices.

See also: AWS API Documentation

Request Syntax

response = client.register_devices(
    DeviceFleetName='string',
    Devices=[
        {
            'DeviceName': 'string',
            'Description': 'string',
            'IotThingName': 'string'
        },
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

• DeviceFleetName (string) –

  [REQUIRED]

  The name of the fleet.

• Devices (list) –

  [REQUIRED]

  A list of devices to register with SageMaker Edge Manager.

  • (dict) –

    Information of a particular device.

    • DeviceName (string) – [REQUIRED]

      The name of the device.

    • Description (string) –

      Description of the device.

    • IotThingName (string) –

      Amazon Web Services Internet of Things (IoT) object name.

• Tags (list) –

  The tags associated with devices.

  • (dict) –

    A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

    You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.

    For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.

    • Key (string) – [REQUIRED]

      The tag key. Tag keys must be unique per resource.

    • Value (string) – [REQUIRED]

      The tag value.

Returns:

None

Exceptions

• SageMaker.Client.exceptions.ResourceLimitExceeded