Skip to content

Commit

Permalink
deploy: 6929b4b
Browse files Browse the repository at this point in the history
  • Loading branch information
zoj613 committed Nov 20, 2024
1 parent 0c631af commit d68840e
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion zarr-lwt/Zarr_lwt/Storage/AmazonS3Store/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@
<span><span class="label">bucket</span>:string <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">profile</span>:string <span class="arrow">&#45;&gt;</span></span>
<span><span>(<span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <span class="xref-unresolved">Lwt</span>.t</span>)</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="type-var">'a</span> <span class="xref-unresolved">Lwt</span>.t</span></span></code></div><div class="spec-doc"><p><code>with_open ~region ~bucket ~profile f</code> opens an S3 bucket store with bucket name <code>bucket</code> at region <code>region</code> using credentials specified by profile <code>profile</code>. The credentials are read locally from a <code>~/.aws/credentials</code> file or from an IAM service if the profile or file is not available. Function <code>f</code> is applied to the store's open handle and its output is returned to the caller.</p><ul><li><code>scheme</code> is the HTTP scheme to use when connecting to S3, and must be one of <code>`Http | `Https</code>. Defaults to <code>`Http</code>.</li><li><code>inet</code> is the IP version and must be one of <code>`V4 | `V6</code>. Defaults to <code>`V4</code>.</li><li><code>retries</code> is the number of times to retry a request should it return an error.</li></ul><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>S3_error</code> <p>if an error occurs while sending a request to the S3 service.</p></li></ul></div></div></div></body></html>
<span><span class="type-var">'a</span> <span class="xref-unresolved">Lwt</span>.t</span></span></code></div><div class="spec-doc"><p><code>with_open ~region ~bucket ~profile f</code> opens an S3 bucket store with bucket name <code>bucket</code> at region <code>region</code> using credentials specified by profile <code>profile</code>. The credentials are read locally from a <code>~/.aws/credentials</code> file or from an IAM service if the profile or file is not available. Function <code>f</code> is applied to the store's open handle and its output is returned to the caller.</p><ul><li><code>scheme</code> is the HTTP scheme to use when connecting to S3, and must be one of <code>`Http | `Https</code>. Defaults to <code>`Http</code>.</li><li><code>inet</code> is the IP version and must be one of <code>`V4 | `V6</code>. Defaults to <code>`V4</code>.</li><li><code>retries</code> is the number of times to retry a request should it return an error.</li></ul><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <a href="#exception-Request_failed"><code>Request_failed</code></a> <p>if an error occurs while sending a request to the S3 service.</p></li></ul></div></div></div></body></html>

0 comments on commit d68840e

Please sign in to comment.