CINXE.COM

<!doctype html> <html class="no-js" lang="en"> <head><meta charset="utf-8"/> <meta name="viewport" content="width=device-width,initial-scale=1"/> <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> <link rel="index" title="Index" href="../../genindex.html" /><link rel="search" title="Search" href="../../search.html" /><link rel="next" title="abort_multipart_upload" href="s3/client/abort_multipart_upload.html" /><link rel="prev" title="ListRumMetricsDestinations" href="rum/paginator/ListRumMetricsDestinations.html" />  <title>S3 - Boto3 1.35.68 documentation</title> <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" /> <link rel="stylesheet" type="text/css" href="../../_static/copybutton.css" /> <link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css" /> <style> body { --color-code-background: #f8f8f8; --color-code-foreground: black; } @media not print { body[data-theme="dark"] { --color-code-background: #272822; --color-code-foreground: #f8f8f2; } @media (prefers-color-scheme: dark) { body:not([data-theme="light"]) { --color-code-background: #272822; --color-code-foreground: #f8f8f2; } } } </style></head> <body> <script> document.body.dataset.theme = localStorage.getItem("theme") || "auto"; </script> <svg xmlns="http://www.w3.org/2000/svg" style="display: none;"> <symbol id="svg-toc" viewBox="0 0 24 24"> <title>Contents</title> <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024"> <path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/> </svg> </symbol> <symbol id="svg-menu" viewBox="0 0 24 24"> <title>Menu</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu"> <line x1="3" y1="12" x2="21" y2="12"></line> <line x1="3" y1="6" x2="21" y2="6"></line> <line x1="3" y1="18" x2="21" y2="18"></line> </svg> </symbol> <symbol id="svg-arrow-right" viewBox="0 0 24 24"> <title>Expand</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right"> <polyline points="9 18 15 12 9 6"></polyline> </svg> </symbol> <symbol id="svg-sun" viewBox="0 0 24 24"> <title>Light mode</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun"> <circle cx="12" cy="12" r="5"></circle> <line x1="12" y1="1" x2="12" y2="3"></line> <line x1="12" y1="21" x2="12" y2="23"></line> <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line> <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line> <line x1="1" y1="12" x2="3" y2="12"></line> <line x1="21" y1="12" x2="23" y2="12"></line> <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line> <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line> </svg> </symbol> <symbol id="svg-moon" viewBox="0 0 24 24"> <title>Dark mode</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon"> <path stroke="none" d="M0 0h24v24H0z" fill="none" /> <path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" /> </svg> </symbol> <symbol id="svg-sun-half" viewBox="0 0 24 24"> <title>Auto light/dark mode</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow"> <path stroke="none" d="M0 0h24v24H0z" fill="none"/> <circle cx="12" cy="12" r="9" /> <path d="M13 12h5" /> <path d="M13 15h4" /> <path d="M13 18h1" /> <path d="M13 9h4" /> <path d="M13 6h1" /> </svg> </symbol> </svg> <svg xmlns="http://www.w3.org/2000/svg" style="display: none;"> <symbol id="svg-close" viewBox="0 0 24 24"> <title>Close Menu</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" stroke="currentColor" stroke-width="3" stroke-linecap="round" stroke-linejoin="round" class="feather-menu"> <line x1="2" y1="22" x2="22" y2="2"/> <line x1="2" y1="2" x2="22" y2="22"/> </svg> </symbol> </svg> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation"> <input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc"> <label class="overlay sidebar-overlay" for="__navigation"> <div class="visually-hidden">Hide navigation sidebar</div> </label> <label class="overlay toc-overlay" for="__toc"> <div class="visually-hidden">Hide table of contents sidebar</div> </label> <div class="page"> <header class="mobile-header"> <div class="header-left"> <label class="nav-overlay-icon" id="nav-menu-open" for="__navigation" tabindex="0"> <div class="visually-hidden">Toggle site navigation sidebar</div> <i class="icon"><svg><use href="#svg-menu"></use></svg></i> </label> </div> <div class="header-center"> <a href="../../index.html"><div class="brand">Boto3 1.35.68 documentation</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> <button class="theme-toggle"> <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg> <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> </button> </div> <label class="toc-overlay-icon toc-header-icon" id="toc-menu-open-sm" for="__toc" tabindex="0"> <div class="visually-hidden">Toggle table of contents sidebar</div> <i class="icon"><svg><use href="#svg-toc"></use></svg></i> </label> </div> </header> <aside class="sidebar-drawer"> <div class="sidebar-container"> <div class="sidebar-sticky"><div class="sidebar-div show-div-sm justify-content-right"> <label class="nav-close-icon" id="nav-menu-close" for="__navigation" tabindex="0"> <div class="visually-hidden">Toggle site navigation sidebar</div> <i class="icon"><svg><use href="#svg-close"></use></svg></i> </label> </div><a class="sidebar-brand" href="../../index.html"> <div class="sidebar-logo-container"> <img class="sidebar-logo only-light" src="../../_static/logos/aws_light_theme_logo.svg" alt="Light Logo"/> <img class="sidebar-logo only-dark" src="../../_static/logos/aws_dark_theme_logo.svg" alt="Dark Logo"/> </div> <span class="sidebar-brand-text">Boto3 1.35.68 documentation</span> </a><form class="sidebar-search-container" method="get" action="../../search.html" role="search"> <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> <input type="hidden" name="check_keywords" value="yes"> <input type="hidden" name="area" value="default"> </form> <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-div"> <p class="sidebar-heading">Feedback</p> <p class="sidebar-text"> Do you have a suggestion to improve this website or boto3? <a href="https://github.com/boto/boto3/issues">Give us feedback</a>. </p> </div><div class="sidebar-tree"> <ul> <li class="toctree-l1"><a class="reference internal" href="../../guide/quickstart.html">Quickstart</a></li> <li class="toctree-l1"><a class="reference internal" href="../../guide/sqs.html">A Sample Tutorial</a></li> <li class="toctree-l1 has-children"><a class="reference internal" href="../../guide/examples.html">Code Examples</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l2 has-children"><a class="reference internal" href="../../guide/cw-examples.html">Amazon CloudWatch examples</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../../guide/cw-example-creating-alarms.html">Creating alarms in Amazon CloudWatch</a></li> <li class="toctree-l3"><a class="reference internal" href="../../guide/cw-example-using-alarms.html">Using alarm actions in Amazon CloudWatch</a></li> <li class="toctree-l3"><a class="reference internal" href="../../guide/cw-example-metrics.html">Getting metrics from Amazon CloudWatch</a></li> <li class="toctree-l3"><a class="reference internal" href="../../guide/cw-example-events.html">Sending events to Amazon CloudWatch Events</a></li> <li class="toctree-l3"><a class="reference internal" href="../../guide/cw-example-subscription-filters.html">Using subscription filters in Amazon CloudWatch Logs</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="../../guide/dynamodb.html">Amazon DynamoDB</a></li> <li class="toctree-l2 has-children"><a class="reference internal" href="../../guide/ec2-examples.html">Amazon EC2 examples</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../../guide/ec2-example-managing-instances.html">Managing Amazon EC2 instances</a></li> <li class="toctree-l3"><a class="reference internal" href="../../guide/ec2-example-key-pairs.html">Working with Amazon EC2 key pairs</a></li> <li class="toctree-l3"><a class="reference internal" href="../../guide/ec2-example-regions-avail-zones.html">Describe Amazon EC2 Regions and Availability Zones</a></li> <li class="toctree-l3"><a class="reference internal" href="../../guide/ec2-example-security-group.html">Working with security groups in Amazon EC2</a></li> <li class="toctree-l3"><a class="reference internal" href="../../guide/ec2-example-elastic-ip-addresses.html">Using Elastic IP addresses in Amazon EC2</a></li> </ul> </li> <li class="toctree-l2 has-children"><a class="reference internal" href="../../guide/iam-examples.html">AWS Identity and Access Management examples</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../../guide/iam-example-managing-users.html">Managing IAM users</a></li> <li class="toctree-l3"><a class="reference internal" href="../../guide/iam-example-policies.html">Working with IAM policies</a></li> <li class="toctree-l3"><a class="reference internal" href="../../guide/iam-example-managing-access-keys.html">Managing IAM access keys</a></li> <li class="toctree-l3"><a class="reference internal" href="../../guide/iam-example-server-certificates.html">Working with IAM server certificates</a></li> <li class="toctree-l3"><a class="reference internal" href="../../guide/iam-example-managing-account-aliases.html">Managing IAM account aliases</a></li> </ul> </li> <li class="toctree-l2 has-children"><a class="reference internal" href="../../guide/kms-examples.html">AWS Key Management Service (AWS KMS) examples</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../../guide/kms-example-encrypt-decrypt-file.html">Encrypt and decrypt a file</a></li> </ul> </li> <li class="toctree-l2 has-children"><a class="reference internal" href="../../guide/s3-examples.html">Amazon S3 examples</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../../guide/s3-example-creating-buckets.html">Amazon S3 buckets</a></li> <li class="toctree-l3"><a class="reference internal" href="../../guide/s3-uploading-files.html">Uploading files</a></li> <li class="toctree-l3"><a class="reference internal" href="../../guide/s3-example-download-file.html">Downloading files</a></li> <li class="toctree-l3"><a class="reference internal" href="../../guide/s3.html">File transfer configuration</a></li> <li class="toctree-l3"><a class="reference internal" href="../../guide/s3-presigned-urls.html">Presigned URLs</a></li> <li class="toctree-l3"><a class="reference internal" href="../../guide/s3-example-bucket-policies.html">Bucket policies</a></li> <li class="toctree-l3"><a class="reference internal" href="../../guide/s3-example-access-permissions.html">Access permissions</a></li> <li class="toctree-l3"><a class="reference internal" href="../../guide/s3-example-static-web-host.html">Using an Amazon S3 bucket as a static web host</a></li> <li class="toctree-l3"><a class="reference internal" href="../../guide/s3-example-configuring-buckets.html">Bucket CORS configuration</a></li> <li class="toctree-l3"><a class="reference internal" href="../../guide/s3-example-privatelink.html">AWS PrivateLink for Amazon S3</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="../../guide/secrets-manager.html">AWS Secrets Manager</a></li> <li class="toctree-l2 has-children"><a class="reference internal" href="../../guide/ses-examples.html">Amazon SES examples</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" role="switch" type="checkbox"/><label for="toctree-checkbox-7"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../../guide/ses-verify.html">Verifying email addresses</a></li> <li class="toctree-l3"><a class="reference internal" href="../../guide/ses-template.html">Working with email templates</a></li> <li class="toctree-l3"><a class="reference internal" href="../../guide/ses-filters.html">Managing email filters</a></li> <li class="toctree-l3"><a class="reference internal" href="../../guide/ses-rules.html">Using email rules</a></li> </ul> </li> <li class="toctree-l2 has-children"><a class="reference internal" href="../../guide/sqs-examples.html">Amazon SQS examples</a><input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" role="switch" type="checkbox"/><label for="toctree-checkbox-8"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../../guide/sqs-example-using-queues.html">Using queues in Amazon SQS</a></li> <li class="toctree-l3"><a class="reference internal" href="../../guide/sqs-example-sending-receiving-msgs.html">Sending and receiving messages in Amazon SQS</a></li> <li class="toctree-l3"><a class="reference internal" href="../../guide/sqs-example-visibility-timeout.html">Managing visibility timeout in Amazon SQS</a></li> <li class="toctree-l3"><a class="reference internal" href="../../guide/sqs-example-long-polling.html">Enabling long polling in Amazon SQS</a></li> <li class="toctree-l3"><a class="reference internal" href="../../guide/sqs-example-dead-letter-queue.html">Using dead-letter queues in Amazon SQS</a></li> </ul> </li> </ul> </li> </ul> <ul> <li class="toctree-l1 has-children"><a class="reference internal" href="../../guide/index.html">Developer Guide</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l2"><a class="reference internal" href="../../guide/configuration.html">Configuration</a></li> <li class="toctree-l2"><a class="reference internal" href="../../guide/credentials.html">Credentials</a></li> <li class="toctree-l2"><a class="reference internal" href="../../guide/clients.html">Low-level clients</a></li> <li class="toctree-l2"><a class="reference internal" href="../../guide/resources.html">Resources</a></li> <li class="toctree-l2"><a class="reference internal" href="../../guide/session.html">Session</a></li> <li class="toctree-l2"><a class="reference internal" href="../../guide/collections.html">Collections</a></li> <li class="toctree-l2"><a class="reference internal" href="../../guide/paginators.html">Paginators</a></li> <li class="toctree-l2"><a class="reference internal" href="../../guide/error-handling.html">Error handling</a></li> <li class="toctree-l2"><a class="reference internal" href="../../guide/retries.html">Retries</a></li> <li class="toctree-l2"><a class="reference internal" href="../../guide/events.html">Extensibility guide</a></li> <li class="toctree-l2"><a class="reference internal" href="../../guide/cloud9.html">Cloud9</a></li> <li class="toctree-l2"><a class="reference internal" href="../../guide/new.html">What鈥檚 new</a></li> <li class="toctree-l2 has-children"><a class="reference internal" href="../../guide/migration.html">Migrating from Boto 2.x</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../../guide/migrations3.html">Amazon S3</a></li> <li class="toctree-l3"><a class="reference internal" href="../../guide/migrationec2.html">Amazon EC2</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="../../guide/migrationpy3.html">Migrating to Python 3</a></li> <li class="toctree-l2"><a class="reference internal" href="../../guide/upgrading.html">Upgrading notes</a></li> </ul> </li> </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="../../guide/security.html">Security</a></li> </ul> <ul class="current"> <li class="toctree-l1 current has-children"><a class="reference internal" href="index.html">Available Services</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" role="switch" type="checkbox"/><label for="toctree-checkbox-11"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="accessanalyzer.html">AccessAnalyzer</a></li> <li class="toctree-l2"><a class="reference internal" href="account.html">Account</a></li> <li class="toctree-l2"><a class="reference internal" href="acm.html">ACM</a></li> <li class="toctree-l2"><a class="reference internal" href="acm-pca.html">ACMPCA</a></li> <li class="toctree-l2"><a class="reference internal" href="amp.html">PrometheusService</a></li> <li class="toctree-l2"><a class="reference internal" href="amplify.html">Amplify</a></li> <li class="toctree-l2"><a class="reference internal" href="amplifybackend.html">AmplifyBackend</a></li> <li class="toctree-l2"><a class="reference internal" href="amplifyuibuilder.html">AmplifyUIBuilder</a></li> <li class="toctree-l2"><a class="reference internal" href="apigateway.html">APIGateway</a></li> <li class="toctree-l2"><a class="reference internal" href="apigatewaymanagementapi.html">ApiGatewayManagementApi</a></li> <li class="toctree-l2"><a class="reference internal" href="apigatewayv2.html">ApiGatewayV2</a></li> <li class="toctree-l2"><a class="reference internal" href="appconfig.html">AppConfig</a></li> <li class="toctree-l2"><a class="reference internal" href="appconfigdata.html">AppConfigData</a></li> <li class="toctree-l2"><a class="reference internal" href="appfabric.html">AppFabric</a></li> <li class="toctree-l2"><a class="reference internal" href="appflow.html">Appflow</a></li> <li class="toctree-l2"><a class="reference internal" href="appintegrations.html">AppIntegrationsService</a></li> <li class="toctree-l2"><a class="reference internal" href="application-autoscaling.html">ApplicationAutoScaling</a></li> <li class="toctree-l2"><a class="reference internal" href="application-insights.html">ApplicationInsights</a></li> <li class="toctree-l2"><a class="reference internal" href="application-signals.html">CloudWatchApplicationSignals</a></li> <li class="toctree-l2"><a class="reference internal" href="applicationcostprofiler.html">ApplicationCostProfiler</a></li> <li class="toctree-l2"><a class="reference internal" href="appmesh.html">AppMesh</a></li> <li class="toctree-l2"><a class="reference internal" href="apprunner.html">AppRunner</a></li> <li class="toctree-l2"><a class="reference internal" href="appstream.html">AppStream</a></li> <li class="toctree-l2"><a class="reference internal" href="appsync.html">AppSync</a></li> <li class="toctree-l2"><a class="reference internal" href="apptest.html">MainframeModernizationApplicationTesting</a></li> <li class="toctree-l2"><a class="reference internal" href="arc-zonal-shift.html">ARCZonalShift</a></li> <li class="toctree-l2"><a class="reference internal" href="artifact.html">Artifact</a></li> <li class="toctree-l2"><a class="reference internal" href="athena.html">Athena</a></li> <li class="toctree-l2"><a class="reference internal" href="auditmanager.html">AuditManager</a></li> <li class="toctree-l2"><a class="reference internal" href="autoscaling.html">AutoScaling</a></li> <li class="toctree-l2"><a class="reference internal" href="autoscaling-plans.html">AutoScalingPlans</a></li> <li class="toctree-l2"><a class="reference internal" href="b2bi.html">B2BI</a></li> <li class="toctree-l2"><a class="reference internal" href="backup.html">Backup</a></li> <li class="toctree-l2"><a class="reference internal" href="backup-gateway.html">BackupGateway</a></li> <li class="toctree-l2"><a class="reference internal" href="batch.html">Batch</a></li> <li class="toctree-l2"><a class="reference internal" href="bcm-data-exports.html">BillingandCostManagementDataExports</a></li> <li class="toctree-l2"><a class="reference internal" href="bcm-pricing-calculator.html">BillingandCostManagementPricingCalculator</a></li> <li class="toctree-l2"><a class="reference internal" href="bedrock.html">Bedrock</a></li> <li class="toctree-l2"><a class="reference internal" href="bedrock-agent.html">AgentsforBedrock</a></li> <li class="toctree-l2"><a class="reference internal" href="bedrock-agent-runtime.html">AgentsforBedrockRuntime</a></li> <li class="toctree-l2"><a class="reference internal" href="bedrock-runtime.html">BedrockRuntime</a></li> <li class="toctree-l2"><a class="reference internal" href="billing.html">Billing</a></li> <li class="toctree-l2"><a class="reference internal" href="billingconductor.html">BillingConductor</a></li> <li class="toctree-l2"><a class="reference internal" href="braket.html">Braket</a></li> <li class="toctree-l2"><a class="reference internal" href="budgets.html">Budgets</a></li> <li class="toctree-l2"><a class="reference internal" href="ce.html">CostExplorer</a></li> <li class="toctree-l2"><a class="reference internal" href="chatbot.html">Chatbot</a></li> <li class="toctree-l2"><a class="reference internal" href="chime.html">Chime</a></li> <li class="toctree-l2"><a class="reference internal" href="chime-sdk-identity.html">ChimeSDKIdentity</a></li> <li class="toctree-l2"><a class="reference internal" href="chime-sdk-media-pipelines.html">ChimeSDKMediaPipelines</a></li> <li class="toctree-l2"><a class="reference internal" href="chime-sdk-meetings.html">ChimeSDKMeetings</a></li> <li class="toctree-l2"><a class="reference internal" href="chime-sdk-messaging.html">ChimeSDKMessaging</a></li> <li class="toctree-l2"><a class="reference internal" href="chime-sdk-voice.html">ChimeSDKVoice</a></li> <li class="toctree-l2"><a class="reference internal" href="cleanrooms.html">CleanRoomsService</a></li> <li class="toctree-l2"><a class="reference internal" href="cleanroomsml.html">CleanRoomsML</a></li> <li class="toctree-l2"><a class="reference internal" href="cloud9.html">Cloud9</a></li> <li class="toctree-l2"><a class="reference internal" href="cloudcontrol.html">CloudControlApi</a></li> <li class="toctree-l2"><a class="reference internal" href="clouddirectory.html">CloudDirectory</a></li> <li class="toctree-l2"><a class="reference internal" href="cloudformation.html">CloudFormation</a></li> <li class="toctree-l2"><a class="reference internal" href="cloudfront.html">CloudFront</a></li> <li class="toctree-l2"><a class="reference internal" href="cloudfront-keyvaluestore.html">CloudFrontKeyValueStore</a></li> <li class="toctree-l2"><a class="reference internal" href="cloudhsm.html">CloudHSM</a></li> <li class="toctree-l2"><a class="reference internal" href="cloudhsmv2.html">CloudHSMV2</a></li> <li class="toctree-l2"><a class="reference internal" href="cloudsearch.html">CloudSearch</a></li> <li class="toctree-l2"><a class="reference internal" href="cloudsearchdomain.html">CloudSearchDomain</a></li> <li class="toctree-l2"><a class="reference internal" href="cloudtrail.html">CloudTrail</a></li> <li class="toctree-l2"><a class="reference internal" href="cloudtrail-data.html">CloudTrailDataService</a></li> <li class="toctree-l2"><a class="reference internal" href="cloudwatch.html">CloudWatch</a></li> <li class="toctree-l2"><a class="reference internal" href="codeartifact.html">CodeArtifact</a></li> <li class="toctree-l2"><a class="reference internal" href="codebuild.html">CodeBuild</a></li> <li class="toctree-l2"><a class="reference internal" href="codecatalyst.html">CodeCatalyst</a></li> <li class="toctree-l2"><a class="reference internal" href="codecommit.html">CodeCommit</a></li> <li class="toctree-l2"><a class="reference internal" href="codeconnections.html">CodeConnections</a></li> <li class="toctree-l2"><a class="reference internal" href="codedeploy.html">CodeDeploy</a></li> <li class="toctree-l2"><a class="reference internal" href="codeguru-reviewer.html">CodeGuruReviewer</a></li> <li class="toctree-l2"><a class="reference internal" href="codeguru-security.html">CodeGuruSecurity</a></li> <li class="toctree-l2"><a class="reference internal" href="codeguruprofiler.html">CodeGuruProfiler</a></li> <li class="toctree-l2"><a class="reference internal" href="codepipeline.html">CodePipeline</a></li> <li class="toctree-l2"><a class="reference internal" href="codestar-connections.html">CodeStarconnections</a></li> <li class="toctree-l2"><a class="reference internal" href="codestar-notifications.html">CodeStarNotifications</a></li> <li class="toctree-l2"><a class="reference internal" href="cognito-identity.html">CognitoIdentity</a></li> <li class="toctree-l2"><a class="reference internal" href="cognito-idp.html">CognitoIdentityProvider</a></li> <li class="toctree-l2"><a class="reference internal" href="cognito-sync.html">CognitoSync</a></li> <li class="toctree-l2"><a class="reference internal" href="comprehend.html">Comprehend</a></li> <li class="toctree-l2"><a class="reference internal" href="comprehendmedical.html">ComprehendMedical</a></li> <li class="toctree-l2"><a class="reference internal" href="compute-optimizer.html">ComputeOptimizer</a></li> <li class="toctree-l2"><a class="reference internal" href="config.html">ConfigService</a></li> <li class="toctree-l2"><a class="reference internal" href="connect.html">Connect</a></li> <li class="toctree-l2"><a class="reference internal" href="connect-contact-lens.html">ConnectContactLens</a></li> <li class="toctree-l2"><a class="reference internal" href="connectcampaigns.html">ConnectCampaignService</a></li> <li class="toctree-l2"><a class="reference internal" href="connectcampaignsv2.html">ConnectCampaignServiceV2</a></li> <li class="toctree-l2"><a class="reference internal" href="connectcases.html">ConnectCases</a></li> <li class="toctree-l2"><a class="reference internal" href="connectparticipant.html">ConnectParticipant</a></li> <li class="toctree-l2"><a class="reference internal" href="controlcatalog.html">ControlCatalog</a></li> <li class="toctree-l2"><a class="reference internal" href="controltower.html">ControlTower</a></li> <li class="toctree-l2"><a class="reference internal" href="cost-optimization-hub.html">CostOptimizationHub</a></li> <li class="toctree-l2"><a class="reference internal" href="cur.html">CostandUsageReportService</a></li> <li class="toctree-l2"><a class="reference internal" href="customer-profiles.html">CustomerProfiles</a></li> <li class="toctree-l2"><a class="reference internal" href="databrew.html">GlueDataBrew</a></li> <li class="toctree-l2"><a class="reference internal" href="dataexchange.html">DataExchange</a></li> <li class="toctree-l2"><a class="reference internal" href="datapipeline.html">DataPipeline</a></li> <li class="toctree-l2"><a class="reference internal" href="datasync.html">DataSync</a></li> <li class="toctree-l2"><a class="reference internal" href="datazone.html">DataZone</a></li> <li class="toctree-l2"><a class="reference internal" href="dax.html">DAX</a></li> <li class="toctree-l2"><a class="reference internal" href="deadline.html">DeadlineCloud</a></li> <li class="toctree-l2"><a class="reference internal" href="detective.html">Detective</a></li> <li class="toctree-l2"><a class="reference internal" href="devicefarm.html">DeviceFarm</a></li> <li class="toctree-l2"><a class="reference internal" href="devops-guru.html">DevOpsGuru</a></li> <li class="toctree-l2"><a class="reference internal" href="directconnect.html">DirectConnect</a></li> <li class="toctree-l2"><a class="reference internal" href="discovery.html">ApplicationDiscoveryService</a></li> <li class="toctree-l2"><a class="reference internal" href="dlm.html">DLM</a></li> <li class="toctree-l2"><a class="reference internal" href="dms.html">DatabaseMigrationService</a></li> <li class="toctree-l2"><a class="reference internal" href="docdb.html">DocDB</a></li> <li class="toctree-l2"><a class="reference internal" href="docdb-elastic.html">DocDBElastic</a></li> <li class="toctree-l2"><a class="reference internal" href="drs.html">drs</a></li> <li class="toctree-l2"><a class="reference internal" href="ds.html">DirectoryService</a></li> <li class="toctree-l2"><a class="reference internal" href="ds-data.html">DirectoryServiceData</a></li> <li class="toctree-l2"><a class="reference internal" href="dynamodb.html">DynamoDB</a></li> <li class="toctree-l2"><a class="reference internal" href="dynamodbstreams.html">DynamoDBStreams</a></li> <li class="toctree-l2"><a class="reference internal" href="ebs.html">EBS</a></li> <li class="toctree-l2"><a class="reference internal" href="ec2.html">EC2</a></li> <li class="toctree-l2"><a class="reference internal" href="ec2-instance-connect.html">EC2InstanceConnect</a></li> <li class="toctree-l2"><a class="reference internal" href="ecr.html">ECR</a></li> <li class="toctree-l2"><a class="reference internal" href="ecr-public.html">ECRPublic</a></li> <li class="toctree-l2"><a class="reference internal" href="ecs.html">ECS</a></li> <li class="toctree-l2"><a class="reference internal" href="efs.html">EFS</a></li> <li class="toctree-l2"><a class="reference internal" href="eks.html">EKS</a></li> <li class="toctree-l2"><a class="reference internal" href="eks-auth.html">EKSAuth</a></li> <li class="toctree-l2"><a class="reference internal" href="elastic-inference.html">ElasticInference</a></li> <li class="toctree-l2"><a class="reference internal" href="elasticache.html">ElastiCache</a></li> <li class="toctree-l2"><a class="reference internal" href="elasticbeanstalk.html">ElasticBeanstalk</a></li> <li class="toctree-l2"><a class="reference internal" href="elastictranscoder.html">ElasticTranscoder</a></li> <li class="toctree-l2"><a class="reference internal" href="elb.html">ElasticLoadBalancing</a></li> <li class="toctree-l2"><a class="reference internal" href="elbv2.html">ElasticLoadBalancingv2</a></li> <li class="toctree-l2"><a class="reference internal" href="emr.html">EMR</a></li> <li class="toctree-l2"><a class="reference internal" href="emr-containers.html">EMRContainers</a></li> <li class="toctree-l2"><a class="reference internal" href="emr-serverless.html">EMRServerless</a></li> <li class="toctree-l2"><a class="reference internal" href="entityresolution.html">EntityResolution</a></li> <li class="toctree-l2"><a class="reference internal" href="es.html">ElasticsearchService</a></li> <li class="toctree-l2"><a class="reference internal" href="events.html">EventBridge</a></li> <li class="toctree-l2"><a class="reference internal" href="evidently.html">CloudWatchEvidently</a></li> <li class="toctree-l2"><a class="reference internal" href="finspace.html">finspace</a></li> <li class="toctree-l2"><a class="reference internal" href="finspace-data.html">FinSpaceData</a></li> <li class="toctree-l2"><a class="reference internal" href="firehose.html">Firehose</a></li> <li class="toctree-l2"><a class="reference internal" href="fis.html">FIS</a></li> <li class="toctree-l2"><a class="reference internal" href="fms.html">FMS</a></li> <li class="toctree-l2"><a class="reference internal" href="forecast.html">ForecastService</a></li> <li class="toctree-l2"><a class="reference internal" href="forecastquery.html">ForecastQueryService</a></li> <li class="toctree-l2"><a class="reference internal" href="frauddetector.html">FraudDetector</a></li> <li class="toctree-l2"><a class="reference internal" href="freetier.html">FreeTier</a></li> <li class="toctree-l2"><a class="reference internal" href="fsx.html">FSx</a></li> <li class="toctree-l2"><a class="reference internal" href="gamelift.html">GameLift</a></li> <li class="toctree-l2"><a class="reference internal" href="geo-maps.html">LocationServiceMapsV2</a></li> <li class="toctree-l2"><a class="reference internal" href="geo-places.html">LocationServicePlacesV2</a></li> <li class="toctree-l2"><a class="reference internal" href="geo-routes.html">LocationServiceRoutesV2</a></li> <li class="toctree-l2"><a class="reference internal" href="glacier.html">Glacier</a></li> <li class="toctree-l2"><a class="reference internal" href="globalaccelerator.html">GlobalAccelerator</a></li> <li class="toctree-l2"><a class="reference internal" href="glue.html">Glue</a></li> <li class="toctree-l2"><a class="reference internal" href="grafana.html">ManagedGrafana</a></li> <li class="toctree-l2"><a class="reference internal" href="greengrass.html">Greengrass</a></li> <li class="toctree-l2"><a class="reference internal" href="greengrassv2.html">GreengrassV2</a></li> <li class="toctree-l2"><a class="reference internal" href="groundstation.html">GroundStation</a></li> <li class="toctree-l2"><a class="reference internal" href="guardduty.html">GuardDuty</a></li> <li class="toctree-l2"><a class="reference internal" href="health.html">Health</a></li> <li class="toctree-l2"><a class="reference internal" href="healthlake.html">HealthLake</a></li> <li class="toctree-l2"><a class="reference internal" href="iam.html">IAM</a></li> <li class="toctree-l2"><a class="reference internal" href="identitystore.html">IdentityStore</a></li> <li class="toctree-l2"><a class="reference internal" href="imagebuilder.html">imagebuilder</a></li> <li class="toctree-l2"><a class="reference internal" href="importexport.html">ImportExport</a></li> <li class="toctree-l2"><a class="reference internal" href="inspector.html">Inspector</a></li> <li class="toctree-l2"><a class="reference internal" href="inspector-scan.html">inspectorscan</a></li> <li class="toctree-l2"><a class="reference internal" href="inspector2.html">Inspector2</a></li> <li class="toctree-l2"><a class="reference internal" href="internetmonitor.html">CloudWatchInternetMonitor</a></li> <li class="toctree-l2"><a class="reference internal" href="iot.html">IoT</a></li> <li class="toctree-l2"><a class="reference internal" href="iot-data.html">IoTDataPlane</a></li> <li class="toctree-l2"><a class="reference internal" href="iot-jobs-data.html">IoTJobsDataPlane</a></li> <li class="toctree-l2"><a class="reference internal" href="iot1click-devices.html">IoT1ClickDevicesService</a></li> <li class="toctree-l2"><a class="reference internal" href="iot1click-projects.html">IoT1ClickProjects</a></li> <li class="toctree-l2"><a class="reference internal" href="iotanalytics.html">IoTAnalytics</a></li> <li class="toctree-l2"><a class="reference internal" href="iotdeviceadvisor.html">IoTDeviceAdvisor</a></li> <li class="toctree-l2"><a class="reference internal" href="iotevents.html">IoTEvents</a></li> <li class="toctree-l2"><a class="reference internal" href="iotevents-data.html">IoTEventsData</a></li> <li class="toctree-l2"><a class="reference internal" href="iotfleethub.html">IoTFleetHub</a></li> <li class="toctree-l2"><a class="reference internal" href="iotfleetwise.html">IoTFleetWise</a></li> <li class="toctree-l2"><a class="reference internal" href="iotsecuretunneling.html">IoTSecureTunneling</a></li> <li class="toctree-l2"><a class="reference internal" href="iotsitewise.html">IoTSiteWise</a></li> <li class="toctree-l2"><a class="reference internal" href="iotthingsgraph.html">IoTThingsGraph</a></li> <li class="toctree-l2"><a class="reference internal" href="iottwinmaker.html">IoTTwinMaker</a></li> <li class="toctree-l2"><a class="reference internal" href="iotwireless.html">IoTWireless</a></li> <li class="toctree-l2"><a class="reference internal" href="ivs.html">IVS</a></li> <li class="toctree-l2"><a class="reference internal" href="ivs-realtime.html">ivsrealtime</a></li> <li class="toctree-l2"><a class="reference internal" href="ivschat.html">ivschat</a></li> <li class="toctree-l2"><a class="reference internal" href="kafka.html">Kafka</a></li> <li class="toctree-l2"><a class="reference internal" href="kafkaconnect.html">KafkaConnect</a></li> <li class="toctree-l2"><a class="reference internal" href="kendra.html">kendra</a></li> <li class="toctree-l2"><a class="reference internal" href="kendra-ranking.html">KendraRanking</a></li> <li class="toctree-l2"><a class="reference internal" href="keyspaces.html">Keyspaces</a></li> <li class="toctree-l2"><a class="reference internal" href="kinesis.html">Kinesis</a></li> <li class="toctree-l2"><a class="reference internal" href="kinesis-video-archived-media.html">KinesisVideoArchivedMedia</a></li> <li class="toctree-l2"><a class="reference internal" href="kinesis-video-media.html">KinesisVideoMedia</a></li> <li class="toctree-l2"><a class="reference internal" href="kinesis-video-signaling.html">KinesisVideoSignalingChannels</a></li> <li class="toctree-l2"><a class="reference internal" href="kinesis-video-webrtc-storage.html">KinesisVideoWebRTCStorage</a></li> <li class="toctree-l2"><a class="reference internal" href="kinesisanalytics.html">KinesisAnalytics</a></li> <li class="toctree-l2"><a class="reference internal" href="kinesisanalyticsv2.html">KinesisAnalyticsV2</a></li> <li class="toctree-l2"><a class="reference internal" href="kinesisvideo.html">KinesisVideo</a></li> <li class="toctree-l2"><a class="reference internal" href="kms.html">KMS</a></li> <li class="toctree-l2"><a class="reference internal" href="lakeformation.html">LakeFormation</a></li> <li class="toctree-l2"><a class="reference internal" href="lambda.html">Lambda</a></li> <li class="toctree-l2"><a class="reference internal" href="launch-wizard.html">LaunchWizard</a></li> <li class="toctree-l2"><a class="reference internal" href="lex-models.html">LexModelBuildingService</a></li> <li class="toctree-l2"><a class="reference internal" href="lex-runtime.html">LexRuntimeService</a></li> <li class="toctree-l2"><a class="reference internal" href="lexv2-models.html">LexModelsV2</a></li> <li class="toctree-l2"><a class="reference internal" href="lexv2-runtime.html">LexRuntimeV2</a></li> <li class="toctree-l2"><a class="reference internal" href="license-manager.html">LicenseManager</a></li> <li class="toctree-l2"><a class="reference internal" href="license-manager-linux-subscriptions.html">LicenseManagerLinuxSubscriptions</a></li> <li class="toctree-l2"><a class="reference internal" href="license-manager-user-subscriptions.html">LicenseManagerUserSubscriptions</a></li> <li class="toctree-l2"><a class="reference internal" href="lightsail.html">Lightsail</a></li> <li class="toctree-l2"><a class="reference internal" href="location.html">LocationService</a></li> <li class="toctree-l2"><a class="reference internal" href="logs.html">CloudWatchLogs</a></li> <li class="toctree-l2"><a class="reference internal" href="lookoutequipment.html">LookoutEquipment</a></li> <li class="toctree-l2"><a class="reference internal" href="lookoutmetrics.html">LookoutMetrics</a></li> <li class="toctree-l2"><a class="reference internal" href="lookoutvision.html">LookoutforVision</a></li> <li class="toctree-l2"><a class="reference internal" href="m2.html">MainframeModernization</a></li> <li class="toctree-l2"><a class="reference internal" href="machinelearning.html">MachineLearning</a></li> <li class="toctree-l2"><a class="reference internal" href="macie2.html">Macie2</a></li> <li class="toctree-l2"><a class="reference internal" href="mailmanager.html">MailManager</a></li> <li class="toctree-l2"><a class="reference internal" href="managedblockchain.html">ManagedBlockchain</a></li> <li class="toctree-l2"><a class="reference internal" href="managedblockchain-query.html">ManagedBlockchainQuery</a></li> <li class="toctree-l2"><a class="reference internal" href="marketplace-agreement.html">AgreementService</a></li> <li class="toctree-l2"><a class="reference internal" href="marketplace-catalog.html">MarketplaceCatalog</a></li> <li class="toctree-l2"><a class="reference internal" href="marketplace-deployment.html">MarketplaceDeploymentService</a></li> <li class="toctree-l2"><a class="reference internal" href="marketplace-entitlement.html">MarketplaceEntitlementService</a></li> <li class="toctree-l2"><a class="reference internal" href="marketplace-reporting.html">MarketplaceReportingService</a></li> <li class="toctree-l2"><a class="reference internal" href="marketplacecommerceanalytics.html">MarketplaceCommerceAnalytics</a></li> <li class="toctree-l2"><a class="reference internal" href="mediaconnect.html">MediaConnect</a></li> <li class="toctree-l2"><a class="reference internal" href="mediaconvert.html">MediaConvert</a></li> <li class="toctree-l2"><a class="reference internal" href="medialive.html">MediaLive</a></li> <li class="toctree-l2"><a class="reference internal" href="mediapackage.html">MediaPackage</a></li> <li class="toctree-l2"><a class="reference internal" href="mediapackage-vod.html">MediaPackageVod</a></li> <li class="toctree-l2"><a class="reference internal" href="mediapackagev2.html">mediapackagev2</a></li> <li class="toctree-l2"><a class="reference internal" href="mediastore.html">MediaStore</a></li> <li class="toctree-l2"><a class="reference internal" href="mediastore-data.html">MediaStoreData</a></li> <li class="toctree-l2"><a class="reference internal" href="mediatailor.html">MediaTailor</a></li> <li class="toctree-l2"><a class="reference internal" href="medical-imaging.html">HealthImaging</a></li> <li class="toctree-l2"><a class="reference internal" href="memorydb.html">MemoryDB</a></li> <li class="toctree-l2"><a class="reference internal" href="meteringmarketplace.html">MarketplaceMetering</a></li> <li class="toctree-l2"><a class="reference internal" href="mgh.html">MigrationHub</a></li> <li class="toctree-l2"><a class="reference internal" href="mgn.html">mgn</a></li> <li class="toctree-l2"><a class="reference internal" href="migration-hub-refactor-spaces.html">MigrationHubRefactorSpaces</a></li> <li class="toctree-l2"><a class="reference internal" href="migrationhub-config.html">MigrationHubConfig</a></li> <li class="toctree-l2"><a class="reference internal" href="migrationhuborchestrator.html">MigrationHubOrchestrator</a></li> <li class="toctree-l2"><a class="reference internal" href="migrationhubstrategy.html">MigrationHubStrategyRecommendations</a></li> <li class="toctree-l2"><a class="reference internal" href="mq.html">MQ</a></li> <li class="toctree-l2"><a class="reference internal" href="mturk.html">MTurk</a></li> <li class="toctree-l2"><a class="reference internal" href="mwaa.html">MWAA</a></li> <li class="toctree-l2"><a class="reference internal" href="neptune.html">Neptune</a></li> <li class="toctree-l2"><a class="reference internal" href="neptune-graph.html">NeptuneGraph</a></li> <li class="toctree-l2"><a class="reference internal" href="neptunedata.html">NeptuneData</a></li> <li class="toctree-l2"><a class="reference internal" href="network-firewall.html">NetworkFirewall</a></li> <li class="toctree-l2"><a class="reference internal" href="networkmanager.html">NetworkManager</a></li> <li class="toctree-l2"><a class="reference internal" href="networkmonitor.html">CloudWatchNetworkMonitor</a></li> <li class="toctree-l2"><a class="reference internal" href="notifications.html">UserNotifications</a></li> <li class="toctree-l2"><a class="reference internal" href="notificationscontacts.html">UserNotificationsContacts</a></li> <li class="toctree-l2"><a class="reference internal" href="oam.html">CloudWatchObservabilityAccessManager</a></li> <li class="toctree-l2"><a class="reference internal" href="omics.html">Omics</a></li> <li class="toctree-l2"><a class="reference internal" href="opensearch.html">OpenSearchService</a></li> <li class="toctree-l2"><a class="reference internal" href="opensearchserverless.html">OpenSearchServiceServerless</a></li> <li class="toctree-l2"><a class="reference internal" href="opsworks.html">OpsWorks</a></li> <li class="toctree-l2"><a class="reference internal" href="opsworkscm.html">OpsWorksCM</a></li> <li class="toctree-l2"><a class="reference internal" href="organizations.html">Organizations</a></li> <li class="toctree-l2"><a class="reference internal" href="osis.html">OpenSearchIngestion</a></li> <li class="toctree-l2"><a class="reference internal" href="outposts.html">Outposts</a></li> <li class="toctree-l2"><a class="reference internal" href="panorama.html">Panorama</a></li> <li class="toctree-l2"><a class="reference internal" href="partnercentral-selling.html">PartnerCentralSellingAPI</a></li> <li class="toctree-l2"><a class="reference internal" href="payment-cryptography.html">PaymentCryptographyControlPlane</a></li> <li class="toctree-l2"><a class="reference internal" href="payment-cryptography-data.html">PaymentCryptographyDataPlane</a></li> <li class="toctree-l2"><a class="reference internal" href="pca-connector-ad.html">PcaConnectorAd</a></li> <li class="toctree-l2"><a class="reference internal" href="pca-connector-scep.html">PrivateCAConnectorforSCEP</a></li> <li class="toctree-l2"><a class="reference internal" href="pcs.html">ParallelComputingService</a></li> <li class="toctree-l2"><a class="reference internal" href="personalize.html">Personalize</a></li> <li class="toctree-l2"><a class="reference internal" href="personalize-events.html">PersonalizeEvents</a></li> <li class="toctree-l2"><a class="reference internal" href="personalize-runtime.html">PersonalizeRuntime</a></li> <li class="toctree-l2"><a class="reference internal" href="pi.html">PI</a></li> <li class="toctree-l2"><a class="reference internal" href="pinpoint.html">Pinpoint</a></li> <li class="toctree-l2"><a class="reference internal" href="pinpoint-email.html">PinpointEmail</a></li> <li class="toctree-l2"><a class="reference internal" href="pinpoint-sms-voice.html">PinpointSMSVoice</a></li> <li class="toctree-l2"><a class="reference internal" href="pinpoint-sms-voice-v2.html">PinpointSMSVoiceV2</a></li> <li class="toctree-l2"><a class="reference internal" href="pipes.html">EventBridgePipes</a></li> <li class="toctree-l2"><a class="reference internal" href="polly.html">Polly</a></li> <li class="toctree-l2"><a class="reference internal" href="pricing.html">Pricing</a></li> <li class="toctree-l2"><a class="reference internal" href="privatenetworks.html">Private5G</a></li> <li class="toctree-l2"><a class="reference internal" href="proton.html">Proton</a></li> <li class="toctree-l2"><a class="reference internal" href="qapps.html">QApps</a></li> <li class="toctree-l2"><a class="reference internal" href="qbusiness.html">QBusiness</a></li> <li class="toctree-l2"><a class="reference internal" href="qconnect.html">QConnect</a></li> <li class="toctree-l2"><a class="reference internal" href="qldb.html">QLDB</a></li> <li class="toctree-l2"><a class="reference internal" href="qldb-session.html">QLDBSession</a></li> <li class="toctree-l2"><a class="reference internal" href="quicksight.html">QuickSight</a></li> <li class="toctree-l2"><a class="reference internal" href="ram.html">RAM</a></li> <li class="toctree-l2"><a class="reference internal" href="rbin.html">RecycleBin</a></li> <li class="toctree-l2"><a class="reference internal" href="rds.html">RDS</a></li> <li class="toctree-l2"><a class="reference internal" href="rds-data.html">RDSDataService</a></li> <li class="toctree-l2"><a class="reference internal" href="redshift.html">Redshift</a></li> <li class="toctree-l2"><a class="reference internal" href="redshift-data.html">RedshiftDataAPIService</a></li> <li class="toctree-l2"><a class="reference internal" href="redshift-serverless.html">RedshiftServerless</a></li> <li class="toctree-l2"><a class="reference internal" href="rekognition.html">Rekognition</a></li> <li class="toctree-l2"><a class="reference internal" href="repostspace.html">rePostPrivate</a></li> <li class="toctree-l2"><a class="reference internal" href="resiliencehub.html">ResilienceHub</a></li> <li class="toctree-l2"><a class="reference internal" href="resource-explorer-2.html">ResourceExplorer</a></li> <li class="toctree-l2"><a class="reference internal" href="resource-groups.html">ResourceGroups</a></li> <li class="toctree-l2"><a class="reference internal" href="resourcegroupstaggingapi.html">ResourceGroupsTaggingAPI</a></li> <li class="toctree-l2"><a class="reference internal" href="robomaker.html">RoboMaker</a></li> <li class="toctree-l2"><a class="reference internal" href="rolesanywhere.html">IAMRolesAnywhere</a></li> <li class="toctree-l2"><a class="reference internal" href="route53.html">Route53</a></li> <li class="toctree-l2"><a class="reference internal" href="route53-recovery-cluster.html">Route53RecoveryCluster</a></li> <li class="toctree-l2"><a class="reference internal" href="route53-recovery-control-config.html">Route53RecoveryControlConfig</a></li> <li class="toctree-l2"><a class="reference internal" href="route53-recovery-readiness.html">Route53RecoveryReadiness</a></li> <li class="toctree-l2"><a class="reference internal" href="route53domains.html">Route53Domains</a></li> <li class="toctree-l2"><a class="reference internal" href="route53profiles.html">Route53Profiles</a></li> <li class="toctree-l2"><a class="reference internal" href="route53resolver.html">Route53Resolver</a></li> <li class="toctree-l2"><a class="reference internal" href="rum.html">CloudWatchRUM</a></li> <li class="toctree-l2 current current-page"><a class="current reference internal" href="#">S3</a></li> <li class="toctree-l2"><a class="reference internal" href="s3control.html">S3Control</a></li> <li class="toctree-l2"><a class="reference internal" href="s3outposts.html">S3Outposts</a></li> <li class="toctree-l2"><a class="reference internal" href="sagemaker.html">SageMaker</a></li> <li class="toctree-l2"><a class="reference internal" href="sagemaker-a2i-runtime.html">AugmentedAIRuntime</a></li> <li class="toctree-l2"><a class="reference internal" href="sagemaker-edge.html">SagemakerEdgeManager</a></li> <li class="toctree-l2"><a class="reference internal" href="sagemaker-featurestore-runtime.html">SageMakerFeatureStoreRuntime</a></li> <li class="toctree-l2"><a class="reference internal" href="sagemaker-geospatial.html">SageMakergeospatialcapabilities</a></li> <li class="toctree-l2"><a class="reference internal" href="sagemaker-metrics.html">SageMakerMetrics</a></li> <li class="toctree-l2"><a class="reference internal" href="sagemaker-runtime.html">SageMakerRuntime</a></li> <li class="toctree-l2"><a class="reference internal" href="savingsplans.html">SavingsPlans</a></li> <li class="toctree-l2"><a class="reference internal" href="scheduler.html">EventBridgeScheduler</a></li> <li class="toctree-l2"><a class="reference internal" href="schemas.html">Schemas</a></li> <li class="toctree-l2"><a class="reference internal" href="sdb.html">SimpleDB</a></li> <li class="toctree-l2"><a class="reference internal" href="secretsmanager.html">SecretsManager</a></li> <li class="toctree-l2"><a class="reference internal" href="securityhub.html">SecurityHub</a></li> <li class="toctree-l2"><a class="reference internal" href="securitylake.html">SecurityLake</a></li> <li class="toctree-l2"><a class="reference internal" href="serverlessrepo.html">ServerlessApplicationRepository</a></li> <li class="toctree-l2"><a class="reference internal" href="service-quotas.html">ServiceQuotas</a></li> <li class="toctree-l2"><a class="reference internal" href="servicecatalog.html">ServiceCatalog</a></li> <li class="toctree-l2"><a class="reference internal" href="servicecatalog-appregistry.html">AppRegistry</a></li> <li class="toctree-l2"><a class="reference internal" href="servicediscovery.html">ServiceDiscovery</a></li> <li class="toctree-l2"><a class="reference internal" href="ses.html">SES</a></li> <li class="toctree-l2"><a class="reference internal" href="sesv2.html">SESV2</a></li> <li class="toctree-l2"><a class="reference internal" href="shield.html">Shield</a></li> <li class="toctree-l2"><a class="reference internal" href="signer.html">signer</a></li> <li class="toctree-l2"><a class="reference internal" href="simspaceweaver.html">SimSpaceWeaver</a></li> <li class="toctree-l2"><a class="reference internal" href="sms.html">SMS</a></li> <li class="toctree-l2"><a class="reference internal" href="snow-device-management.html">SnowDeviceManagement</a></li> <li class="toctree-l2"><a class="reference internal" href="snowball.html">Snowball</a></li> <li class="toctree-l2"><a class="reference internal" href="sns.html">SNS</a></li> <li class="toctree-l2"><a class="reference internal" href="socialmessaging.html">EndUserMessagingSocial</a></li> <li class="toctree-l2"><a class="reference internal" href="sqs.html">SQS</a></li> <li class="toctree-l2"><a class="reference internal" href="ssm.html">SSM</a></li> <li class="toctree-l2"><a class="reference internal" href="ssm-contacts.html">SSMContacts</a></li> <li class="toctree-l2"><a class="reference internal" href="ssm-incidents.html">SSMIncidents</a></li> <li class="toctree-l2"><a class="reference internal" href="ssm-quicksetup.html">SystemsManagerQuickSetup</a></li> <li class="toctree-l2"><a class="reference internal" href="ssm-sap.html">SsmSap</a></li> <li class="toctree-l2"><a class="reference internal" href="sso.html">SSO</a></li> <li class="toctree-l2"><a class="reference internal" href="sso-admin.html">SSOAdmin</a></li> <li class="toctree-l2"><a class="reference internal" href="sso-oidc.html">SSOOIDC</a></li> <li class="toctree-l2"><a class="reference internal" href="stepfunctions.html">SFN</a></li> <li class="toctree-l2"><a class="reference internal" href="storagegateway.html">StorageGateway</a></li> <li class="toctree-l2"><a class="reference internal" href="sts.html">STS</a></li> <li class="toctree-l2"><a class="reference internal" href="supplychain.html">SupplyChain</a></li> <li class="toctree-l2"><a class="reference internal" href="support.html">Support</a></li> <li class="toctree-l2"><a class="reference internal" href="support-app.html">SupportApp</a></li> <li class="toctree-l2"><a class="reference internal" href="swf.html">SWF</a></li> <li class="toctree-l2"><a class="reference internal" href="synthetics.html">Synthetics</a></li> <li class="toctree-l2"><a class="reference internal" href="taxsettings.html">TaxSettings</a></li> <li class="toctree-l2"><a class="reference internal" href="textract.html">Textract</a></li> <li class="toctree-l2"><a class="reference internal" href="timestream-influxdb.html">TimestreamInfluxDB</a></li> <li class="toctree-l2"><a class="reference internal" href="timestream-query.html">TimestreamQuery</a></li> <li class="toctree-l2"><a class="reference internal" href="timestream-write.html">TimestreamWrite</a></li> <li class="toctree-l2"><a class="reference internal" href="tnb.html">TelcoNetworkBuilder</a></li> <li class="toctree-l2"><a class="reference internal" href="transcribe.html">TranscribeService</a></li> <li class="toctree-l2"><a class="reference internal" href="transfer.html">Transfer</a></li> <li class="toctree-l2"><a class="reference internal" href="translate.html">Translate</a></li> <li class="toctree-l2"><a class="reference internal" href="trustedadvisor.html">TrustedAdvisorPublicAPI</a></li> <li class="toctree-l2"><a class="reference internal" href="verifiedpermissions.html">VerifiedPermissions</a></li> <li class="toctree-l2"><a class="reference internal" href="voice-id.html">VoiceID</a></li> <li class="toctree-l2"><a class="reference internal" href="vpc-lattice.html">VPCLattice</a></li> <li class="toctree-l2"><a class="reference internal" href="waf.html">WAF</a></li> <li class="toctree-l2"><a class="reference internal" href="waf-regional.html">WAFRegional</a></li> <li class="toctree-l2"><a class="reference internal" href="wafv2.html">WAFV2</a></li> <li class="toctree-l2"><a class="reference internal" href="wellarchitected.html">WellArchitected</a></li> <li class="toctree-l2"><a class="reference internal" href="wisdom.html">ConnectWisdomService</a></li> <li class="toctree-l2"><a class="reference internal" href="workdocs.html">WorkDocs</a></li> <li class="toctree-l2"><a class="reference internal" href="workmail.html">WorkMail</a></li> <li class="toctree-l2"><a class="reference internal" href="workmailmessageflow.html">WorkMailMessageFlow</a></li> <li class="toctree-l2"><a class="reference internal" href="workspaces.html">WorkSpaces</a></li> <li class="toctree-l2"><a class="reference internal" href="workspaces-thin-client.html">WorkSpacesThinClient</a></li> <li class="toctree-l2"><a class="reference internal" href="workspaces-web.html">WorkSpacesWeb</a></li> <li class="toctree-l2"><a class="reference internal" href="xray.html">XRay</a></li> </ul> </li> </ul> <ul> <li class="toctree-l1 has-children"><a class="reference internal" href="../core/index.html">Core References</a><input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" role="switch" type="checkbox"/><label for="toctree-checkbox-12"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l2"><a class="reference internal" href="../core/boto3.html">Boto3 reference</a></li> <li class="toctree-l2"><a class="reference internal" href="../core/collections.html">Collections reference</a></li> <li class="toctree-l2"><a class="reference internal" href="../core/resources.html">Resources reference</a></li> <li class="toctree-l2"><a class="reference internal" href="../core/session.html">Session reference</a></li> </ul> </li> </ul> <ul> <li class="toctree-l1 has-children"><a class="reference internal" href="../customizations/index.html">Customization References</a><input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" role="switch" type="checkbox"/><label for="toctree-checkbox-13"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l2"><a class="reference internal" href="../customizations/dynamodb.html">DynamoDB customization reference</a></li> <li class="toctree-l2"><a class="reference internal" href="../customizations/s3.html">S3 customization reference</a></li> </ul> </li> </ul> </div></div> </div> </div> </aside> <div class="main"> <div class="content"> <div class="article-container"> <a href="#" class="back-to-top muted-link"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"> <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path> </svg> <span>Back to top</span> </a> <div class="content-icon-container"> <div class="theme-toggle-container theme-toggle-content"> <button class="theme-toggle"> <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg> <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> </button> </div> <label class="toc-overlay-icon toc-content-icon" id="toc-menu-open-md" for="__toc" tabindex="0"> <div class="visually-hidden">Toggle table of contents sidebar</div> <i class="icon"><svg><use href="#svg-toc"></use></svg></i> </label> </div> <article role="main"> <section id="s3"> <h1>S3<a class="headerlink" href="#s3" title="Permalink to this heading">#</a></h1> <section id="client"> <h2>Client<a class="headerlink" href="#client" title="Permalink to this heading">#</a></h2> <dl class="py class"> <dt class="sig sig-object py" id="S3.Client"> <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">S3.</span></span><span class="sig-name descname"><span class="pre">Client</span></span><a class="headerlink" href="#S3.Client" title="Permalink to this definition">#</a></dt> <dd><p>A low-level client representing Amazon Simple Storage Service (S3)</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">boto3</span> <span class="n">client</span> <span class="o">=</span> <span class="n">boto3</span><span class="o">.</span><span class="n">client</span><span class="p">(</span><span class="s1">'s3'</span><span class="p">)</span> </pre></div> </div> </dd></dl> <p>These are the available methods:</p> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="s3/client/abort_multipart_upload.html">abort_multipart_upload</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/can_paginate.html">can_paginate</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/close.html">close</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/complete_multipart_upload.html">complete_multipart_upload</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/copy.html">copy</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/copy_object.html">copy_object</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/create_bucket.html">create_bucket</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/create_multipart_upload.html">create_multipart_upload</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/create_session.html">create_session</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/delete_bucket.html">delete_bucket</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/delete_bucket_analytics_configuration.html">delete_bucket_analytics_configuration</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/delete_bucket_cors.html">delete_bucket_cors</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/delete_bucket_encryption.html">delete_bucket_encryption</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/delete_bucket_intelligent_tiering_configuration.html">delete_bucket_intelligent_tiering_configuration</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/delete_bucket_inventory_configuration.html">delete_bucket_inventory_configuration</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/delete_bucket_lifecycle.html">delete_bucket_lifecycle</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/delete_bucket_metrics_configuration.html">delete_bucket_metrics_configuration</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/delete_bucket_ownership_controls.html">delete_bucket_ownership_controls</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/delete_bucket_policy.html">delete_bucket_policy</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/delete_bucket_replication.html">delete_bucket_replication</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/delete_bucket_tagging.html">delete_bucket_tagging</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/delete_bucket_website.html">delete_bucket_website</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/delete_object.html">delete_object</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/delete_object_tagging.html">delete_object_tagging</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/delete_objects.html">delete_objects</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/delete_public_access_block.html">delete_public_access_block</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/download_file.html">download_file</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/download_fileobj.html">download_fileobj</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/generate_presigned_post.html">generate_presigned_post</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/generate_presigned_url.html">generate_presigned_url</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/get_bucket_accelerate_configuration.html">get_bucket_accelerate_configuration</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/get_bucket_acl.html">get_bucket_acl</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/get_bucket_analytics_configuration.html">get_bucket_analytics_configuration</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/get_bucket_cors.html">get_bucket_cors</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/get_bucket_encryption.html">get_bucket_encryption</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/get_bucket_intelligent_tiering_configuration.html">get_bucket_intelligent_tiering_configuration</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/get_bucket_inventory_configuration.html">get_bucket_inventory_configuration</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/get_bucket_lifecycle.html">get_bucket_lifecycle</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/get_bucket_lifecycle_configuration.html">get_bucket_lifecycle_configuration</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/get_bucket_location.html">get_bucket_location</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/get_bucket_logging.html">get_bucket_logging</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/get_bucket_metrics_configuration.html">get_bucket_metrics_configuration</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/get_bucket_notification.html">get_bucket_notification</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/get_bucket_notification_configuration.html">get_bucket_notification_configuration</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/get_bucket_ownership_controls.html">get_bucket_ownership_controls</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/get_bucket_policy.html">get_bucket_policy</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/get_bucket_policy_status.html">get_bucket_policy_status</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/get_bucket_replication.html">get_bucket_replication</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/get_bucket_request_payment.html">get_bucket_request_payment</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/get_bucket_tagging.html">get_bucket_tagging</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/get_bucket_versioning.html">get_bucket_versioning</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/get_bucket_website.html">get_bucket_website</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/get_object.html">get_object</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/get_object_acl.html">get_object_acl</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/get_object_attributes.html">get_object_attributes</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/get_object_legal_hold.html">get_object_legal_hold</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/get_object_lock_configuration.html">get_object_lock_configuration</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/get_object_retention.html">get_object_retention</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/get_object_tagging.html">get_object_tagging</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/get_object_torrent.html">get_object_torrent</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/get_paginator.html">get_paginator</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/get_public_access_block.html">get_public_access_block</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/get_waiter.html">get_waiter</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/head_bucket.html">head_bucket</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/head_object.html">head_object</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/list_bucket_analytics_configurations.html">list_bucket_analytics_configurations</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/list_bucket_intelligent_tiering_configurations.html">list_bucket_intelligent_tiering_configurations</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/list_bucket_inventory_configurations.html">list_bucket_inventory_configurations</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/list_bucket_metrics_configurations.html">list_bucket_metrics_configurations</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/list_buckets.html">list_buckets</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/list_directory_buckets.html">list_directory_buckets</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/list_multipart_uploads.html">list_multipart_uploads</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/list_object_versions.html">list_object_versions</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/list_objects.html">list_objects</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/list_objects_v2.html">list_objects_v2</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/list_parts.html">list_parts</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/put_bucket_accelerate_configuration.html">put_bucket_accelerate_configuration</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/put_bucket_acl.html">put_bucket_acl</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/put_bucket_analytics_configuration.html">put_bucket_analytics_configuration</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/put_bucket_cors.html">put_bucket_cors</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/put_bucket_encryption.html">put_bucket_encryption</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/put_bucket_intelligent_tiering_configuration.html">put_bucket_intelligent_tiering_configuration</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/put_bucket_inventory_configuration.html">put_bucket_inventory_configuration</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/put_bucket_lifecycle.html">put_bucket_lifecycle</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/put_bucket_lifecycle_configuration.html">put_bucket_lifecycle_configuration</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/put_bucket_logging.html">put_bucket_logging</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/put_bucket_metrics_configuration.html">put_bucket_metrics_configuration</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/put_bucket_notification.html">put_bucket_notification</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/put_bucket_notification_configuration.html">put_bucket_notification_configuration</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/put_bucket_ownership_controls.html">put_bucket_ownership_controls</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/put_bucket_policy.html">put_bucket_policy</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/put_bucket_replication.html">put_bucket_replication</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/put_bucket_request_payment.html">put_bucket_request_payment</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/put_bucket_tagging.html">put_bucket_tagging</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/put_bucket_versioning.html">put_bucket_versioning</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/put_bucket_website.html">put_bucket_website</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/put_object.html">put_object</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/put_object_acl.html">put_object_acl</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/put_object_legal_hold.html">put_object_legal_hold</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/put_object_lock_configuration.html">put_object_lock_configuration</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/put_object_retention.html">put_object_retention</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/put_object_tagging.html">put_object_tagging</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/put_public_access_block.html">put_public_access_block</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/restore_object.html">restore_object</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/select_object_content.html">select_object_content</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/upload_file.html">upload_file</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/upload_fileobj.html">upload_fileobj</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/upload_part.html">upload_part</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/upload_part_copy.html">upload_part_copy</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/client/write_get_object_response.html">write_get_object_response</a></li> </ul> </div> </section> <section id="paginators"> <h2>Paginators<a class="headerlink" href="#paginators" title="Permalink to this heading">#</a></h2> <p>Paginators are available on a client instance via the <code class="docutils literal notranslate"><span class="pre">get_paginator</span></code> method. For more detailed instructions and examples on the usage of paginators, see the paginators <a class="reference external" href="https://boto3.amazonaws.com/v1/documentation/api/latest/guide/paginators.html">user guide</a>.</p> <p>The available paginators are:</p> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="s3/paginator/ListBuckets.html">ListBuckets</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/paginator/ListDirectoryBuckets.html">ListDirectoryBuckets</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/paginator/ListMultipartUploads.html">ListMultipartUploads</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/paginator/ListObjectVersions.html">ListObjectVersions</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/paginator/ListObjects.html">ListObjects</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/paginator/ListObjectsV2.html">ListObjectsV2</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/paginator/ListParts.html">ListParts</a></li> </ul> </div> </section> <section id="waiters"> <h2>Waiters<a class="headerlink" href="#waiters" title="Permalink to this heading">#</a></h2> <p>Waiters are available on a client instance via the <code class="docutils literal notranslate"><span class="pre">get_waiter</span></code> method. For more detailed instructions and examples on the usage or waiters, see the waiters <a class="reference external" href="https://boto3.amazonaws.com/v1/documentation/api/latest/guide/clients.html#waiters">user guide</a>.</p> <p>The available waiters are:</p> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="s3/waiter/BucketExists.html">BucketExists</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/waiter/BucketNotExists.html">BucketNotExists</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/waiter/ObjectExists.html">ObjectExists</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/waiter/ObjectNotExists.html">ObjectNotExists</a></li> </ul> </div> </section> <section id="resources"> <h2>Resources<a class="headerlink" href="#resources" title="Permalink to this heading">#</a></h2> <p>Resources are available in boto3 via the <code class="docutils literal notranslate"><span class="pre">resource</span></code> method. For more detailed instructions and examples on the usage of resources, see the resources <a class="reference external" href="https://boto3.amazonaws.com/v1/documentation/api/latest/guide/resources.html">user guide</a>.</p> <p>The available resources are:</p> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="s3/service-resource/index.html">Service Resource</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/bucket/index.html">Bucket</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/bucketacl/index.html">BucketAcl</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/bucketcors/index.html">BucketCors</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/bucketlifecycle/index.html">BucketLifecycle</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/bucketlifecycleconfiguration/index.html">BucketLifecycleConfiguration</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/bucketlogging/index.html">BucketLogging</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/bucketnotification/index.html">BucketNotification</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/bucketpolicy/index.html">BucketPolicy</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/bucketrequestpayment/index.html">BucketRequestPayment</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/buckettagging/index.html">BucketTagging</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/bucketversioning/index.html">BucketVersioning</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/bucketwebsite/index.html">BucketWebsite</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/multipartupload/index.html">MultipartUpload</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/multipartuploadpart/index.html">MultipartUploadPart</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/object/index.html">Object</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/objectacl/index.html">ObjectAcl</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/objectsummary/index.html">ObjectSummary</a></li> <li class="toctree-l1"><a class="reference internal" href="s3/objectversion/index.html">ObjectVersion</a></li> </ul> </div> </section> <section id="examples"> <h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading">#</a></h2> <section id="list-objects-in-an-amazon-s3-bucket"> <h3>List objects in an Amazon S3 bucket<a class="headerlink" href="#list-objects-in-an-amazon-s3-bucket" title="Permalink to this heading">#</a></h3> <p>The following example shows how to use an Amazon S3 bucket resource to list the objects in the bucket.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">boto3</span> <span class="n">s3</span> <span class="o">=</span> <span class="n">boto3</span><span class="o">.</span><span class="n">resource</span><span class="p">(</span><span class="s1">'s3'</span><span class="p">)</span> <span class="n">bucket</span> <span class="o">=</span> <span class="n">s3</span><span class="o">.</span><span class="n">Bucket</span><span class="p">(</span><span class="s1">'amzn-s3-demo-bucket'</span><span class="p">)</span> <span class="k">for</span> <span class="n">obj</span> <span class="ow">in</span> <span class="n">bucket</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">all</span><span class="p">():</span> <span class="nb">print</span><span class="p">(</span><span class="n">obj</span><span class="o">.</span><span class="n">key</span><span class="p">)</span> </pre></div> </div> </section> <section id="list-top-level-common-prefixes-in-amazon-s3-bucket"> <h3>List top-level common prefixes in Amazon S3 bucket<a class="headerlink" href="#list-top-level-common-prefixes-in-amazon-s3-bucket" title="Permalink to this heading">#</a></h3> <p>This example shows how to list all of the top-level common prefixes in an Amazon S3 bucket:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">boto3</span> <span class="n">client</span> <span class="o">=</span> <span class="n">boto3</span><span class="o">.</span><span class="n">client</span><span class="p">(</span><span class="s1">'s3'</span><span class="p">)</span> <span class="n">paginator</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_paginator</span><span class="p">(</span><span class="s1">'list_objects'</span><span class="p">)</span> <span class="n">result</span> <span class="o">=</span> <span class="n">paginator</span><span class="o">.</span><span class="n">paginate</span><span class="p">(</span><span class="n">Bucket</span><span class="o">=</span><span class="s1">'amzn-s3-demo-bucket'</span><span class="p">,</span> <span class="n">Delimiter</span><span class="o">=</span><span class="s1">'/'</span><span class="p">)</span> <span class="k">for</span> <span class="n">prefix</span> <span class="ow">in</span> <span class="n">result</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="s1">'CommonPrefixes'</span><span class="p">):</span> <span class="nb">print</span><span class="p">(</span><span class="n">prefix</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'Prefix'</span><span class="p">))</span> </pre></div> </div> </section> <section id="restore-glacier-objects-in-an-amazon-s3-bucket"> <h3>Restore Glacier objects in an Amazon S3 bucket<a class="headerlink" href="#restore-glacier-objects-in-an-amazon-s3-bucket" title="Permalink to this heading">#</a></h3> <p>The following example shows how to initiate restoration of glacier objects in an Amazon S3 bucket, determine if a restoration is on-going, and determine if a restoration is finished.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">boto3</span> <span class="n">s3</span> <span class="o">=</span> <span class="n">boto3</span><span class="o">.</span><span class="n">resource</span><span class="p">(</span><span class="s1">'s3'</span><span class="p">)</span> <span class="n">bucket</span> <span class="o">=</span> <span class="n">s3</span><span class="o">.</span><span class="n">Bucket</span><span class="p">(</span><span class="s1">'amzn-s3-demo-bucket'</span><span class="p">)</span> <span class="k">for</span> <span class="n">obj_sum</span> <span class="ow">in</span> <span class="n">bucket</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">all</span><span class="p">():</span> <span class="n">obj</span> <span class="o">=</span> <span class="n">s3</span><span class="o">.</span><span class="n">Object</span><span class="p">(</span><span class="n">obj_sum</span><span class="o">.</span><span class="n">bucket_name</span><span class="p">,</span> <span class="n">obj_sum</span><span class="o">.</span><span class="n">key</span><span class="p">)</span> <span class="k">if</span> <span class="n">obj</span><span class="o">.</span><span class="n">storage_class</span> <span class="o">==</span> <span class="s1">'GLACIER'</span><span class="p">:</span> <span class="c1"># Try to restore the object if the storage class is glacier and</span> <span class="c1"># the object does not have a completed or ongoing restoration</span> <span class="c1"># request.</span> <span class="k">if</span> <span class="n">obj</span><span class="o">.</span><span class="n">restore</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> <span class="nb">print</span><span class="p">(</span><span class="s1">'Submitting restoration request: </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">obj</span><span class="o">.</span><span class="n">key</span><span class="p">)</span> <span class="n">obj</span><span class="o">.</span><span class="n">restore_object</span><span class="p">(</span><span class="n">RestoreRequest</span><span class="o">=</span><span class="p">{</span><span class="s1">'Days'</span><span class="p">:</span> <span class="mi">1</span><span class="p">})</span> <span class="c1"># Print out objects whose restoration is on-going</span> <span class="k">elif</span> <span class="s1">'ongoing-request="true"'</span> <span class="ow">in</span> <span class="n">obj</span><span class="o">.</span><span class="n">restore</span><span class="p">:</span> <span class="nb">print</span><span class="p">(</span><span class="s1">'Restoration in-progress: </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">obj</span><span class="o">.</span><span class="n">key</span><span class="p">)</span> <span class="c1"># Print out objects whose restoration is complete</span> <span class="k">elif</span> <span class="s1">'ongoing-request="false"'</span> <span class="ow">in</span> <span class="n">obj</span><span class="o">.</span><span class="n">restore</span><span class="p">:</span> <span class="nb">print</span><span class="p">(</span><span class="s1">'Restoration complete: </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">obj</span><span class="o">.</span><span class="n">key</span><span class="p">)</span> </pre></div> </div> </section> <section id="uploading-downloading-files-using-sse-kms"> <h3>Uploading/downloading files using SSE KMS<a class="headerlink" href="#uploading-downloading-files-using-sse-kms" title="Permalink to this heading">#</a></h3> <p>This example shows how to use SSE-KMS to upload objects using server side encryption with a key managed by KMS.</p> <p>We can either use the default KMS master key, or create a custom key in AWS and use it to encrypt the object by passing in its key id.</p> <p>With KMS, nothing else needs to be provided for getting the object; S3 already knows how to decrypt the object.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">boto3</span> <span class="kn">import</span> <span class="nn">os</span> <span class="n">BUCKET</span> <span class="o">=</span> <span class="s1">'amzn-s3-demo-bucket'</span> <span class="n">s3</span> <span class="o">=</span> <span class="n">boto3</span><span class="o">.</span><span class="n">client</span><span class="p">(</span><span class="s1">'s3'</span><span class="p">)</span> <span class="n">keyid</span> <span class="o">=</span> <span class="s1">'<the key id>'</span> <span class="nb">print</span><span class="p">(</span><span class="s2">"Uploading S3 object with SSE-KMS"</span><span class="p">)</span> <span class="n">s3</span><span class="o">.</span><span class="n">put_object</span><span class="p">(</span><span class="n">Bucket</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="s1">'encrypt-key'</span><span class="p">,</span> <span class="n">Body</span><span class="o">=</span><span class="sa">b</span><span class="s1">'foobar'</span><span class="p">,</span> <span class="n">ServerSideEncryption</span><span class="o">=</span><span class="s1">'aws:kms'</span><span class="p">,</span> <span class="c1"># Optional: SSEKMSKeyId</span> <span class="n">SSEKMSKeyId</span><span class="o">=</span><span class="n">keyid</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="s2">"Done"</span><span class="p">)</span> <span class="c1"># Getting the object:</span> <span class="nb">print</span><span class="p">(</span><span class="s2">"Getting S3 object..."</span><span class="p">)</span> <span class="n">response</span> <span class="o">=</span> <span class="n">s3</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">BUCKET</span><span class="p">,</span> <span class="n">Key</span><span class="o">=</span><span class="s1">'encrypt-key'</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="s2">"Done, response body:"</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="n">response</span><span class="p">[</span><span class="s1">'Body'</span><span class="p">]</span><span class="o">.</span><span class="n">read</span><span class="p">())</span> </pre></div> </div> </section> <section id="uploading-downloading-files-using-sse-customer-keys"> <h3>Uploading/downloading files using SSE Customer Keys<a class="headerlink" href="#uploading-downloading-files-using-sse-customer-keys" title="Permalink to this heading">#</a></h3> <p>This example shows how to use SSE-C to upload objects using server side encryption with a customer provided key.</p> <p>First, we鈥檒l need a 32 byte key. For this example, we鈥檒l randomly generate a key but you can use any 32 byte key you want. Remember, you must the same key to download the object. If you lose the encryption key, you lose the object.</p> <p>Also note how we don鈥檛 have to provide the SSECustomerKeyMD5. Boto3 will automatically compute this value for us.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">boto3</span> <span class="kn">import</span> <span class="nn">os</span> <span class="n">BUCKET</span> <span class="o">=</span> <span class="s1">'amzn-s3-demo-bucket'</span> <span class="n">KEY</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">urandom</span><span class="p">(</span><span class="mi">32</span><span class="p">)</span> <span class="n">s3</span> <span class="o">=</span> <span class="n">boto3</span><span class="o">.</span><span class="n">client</span><span class="p">(</span><span class="s1">'s3'</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="s2">"Uploading S3 object with SSE-C"</span><span class="p">)</span> <span class="n">s3</span><span class="o">.</span><span class="n">put_object</span><span class="p">(</span><span class="n">Bucket</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="s1">'encrypt-key'</span><span class="p">,</span> <span class="n">Body</span><span class="o">=</span><span class="sa">b</span><span class="s1">'foobar'</span><span class="p">,</span> <span class="n">SSECustomerKey</span><span class="o">=</span><span class="n">KEY</span><span class="p">,</span> <span class="n">SSECustomerAlgorithm</span><span class="o">=</span><span class="s1">'AES256'</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="s2">"Done"</span><span class="p">)</span> <span class="c1"># Getting the object:</span> <span class="nb">print</span><span class="p">(</span><span class="s2">"Getting S3 object..."</span><span class="p">)</span> <span class="c1"># Note how we're using the same ``KEY`` we</span> <span class="c1"># created earlier.</span> <span class="n">response</span> <span class="o">=</span> <span class="n">s3</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">BUCKET</span><span class="p">,</span> <span class="n">Key</span><span class="o">=</span><span class="s1">'encrypt-key'</span><span class="p">,</span> <span class="n">SSECustomerKey</span><span class="o">=</span><span class="n">KEY</span><span class="p">,</span> <span class="n">SSECustomerAlgorithm</span><span class="o">=</span><span class="s1">'AES256'</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="s2">"Done, response body:"</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="n">response</span><span class="p">[</span><span class="s1">'Body'</span><span class="p">]</span><span class="o">.</span><span class="n">read</span><span class="p">())</span> </pre></div> </div> </section> <section id="downloading-a-specific-version-of-an-s3-object"> <h3>Downloading a specific version of an S3 object<a class="headerlink" href="#downloading-a-specific-version-of-an-s3-object" title="Permalink to this heading">#</a></h3> <p>This example shows how to download a specific version of an S3 object.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">boto3</span> <span class="n">s3</span> <span class="o">=</span> <span class="n">boto3</span><span class="o">.</span><span class="n">client</span><span class="p">(</span><span class="s1">'s3'</span><span class="p">)</span> <span class="n">s3</span><span class="o">.</span><span class="n">download_file</span><span class="p">(</span> <span class="s2">"amzn-s3-demo-bucket"</span><span class="p">,</span> <span class="s2">"key-name"</span><span class="p">,</span> <span class="s2">"tmp.txt"</span><span class="p">,</span> <span class="n">ExtraArgs</span><span class="o">=</span><span class="p">{</span><span class="s2">"VersionId"</span><span class="p">:</span> <span class="s2">"my-version-id"</span><span class="p">}</span> <span class="p">)</span> </pre></div> </div> </section> <section id="filter-objects-by-last-modified-time-using-jmespath"> <h3>Filter objects by last modified time using JMESPath<a class="headerlink" href="#filter-objects-by-last-modified-time-using-jmespath" title="Permalink to this heading">#</a></h3> <p>This example shows how to filter objects by last modified time using JMESPath.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">boto3</span> <span class="n">s3</span> <span class="o">=</span> <span class="n">boto3</span><span class="o">.</span><span class="n">client</span><span class="p">(</span><span class="s2">"s3"</span><span class="p">)</span> <span class="n">s3_paginator</span> <span class="o">=</span> <span class="n">s3</span><span class="o">.</span><span class="n">get_paginator</span><span class="p">(</span><span class="s1">'list_objects_v2'</span><span class="p">)</span> <span class="n">s3_iterator</span> <span class="o">=</span> <span class="n">s3_paginator</span><span class="o">.</span><span class="n">paginate</span><span class="p">(</span><span class="n">Bucket</span><span class="o">=</span><span class="s1">'amzn-s3-demo-bucket'</span><span class="p">)</span> <span class="n">filtered_iterator</span> <span class="o">=</span> <span class="n">s3_iterator</span><span class="o">.</span><span class="n">search</span><span class="p">(</span> <span class="s2">"Contents[?to_string(LastModified)>='</span><span class="se">\"</span><span class="s2">2022-01-05 08:05:37+00:00</span><span class="se">\"</span><span class="s2">'].Key"</span> <span class="p">)</span> <span class="k">for</span> <span class="n">key_data</span> <span class="ow">in</span> <span class="n">filtered_iterator</span><span class="p">:</span> <span class="nb">print</span><span class="p">(</span><span class="n">key_data</span><span class="p">)</span> </pre></div> </div> </section> </section> <section id="client-context-parameters"> <h2>Client Context Parameters<a class="headerlink" href="#client-context-parameters" title="Permalink to this heading">#</a></h2> <p>Client context parameters are configurable on a client instance via the <code class="docutils literal notranslate"><span class="pre">client_context_params</span></code> parameter in the <code class="docutils literal notranslate"><span class="pre">Config</span></code> object. For more detailed instructions and examples on the exact usage of context params see the <a class="reference external" href="https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html">configuration guide</a>.</p> <p>The available <code class="docutils literal notranslate"><span class="pre">s3</span></code> client context params are:</p> <ul class="simple"> <li><dl class="simple"> <dt><code class="docutils literal notranslate"><span class="pre">disable_s3_express_session_auth</span></code> (boolean) - Disables this client鈥檚 usage of Session Auth for S3Express</dt><dd><p>buckets and reverts to using conventional SigV4 for those.</p> </dd> </dl> </li> </ul> </section> </section> </article> </div> <footer> <div class="related-pages"> <a class="next-page" href="s3/client/abort_multipart_upload.html"> <div class="page-info"> <div class="context"> <span>Next</span> </div> <div class="title">abort_multipart_upload</div> </div> <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> </a> <a class="prev-page" href="rum/paginator/ListRumMetricsDestinations.html"> <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> <div class="page-info"> <div class="context"> <span>Previous</span> </div> <div class="title">ListRumMetricsDestinations</div> </div> </a> </div> <div class="bottom-of-page"> <div class="left-details"> <div class="copyright"> Copyright © 2024, Amazon Web Services, Inc </div> Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s <a href="https://github.com/pradyunsg/furo">Furo</a> <div class="legal-info"> <script type="text/javascript" src="../../_static/shortbreadv1.js"></script> <script type="text/javascript"> const shortbread = AWSCShortbread({ domain: ".amazonaws.com", }); shortbread.checkForCookieConsent(); </script> <a href="https://aws.amazon.com/privacy">Privacy</a> | <a href="https://aws.amazon.com/terms">Site Terms</a> | <a href="#" onclick="shortbread.customizeCookies();">Cookie preferences</a> </div> </div> <div class="right-details"> <div class="icons"> <a class="muted-link " href="https://github.com/boto/boto3" aria-label="GitHub"> <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16"> <path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path> </svg> </a> </div> </div> </div> </footer> </div> <aside class="toc-drawer"> <div class="toc-sticky toc-scroll"> <div class="sidebar-div show-div-md justify-content-left"> <label class="nav-close-icon" id="toc-menu-close" for="__toc" tabindex="0"> <div class="visually-hidden">Toggle site table of content right sidebar</div> <i class="icon"><svg><use href="#svg-close"></use></svg></i> </label> </div> <div class="toc-title-container"> <span class="toc-title"> On this page </span> </div> <div class="toc-tree-container"> <div class="toc-tree"> <ul> <li><a class="reference internal" href="#">S3</a><ul> <li><a class="reference internal" href="#client">Client</a><ul> <li><a class="reference internal" href="#S3.Client"><code class="docutils literal notranslate"><span class="pre">S3.Client</span></code></a></li> </ul> </li> <li><a class="reference internal" href="#paginators">Paginators</a><ul class="simple"> </ul> </li> <li><a class="reference internal" href="#waiters">Waiters</a><ul class="simple"> </ul> </li> <li><a class="reference internal" href="#resources">Resources</a><ul class="simple"> </ul> </li> <li><a class="reference internal" href="#examples">Examples</a><ul> <li><a class="reference internal" href="#list-objects-in-an-amazon-s3-bucket">List objects in an Amazon S3 bucket</a></li> <li><a class="reference internal" href="#list-top-level-common-prefixes-in-amazon-s3-bucket">List top-level common prefixes in Amazon S3 bucket</a></li> <li><a class="reference internal" href="#restore-glacier-objects-in-an-amazon-s3-bucket">Restore Glacier objects in an Amazon S3 bucket</a></li> <li><a class="reference internal" href="#uploading-downloading-files-using-sse-kms">Uploading/downloading files using SSE KMS</a></li> <li><a class="reference internal" href="#uploading-downloading-files-using-sse-customer-keys">Uploading/downloading files using SSE Customer Keys</a></li> <li><a class="reference internal" href="#downloading-a-specific-version-of-an-s3-object">Downloading a specific version of an S3 object</a></li> <li><a class="reference internal" href="#filter-objects-by-last-modified-time-using-jmespath">Filter objects by last modified time using JMESPath</a></li> </ul> </li> <li><a class="reference internal" href="#client-context-parameters">Client Context Parameters</a></li> </ul> </li> </ul> </div> </div> </div> </aside> </div> </div><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script> <script src="../../_static/jquery.js"></script> <script src="../../_static/underscore.js"></script> <script src="../../_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="../../_static/doctools.js"></script> <script src="../../_static/sphinx_highlight.js"></script> <script src="../../_static/scripts/furo.js"></script> <script src="../../_static/clipboard.min.js"></script> <script src="../../_static/copybutton.js"></script> <script src="../../_static/js/custom.js"></script> </body> </html>