Skip to content

describe_device

describe_device(
    managed_device_id: ManagedDeviceId,
    *,
    config_overrides: Optional[SnowDeviceManagementClientConfig] = None,
) -> DescribeDeviceOutput

Checks device-specific information, such as the device type, software version, IP addresses, and lock status.

Parameters:

  • managed_device_id (ManagedDeviceId) –

    The ID of the device that you are checking the information of.

Raises:

Source code in docs_src/capo_snow_device_management/_services/snow_device_management.py
def describe_device(
    self,
    managed_device_id: "capo_snow_device_management.types.managed_device_id.ManagedDeviceId",
    *,
    config_overrides: Optional[SnowDeviceManagementClientConfig] = None,
) -> (
    "capo_snow_device_management.types.describe_device_output.DescribeDeviceOutput"
):
    """<p>Checks device-specific information, such as the device type, software version, IP addresses, and lock status.</p>

    Args:
        managed_device_id: <p>The ID of the device that you are checking the information of.</p>

    Raises:
        capo_snow_device_management.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this action.</p>
        capo_snow_device_management.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred while processing the request.</p>
        capo_snow_device_management.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request references a resource that doesn't exist.</p>
        capo_snow_device_management.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_snow_device_management.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_snow_device_management.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_snow_device_management.types.describe_device_input.DescribeDeviceInput]",
    ) -> OperationResponse[
        "capo_snow_device_management.types.describe_device_output.DescribeDeviceOutput"
    ]:
        import capo_snow_device_management._operations.snow_device_management.describe_device

        output, http_response = (
            capo_snow_device_management._operations.snow_device_management.describe_device.describe_device(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeDevice")
    )
    input_: capo_snow_device_management.types.describe_device_input.DescribeDeviceInput = {
        "managed_device_id": managed_device_id
    }

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