delete_whats_app_message_media ¶

delete_whats_app_message_media(
    media_id: WhatsAppMediaId,
    origination_phone_number_id: WhatsAppPhoneNumberId,
    *,
    config_overrides: Optional[SocialMessagingClientConfig] = None,
) -> DeleteWhatsAppMessageMediaOutput

Delete a media object from the WhatsApp service. If the object is still in an Amazon S3 bucket you should delete it from there too.

Parameters:

media_id (WhatsAppMediaId) –

The unique identifier of the media file to delete. Use the mediaId returned from PostWhatsAppMessageMedia.
origination_phone_number_id (WhatsAppPhoneNumberId) –

The unique identifier of the originating phone number associated with the media. Phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901. Use GetLinkedWhatsAppBusinessAccount to find a phone number's id.

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
ValidationException –

The request contains an invalid parameter value.
AccessDeniedByMetaException –

You do not have sufficient access to perform this action.
DependencyException –

Thrown when performing an action because a dependency would be broken.
InternalServiceException –

The request processing has failed because of an unknown error, exception, or failure.
InvalidParametersException –

One or more parameters provided to the action are not valid.
ResourceNotFoundException –

The resource was not found.
ThrottledRequestException –

The request was denied due to request throttling.
UnknownServiceError –

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

Source code in docs_src/capo_socialmessaging/_services/social_messaging.py

def delete_whats_app_message_media(
    self,
    media_id: "capo_socialmessaging.types.whats_app_media_id.WhatsAppMediaId",
    origination_phone_number_id: "capo_socialmessaging.types.whats_app_phone_number_id.WhatsAppPhoneNumberId",
    *,
    config_overrides: Optional[SocialMessagingClientConfig] = None,
) -> "capo_socialmessaging.types.delete_whats_app_message_media_output.DeleteWhatsAppMessageMediaOutput":
    """<p>Delete a media object from the WhatsApp service. If the object is still in an Amazon S3 bucket you should delete it from there too.</p>

    Args:
        media_id: <p>The unique identifier of the media file to delete. Use the <code>mediaId</code> returned from <a href="https://console.aws.amazon.com/social-messaging/latest/APIReference/API_PostWhatsAppMessageMedia.html">PostWhatsAppMessageMedia</a>.</p>
        origination_phone_number_id: <p>The unique identifier of the originating phone number associated with the media. Phone number identifiers are formatted as <code>phone-number-id-01234567890123456789012345678901</code>. Use <a href="https://docs.aws.amazon.com/social-messaging/latest/APIReference/API_GetLinkedWhatsAppBusinessAccount.html">GetLinkedWhatsAppBusinessAccount</a> to find a phone number's id.</p>

    Raises:
        capo_socialmessaging.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_socialmessaging.errors.validation_exception.ValidationException: <p>The request contains an invalid parameter value. </p>
        capo_socialmessaging.errors.access_denied_by_meta_exception.AccessDeniedByMetaException: <p>You do not have sufficient access to perform this action.</p>
        capo_socialmessaging.errors.dependency_exception.DependencyException: <p>Thrown when performing an action because a dependency would be broken.</p>
        capo_socialmessaging.errors.internal_service_exception.InternalServiceException: <p>The request processing has failed because of an unknown error, exception, or failure.</p>
        capo_socialmessaging.errors.invalid_parameters_exception.InvalidParametersException: <p>One or more parameters provided to the action are not valid.</p>
        capo_socialmessaging.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource was not found.</p>
        capo_socialmessaging.errors.throttled_request_exception.ThrottledRequestException: <p>The request was denied due to request throttling.</p>
        capo_socialmessaging.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_socialmessaging.types.delete_whats_app_message_media_input.DeleteWhatsAppMessageMediaInput]",
    ) -> OperationResponse[
        "capo_socialmessaging.types.delete_whats_app_message_media_output.DeleteWhatsAppMessageMediaOutput"
    ]:
        import capo_socialmessaging._operations.social_messaging.delete_whats_app_message_media

        output, http_response = (
            capo_socialmessaging._operations.social_messaging.delete_whats_app_message_media.delete_whats_app_message_media(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteWhatsAppMessageMedia")
    )
    input_: capo_socialmessaging.types.delete_whats_app_message_media_input.DeleteWhatsAppMessageMediaInput = {
        "media_id": media_id,
        "origination_phone_number_id": origination_phone_number_id,
    }

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