blob: e2839497aea09e0f4a080eaef5a853db7088c68b [file] [log] [blame]
<!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 module &mdash; Apache Beam 2.37.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" />
<link rel="next" title="apache_beam.io.aws.s3filesystem module" href="apache_beam.io.aws.s3filesystem.html" />
<link rel="prev" title="apache_beam.io.aws.clients.s3.fake_client module" href="apache_beam.io.aws.clients.s3.fake_client.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.37.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 class="current">
<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 current"><a class="reference internal" href="apache_beam.io.html">apache_beam.io package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="apache_beam.io.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="apache_beam.io.aws.html">apache_beam.io.aws package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="apache_beam.io.aws.html#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.io.aws.html#submodules">Submodules</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.azure.html">apache_beam.io.azure package</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.external.html">apache_beam.io.external package</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.flink.html">apache_beam.io.flink package</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.gcp.html">apache_beam.io.gcp package</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.io.html#submodules">Submodules</a></li>
</ul>
</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.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>
</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="apache_beam.io.html">apache_beam.io package</a> &raquo;</li>
<li><a href="apache_beam.io.aws.html">apache_beam.io.aws package</a> &raquo;</li>
<li><a href="apache_beam.io.aws.clients.html">apache_beam.io.aws.clients package</a> &raquo;</li>
<li><a href="apache_beam.io.aws.clients.s3.html">apache_beam.io.aws.clients.s3 package</a> &raquo;</li>
<li>apache_beam.io.aws.clients.s3.messages module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/apache_beam.io.aws.clients.s3.messages.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-apache_beam.io.aws.clients.s3.messages">
<span id="apache-beam-io-aws-clients-s3-messages-module"></span><h1>apache_beam.io.aws.clients.s3.messages module<a class="headerlink" href="#module-apache_beam.io.aws.clients.s3.messages" title="Permalink to this headline"></a></h1>
<dl class="class">
<dt id="apache_beam.io.aws.clients.s3.messages.GetRequest">
<em class="property">class </em><code class="descclassname">apache_beam.io.aws.clients.s3.messages.</code><code class="descname">GetRequest</code><span class="sig-paren">(</span><em>bucket</em>, <em>object</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/aws/clients/s3/messages.html#GetRequest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.aws.clients.s3.messages.GetRequest" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>S3 request object for <cite>Get</cite> command</p>
</dd></dl>
<dl class="class">
<dt id="apache_beam.io.aws.clients.s3.messages.UploadResponse">
<em class="property">class </em><code class="descclassname">apache_beam.io.aws.clients.s3.messages.</code><code class="descname">UploadResponse</code><span class="sig-paren">(</span><em>upload_id</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/aws/clients/s3/messages.html#UploadResponse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.aws.clients.s3.messages.UploadResponse" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>S3 response object for <cite>StartUpload</cite> command</p>
</dd></dl>
<dl class="class">
<dt id="apache_beam.io.aws.clients.s3.messages.UploadRequest">
<em class="property">class </em><code class="descclassname">apache_beam.io.aws.clients.s3.messages.</code><code class="descname">UploadRequest</code><span class="sig-paren">(</span><em>bucket</em>, <em>object</em>, <em>mime_type</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/aws/clients/s3/messages.html#UploadRequest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.aws.clients.s3.messages.UploadRequest" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>S3 request object for <cite>StartUpload</cite> command</p>
</dd></dl>
<dl class="class">
<dt id="apache_beam.io.aws.clients.s3.messages.UploadPartRequest">
<em class="property">class </em><code class="descclassname">apache_beam.io.aws.clients.s3.messages.</code><code class="descname">UploadPartRequest</code><span class="sig-paren">(</span><em>bucket</em>, <em>object</em>, <em>upload_id</em>, <em>part_number</em>, <em>bytes</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/aws/clients/s3/messages.html#UploadPartRequest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.aws.clients.s3.messages.UploadPartRequest" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>S3 request object for <cite>UploadPart</cite> command</p>
</dd></dl>
<dl class="class">
<dt id="apache_beam.io.aws.clients.s3.messages.UploadPartResponse">
<em class="property">class </em><code class="descclassname">apache_beam.io.aws.clients.s3.messages.</code><code class="descname">UploadPartResponse</code><span class="sig-paren">(</span><em>etag</em>, <em>part_number</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/aws/clients/s3/messages.html#UploadPartResponse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.aws.clients.s3.messages.UploadPartResponse" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>S3 response object for <cite>UploadPart</cite> command</p>
</dd></dl>
<dl class="class">
<dt id="apache_beam.io.aws.clients.s3.messages.CompleteMultipartUploadRequest">
<em class="property">class </em><code class="descclassname">apache_beam.io.aws.clients.s3.messages.</code><code class="descname">CompleteMultipartUploadRequest</code><span class="sig-paren">(</span><em>bucket</em>, <em>object</em>, <em>upload_id</em>, <em>parts</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/aws/clients/s3/messages.html#CompleteMultipartUploadRequest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.aws.clients.s3.messages.CompleteMultipartUploadRequest" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>S3 request object for <cite>UploadPart</cite> command</p>
</dd></dl>
<dl class="class">
<dt id="apache_beam.io.aws.clients.s3.messages.ListRequest">
<em class="property">class </em><code class="descclassname">apache_beam.io.aws.clients.s3.messages.</code><code class="descname">ListRequest</code><span class="sig-paren">(</span><em>bucket</em>, <em>prefix</em>, <em>continuation_token=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/aws/clients/s3/messages.html#ListRequest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.aws.clients.s3.messages.ListRequest" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>S3 request object for <cite>List</cite> command</p>
</dd></dl>
<dl class="class">
<dt id="apache_beam.io.aws.clients.s3.messages.ListResponse">
<em class="property">class </em><code class="descclassname">apache_beam.io.aws.clients.s3.messages.</code><code class="descname">ListResponse</code><span class="sig-paren">(</span><em>items</em>, <em>next_token=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/aws/clients/s3/messages.html#ListResponse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.aws.clients.s3.messages.ListResponse" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>S3 response object for <cite>List</cite> command</p>
</dd></dl>
<dl class="class">
<dt id="apache_beam.io.aws.clients.s3.messages.Item">
<em class="property">class </em><code class="descclassname">apache_beam.io.aws.clients.s3.messages.</code><code class="descname">Item</code><span class="sig-paren">(</span><em>etag</em>, <em>key</em>, <em>last_modified</em>, <em>size</em>, <em>mime_type=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/aws/clients/s3/messages.html#Item"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.aws.clients.s3.messages.Item" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>An item in S3</p>
</dd></dl>
<dl class="class">
<dt id="apache_beam.io.aws.clients.s3.messages.DeleteRequest">
<em class="property">class </em><code class="descclassname">apache_beam.io.aws.clients.s3.messages.</code><code class="descname">DeleteRequest</code><span class="sig-paren">(</span><em>bucket</em>, <em>object</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/aws/clients/s3/messages.html#DeleteRequest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.aws.clients.s3.messages.DeleteRequest" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>S3 request object for <cite>Delete</cite> command</p>
</dd></dl>
<dl class="class">
<dt id="apache_beam.io.aws.clients.s3.messages.DeleteBatchRequest">
<em class="property">class </em><code class="descclassname">apache_beam.io.aws.clients.s3.messages.</code><code class="descname">DeleteBatchRequest</code><span class="sig-paren">(</span><em>bucket</em>, <em>objects</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/aws/clients/s3/messages.html#DeleteBatchRequest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.aws.clients.s3.messages.DeleteBatchRequest" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
</dd></dl>
<dl class="class">
<dt id="apache_beam.io.aws.clients.s3.messages.DeleteBatchResponse">
<em class="property">class </em><code class="descclassname">apache_beam.io.aws.clients.s3.messages.</code><code class="descname">DeleteBatchResponse</code><span class="sig-paren">(</span><em>deleted</em>, <em>failed</em>, <em>errors</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/aws/clients/s3/messages.html#DeleteBatchResponse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.aws.clients.s3.messages.DeleteBatchResponse" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
</dd></dl>
<dl class="class">
<dt id="apache_beam.io.aws.clients.s3.messages.CopyRequest">
<em class="property">class </em><code class="descclassname">apache_beam.io.aws.clients.s3.messages.</code><code class="descname">CopyRequest</code><span class="sig-paren">(</span><em>src_bucket</em>, <em>src_key</em>, <em>dest_bucket</em>, <em>dest_key</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/aws/clients/s3/messages.html#CopyRequest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.aws.clients.s3.messages.CopyRequest" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
</dd></dl>
<dl class="exception">
<dt id="apache_beam.io.aws.clients.s3.messages.S3ClientError">
<em class="property">exception </em><code class="descclassname">apache_beam.io.aws.clients.s3.messages.</code><code class="descname">S3ClientError</code><span class="sig-paren">(</span><em>message=None</em>, <em>code=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/aws/clients/s3/messages.html#S3ClientError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.aws.clients.s3.messages.S3ClientError" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="apache_beam.io.aws.s3filesystem.html" class="btn btn-neutral float-right" title="apache_beam.io.aws.s3filesystem module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="apache_beam.io.aws.clients.s3.fake_client.html" class="btn btn-neutral float-left" title="apache_beam.io.aws.clients.s3.fake_client module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<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>