aws-sdk-rust 0.1.42

Important Enhancements: 1) Supports V2 and V4 API Signatures for third party S3 compliant products like Ceph 2) Works from behind proxies 3) Returned data can be in Rust structs, JSON or XML Works only for S3. Other AWS Storage features are coming soon!
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta name="generator" content="rustdoc">
    <meta name="description" content="API documentation for the Rust `aws` mod in crate `aws_sdk_rust`.">
    <meta name="keywords" content="rust, rustlang, rust-lang, aws">

    <title>aws_sdk_rust::aws - Rust</title>

    <link rel="stylesheet" type="text/css" href="../../normalize.css">
    <link rel="stylesheet" type="text/css" href="../../rustdoc.css">
    <link rel="stylesheet" type="text/css" href="../../main.css">
    

    <link rel="shortcut icon" href="https://lambdastackio.github.io/static/images/favicon.ico">
    
</head>
<body class="rustdoc mod">
    <!--[if lte IE 8]>
    <div class="warning">
        This old browser is unsupported and will most likely display funky
        things.
    </div>
    <![endif]-->

    

    <nav class="sidebar">
        <a href='../../aws_sdk_rust/index.html'><img src='https://lambdastackio.github.io/static/images/lambdastack-200x200.png' alt='logo' width='100'></a>
        <p class='location'>Module aws</p><div class="block items"><ul><li><a href="#modules">Modules</a></li></ul></div><p class='location'><a href='../index.html'>aws_sdk_rust</a></p><script>window.sidebarCurrent = {name: 'aws', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script>
    </nav>

    <nav class="sub">
        <form class="search-form js-only">
            <div class="search-container">
                <input class="search-input" name="search"
                       autocomplete="off"
                       placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
                       type="search">
            </div>
        </form>
    </nav>

    <section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Module <a href='../index.html'>aws_sdk_rust</a>::<wbr><a class="mod" href=''>aws</a></span><span class='out-of-band'><span id='render-detail'>
                   <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
                       [<span class='inner'>&#x2212;</span>]
                   </a>
               </span><a class='srclink' href='../../src/aws_sdk_rust/aws/mod.rs.html#16-61' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>Each of the modules listed below contain <code>Client</code> and <code>Library</code> documentation. At the top of
each file the documentation identifies if the given source file is mainly used for <code>Client</code>
or by the <code>Library</code>. Of course, we welcome <em>ALL</em> pull requests so digging into the <code>Library</code>
documentation is encouraged to get an idea how <code>aws-sdk-rust</code> works.</p>

<p>However, if you&#39;re only interested in how to use it from your app then skip the docs that
start with <code>Library</code> and focus on those that start with <code>Client</code>.</p>

<p>NB: ####Endpoint is the only non-unit structure that is not JSON encodable/decodable due to
third party Url struct. A custom to_json trait would need to be implemented. Not real impactful
since this struct is mainly used for initial endpoint connections.</p>

<p>NB: ####CompleteMultipartUploadRequest is <em>not</em> JSON decodable without implementing a custom to_json trait
because of Option&lt;&amp;&#39;a [u8]&gt;. You can still encode to JSON.</p>

<p>NB: ####PutObjectRequest is <em>not</em> JSON decodable without implementing a custom to_json trait
because of Option&lt;&amp;&#39;a [u8]&gt;. You can still encode to JSON.</p>

<p>NB: ####UploadPartRequest is <em>not</em> JSON decodable without implementing a custom to_json trait
because of Option&lt;&amp;&#39;a [u8]&gt;. You can still encode to JSON.</p>

<p>Example JSON output: (see /src/main.rs for full examples)
   use rustc_serialize::json;</p>

<p>let mut list_objects = ListObjectsRequest::default();
   list_objects.bucket = bucket_name.to_string();</p>

<p>match client.list_objects(&amp;list_objects) {
       Ok(objects) =&gt; {
           // Example of Serializing Rust struct
           println!(&quot;{:#?}&quot;, objects);
           // Example of converting to JSON. Can also call json::encode(&amp;objects).unwrap();
           println!(&quot;{}&quot;, json::as_pretty_json(&amp;objects));
       },
       Err(e) =&gt; println!(&quot;{:#?}&quot;, e)
   }</p>
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
<table>
                       <tr class=' module-item'>
                           <td><a class="mod" href="common/index.html"
                                  title='mod aws_sdk_rust::aws::common'>common</a></td>
                           <td class='docblock-short'>
                                <p><code>common</code> contains the type, struct, enum and impls that are common accross most requests
such as buckets, objects etc.
Contains both <code>Library</code> and <code>Client</code> documentation.</p>
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="mod" href="errors/index.html"
                                  title='mod aws_sdk_rust::aws::errors'>errors</a></td>
                           <td class='docblock-short'>
                                <p><code>errors</code> contains the type, struct, enum and impls of different Error Types.</p>
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="mod" href="s3/index.html"
                                  title='mod aws_sdk_rust::aws::s3'>s3</a></td>
                           <td class='docblock-short'>
                                <p><code>s3</code> contains the type, struct, enum and impls of all S3 only related items. Also, it contains
<code>S3Client</code> which is the interface used by applications.</p>
                           </td>
                       </tr></table></section>
    <section id='search' class="content hidden"></section>

    <section class="footer"></section>

    <aside id="help" class="hidden">
        <div>
            <h1 class="hidden">Help</h1>

            <div class="shortcuts">
                <h2>Keyboard Shortcuts</h2>

                <dl>
                    <dt>?</dt>
                    <dd>Show this help dialog</dd>
                    <dt>S</dt>
                    <dd>Focus the search field</dd>
                    <dt>&larrb;</dt>
                    <dd>Move up in search results</dd>
                    <dt>&rarrb;</dt>
                    <dd>Move down in search results</dd>
                    <dt>&#9166;</dt>
                    <dd>Go to active search result</dd>
                    <dt>+</dt>
                    <dd>Collapse/expand all sections</dd>
                </dl>
            </div>

            <div class="infos">
                <h2>Search Tricks</h2>

                <p>
                    Prefix searches with a type followed by a colon (e.g.
                    <code>fn:</code>) to restrict the search to a given type.
                </p>

                <p>
                    Accepted types are: <code>fn</code>, <code>mod</code>,
                    <code>struct</code>, <code>enum</code>,
                    <code>trait</code>, <code>type</code>, <code>macro</code>,
                    and <code>const</code>.
                </p>

                <p>
                    Search functions by type signature (e.g.
                    <code>vec -> usize</code> or <code>* -> vec</code>)
                </p>
            </div>
        </div>
    </aside>

    

    <script>
        window.rootPath = "../../";
        window.currentCrate = "aws_sdk_rust";
    </script>
    <script src="../../main.js"></script>
    <script defer src="../../search-index.js"></script>
</body>
</html>