| |
| |
| <!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.boto3_client — Apache Beam 2.38.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.38.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.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> »</li> |
| |
| <li><a href="../../../../../index.html">Module code</a> »</li> |
| |
| <li>apache_beam.io.aws.clients.s3.boto3_client</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.boto3_client</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 "License"); 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 "AS IS" 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> |
| |
| <span class="kn">from</span> <span class="nn">apache_beam.io.aws.clients.s3</span> <span class="kn">import</span> <span class="n">messages</span> |
| <span class="kn">from</span> <span class="nn">apache_beam.options</span> <span class="kn">import</span> <span class="n">pipeline_options</span> |
| <span class="kn">from</span> <span class="nn">apache_beam.utils</span> <span class="kn">import</span> <span class="n">retry</span> |
| |
| <span class="k">try</span><span class="p">:</span> |
| <span class="c1"># pylint: disable=wrong-import-order, wrong-import-position</span> |
| <span class="c1"># pylint: disable=ungrouped-imports</span> |
| <span class="kn">import</span> <span class="nn">boto3</span> |
| |
| <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span> |
| <span class="n">boto3</span> <span class="o">=</span> <span class="kc">None</span> |
| |
| |
| <div class="viewcode-block" id="get_http_error_code"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.boto3_client.html#apache_beam.io.aws.clients.s3.boto3_client.get_http_error_code">[docs]</a><span class="k">def</span> <span class="nf">get_http_error_code</span><span class="p">(</span><span class="n">exc</span><span class="p">):</span> |
| <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">exc</span><span class="p">,</span> <span class="s1">'response'</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">exc</span><span class="o">.</span><span class="n">response</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'ResponseMetadata'</span><span class="p">,</span> <span class="p">{})</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'HTTPStatusCode'</span><span class="p">)</span> |
| <span class="k">return</span> <span class="kc">None</span></div> |
| |
| |
| <div class="viewcode-block" id="Client"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.boto3_client.html#apache_beam.io.aws.clients.s3.boto3_client.Client">[docs]</a><span class="k">class</span> <span class="nc">Client</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Wrapper for boto3 library</span> |
| <span class="sd"> """</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">options</span><span class="p">):</span> |
| <span class="k">assert</span> <span class="n">boto3</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">,</span> <span class="s1">'Missing boto3 requirement'</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">options</span><span class="p">,</span> <span class="n">pipeline_options</span><span class="o">.</span><span class="n">PipelineOptions</span><span class="p">):</span> |
| <span class="n">s3_options</span> <span class="o">=</span> <span class="n">options</span><span class="o">.</span><span class="n">view_as</span><span class="p">(</span><span class="n">pipeline_options</span><span class="o">.</span><span class="n">S3Options</span><span class="p">)</span> |
| <span class="n">access_key_id</span> <span class="o">=</span> <span class="n">s3_options</span><span class="o">.</span><span class="n">s3_access_key_id</span> |
| <span class="n">secret_access_key</span> <span class="o">=</span> <span class="n">s3_options</span><span class="o">.</span><span class="n">s3_secret_access_key</span> |
| <span class="n">session_token</span> <span class="o">=</span> <span class="n">s3_options</span><span class="o">.</span><span class="n">s3_session_token</span> |
| <span class="n">endpoint_url</span> <span class="o">=</span> <span class="n">s3_options</span><span class="o">.</span><span class="n">s3_endpoint_url</span> |
| <span class="n">use_ssl</span> <span class="o">=</span> <span class="ow">not</span> <span class="n">s3_options</span><span class="o">.</span><span class="n">s3_disable_ssl</span> |
| <span class="n">region_name</span> <span class="o">=</span> <span class="n">s3_options</span><span class="o">.</span><span class="n">s3_region_name</span> |
| <span class="n">api_version</span> <span class="o">=</span> <span class="n">s3_options</span><span class="o">.</span><span class="n">s3_api_version</span> |
| <span class="n">verify</span> <span class="o">=</span> <span class="n">s3_options</span><span class="o">.</span><span class="n">s3_verify</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">access_key_id</span> <span class="o">=</span> <span class="n">options</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'s3_access_key_id'</span><span class="p">)</span> |
| <span class="n">secret_access_key</span> <span class="o">=</span> <span class="n">options</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'s3_secret_access_key'</span><span class="p">)</span> |
| <span class="n">session_token</span> <span class="o">=</span> <span class="n">options</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'s3_session_token'</span><span class="p">)</span> |
| <span class="n">endpoint_url</span> <span class="o">=</span> <span class="n">options</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'s3_endpoint_url'</span><span class="p">)</span> |
| <span class="n">use_ssl</span> <span class="o">=</span> <span class="ow">not</span> <span class="n">options</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'s3_disable_ssl'</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span> |
| <span class="n">region_name</span> <span class="o">=</span> <span class="n">options</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'s3_region_name'</span><span class="p">)</span> |
| <span class="n">api_version</span> <span class="o">=</span> <span class="n">options</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'s3_api_version'</span><span class="p">)</span> |
| <span class="n">verify</span> <span class="o">=</span> <span class="n">options</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'s3_verify'</span><span class="p">)</span> |
| |
| <span class="n">session</span> <span class="o">=</span> <span class="n">boto3</span><span class="o">.</span><span class="n">session</span><span class="o">.</span><span class="n">Session</span><span class="p">()</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">client</span> <span class="o">=</span> <span class="n">session</span><span class="o">.</span><span class="n">client</span><span class="p">(</span> |
| <span class="n">service_name</span><span class="o">=</span><span class="s1">'s3'</span><span class="p">,</span> |
| <span class="n">region_name</span><span class="o">=</span><span class="n">region_name</span><span class="p">,</span> |
| <span class="n">api_version</span><span class="o">=</span><span class="n">api_version</span><span class="p">,</span> |
| <span class="n">use_ssl</span><span class="o">=</span><span class="n">use_ssl</span><span class="p">,</span> |
| <span class="n">verify</span><span class="o">=</span><span class="n">verify</span><span class="p">,</span> |
| <span class="n">endpoint_url</span><span class="o">=</span><span class="n">endpoint_url</span><span class="p">,</span> |
| <span class="n">aws_access_key_id</span><span class="o">=</span><span class="n">access_key_id</span><span class="p">,</span> |
| <span class="n">aws_secret_access_key</span><span class="o">=</span><span class="n">secret_access_key</span><span class="p">,</span> |
| <span class="n">aws_session_token</span><span class="o">=</span><span class="n">session_token</span><span class="p">)</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_download_request</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_download_stream</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_download_pos</span> <span class="o">=</span> <span class="mi">0</span> |
| |
| <div class="viewcode-block" id="Client.get_object_metadata"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.boto3_client.html#apache_beam.io.aws.clients.s3.boto3_client.Client.get_object_metadata">[docs]</a> <span class="k">def</span> <span class="nf">get_object_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">):</span> |
| <span class="sd">"""Retrieves an object's metadata.</span> |
| |
| <span class="sd"> Args:</span> |
| <span class="sd"> request: (GetRequest) input message</span> |
| |
| <span class="sd"> Returns:</span> |
| <span class="sd"> (Object) The response message.</span> |
| <span class="sd"> """</span> |
| <span class="n">kwargs</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'Bucket'</span><span class="p">:</span> <span class="n">request</span><span class="o">.</span><span class="n">bucket</span><span class="p">,</span> <span class="s1">'Key'</span><span class="p">:</span> <span class="n">request</span><span class="o">.</span><span class="n">object</span><span class="p">}</span> |
| |
| <span class="k">try</span><span class="p">:</span> |
| <span class="n">boto_response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">head_object</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> |
| <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">messages</span><span class="o">.</span><span class="n">S3ClientError</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">),</span> <span class="n">get_http_error_code</span><span class="p">(</span><span class="n">e</span><span class="p">))</span> |
| |
| <span class="n">item</span> <span class="o">=</span> <span class="n">messages</span><span class="o">.</span><span class="n">Item</span><span class="p">(</span> |
| <span class="n">boto_response</span><span class="p">[</span><span class="s1">'ETag'</span><span class="p">],</span> |
| <span class="n">request</span><span class="o">.</span><span class="n">object</span><span class="p">,</span> |
| <span class="n">boto_response</span><span class="p">[</span><span class="s1">'LastModified'</span><span class="p">],</span> |
| <span class="n">boto_response</span><span class="p">[</span><span class="s1">'ContentLength'</span><span class="p">],</span> |
| <span class="n">boto_response</span><span class="p">[</span><span class="s1">'ContentType'</span><span class="p">])</span> |
| |
| <span class="k">return</span> <span class="n">item</span></div> |
| |
| <div class="viewcode-block" id="Client.get_stream"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.boto3_client.html#apache_beam.io.aws.clients.s3.boto3_client.Client.get_stream">[docs]</a> <span class="k">def</span> <span class="nf">get_stream</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">start</span><span class="p">):</span> |
| <span class="sd">"""Opens a stream object starting at the given position.</span> |
| |
| <span class="sd"> Args:</span> |
| <span class="sd"> request: (GetRequest) request</span> |
| <span class="sd"> start: (int) start offset</span> |
| <span class="sd"> Returns:</span> |
| <span class="sd"> (Stream) Boto3 stream object.</span> |
| <span class="sd"> """</span> |
| |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_download_request</span> <span class="ow">and</span> <span class="p">(</span> |
| <span class="n">start</span> <span class="o">!=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_download_pos</span> <span class="ow">or</span> |
| <span class="n">request</span><span class="o">.</span><span class="n">bucket</span> <span class="o">!=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_download_request</span><span class="o">.</span><span class="n">bucket</span> <span class="ow">or</span> |
| <span class="n">request</span><span class="o">.</span><span class="n">object</span> <span class="o">!=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_download_request</span><span class="o">.</span><span class="n">object</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_download_stream</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_download_stream</span> <span class="o">=</span> <span class="kc">None</span> |
| |
| <span class="c1"># noinspection PyProtectedMember</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_download_stream</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">_download_stream</span><span class="o">.</span><span class="n">_raw_stream</span><span class="o">.</span><span class="n">closed</span><span class="p">:</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_download_stream</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">get_object</span><span class="p">(</span> |
| <span class="n">Bucket</span><span class="o">=</span><span class="n">request</span><span class="o">.</span><span class="n">bucket</span><span class="p">,</span> |
| <span class="n">Key</span><span class="o">=</span><span class="n">request</span><span class="o">.</span><span class="n">object</span><span class="p">,</span> |
| <span class="n">Range</span><span class="o">=</span><span class="s1">'bytes=</span><span class="si">{}</span><span class="s1">-'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">start</span><span class="p">))[</span><span class="s1">'Body'</span><span class="p">]</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_download_request</span> <span class="o">=</span> <span class="n">request</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_download_pos</span> <span class="o">=</span> <span class="n">start</span> |
| <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">messages</span><span class="o">.</span><span class="n">S3ClientError</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">),</span> <span class="n">get_http_error_code</span><span class="p">(</span><span class="n">e</span><span class="p">))</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_download_stream</span></div> |
| |
| <div class="viewcode-block" id="Client.get_range"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.boto3_client.html#apache_beam.io.aws.clients.s3.boto3_client.Client.get_range">[docs]</a> <span class="nd">@retry</span><span class="o">.</span><span class="n">with_exponential_backoff</span><span class="p">()</span> |
| <span class="k">def</span> <span class="nf">get_range</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">start</span><span class="p">,</span> <span class="n">end</span><span class="p">):</span> |
| <span class="sa">r</span><span class="sd">"""Retrieves an object's contents.</span> |
| |
| <span class="sd"> Args:</span> |
| <span class="sd"> request: (GetRequest) request</span> |
| <span class="sd"> start: (int) start offset</span> |
| <span class="sd"> end: (int) end offset (exclusive)</span> |
| <span class="sd"> Returns:</span> |
| <span class="sd"> (bytes) The response message.</span> |
| <span class="sd"> """</span> |
| <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">2</span><span class="p">):</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="n">stream</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_stream</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">start</span><span class="p">)</span> |
| <span class="n">data</span> <span class="o">=</span> <span class="n">stream</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="n">end</span> <span class="o">-</span> <span class="n">start</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_download_pos</span> <span class="o">+=</span> <span class="nb">len</span><span class="p">(</span><span class="n">data</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">data</span> |
| <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_download_stream</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_download_request</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="k">if</span> <span class="n">i</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| <span class="c1"># Read errors are likely with long-lived connections, retry immediately if a read fails once</span> |
| <span class="k">continue</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">e</span><span class="p">,</span> <span class="n">messages</span><span class="o">.</span><span class="n">S3ClientError</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="n">e</span> |
| <span class="k">raise</span> <span class="n">messages</span><span class="o">.</span><span class="n">S3ClientError</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">),</span> <span class="n">get_http_error_code</span><span class="p">(</span><span class="n">e</span><span class="p">))</span></div> |
| |
| <div class="viewcode-block" id="Client.list"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.boto3_client.html#apache_beam.io.aws.clients.s3.boto3_client.Client.list">[docs]</a> <span class="k">def</span> <span class="nf">list</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">):</span> |
| <span class="sa">r</span><span class="sd">"""Retrieves a list of objects matching the criteria.</span> |
| |
| <span class="sd"> Args:</span> |
| <span class="sd"> request: (ListRequest) input message</span> |
| <span class="sd"> Returns:</span> |
| <span class="sd"> (ListResponse) The response message.</span> |
| <span class="sd"> """</span> |
| <span class="n">kwargs</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'Bucket'</span><span class="p">:</span> <span class="n">request</span><span class="o">.</span><span class="n">bucket</span><span class="p">,</span> <span class="s1">'Prefix'</span><span class="p">:</span> <span class="n">request</span><span class="o">.</span><span class="n">prefix</span><span class="p">}</span> |
| |
| <span class="k">if</span> <span class="n">request</span><span class="o">.</span><span class="n">continuation_token</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">kwargs</span><span class="p">[</span><span class="s1">'ContinuationToken'</span><span class="p">]</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">continuation_token</span> |
| |
| <span class="k">try</span><span class="p">:</span> |
| <span class="n">boto_response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">list_objects_v2</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> |
| <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">messages</span><span class="o">.</span><span class="n">S3ClientError</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">),</span> <span class="n">get_http_error_code</span><span class="p">(</span><span class="n">e</span><span class="p">))</span> |
| |
| <span class="k">if</span> <span class="n">boto_response</span><span class="p">[</span><span class="s1">'KeyCount'</span><span class="p">]</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| <span class="n">message</span> <span class="o">=</span> <span class="s1">'Tried to list nonexistent S3 path: s3://</span><span class="si">%s</span><span class="s1">/</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span> |
| <span class="n">request</span><span class="o">.</span><span class="n">bucket</span><span class="p">,</span> <span class="n">request</span><span class="o">.</span><span class="n">prefix</span><span class="p">)</span> |
| <span class="k">raise</span> <span class="n">messages</span><span class="o">.</span><span class="n">S3ClientError</span><span class="p">(</span><span class="n">message</span><span class="p">,</span> <span class="mi">404</span><span class="p">)</span> |
| |
| <span class="n">items</span> <span class="o">=</span> <span class="p">[</span> |
| <span class="n">messages</span><span class="o">.</span><span class="n">Item</span><span class="p">(</span> |
| <span class="n">etag</span><span class="o">=</span><span class="n">content</span><span class="p">[</span><span class="s1">'ETag'</span><span class="p">],</span> |
| <span class="n">key</span><span class="o">=</span><span class="n">content</span><span class="p">[</span><span class="s1">'Key'</span><span class="p">],</span> |
| <span class="n">last_modified</span><span class="o">=</span><span class="n">content</span><span class="p">[</span><span class="s1">'LastModified'</span><span class="p">],</span> |
| <span class="n">size</span><span class="o">=</span><span class="n">content</span><span class="p">[</span><span class="s1">'Size'</span><span class="p">])</span> <span class="k">for</span> <span class="n">content</span> <span class="ow">in</span> <span class="n">boto_response</span><span class="p">[</span><span class="s1">'Contents'</span><span class="p">]</span> |
| <span class="p">]</span> |
| |
| <span class="k">try</span><span class="p">:</span> |
| <span class="n">next_token</span> <span class="o">=</span> <span class="n">boto_response</span><span class="p">[</span><span class="s1">'NextContinuationToken'</span><span class="p">]</span> |
| <span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span> |
| <span class="n">next_token</span> <span class="o">=</span> <span class="kc">None</span> |
| |
| <span class="n">response</span> <span class="o">=</span> <span class="n">messages</span><span class="o">.</span><span class="n">ListResponse</span><span class="p">(</span><span class="n">items</span><span class="p">,</span> <span class="n">next_token</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">response</span></div> |
| |
| <div class="viewcode-block" id="Client.create_multipart_upload"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.boto3_client.html#apache_beam.io.aws.clients.s3.boto3_client.Client.create_multipart_upload">[docs]</a> <span class="k">def</span> <span class="nf">create_multipart_upload</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">):</span> |
| <span class="sa">r</span><span class="sd">"""Initates a multipart upload to S3 for a given object</span> |
| |
| <span class="sd"> Args:</span> |
| <span class="sd"> request: (UploadRequest) input message</span> |
| <span class="sd"> Returns:</span> |
| <span class="sd"> (UploadResponse) The response message.</span> |
| <span class="sd"> """</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="n">boto_response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">create_multipart_upload</span><span class="p">(</span> |
| <span class="n">Bucket</span><span class="o">=</span><span class="n">request</span><span class="o">.</span><span class="n">bucket</span><span class="p">,</span> |
| <span class="n">Key</span><span class="o">=</span><span class="n">request</span><span class="o">.</span><span class="n">object</span><span class="p">,</span> |
| <span class="n">ContentType</span><span class="o">=</span><span class="n">request</span><span class="o">.</span><span class="n">mime_type</span><span class="p">)</span> |
| <span class="n">response</span> <span class="o">=</span> <span class="n">messages</span><span class="o">.</span><span class="n">UploadResponse</span><span class="p">(</span><span class="n">boto_response</span><span class="p">[</span><span class="s1">'UploadId'</span><span class="p">])</span> |
| <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">messages</span><span class="o">.</span><span class="n">S3ClientError</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">),</span> <span class="n">get_http_error_code</span><span class="p">(</span><span class="n">e</span><span class="p">))</span> |
| <span class="k">return</span> <span class="n">response</span></div> |
| |
| <div class="viewcode-block" id="Client.upload_part"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.boto3_client.html#apache_beam.io.aws.clients.s3.boto3_client.Client.upload_part">[docs]</a> <span class="k">def</span> <span class="nf">upload_part</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">):</span> |
| <span class="sa">r</span><span class="sd">"""Uploads part of a file to S3 during a multipart upload</span> |
| |
| <span class="sd"> Args:</span> |
| <span class="sd"> request: (UploadPartRequest) input message</span> |
| <span class="sd"> Returns:</span> |
| <span class="sd"> (UploadPartResponse) The response message.</span> |
| <span class="sd"> """</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="n">boto_response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">upload_part</span><span class="p">(</span> |
| <span class="n">Body</span><span class="o">=</span><span class="n">request</span><span class="o">.</span><span class="n">bytes</span><span class="p">,</span> |
| <span class="n">Bucket</span><span class="o">=</span><span class="n">request</span><span class="o">.</span><span class="n">bucket</span><span class="p">,</span> |
| <span class="n">Key</span><span class="o">=</span><span class="n">request</span><span class="o">.</span><span class="n">object</span><span class="p">,</span> |
| <span class="n">PartNumber</span><span class="o">=</span><span class="n">request</span><span class="o">.</span><span class="n">part_number</span><span class="p">,</span> |
| <span class="n">UploadId</span><span class="o">=</span><span class="n">request</span><span class="o">.</span><span class="n">upload_id</span><span class="p">)</span> |
| <span class="n">response</span> <span class="o">=</span> <span class="n">messages</span><span class="o">.</span><span class="n">UploadPartResponse</span><span class="p">(</span> |
| <span class="n">boto_response</span><span class="p">[</span><span class="s1">'ETag'</span><span class="p">],</span> <span class="n">request</span><span class="o">.</span><span class="n">part_number</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">response</span> |
| <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">messages</span><span class="o">.</span><span class="n">S3ClientError</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">),</span> <span class="n">get_http_error_code</span><span class="p">(</span><span class="n">e</span><span class="p">))</span></div> |
| |
| <div class="viewcode-block" id="Client.complete_multipart_upload"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.boto3_client.html#apache_beam.io.aws.clients.s3.boto3_client.Client.complete_multipart_upload">[docs]</a> <span class="k">def</span> <span class="nf">complete_multipart_upload</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">):</span> |
| <span class="sa">r</span><span class="sd">"""Completes a multipart upload to S3</span> |
| |
| <span class="sd"> Args:</span> |
| <span class="sd"> request: (UploadPartRequest) input message</span> |
| <span class="sd"> Returns:</span> |
| <span class="sd"> (Void) The response message.</span> |
| <span class="sd"> """</span> |
| <span class="n">parts</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'Parts'</span><span class="p">:</span> <span class="n">request</span><span class="o">.</span><span class="n">parts</span><span class="p">}</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">complete_multipart_upload</span><span class="p">(</span> |
| <span class="n">Bucket</span><span class="o">=</span><span class="n">request</span><span class="o">.</span><span class="n">bucket</span><span class="p">,</span> |
| <span class="n">Key</span><span class="o">=</span><span class="n">request</span><span class="o">.</span><span class="n">object</span><span class="p">,</span> |
| <span class="n">UploadId</span><span class="o">=</span><span class="n">request</span><span class="o">.</span><span class="n">upload_id</span><span class="p">,</span> |
| <span class="n">MultipartUpload</span><span class="o">=</span><span class="n">parts</span><span class="p">)</span> |
| <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">messages</span><span class="o">.</span><span class="n">S3ClientError</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">),</span> <span class="n">get_http_error_code</span><span class="p">(</span><span class="n">e</span><span class="p">))</span></div> |
| |
| <div class="viewcode-block" id="Client.delete"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.boto3_client.html#apache_beam.io.aws.clients.s3.boto3_client.Client.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">):</span> |
| <span class="sa">r</span><span class="sd">"""Deletes given object from bucket</span> |
| <span class="sd"> Args:</span> |
| <span class="sd"> request: (DeleteRequest) input message</span> |
| <span class="sd"> Returns:</span> |
| <span class="sd"> (void) Void, otherwise will raise if an error occurs</span> |
| <span class="sd"> """</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">delete_object</span><span class="p">(</span><span class="n">Bucket</span><span class="o">=</span><span class="n">request</span><span class="o">.</span><span class="n">bucket</span><span class="p">,</span> <span class="n">Key</span><span class="o">=</span><span class="n">request</span><span class="o">.</span><span class="n">object</span><span class="p">)</span> |
| <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">messages</span><span class="o">.</span><span class="n">S3ClientError</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">),</span> <span class="n">get_http_error_code</span><span class="p">(</span><span class="n">e</span><span class="p">))</span></div> |
| |
| <div class="viewcode-block" id="Client.delete_batch"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.boto3_client.html#apache_beam.io.aws.clients.s3.boto3_client.Client.delete_batch">[docs]</a> <span class="k">def</span> <span class="nf">delete_batch</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">):</span> |
| |
| <span class="n">aws_request</span> <span class="o">=</span> <span class="p">{</span> |
| <span class="s1">'Bucket'</span><span class="p">:</span> <span class="n">request</span><span class="o">.</span><span class="n">bucket</span><span class="p">,</span> |
| <span class="s1">'Delete'</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s1">'Objects'</span><span class="p">:</span> <span class="p">[{</span> |
| <span class="s1">'Key'</span><span class="p">:</span> <span class="nb">object</span> |
| <span class="p">}</span> <span class="k">for</span> <span class="nb">object</span> <span class="ow">in</span> <span class="n">request</span><span class="o">.</span><span class="n">objects</span><span class="p">]</span> |
| <span class="p">}</span> |
| <span class="p">}</span> |
| |
| <span class="k">try</span><span class="p">:</span> |
| <span class="n">aws_response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">delete_objects</span><span class="p">(</span><span class="o">**</span><span class="n">aws_request</span><span class="p">)</span> |
| <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">messages</span><span class="o">.</span><span class="n">S3ClientError</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">),</span> <span class="n">get_http_error_code</span><span class="p">(</span><span class="n">e</span><span class="p">))</span> |
| |
| <span class="n">deleted</span> <span class="o">=</span> <span class="p">[</span><span class="n">obj</span><span class="p">[</span><span class="s1">'Key'</span><span class="p">]</span> <span class="k">for</span> <span class="n">obj</span> <span class="ow">in</span> <span class="n">aws_response</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'Deleted'</span><span class="p">,</span> <span class="p">[])]</span> |
| |
| <span class="n">failed</span> <span class="o">=</span> <span class="p">[</span><span class="n">obj</span><span class="p">[</span><span class="s1">'Key'</span><span class="p">]</span> <span class="k">for</span> <span class="n">obj</span> <span class="ow">in</span> <span class="n">aws_response</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'Errors'</span><span class="p">,</span> <span class="p">[])]</span> |
| |
| <span class="n">errors</span> <span class="o">=</span> <span class="p">[</span> |
| <span class="n">messages</span><span class="o">.</span><span class="n">S3ClientError</span><span class="p">(</span><span class="n">obj</span><span class="p">[</span><span class="s1">'Message'</span><span class="p">],</span> <span class="n">obj</span><span class="p">[</span><span class="s1">'Code'</span><span class="p">])</span> |
| <span class="k">for</span> <span class="n">obj</span> <span class="ow">in</span> <span class="n">aws_response</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'Errors'</span><span class="p">,</span> <span class="p">[])</span> |
| <span class="p">]</span> |
| |
| <span class="k">return</span> <span class="n">messages</span><span class="o">.</span><span class="n">DeleteBatchResponse</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></div> |
| |
| <div class="viewcode-block" id="Client.copy"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.boto3_client.html#apache_beam.io.aws.clients.s3.boto3_client.Client.copy">[docs]</a> <span class="k">def</span> <span class="nf">copy</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">):</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="n">copy_src</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'Bucket'</span><span class="p">:</span> <span class="n">request</span><span class="o">.</span><span class="n">src_bucket</span><span class="p">,</span> <span class="s1">'Key'</span><span class="p">:</span> <span class="n">request</span><span class="o">.</span><span class="n">src_key</span><span class="p">}</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="n">copy_src</span><span class="p">,</span> <span class="n">request</span><span class="o">.</span><span class="n">dest_bucket</span><span class="p">,</span> <span class="n">request</span><span class="o">.</span><span class="n">dest_key</span><span class="p">)</span> |
| <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">messages</span><span class="o">.</span><span class="n">S3ClientError</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">),</span> <span class="n">get_http_error_code</span><span class="p">(</span><span class="n">e</span><span class="p">))</span></div></div> |
| </pre></div> |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| © 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> |