Skip to content

register_devices async

register_devices(
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    device_fleet_name: Optional[EntityName] = None,
    devices: Optional[Devices] = None,
    tags: Optional[TagList] = None,
) -> None

Register devices.

Parameters:

  • device_fleet_name (Optional[EntityName], default: None ) –

    The name of the fleet.

  • devices (Optional[Devices], default: None ) –

    A list of devices to register with SageMaker Edge Manager.

  • tags (Optional[TagList], default: None ) –

    The tags associated with devices.

Raises:

  • ResourceLimitExceeded –

    You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_sagemaker/_services/async_sage_maker.py
async def register_devices(
    self,
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    device_fleet_name: Optional[
        "capo_sagemaker.types.entity_name.EntityName"
    ] = None,
    devices: Optional["capo_sagemaker.types.devices.Devices"] = None,
    tags: Optional["capo_sagemaker.types.tag_list.TagList"] = None,
) -> None:
    """<p>Register devices.</p>

    Args:
        device_fleet_name: <p>The name of the fleet.</p>
        devices: <p>A list of devices to register with SageMaker Edge Manager.</p>
        tags: <p>The tags associated with devices.</p>

    Raises:
        capo_sagemaker.errors.resource_limit_exceeded.ResourceLimitExceeded: <p> You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. </p>
        capo_sagemaker.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_sagemaker.types.register_devices_request.RegisterDevicesRequest]",
    ) -> AsyncOperationResponse[None]:
        import capo_sagemaker._operations.sage_maker.register_devices

        (
            output,
            http_response,
        ) = await capo_sagemaker._operations.sage_maker.register_devices.async_register_devices(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("RegisterDevices")
    )
    input_: capo_sagemaker.types.register_devices_request.RegisterDevicesRequest = {}
    if device_fleet_name is not None:
        input_["device_fleet_name"] = device_fleet_name
    if devices is not None:
        input_["devices"] = devices
    if tags is not None:
        input_["tags"] = tags

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output