ContextQMD
Back to Aws Doc Sdk Examples

S3 Directory Buckets code examples for the SDK for Python

python/example_code/s3-directory-buckets/README.md

latest3.6 KB
Original Source

S3 Directory Buckets code examples for the SDK for Python

Overview

Shows how to use the AWS SDK for Python (Boto3) to work with Amazon S3 Directory Buckets.

<!--custom.overview.start--> <!--custom.overview.end-->

S3 Directory Buckets are designed to store data within a single AWS Zone. Directory buckets organize data hierarchically into directories, providing a structure similar to a file system.

⚠ Important

  • Running this code might result in charges to your AWS account. For more details, see AWS Pricing and Free Tier.
  • Running the tests might result in charges to your AWS account.
  • We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see Grant least privilege.
  • This code is not tested in every AWS Region. For more information, see AWS Regional Services.
<!--custom.important.start--> <!--custom.important.end-->

Code examples

Prerequisites

For prerequisites, see the README in the python folder.

Install the packages required by these examples by running the following in a virtual environment:

python -m pip install -r requirements.txt
<!--custom.prerequisites.start--> <!--custom.prerequisites.end-->

Basics

Code examples that show you how to perform the essential operations within a service.

Single actions

Code excerpts that show you how to call individual service functions.

<!--custom.examples.start--> <!--custom.examples.end-->

Run the examples

Instructions

<!--custom.instructions.start--> <!--custom.instructions.end-->

Learn the basics

This example shows you how to do the following:

  • Set up a VPC and VPC Endpoint.
  • Set up the Policies, Roles, and User to work with S3 directory buckets and the S3 Express One Zone storage class.
  • Create two S3 Clients.
  • Create two buckets.
  • Create an object and copy it over.
  • Demonstrate performance difference.
  • Populate the buckets to show the lexicographical difference.
  • Prompt the user to see if they want to clean up the resources.
<!--custom.basic_prereqs.s3-directory-buckets_Scenario_ExpressBasics.start--> <!--custom.basic_prereqs.s3-directory-buckets_Scenario_ExpressBasics.end-->

Start the example by running the following at a command prompt:

python s3_express_getting_started.py
<!--custom.basics.s3-directory-buckets_Scenario_ExpressBasics.start--> <!--custom.basics.s3-directory-buckets_Scenario_ExpressBasics.end-->

Tests

⚠ Running tests might result in charges to your AWS account.

To find instructions for running these tests, see the README in the python folder.

<!--custom.tests.start--> <!--custom.tests.end-->

Additional resources

<!--custom.resources.start--> <!--custom.resources.end-->

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

SPDX-License-Identifier: Apache-2.0