IPWorks S3 2020 Python Edition

Questions / Feedback?

send_custom_request Method

Sends a custom request to the server.


def send_custom_request(http_method: str, object_name: str, request_body: str) -> None: ...


This method can be used to send arbitrary requests to the server.

Valid values for HttpMethod are:

  • GET (default if empty)
  • HEAD
  • POST
  • PUT

The ObjectName and RequestBody parameters may be empty if not needed.


When this method is called, the class does the following:

  1. Builds a request URL, including query parameters, based on the following:
    • use_ssl, region, and use_virtual_hosting for the base URL.
      • Alternatively, if service_provider is spCustom (255), the custom URL specified using the URL configuration setting is used directly, and these properties are ignored.
    • bucket (if non-empty)
    • ObjectName (if non-empty)
    • version_id (if both it and ObjectName are non-empty)
    • QueryParam*
  2. Adds request headers from:
  3. Signs the request (unless the SignCustomRequest configuration setting is disabled).
  4. Sends the request, including RequestBody if non-empty.
  5. Stores the response headers in the ParsedHeader* properties; and the response body in the specified local_file, or object_data (using the same logic as get_object).

If the response body is XML data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks S3 2020 Python Edition - Version 20.0 [Build 8164]