Skip to content

update_device_fleet

update_device_fleet(
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    device_fleet_name: Optional[EntityName] = None,
    role_arn: Optional[RoleArn] = None,
    description: Optional[DeviceFleetDescription] = None,
    output_config: Optional[EdgeOutputConfig] = None,
    enable_iot_role_alias: Optional[EnableIotRoleAlias] = None,
) -> None

Updates a fleet of devices.

Parameters:

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

    The name of the fleet.

  • role_arn (Optional[RoleArn], default: None ) –

    The Amazon Resource Name (ARN) of the device.

  • description (Optional[DeviceFleetDescription], default: None ) –

    Description of the fleet.

  • output_config (Optional[EdgeOutputConfig], default: None ) –

    Output configuration for storing sample data collected by the fleet.

  • enable_iot_role_alias (Optional[EnableIotRoleAlias], default: None ) –

    Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. The name of the role alias generated will match this pattern: "SageMakerEdge-{DeviceFleetName}".

    For example, if your device fleet is called "demo-fleet", the name of the role alias will be "SageMakerEdge-demo-fleet".

Raises:

Source code in docs_src/capo_sagemaker/_services/sage_maker.py
def update_device_fleet(
    self,
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    device_fleet_name: Optional[
        "capo_sagemaker.types.entity_name.EntityName"
    ] = None,
    role_arn: Optional["capo_sagemaker.types.role_arn.RoleArn"] = None,
    description: Optional[
        "capo_sagemaker.types.device_fleet_description.DeviceFleetDescription"
    ] = None,
    output_config: Optional[
        "capo_sagemaker.types.edge_output_config.EdgeOutputConfig"
    ] = None,
    enable_iot_role_alias: Optional[
        "capo_sagemaker.types.enable_iot_role_alias.EnableIotRoleAlias"
    ] = None,
) -> None:
    """<p>Updates a fleet of devices.</p>

    Args:
        device_fleet_name: <p>The name of the fleet.</p>
        role_arn: <p>The Amazon Resource Name (ARN) of the device.</p>
        description: <p>Description of the fleet.</p>
        output_config: <p>Output configuration for storing sample data collected by the fleet.</p>
        enable_iot_role_alias: <p>Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. The name of the role alias generated will match this pattern: "SageMakerEdge-{DeviceFleetName}".</p> <p>For example, if your device fleet is called "demo-fleet", the name of the role alias will be "SageMakerEdge-demo-fleet".</p>

    Raises:
        capo_sagemaker.errors.resource_in_use.ResourceInUse: <p>Resource being accessed is in use.</p>
        capo_sagemaker.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_sagemaker.types.update_device_fleet_request.UpdateDeviceFleetRequest]",
    ) -> OperationResponse[None]:
        import capo_sagemaker._operations.sage_maker.update_device_fleet

        output, http_response = (
            capo_sagemaker._operations.sage_maker.update_device_fleet.update_device_fleet(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateDeviceFleet")
    )
    input_: capo_sagemaker.types.update_device_fleet_request.UpdateDeviceFleetRequest = {}
    if device_fleet_name is not None:
        input_["device_fleet_name"] = device_fleet_name
    if role_arn is not None:
        input_["role_arn"] = role_arn
    if description is not None:
        input_["description"] = description
    if output_config is not None:
        input_["output_config"] = output_config
    if enable_iot_role_alias is not None:
        input_["enable_iot_role_alias"] = enable_iot_role_alias

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output