pydoc/2.47.0/_modules/apache_beam/io/aws/clients/s3/messages.html - beam-site - Git at Google



 <!DOCTYPE html>
 <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
 <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
 <head>
   <meta charset="utf-8">

   <meta name="viewport" content="width=device-width, initial-scale=1.0">

   <title>apache_beam.io.aws.clients.s3.messages &mdash; Apache Beam 2.47.0 documentation</title>


   <script type="text/javascript" src="../../../../../../_static/js/modernizr.min.js"></script>


       <script type="text/javascript" id="documentation_options" data-url_root="../../../../../../" src="../../../../../../_static/documentation_options.js"></script>
         <script type="text/javascript" src="../../../../../../_static/jquery.js"></script>
         <script type="text/javascript" src="../../../../../../_static/underscore.js"></script>
         <script type="text/javascript" src="../../../../../../_static/doctools.js"></script>
         <script type="text/javascript" src="../../../../../../_static/language_data.js"></script>
         <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>

     <script type="text/javascript" src="../../../../../../_static/js/theme.js"></script>


   <link rel="stylesheet" href="../../../../../../_static/css/theme.css" type="text/css" />
   <link rel="stylesheet" href="../../../../../../_static/pygments.css" type="text/css" />
     <link rel="index" title="Index" href="../../../../../../genindex.html" />
     <link rel="search" title="Search" href="../../../../../../search.html" />
 </head>

 <body class="wy-body-for-nav">


   <div class="wy-grid-for-nav">

     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >


             <a href="../../../../../../index.html" class="icon icon-home"> Apache Beam


           </a>


               <div class="version">
                 2.47.0
               </div>


 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../../../../search.html" method="get">
     <input type="text" name="q" placeholder="Search docs" />
     <input type="hidden" name="check_keywords" value="yes" />
     <input type="hidden" name="area" value="default" />
   </form>
 </div>


         </div>

         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">


               <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.coders.html">apache_beam.coders package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.dataframe.html">apache_beam.dataframe package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.io.html">apache_beam.io package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.metrics.html">apache_beam.metrics package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.ml.html">apache_beam.ml package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.options.html">apache_beam.options package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.portability.html">apache_beam.portability package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.runners.html">apache_beam.runners package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.testing.html">apache_beam.testing package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.transforms.html">apache_beam.transforms package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.typehints.html">apache_beam.typehints package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.utils.html">apache_beam.utils package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.yaml.html">apache_beam.yaml package</a></li>
 </ul>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.error.html">apache_beam.error module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.pipeline.html">apache_beam.pipeline module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.pvalue.html">apache_beam.pvalue module</a></li>
 </ul>


         </div>
       </div>
     </nav>

     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">


       <nav class="wy-nav-top" aria-label="top navigation">

           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
           <a href="../../../../../../index.html">Apache Beam</a>

       </nav>


       <div class="wy-nav-content">

         <div class="rst-content">


 <div role="navigation" aria-label="breadcrumbs navigation">

   <ul class="wy-breadcrumbs">

       <li><a href="../../../../../../index.html">Docs</a> &raquo;</li>

           <li><a href="../../../../../index.html">Module code</a> &raquo;</li>

       <li>apache_beam.io.aws.clients.s3.messages</li>


       <li class="wy-breadcrumbs-aside">

       </li>

   </ul>


   <hr/>
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">

   <h1>Source code for apache_beam.io.aws.clients.s3.messages</h1><div class="highlight"><pre>
 <span></span><span class="c1">#</span>
 <span class="c1"># Licensed to the Apache Software Foundation (ASF) under one or more</span>
 <span class="c1"># contributor license agreements.  See the NOTICE file distributed with</span>
 <span class="c1"># this work for additional information regarding copyright ownership.</span>
 <span class="c1"># The ASF licenses this file to You under the Apache License, Version 2.0</span>
 <span class="c1"># (the &quot;License&quot;); you may not use this file except in compliance with</span>
 <span class="c1"># the License.  You may obtain a copy of the License at</span>
 <span class="c1">#</span>
 <span class="c1">#    http://www.apache.org/licenses/LICENSE-2.0</span>
 <span class="c1">#</span>
 <span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
 <span class="c1"># distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
 <span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
 <span class="c1"># See the License for the specific language governing permissions and</span>
 <span class="c1"># limitations under the License.</span>
 <span class="c1">#</span>

 <span class="c1"># pytype: skip-file</span>


 <div class="viewcode-block" id="GetRequest"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.messages.html#apache_beam.io.aws.clients.s3.messages.GetRequest">[docs]</a><span class="k">class</span> <span class="nc">GetRequest</span><span class="p">():</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">  S3 request object for `Get` command</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">bucket</span><span class="p">,</span> <span class="nb">object</span><span class="p">):</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">bucket</span> <span class="o">=</span> <span class="n">bucket</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">object</span> <span class="o">=</span> <span class="nb">object</span></div>


 <div class="viewcode-block" id="UploadResponse"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.messages.html#apache_beam.io.aws.clients.s3.messages.UploadResponse">[docs]</a><span class="k">class</span> <span class="nc">UploadResponse</span><span class="p">():</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">  S3 response object for `StartUpload` command</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">upload_id</span><span class="p">):</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">upload_id</span> <span class="o">=</span> <span class="n">upload_id</span></div>


 <div class="viewcode-block" id="UploadRequest"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.messages.html#apache_beam.io.aws.clients.s3.messages.UploadRequest">[docs]</a><span class="k">class</span> <span class="nc">UploadRequest</span><span class="p">():</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">  S3 request object for `StartUpload` command</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">bucket</span><span class="p">,</span> <span class="nb">object</span><span class="p">,</span> <span class="n">mime_type</span><span class="p">):</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">bucket</span> <span class="o">=</span> <span class="n">bucket</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">object</span> <span class="o">=</span> <span class="nb">object</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">mime_type</span> <span class="o">=</span> <span class="n">mime_type</span></div>


 <div class="viewcode-block" id="UploadPartRequest"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.messages.html#apache_beam.io.aws.clients.s3.messages.UploadPartRequest">[docs]</a><span class="k">class</span> <span class="nc">UploadPartRequest</span><span class="p">():</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">  S3 request object for `UploadPart` command</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">bucket</span><span class="p">,</span> <span class="nb">object</span><span class="p">,</span> <span class="n">upload_id</span><span class="p">,</span> <span class="n">part_number</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">):</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">bucket</span> <span class="o">=</span> <span class="n">bucket</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">object</span> <span class="o">=</span> <span class="nb">object</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">upload_id</span> <span class="o">=</span> <span class="n">upload_id</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">part_number</span> <span class="o">=</span> <span class="n">part_number</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">bytes</span> <span class="o">=</span> <span class="nb">bytes</span></div>
     <span class="c1"># self.mime_type = mime_type</span>


 <div class="viewcode-block" id="UploadPartResponse"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.messages.html#apache_beam.io.aws.clients.s3.messages.UploadPartResponse">[docs]</a><span class="k">class</span> <span class="nc">UploadPartResponse</span><span class="p">():</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">  S3 response object for `UploadPart` command</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">etag</span><span class="p">,</span> <span class="n">part_number</span><span class="p">):</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">etag</span> <span class="o">=</span> <span class="n">etag</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">part_number</span> <span class="o">=</span> <span class="n">part_number</span></div>


 <div class="viewcode-block" id="CompleteMultipartUploadRequest"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.messages.html#apache_beam.io.aws.clients.s3.messages.CompleteMultipartUploadRequest">[docs]</a><span class="k">class</span> <span class="nc">CompleteMultipartUploadRequest</span><span class="p">():</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">  S3 request object for `UploadPart` command</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">bucket</span><span class="p">,</span> <span class="nb">object</span><span class="p">,</span> <span class="n">upload_id</span><span class="p">,</span> <span class="n">parts</span><span class="p">):</span>
     <span class="c1"># parts is a list of objects of the form</span>
     <span class="c1"># {&#39;ETag&#39;: response.etag, &#39;PartNumber&#39;: response.part_number}</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">bucket</span> <span class="o">=</span> <span class="n">bucket</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">object</span> <span class="o">=</span> <span class="nb">object</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">upload_id</span> <span class="o">=</span> <span class="n">upload_id</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">parts</span> <span class="o">=</span> <span class="n">parts</span></div>
     <span class="c1"># self.mime_type = mime_type</span>


 <div class="viewcode-block" id="ListRequest"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.messages.html#apache_beam.io.aws.clients.s3.messages.ListRequest">[docs]</a><span class="k">class</span> <span class="nc">ListRequest</span><span class="p">():</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">  S3 request object for `List` command</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">bucket</span><span class="p">,</span> <span class="n">prefix</span><span class="p">,</span> <span class="n">continuation_token</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">bucket</span> <span class="o">=</span> <span class="n">bucket</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">prefix</span> <span class="o">=</span> <span class="n">prefix</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">continuation_token</span> <span class="o">=</span> <span class="n">continuation_token</span></div>


 <div class="viewcode-block" id="ListResponse"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.messages.html#apache_beam.io.aws.clients.s3.messages.ListResponse">[docs]</a><span class="k">class</span> <span class="nc">ListResponse</span><span class="p">():</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">  S3 response object for `List` command</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">items</span><span class="p">,</span> <span class="n">next_token</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">items</span> <span class="o">=</span> <span class="n">items</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">next_token</span> <span class="o">=</span> <span class="n">next_token</span></div>


 <div class="viewcode-block" id="Item"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.messages.html#apache_beam.io.aws.clients.s3.messages.Item">[docs]</a><span class="k">class</span> <span class="nc">Item</span><span class="p">():</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">  An item in S3</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">etag</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">last_modified</span><span class="p">,</span> <span class="n">size</span><span class="p">,</span> <span class="n">mime_type</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">etag</span> <span class="o">=</span> <span class="n">etag</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">key</span> <span class="o">=</span> <span class="n">key</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">last_modified</span> <span class="o">=</span> <span class="n">last_modified</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">size</span> <span class="o">=</span> <span class="n">size</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">mime_type</span> <span class="o">=</span> <span class="n">mime_type</span></div>


 <div class="viewcode-block" id="DeleteRequest"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.messages.html#apache_beam.io.aws.clients.s3.messages.DeleteRequest">[docs]</a><span class="k">class</span> <span class="nc">DeleteRequest</span><span class="p">():</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">  S3 request object for `Delete` command</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">bucket</span><span class="p">,</span> <span class="nb">object</span><span class="p">):</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">bucket</span> <span class="o">=</span> <span class="n">bucket</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">object</span> <span class="o">=</span> <span class="nb">object</span></div>


 <div class="viewcode-block" id="DeleteBatchRequest"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.messages.html#apache_beam.io.aws.clients.s3.messages.DeleteBatchRequest">[docs]</a><span class="k">class</span> <span class="nc">DeleteBatchRequest</span><span class="p">():</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">bucket</span><span class="p">,</span> <span class="n">objects</span><span class="p">):</span>
     <span class="c1"># `objects` is a list of strings corresponding to the keys to be deleted</span>
     <span class="c1"># in the bucket</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">bucket</span> <span class="o">=</span> <span class="n">bucket</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">objects</span> <span class="o">=</span> <span class="n">objects</span></div>


 <div class="viewcode-block" id="DeleteBatchResponse"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.messages.html#apache_beam.io.aws.clients.s3.messages.DeleteBatchResponse">[docs]</a><span class="k">class</span> <span class="nc">DeleteBatchResponse</span><span class="p">():</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">deleted</span><span class="p">,</span> <span class="n">failed</span><span class="p">,</span> <span class="n">errors</span><span class="p">):</span>
     <span class="c1"># `deleted` is a list of strings corresponding to the keys that were deleted</span>
     <span class="c1"># `failed` is a list of strings corresponding to the keys that caused errors</span>
     <span class="c1"># `errors` is a list of S3ClientErrors, aligned with the order of `failed`</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">deleted</span> <span class="o">=</span> <span class="n">deleted</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">failed</span> <span class="o">=</span> <span class="n">failed</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">errors</span> <span class="o">=</span> <span class="n">errors</span></div>


 <div class="viewcode-block" id="CopyRequest"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.messages.html#apache_beam.io.aws.clients.s3.messages.CopyRequest">[docs]</a><span class="k">class</span> <span class="nc">CopyRequest</span><span class="p">():</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">src_bucket</span><span class="p">,</span> <span class="n">src_key</span><span class="p">,</span> <span class="n">dest_bucket</span><span class="p">,</span> <span class="n">dest_key</span><span class="p">):</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">src_bucket</span> <span class="o">=</span> <span class="n">src_bucket</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">src_key</span> <span class="o">=</span> <span class="n">src_key</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">dest_bucket</span> <span class="o">=</span> <span class="n">dest_bucket</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">dest_key</span> <span class="o">=</span> <span class="n">dest_key</span></div>


 <div class="viewcode-block" id="S3ClientError"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.messages.html#apache_beam.io.aws.clients.s3.messages.S3ClientError">[docs]</a><span class="k">class</span> <span class="nc">S3ClientError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
   <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">code</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">message</span> <span class="o">=</span> <span class="n">message</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">code</span> <span class="o">=</span> <span class="n">code</span></div>
 </pre></div>

            </div>

           </div>
           <footer>


   <hr/>

   <div role="contentinfo">
     <p>
         &copy; Copyright

     </p>
   </div>
   Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.

 </footer>

         </div>
       </div>

     </section>

   </div>


   <script type="text/javascript">
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
   </script>


 </body>
 </html>