diff --git a/README.md b/README.md index 0281abe6e..ff999d798 100644 --- a/README.md +++ b/README.md @@ -5,63 +5,51 @@ [apache-url]: https://github.com/aws/aws-sdk-python/blob/main/LICENSE > [!WARNING] -> The AWS SDK for Python v4 is **experimental** and in early development. It is intended for evaluation and testing in pre-production environments only. Do not use it for production workloads. APIs and behavior might change before general availability. -> -> **For production deployments, use [Boto3](https://github.com/boto/boto3)**: the established, generally available AWS SDK for Python with full coverage of all AWS services. +> The AWS SDK for Python v4 is currently in **Developer Preview**. It is intended for evaluation and testing only. Do not use it for production workloads. -[API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/) | [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/welcome.html) - -This repository contains the next-generation AWS SDK for Python v4, rebuilt from -the ground up with an async-first, modular architecture. These new clients allow -you to interact with select AWS services using Python's native `async`/`await` -functionality. Unlike Boto3, these clients are distributed per-service, leaving -you the option to install only what fits your needs. +The AWS SDK for Python v4 is the next major version of the AWS SDK for Python and the successor to [Boto3](https://github.com/boto/boto3). ### Key features -+ **Native asynchronous APIs**: Service clients use Python `async` and `await` for non-blocking operations and concurrent I/O. -+ **Bidirectional streaming**: Supported clients can send and receive event streams concurrently over HTTP/2. -+ **Modular packages**: Each service client is available as a separate package (e.g., `aws-sdk-dynamodb`), reducing the dependencies you install and deploy. -+ **Generated types**: Type annotations provide editor completion and static-analysis support. ++ **Synchronous and asynchronous clients**: Each service package provides a synchronous client and an asynchronous client that uses `asyncio` for non-blocking operations and concurrent I/O. ++ **Modular packages**: Each service client is available as a separate package, ensuring you only install services you need. ++ **Bidirectional streaming**: Supported asynchronous clients can send and receive event streams concurrently over HTTP/2. ++ **Generated types**: Every client, operation, and request and response model ships with type annotations and API documentation, so type checkers catch invalid requests before your code runs. ++ **Keyword and dictionary inputs**: Operations accept request parameters as keyword arguments, as a dictionary, or as a typed input model. + +### Documentation +- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/welcome.html) +- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/) -### When to use this SDK vs. Boto3 +### Comparison with Boto3 -| | **AWS SDK for Python v4** | **[Boto3](https://github.com/boto/boto3)** | +| Capability | **AWS SDK for Python v4** | **Boto3** | | --- | --- | --- | -| Release status | Experimental | General Availability | -| Production use | Not recommended | Yes | -| Architecture | Async-first, modular per-service packages | Synchronous, monolithic package | -| Service coverage | 24 services (expanding) | All AWS services | +| Release status | Developer Preview | General Availability | +| Service coverage | 37 services (growing) | All AWS services | +| Paginators, waiters, presigned URLs | Not yet available | Available | -**Choose [Boto3](https://github.com/boto/boto3) if you** need production stability, full AWS service coverage, synchronous workloads, or features like paginators, waiters, and presigned URLs. +Boto3 remains fully supported. You can install both SDKs in the same application. -**Choose the AWS SDK for Python v4 if you** are evaluating native async capabilities, building high-throughput async prototypes, working with streaming services in test environments, or want to provide feedback to shape the GA release. +See [Choosing the AWS SDK for Python](https://docs.aws.amazon.com/sdk-for-python/v4/guide/choosing-sdk.html) in +the developer guide for a more detailed comparison. ## Installation -The SDK requires Python 3.12 or later and publishes each service client as a -separate package. For example, the following command installs the DynamoDB -and Transcribe Streaming clients as individual packages: +The SDK requires Python 3.12 or later. For example, the following command +installs the Amazon S3 and Amazon Bedrock Runtime clients: ```bash -python -m pip install aws-sdk-dynamodb aws-sdk-transcribe-streaming +python -m pip install aws-sdk-s3 aws-sdk-bedrock-runtime ``` -The same clients are also available as optional dependencies of the -`aws-sdk-python` meta-package: +To install several clients at compatible versions, select them as extras of the +`aws-sdk-python` meta-package, which installs only the clients that you select: ```bash -python -m pip install "aws-sdk-python[dynamodb,transcribe_streaming]" +python -m pip install "aws-sdk-python[s3,bedrock-runtime]" ``` -The meta-package installs only the service clients that you select as extras; -without extras, it installs no clients. It coordinates client versions through -its MAJOR.MINOR version, so it installs compatible client versions together. - -Use the meta-package when your application depends on several clients. Install -individual client packages when your application uses only one or two services -and you want the smallest dependency set. - ## Quick start First, create a virtual environment to keep this project's packages separate @@ -72,10 +60,10 @@ python -m venv .venv source .venv/bin/activate ``` -Then install the Amazon STS client used in this example: +Then install the Amazon S3 client used in this example: ```bash -python -m pip install aws-sdk-sts +python -m pip install aws-sdk-s3 ``` Next, set up credentials (in e.g. `~/.aws/credentials`): @@ -87,7 +75,7 @@ aws_secret_access_key = YOUR_SECRET_ACCESS_KEY aws_session_token = YOUR_SESSION_TOKEN ``` -For the credential sources that the experimental SDK supports, see +For the credential sources that the SDK supports, see [Credential providers](https://docs.aws.amazon.com/sdk-for-python/v4/guide/credential-providers.html) in the developer guide. @@ -98,40 +86,64 @@ Then, set up a default Region (in e.g. `~/.aws/config`): region = us-east-1 ``` -Finally, run the following example, which calls Amazon STS `GetCallerIdentity` -to verify your setup: +Finally, run the following example, which calls Amazon S3 `ListBuckets` to +verify your setup. Your identity needs the `s3:ListAllMyBuckets` permission. + +```python +from aws_sdk_s3 import S3Client + +with S3Client() as client: + response = client.list_buckets() + for bucket in response.buckets or []: + print(bucket.name) +``` + +To make the same call asynchronously, use the `Async` variant of the client: ```python import asyncio -from aws_sdk_sts.aio.client import AsyncSTSClient -from aws_sdk_sts.models import GetCallerIdentityInput +from aws_sdk_s3 import AsyncS3Client async def main(): - async with AsyncSTSClient() as client: - response = await client.get_caller_identity(GetCallerIdentityInput()) - print(f"Account: {response.account}") - print(f"Arn: {response.arn}") + async with AsyncS3Client() as client: + response = await client.list_buckets() + for bucket in response.buckets or []: + print(bucket.name) + + +asyncio.run(main()) +``` +## Constructing requests + +Operations accept request parameters as keyword arguments, a dictionary, or a +typed input model. The following calls are equivalent: + +```python +from aws_sdk_s3 import S3Client +from aws_sdk_s3.models import ListObjectsV2Input -if __name__ == "__main__": - asyncio.run(main()) +with S3Client() as client: + client.list_objects_v2(bucket="amzn-s3-demo-bucket", max_keys=10) + client.list_objects_v2({"bucket": "amzn-s3-demo-bucket", "max_keys": 10}) + client.list_objects_v2(ListObjectsV2Input(bucket="amzn-s3-demo-bucket", max_keys=10)) ``` ## Bidirectional streaming transport -Some operations use bidirectional (duplex) event streams. The default aiohttp -transport doesn't support duplex streaming. To use these operations, install -the client's `awscrt` extra and set `AWSCRTHTTPClient` as the transport: +Event stream operations are available only on asynchronous clients. The default +aiohttp transport doesn't support bidirectional (duplex) streams. To use them, +install the client's `awscrt` extra and set `AWSCRTHTTPClient` as the transport: ```bash python -m pip install "aws-sdk-bedrock-runtime[awscrt]" ``` ```python -from aws_sdk_bedrock_runtime.aio.client import AsyncBedrockRuntimeClient -from aws_sdk_bedrock_runtime.aio.config import AsyncBedrockRuntimeConfig +from aws_sdk_bedrock_runtime import AsyncBedrockRuntimeClient +from aws_sdk_bedrock_runtime import AsyncBedrockRuntimeConfig from smithy_http.aio.crt import AWSCRTHTTPClient @@ -145,9 +157,8 @@ async def create_client() -> AsyncBedrockRuntimeClient: ## Resources -+ [SDK Homepage](https://aws.amazon.com/sdk-for-python/) -+ [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/welcome.html) -+ [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/) ++ [AWS SDK for Python Homepage](https://aws.amazon.com/sdk-for-python/) ++ [AWS SDKs and Tools Reference Guide](https://docs.aws.amazon.com/sdkref/latest/guide/overview.html) ## Feedback diff --git a/clients/aws-sdk-acm/README.md b/clients/aws-sdk-acm/README.md index 5ab25f239..39cdcc997 100644 --- a/clients/aws-sdk-acm/README.md +++ b/clients/aws-sdk-acm/README.md @@ -5,8 +5,8 @@ The `aws-sdk-acm` package provides a client for making requests to AWS Certificate Manager. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-api-gateway/README.md b/clients/aws-sdk-api-gateway/README.md index 3c5107f72..c3f0a003b 100644 --- a/clients/aws-sdk-api-gateway/README.md +++ b/clients/aws-sdk-api-gateway/README.md @@ -5,8 +5,8 @@ The `aws-sdk-api-gateway` package provides a client for making requests to Amazon API Gateway. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-appconfigdata/README.md b/clients/aws-sdk-appconfigdata/README.md index d56011720..a75e6ce92 100644 --- a/clients/aws-sdk-appconfigdata/README.md +++ b/clients/aws-sdk-appconfigdata/README.md @@ -5,8 +5,8 @@ The `aws-sdk-appconfigdata` package provides a client for making requests to AWS AppConfig Data. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-bedrock-agent-runtime/README.md b/clients/aws-sdk-bedrock-agent-runtime/README.md index 99352549b..b47308150 100644 --- a/clients/aws-sdk-bedrock-agent-runtime/README.md +++ b/clients/aws-sdk-bedrock-agent-runtime/README.md @@ -5,8 +5,8 @@ The `aws-sdk-bedrock-agent-runtime` package provides a client for making requests to Agents for Amazon Bedrock Runtime. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-bedrock-agent/README.md b/clients/aws-sdk-bedrock-agent/README.md index 538378870..b8cd5dda0 100644 --- a/clients/aws-sdk-bedrock-agent/README.md +++ b/clients/aws-sdk-bedrock-agent/README.md @@ -5,8 +5,8 @@ The `aws-sdk-bedrock-agent` package provides a client for making requests to Agents for Amazon Bedrock. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-bedrock-agentcore-control/README.md b/clients/aws-sdk-bedrock-agentcore-control/README.md index 2aad26304..52c078ce0 100644 --- a/clients/aws-sdk-bedrock-agentcore-control/README.md +++ b/clients/aws-sdk-bedrock-agentcore-control/README.md @@ -5,8 +5,8 @@ The `aws-sdk-bedrock-agentcore-control` package provides a client for making requests to Amazon Bedrock AgentCore Control. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-bedrock-agentcore/README.md b/clients/aws-sdk-bedrock-agentcore/README.md index d8c38a1c8..e62917dd2 100644 --- a/clients/aws-sdk-bedrock-agentcore/README.md +++ b/clients/aws-sdk-bedrock-agentcore/README.md @@ -5,8 +5,8 @@ The `aws-sdk-bedrock-agentcore` package provides a client for making requests to Amazon Bedrock AgentCore. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-bedrock-data-automation-runtime/README.md b/clients/aws-sdk-bedrock-data-automation-runtime/README.md index 13e1d7ac4..b02da4576 100644 --- a/clients/aws-sdk-bedrock-data-automation-runtime/README.md +++ b/clients/aws-sdk-bedrock-data-automation-runtime/README.md @@ -5,8 +5,8 @@ The `aws-sdk-bedrock-data-automation-runtime` package provides a client for making requests to Runtime for Amazon Bedrock Data Automation. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-bedrock-data-automation/README.md b/clients/aws-sdk-bedrock-data-automation/README.md index 8ede07385..a58d0d600 100644 --- a/clients/aws-sdk-bedrock-data-automation/README.md +++ b/clients/aws-sdk-bedrock-data-automation/README.md @@ -5,8 +5,8 @@ The `aws-sdk-bedrock-data-automation` package provides a client for making requests to Data Automation for Amazon Bedrock. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-bedrock-runtime/README.md b/clients/aws-sdk-bedrock-runtime/README.md index 937c7b5b6..4c9bd36db 100644 --- a/clients/aws-sdk-bedrock-runtime/README.md +++ b/clients/aws-sdk-bedrock-runtime/README.md @@ -5,8 +5,8 @@ The `aws-sdk-bedrock-runtime` package provides a client for making requests to Amazon Bedrock Runtime. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-bedrock/README.md b/clients/aws-sdk-bedrock/README.md index 441190196..19c15b799 100644 --- a/clients/aws-sdk-bedrock/README.md +++ b/clients/aws-sdk-bedrock/README.md @@ -5,8 +5,8 @@ The `aws-sdk-bedrock` package provides a client for making requests to Amazon Bedrock. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-cloudformation/README.md b/clients/aws-sdk-cloudformation/README.md index be06e0856..f4b5fe660 100644 --- a/clients/aws-sdk-cloudformation/README.md +++ b/clients/aws-sdk-cloudformation/README.md @@ -5,8 +5,8 @@ The `aws-sdk-cloudformation` package provides a client for making requests to AWS CloudFormation. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-cloudfront-keyvaluestore/README.md b/clients/aws-sdk-cloudfront-keyvaluestore/README.md index 86e7b03d7..ad080286c 100644 --- a/clients/aws-sdk-cloudfront-keyvaluestore/README.md +++ b/clients/aws-sdk-cloudfront-keyvaluestore/README.md @@ -5,8 +5,8 @@ The `aws-sdk-cloudfront-keyvaluestore` package provides a client for making requests to Amazon CloudFront KeyValueStore. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-cloudfront/README.md b/clients/aws-sdk-cloudfront/README.md index 3064e2823..652f8294a 100644 --- a/clients/aws-sdk-cloudfront/README.md +++ b/clients/aws-sdk-cloudfront/README.md @@ -5,8 +5,8 @@ The `aws-sdk-cloudfront` package provides a client for making requests to Amazon CloudFront. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-cloudtrail/README.md b/clients/aws-sdk-cloudtrail/README.md index 88608df82..8b1e9b5ff 100644 --- a/clients/aws-sdk-cloudtrail/README.md +++ b/clients/aws-sdk-cloudtrail/README.md @@ -5,8 +5,8 @@ The `aws-sdk-cloudtrail` package provides a client for making requests to AWS CloudTrail. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-cognito-identity/README.md b/clients/aws-sdk-cognito-identity/README.md index 03a867517..55753721c 100644 --- a/clients/aws-sdk-cognito-identity/README.md +++ b/clients/aws-sdk-cognito-identity/README.md @@ -5,8 +5,8 @@ The `aws-sdk-cognito-identity` package provides a client for making requests to Amazon Cognito Identity. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-connecthealth/README.md b/clients/aws-sdk-connecthealth/README.md index 077486708..733c95899 100644 --- a/clients/aws-sdk-connecthealth/README.md +++ b/clients/aws-sdk-connecthealth/README.md @@ -5,8 +5,8 @@ The `aws-sdk-connecthealth` package provides a client for making requests to Connect Health. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-dynamodb/README.md b/clients/aws-sdk-dynamodb/README.md index 6a31bce5c..6762a8ff3 100644 --- a/clients/aws-sdk-dynamodb/README.md +++ b/clients/aws-sdk-dynamodb/README.md @@ -5,8 +5,8 @@ The `aws-sdk-dynamodb` package provides a client for making requests to Amazon DynamoDB. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-ec2/README.md b/clients/aws-sdk-ec2/README.md index 02f5d4747..5ab3f15ca 100644 --- a/clients/aws-sdk-ec2/README.md +++ b/clients/aws-sdk-ec2/README.md @@ -5,8 +5,8 @@ The `aws-sdk-ec2` package provides a client for making requests to Amazon Elastic Compute Cloud. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-ecs/README.md b/clients/aws-sdk-ecs/README.md index 887b7a2c6..144f2b1a7 100644 --- a/clients/aws-sdk-ecs/README.md +++ b/clients/aws-sdk-ecs/README.md @@ -5,8 +5,8 @@ The `aws-sdk-ecs` package provides a client for making requests to Amazon EC2 Container Service. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-guardduty/README.md b/clients/aws-sdk-guardduty/README.md index e7b47cc06..f56e2e403 100644 --- a/clients/aws-sdk-guardduty/README.md +++ b/clients/aws-sdk-guardduty/README.md @@ -5,8 +5,8 @@ The `aws-sdk-guardduty` package provides a client for making requests to Amazon GuardDuty. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-iam/README.md b/clients/aws-sdk-iam/README.md index a066fdc95..d2f897de5 100644 --- a/clients/aws-sdk-iam/README.md +++ b/clients/aws-sdk-iam/README.md @@ -5,8 +5,8 @@ The `aws-sdk-iam` package provides a client for making requests to AWS Identity and Access Management. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-kinesis/README.md b/clients/aws-sdk-kinesis/README.md index 8a7af71aa..21de31774 100644 --- a/clients/aws-sdk-kinesis/README.md +++ b/clients/aws-sdk-kinesis/README.md @@ -5,8 +5,8 @@ The `aws-sdk-kinesis` package provides a client for making requests to Amazon Kinesis. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-kms/README.md b/clients/aws-sdk-kms/README.md index 6d29ec9ed..d1d299c51 100644 --- a/clients/aws-sdk-kms/README.md +++ b/clients/aws-sdk-kms/README.md @@ -5,8 +5,8 @@ The `aws-sdk-kms` package provides a client for making requests to AWS Key Management Service. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-lambda/README.md b/clients/aws-sdk-lambda/README.md index 0a93a403c..375aa44ca 100644 --- a/clients/aws-sdk-lambda/README.md +++ b/clients/aws-sdk-lambda/README.md @@ -5,8 +5,8 @@ The `aws-sdk-lambda` package provides a client for making requests to AWS Lambda. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-lex-runtime-v2/README.md b/clients/aws-sdk-lex-runtime-v2/README.md index 1610fadd2..7a6299c06 100644 --- a/clients/aws-sdk-lex-runtime-v2/README.md +++ b/clients/aws-sdk-lex-runtime-v2/README.md @@ -5,8 +5,8 @@ The `aws-sdk-lex-runtime-v2` package provides a client for making requests to Amazon Lex Runtime V2. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-polly/README.md b/clients/aws-sdk-polly/README.md index 44330a555..3843d82f1 100644 --- a/clients/aws-sdk-polly/README.md +++ b/clients/aws-sdk-polly/README.md @@ -5,8 +5,8 @@ The `aws-sdk-polly` package provides a client for making requests to Amazon Polly. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-python/README.md b/clients/aws-sdk-python/README.md index 8b03df0ae..4fd32f498 100644 --- a/clients/aws-sdk-python/README.md +++ b/clients/aws-sdk-python/README.md @@ -3,8 +3,8 @@ The `aws-sdk-python` meta-package provides a convenient way to install supported AWS service clients at compatible versions. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-qbusiness/README.md b/clients/aws-sdk-qbusiness/README.md index 0c9824953..7a3aeaad6 100644 --- a/clients/aws-sdk-qbusiness/README.md +++ b/clients/aws-sdk-qbusiness/README.md @@ -5,8 +5,8 @@ The `aws-sdk-qbusiness` package provides a client for making requests to QBusiness. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-rds/README.md b/clients/aws-sdk-rds/README.md index 939211391..aca190c06 100644 --- a/clients/aws-sdk-rds/README.md +++ b/clients/aws-sdk-rds/README.md @@ -5,8 +5,8 @@ The `aws-sdk-rds` package provides a client for making requests to Amazon Relational Database Service. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-s3/README.md b/clients/aws-sdk-s3/README.md index b37251e7b..26511f567 100644 --- a/clients/aws-sdk-s3/README.md +++ b/clients/aws-sdk-s3/README.md @@ -5,8 +5,8 @@ The `aws-sdk-s3` package provides a client for making requests to Amazon Simple Storage Service. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-sagemaker-runtime-http2/README.md b/clients/aws-sdk-sagemaker-runtime-http2/README.md index 1df4e399c..550d58572 100644 --- a/clients/aws-sdk-sagemaker-runtime-http2/README.md +++ b/clients/aws-sdk-sagemaker-runtime-http2/README.md @@ -5,8 +5,8 @@ The `aws-sdk-sagemaker-runtime-http2` package provides a client for making requests to Amazon SageMaker Runtime HTTP2. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-secrets-manager/README.md b/clients/aws-sdk-secrets-manager/README.md index daf79833b..4361fc61d 100644 --- a/clients/aws-sdk-secrets-manager/README.md +++ b/clients/aws-sdk-secrets-manager/README.md @@ -5,8 +5,8 @@ The `aws-sdk-secrets-manager` package provides a client for making requests to AWS Secrets Manager. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-signin/README.md b/clients/aws-sdk-signin/README.md index 96bb7c922..b767a8f8a 100644 --- a/clients/aws-sdk-signin/README.md +++ b/clients/aws-sdk-signin/README.md @@ -5,8 +5,8 @@ The `aws-sdk-signin` package provides a client for making requests to AWS Sign-In Service. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-sns/README.md b/clients/aws-sdk-sns/README.md index b56773df9..b82c425e6 100644 --- a/clients/aws-sdk-sns/README.md +++ b/clients/aws-sdk-sns/README.md @@ -5,8 +5,8 @@ The `aws-sdk-sns` package provides a client for making requests to Amazon Simple Notification Service. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-sqs/README.md b/clients/aws-sdk-sqs/README.md index 6019986f8..d30353855 100644 --- a/clients/aws-sdk-sqs/README.md +++ b/clients/aws-sdk-sqs/README.md @@ -5,8 +5,8 @@ The `aws-sdk-sqs` package provides a client for making requests to Amazon Simple Queue Service. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-sts/README.md b/clients/aws-sdk-sts/README.md index 8578097f9..3fa9cfd55 100644 --- a/clients/aws-sdk-sts/README.md +++ b/clients/aws-sdk-sts/README.md @@ -5,8 +5,8 @@ The `aws-sdk-sts` package provides a client for making requests to AWS Security Token Service. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/clients/aws-sdk-transcribe-streaming/README.md b/clients/aws-sdk-transcribe-streaming/README.md index ca5fc82de..d133817c8 100644 --- a/clients/aws-sdk-transcribe-streaming/README.md +++ b/clients/aws-sdk-transcribe-streaming/README.md @@ -5,8 +5,8 @@ The `aws-sdk-transcribe-streaming` package provides a client for making requests to Amazon Transcribe Streaming Service. -> **Note:** This SDK is experimental and in early development. Breaking changes -> may occur prior to the release of version 1.0.0. +> **Note:** This SDK is in Developer Preview. Breaking changes may occur prior +> to the release of version 1.0.0. ## Installation diff --git a/codegen/integrations/src/main/java/software/amazon/aws/sdk/python/codegen/AwsSdkPackageFilesIntegration.java b/codegen/integrations/src/main/java/software/amazon/aws/sdk/python/codegen/AwsSdkPackageFilesIntegration.java index c4580e945..ee60e3b9b 100644 --- a/codegen/integrations/src/main/java/software/amazon/aws/sdk/python/codegen/AwsSdkPackageFilesIntegration.java +++ b/codegen/integrations/src/main/java/software/amazon/aws/sdk/python/codegen/AwsSdkPackageFilesIntegration.java @@ -62,8 +62,8 @@ public void write(PythonWriter writer, String previousText, ReadmeSection sectio The `$2L` package provides a client for making requests to $1L. - > **Note:** This SDK is experimental and in early development. Breaking changes - > may occur prior to the release of version 1.0.0. + > **Note:** This SDK is in Developer Preview. Breaking changes may occur prior + > to the release of version 1.0.0. ## Installation diff --git a/codegen/integrations/src/test/java/software/amazon/aws/sdk/python/codegen/AwsSdkPackageFilesIntegrationTest.java b/codegen/integrations/src/test/java/software/amazon/aws/sdk/python/codegen/AwsSdkPackageFilesIntegrationTest.java index bf7d56246..fb41c3226 100644 --- a/codegen/integrations/src/test/java/software/amazon/aws/sdk/python/codegen/AwsSdkPackageFilesIntegrationTest.java +++ b/codegen/integrations/src/test/java/software/amazon/aws/sdk/python/codegen/AwsSdkPackageFilesIntegrationTest.java @@ -42,8 +42,8 @@ public void readmeUsesTitleSdkIdAndPackageName() { The `aws-sdk-secrets-manager` package provides a client for making requests to AWS Secrets Manager. - > **Note:** This SDK is experimental and in early development. Breaking changes - > may occur prior to the release of version 1.0.0. + > **Note:** This SDK is in Developer Preview. Breaking changes may occur prior + > to the release of version 1.0.0. ## Installation diff --git a/docs/index.md b/docs/index.md index d7d907879..a53f07064 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,12 +3,12 @@ The AWS SDK for Python v4 provides asynchronous clients for supported AWS services. Each service has its own package. -!!! warning "Experimental: Not for production use" +!!! warning "Developer Preview" - Use this SDK for evaluation and pre-production testing. Interfaces and - behavior may change before general availability. Use - [Boto3](https://boto3.amazonaws.com/v1/documentation/api/latest/index.html) - for production workloads. + The AWS SDK for Python v4 is intended for evaluation and testing only. Do + not use it for production workloads; use + [Boto3](https://docs.aws.amazon.com/boto3/latest/) + instead. [Browse clients](clients/index.md){ .md-button .md-button--primary } [View source](https://github.com/aws/aws-sdk-python){ .md-button } @@ -83,8 +83,7 @@ tables in `us-east-1`: ```python import asyncio -from aws_sdk_dynamodb.aio.client import AsyncDynamoDBClient -from aws_sdk_dynamodb.aio.config import AsyncDynamoDBConfig +from aws_sdk_dynamodb import AsyncDynamoDBClient, AsyncDynamoDBConfig async def main(): diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index e4574103f..0e4611a79 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -13,7 +13,7 @@ p:has(span.breadcrumb) { content: url('../assets/aws-logo-dark.svg'); } -/* Keep the experimental status announcement prominent across the docs site. */ +/* Keep the Developer Preview status announcement prominent across the docs site. */ .md-banner { background-color: #ffe0a3; color: #291b00; diff --git a/overrides/main.html b/overrides/main.html index 170745256..a46eacfac 100644 --- a/overrides/main.html +++ b/overrides/main.html @@ -1,8 +1,9 @@ {% extends "base.html" %} {% block announce %} - Experimental: - This SDK is not for production use, and its APIs and behavior may change. - For production workloads, use - Boto3. + Developer Preview: + This SDK is intended for evaluation and testing only. Do not use it for + production workloads; use + Boto3 + instead. {% endblock %}