send_media_message ¶

def send_media_message(
    self,
    destination_phone_number: "capo_pinpoint_sms_voice_v2.types.phone_number.PhoneNumber",
    origination_identity: "capo_pinpoint_sms_voice_v2.types.media_message_origination_identity.MediaMessageOriginationIdentity",
    *,
    config_overrides: Optional[PinpointSMSVoiceV2ClientConfig] = None,
    message_body: Optional[
        "capo_pinpoint_sms_voice_v2.types.text_message_body.TextMessageBody"
    ] = None,
    media_urls: Optional[
        "capo_pinpoint_sms_voice_v2.types.media_url_list.MediaUrlList"
    ] = None,
    configuration_set_name: Optional[
        "capo_pinpoint_sms_voice_v2.types.configuration_set_name_or_arn.ConfigurationSetNameOrArn"
    ] = None,
    max_price: Optional[
        "capo_pinpoint_sms_voice_v2.types.max_price.MaxPrice"
    ] = None,
    time_to_live: Optional[
        "capo_pinpoint_sms_voice_v2.types.time_to_live.TimeToLive"
    ] = None,
    context: Optional[
        "capo_pinpoint_sms_voice_v2.types.context_map.ContextMap"
    ] = None,
    dry_run: Optional[bool] = None,
    protect_configuration_id: Optional[
        "capo_pinpoint_sms_voice_v2.types.protect_configuration_id_or_arn.ProtectConfigurationIdOrArn"
    ] = None,
    message_feedback_enabled: Optional[bool] = None,
) -> "capo_pinpoint_sms_voice_v2.types.send_media_message_result.SendMediaMessageResult":
    """<p>Creates a new multimedia message (MMS) and sends it to a recipient's phone number. </p>

    Args:
        destination_phone_number: <p>The destination phone number in E.164 format.</p>
        origination_identity: <p>The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.</p> <important> <p>If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).</p> </important>
        message_body: <p>The text body of the message.</p>
        media_urls: <p>An array of URLs to each media file to send. </p> <p>The media files have to be stored in an S3 bucket. Supported media file formats are listed in <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/mms-limitations-character.html">MMS file types, size and character limits</a>. For more information on creating an S3 bucket and managing objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-bucket-overview.html">Creating a bucket</a>, <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/upload-objects.html">Uploading objects</a> in the <i>Amazon S3 User Guide</i>, and <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/send-mms-message.html#send-mms-message-bucket">Setting up an Amazon S3 bucket for MMS files</a> in the <i>Amazon Web Services End User Messaging SMS User Guide</i>.</p>
        configuration_set_name: <p>The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.</p>
        max_price: <p>The maximum amount that you want to spend, in US dollars, per each MMS message.</p>
        time_to_live: <p>How long the media message is valid for. By default this is 72 hours.</p>
        context: <p>You can specify custom data in this field. If you do, that data is logged to the event destination.</p>
        dry_run: <p>When set to true, the message is checked and validated, but isn't sent to the end recipient.</p>
        protect_configuration_id: <p>The unique identifier of the protect configuration to use.</p>
        message_feedback_enabled: <p>Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using <a>PutMessageFeedback</a>.</p>

    Raises:
        capo_pinpoint_sms_voice_v2.errors.access_denied_exception.AccessDeniedException: <p>The request was denied because you don't have sufficient permissions to access the resource.</p>
        capo_pinpoint_sms_voice_v2.errors.conflict_exception.ConflictException: <p>Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.</p>
        capo_pinpoint_sms_voice_v2.errors.internal_server_exception.InternalServerException: <p>The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.</p>
        capo_pinpoint_sms_voice_v2.errors.resource_not_found_exception.ResourceNotFoundException: <p>A requested resource couldn't be found.</p>
        capo_pinpoint_sms_voice_v2.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request would cause a service quota to be exceeded.</p>
        capo_pinpoint_sms_voice_v2.errors.throttling_exception.ThrottlingException: <p>An error that occurred because too many requests were sent during a certain amount of time.</p>
        capo_pinpoint_sms_voice_v2.errors.validation_exception.ValidationException: <p>A validation exception for a field.</p>
        capo_pinpoint_sms_voice_v2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_pinpoint_sms_voice_v2.types.send_media_message_request.SendMediaMessageRequest]",
    ) -> OperationResponse[
        "capo_pinpoint_sms_voice_v2.types.send_media_message_result.SendMediaMessageResult"
    ]:
        import capo_pinpoint_sms_voice_v2._operations.pinpoint_sms_voice_v2.send_media_message

        output, http_response = (
            capo_pinpoint_sms_voice_v2._operations.pinpoint_sms_voice_v2.send_media_message.send_media_message(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("SendMediaMessage")
    )
    input_: capo_pinpoint_sms_voice_v2.types.send_media_message_request.SendMediaMessageRequest = {
        "destination_phone_number": destination_phone_number,
        "origination_identity": origination_identity,
    }
    if message_body is not None:
        input_["message_body"] = message_body
    if media_urls is not None:
        input_["media_urls"] = media_urls
    if configuration_set_name is not None:
        input_["configuration_set_name"] = configuration_set_name
    if max_price is not None:
        input_["max_price"] = max_price
    if time_to_live is not None:
        input_["time_to_live"] = time_to_live
    if context is not None:
        input_["context"] = context
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if protect_configuration_id is not None:
        input_["protect_configuration_id"] = protect_configuration_id
    if message_feedback_enabled is not None:
        input_["message_feedback_enabled"] = message_feedback_enabled

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