Skip to content

transfer_input_device

transfer_input_device(
    input_device_id: __string,
    *,
    config_overrides: Optional[MediaLiveClientConfig] = None,
    target_customer_id: Optional[__string] = None,
    target_region: Optional[__string] = None,
    transfer_message: Optional[__string] = None,
) -> TransferInputDeviceResponse

Start an input device transfer to another AWS account. After you make the request, the other account must accept or reject the transfer.

Parameters:

  • input_device_id (__string) –

    The unique ID of this input device. For example, hd-123456789abcdef.

  • target_customer_id (Optional[__string], default: None ) –

    The AWS account ID (12 digits) for the recipient of the device transfer.

  • target_region (Optional[__string], default: None ) –

    The target AWS region to transfer the device.

  • transfer_message (Optional[__string], default: None ) –

    An optional message for the recipient. Maximum 280 characters.

Raises:

Source code in docs_src/capo_medialive/_services/media_live.py
def transfer_input_device(
    self,
    input_device_id: "capo_medialive.types.__string.__string",
    *,
    config_overrides: Optional[MediaLiveClientConfig] = None,
    target_customer_id: Optional["capo_medialive.types.__string.__string"] = None,
    target_region: Optional["capo_medialive.types.__string.__string"] = None,
    transfer_message: Optional["capo_medialive.types.__string.__string"] = None,
) -> "capo_medialive.types.transfer_input_device_response.TransferInputDeviceResponse":
    """Start an input device transfer to another AWS account. After you make the request, the other account must accept or reject the transfer.

    Args:
        input_device_id: The unique ID of this input device. For example, hd-123456789abcdef.
        target_customer_id: The AWS account ID (12 digits) for the recipient of the device transfer.
        target_region: The target AWS region to transfer the device.
        transfer_message: An optional message for the recipient. Maximum 280 characters.

    Raises:
        capo_medialive.errors.bad_gateway_exception.BadGatewayException: Placeholder documentation for BadGatewayException
        capo_medialive.errors.bad_request_exception.BadRequestException: Placeholder documentation for BadRequestException
        capo_medialive.errors.conflict_exception.ConflictException: Placeholder documentation for ConflictException
        capo_medialive.errors.forbidden_exception.ForbiddenException: Placeholder documentation for ForbiddenException
        capo_medialive.errors.gateway_timeout_exception.GatewayTimeoutException: Placeholder documentation for GatewayTimeoutException
        capo_medialive.errors.internal_server_error_exception.InternalServerErrorException: Placeholder documentation for InternalServerErrorException
        capo_medialive.errors.not_found_exception.NotFoundException: Placeholder documentation for NotFoundException
        capo_medialive.errors.too_many_requests_exception.TooManyRequestsException: Placeholder documentation for TooManyRequestsException
        capo_medialive.errors.unprocessable_entity_exception.UnprocessableEntityException: Placeholder documentation for UnprocessableEntityException
        capo_medialive.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_medialive.types.transfer_input_device_request.TransferInputDeviceRequest]",
    ) -> OperationResponse[
        "capo_medialive.types.transfer_input_device_response.TransferInputDeviceResponse"
    ]:
        import capo_medialive._operations.media_live.transfer_input_device

        output, http_response = (
            capo_medialive._operations.media_live.transfer_input_device.transfer_input_device(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("TransferInputDevice")
    )
    input_: capo_medialive.types.transfer_input_device_request.TransferInputDeviceRequest = {
        "input_device_id": input_device_id
    }
    if target_customer_id is not None:
        input_["target_customer_id"] = target_customer_id
    if target_region is not None:
        input_["target_region"] = target_region
    if transfer_message is not None:
        input_["transfer_message"] = transfer_message

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