diff --git a/clients/aws-sdk-acm/NOTICE b/clients/aws-sdk-acm/NOTICE new file mode 100644 index 000000000..616fc5889 --- /dev/null +++ b/clients/aws-sdk-acm/NOTICE @@ -0,0 +1 @@ +Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. diff --git a/clients/aws-sdk-acm/README.md b/clients/aws-sdk-acm/README.md index 3bb0df40f..5ab25f239 100644 --- a/clients/aws-sdk-acm/README.md +++ b/clients/aws-sdk-acm/README.md @@ -1,12 +1,22 @@ -## AWS Certificate Manager Client +# AWS Certificate Manager Client -aws_sdk_acm client +The `aws-sdk-acm` package provides a client for making +requests to AWS Certificate Manager. -### Documentation +> **Note:** This SDK is experimental and in early development. Breaking changes +> may occur prior to the release of version 1.0.0. -You can use Certificate Manager (ACM) to manage SSL/TLS certificates for -your Amazon Web Services-based websites and applications. For more -information about using ACM, see the [Certificate Manager User -Guide](https://docs.aws.amazon.com/acm/latest/userguide/). +## Installation + +```bash +python -m pip install aws-sdk-acm +``` + +## Documentation + +- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/acm/) - + the ACM client, available operations, and types. +- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - + configuration, authentication, and usage of the AWS SDK for Python v4. diff --git a/clients/aws-sdk-api-gateway/README.md b/clients/aws-sdk-api-gateway/README.md index 7477ff62d..3c5107f72 100644 --- a/clients/aws-sdk-api-gateway/README.md +++ b/clients/aws-sdk-api-gateway/README.md @@ -1,3 +1,5 @@ + + # Amazon API Gateway Client The `aws-sdk-api-gateway` package provides a client for making diff --git a/clients/aws-sdk-appconfigdata/NOTICE b/clients/aws-sdk-appconfigdata/NOTICE new file mode 100644 index 000000000..616fc5889 --- /dev/null +++ b/clients/aws-sdk-appconfigdata/NOTICE @@ -0,0 +1 @@ +Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. diff --git a/clients/aws-sdk-appconfigdata/README.md b/clients/aws-sdk-appconfigdata/README.md index b1943d33c..d56011720 100644 --- a/clients/aws-sdk-appconfigdata/README.md +++ b/clients/aws-sdk-appconfigdata/README.md @@ -1,63 +1,22 @@ -## AWS AppConfig Data Client +# AWS AppConfig Data Client -aws_sdk_appconfigdata client +The `aws-sdk-appconfigdata` package provides a client for making +requests to AWS AppConfig Data. -### Documentation +> **Note:** This SDK is experimental and in early development. Breaking changes +> may occur prior to the release of version 1.0.0. -AppConfig Data provides the data plane APIs your application uses to -retrieve configuration data. Here's how it works: +## Installation -Your application retrieves configuration data by first establishing a -configuration session using the AppConfig Data StartConfigurationSession -API action. Your session's client then makes periodic calls to -GetLatestConfiguration to check for and retrieve the latest data -available. +```bash +python -m pip install aws-sdk-appconfigdata +``` -When calling `StartConfigurationSession`, your code sends the following -information: +## Documentation -- Identifiers (ID or name) of an AppConfig application, environment, and - configuration profile that the session tracks. - -- (Optional) The minimum amount of time the session's client must wait - between calls to `GetLatestConfiguration`. - -In response, AppConfig provides an `InitialConfigurationToken` to be -given to the session's client and used the first time it calls -`GetLatestConfiguration` for that session. - -Warning: - This token should only be used once in your first call to - `GetLatestConfiguration`. You *must* use the new token in the - `GetLatestConfiguration` response (`NextPollConfigurationToken`) in each - subsequent call to `GetLatestConfiguration`. - -When calling `GetLatestConfiguration`, your client code sends the most -recent `ConfigurationToken` value it has and receives in response: - -- `NextPollConfigurationToken`: the `ConfigurationToken` value to use on - the next call to `GetLatestConfiguration`. - -- `NextPollIntervalInSeconds`: the duration the client should wait - before making its next call to `GetLatestConfiguration`. This duration - may vary over the course of the session, so it should be used instead - of the value sent on the `StartConfigurationSession` call. - -- The configuration: the latest data intended for the session. This may - be empty if the client already has the latest version of the - configuration. - -Warning: - The `InitialConfigurationToken` and `NextPollConfigurationToken` should - only be used once. To support long poll use cases, the tokens are valid - for up to 24 hours. If a `GetLatestConfiguration` call uses an expired - token, the system returns `BadRequestException`. - -For more information and to view example CLI commands that show how to -retrieve a configuration using the AppConfig Data -`StartConfigurationSession` and `GetLatestConfiguration` API actions, -see [Retrieving the -configuration](http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration) -in the *AppConfig User Guide*. +- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/appconfigdata/) - + the AppConfigData client, available operations, and types. +- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - + configuration, authentication, and usage of the AWS SDK for Python v4. diff --git a/clients/aws-sdk-bedrock-agent-runtime/README.md b/clients/aws-sdk-bedrock-agent-runtime/README.md index 6ea75cfc8..99352549b 100644 --- a/clients/aws-sdk-bedrock-agent-runtime/README.md +++ b/clients/aws-sdk-bedrock-agent-runtime/README.md @@ -1,3 +1,5 @@ + + # Agents for Amazon Bedrock Runtime Client The `aws-sdk-bedrock-agent-runtime` package provides a client for making diff --git a/clients/aws-sdk-bedrock-agent/README.md b/clients/aws-sdk-bedrock-agent/README.md index c340b92de..538378870 100644 --- a/clients/aws-sdk-bedrock-agent/README.md +++ b/clients/aws-sdk-bedrock-agent/README.md @@ -1,3 +1,5 @@ + + # Agents for Amazon Bedrock Client The `aws-sdk-bedrock-agent` package provides a client for making diff --git a/clients/aws-sdk-bedrock-agentcore-control/README.md b/clients/aws-sdk-bedrock-agentcore-control/README.md index e64c6a9bf..2aad26304 100644 --- a/clients/aws-sdk-bedrock-agentcore-control/README.md +++ b/clients/aws-sdk-bedrock-agentcore-control/README.md @@ -1,3 +1,5 @@ + + # Amazon Bedrock AgentCore Control Client The `aws-sdk-bedrock-agentcore-control` package provides a client for making diff --git a/clients/aws-sdk-bedrock-agentcore/README.md b/clients/aws-sdk-bedrock-agentcore/README.md index 3a12d46ce..d8c38a1c8 100644 --- a/clients/aws-sdk-bedrock-agentcore/README.md +++ b/clients/aws-sdk-bedrock-agentcore/README.md @@ -1,3 +1,5 @@ + + # Amazon Bedrock AgentCore Client The `aws-sdk-bedrock-agentcore` package provides a client for making diff --git a/clients/aws-sdk-bedrock-data-automation-runtime/README.md b/clients/aws-sdk-bedrock-data-automation-runtime/README.md index ac52f1b77..13e1d7ac4 100644 --- a/clients/aws-sdk-bedrock-data-automation-runtime/README.md +++ b/clients/aws-sdk-bedrock-data-automation-runtime/README.md @@ -1,3 +1,5 @@ + + # Runtime for Amazon Bedrock Data Automation Client The `aws-sdk-bedrock-data-automation-runtime` package provides a client for making diff --git a/clients/aws-sdk-bedrock-data-automation/README.md b/clients/aws-sdk-bedrock-data-automation/README.md index 8a5a9cf48..8ede07385 100644 --- a/clients/aws-sdk-bedrock-data-automation/README.md +++ b/clients/aws-sdk-bedrock-data-automation/README.md @@ -1,3 +1,5 @@ + + # Data Automation for Amazon Bedrock Client The `aws-sdk-bedrock-data-automation` package provides a client for making diff --git a/clients/aws-sdk-bedrock-runtime/README.md b/clients/aws-sdk-bedrock-runtime/README.md index 9fc85a634..937c7b5b6 100644 --- a/clients/aws-sdk-bedrock-runtime/README.md +++ b/clients/aws-sdk-bedrock-runtime/README.md @@ -1,3 +1,5 @@ + + # Amazon Bedrock Runtime Client The `aws-sdk-bedrock-runtime` package provides a client for making diff --git a/clients/aws-sdk-bedrock/README.md b/clients/aws-sdk-bedrock/README.md index 6a6262982..441190196 100644 --- a/clients/aws-sdk-bedrock/README.md +++ b/clients/aws-sdk-bedrock/README.md @@ -1,3 +1,5 @@ + + # Amazon Bedrock Client The `aws-sdk-bedrock` package provides a client for making diff --git a/clients/aws-sdk-cloudformation/NOTICE b/clients/aws-sdk-cloudformation/NOTICE new file mode 100644 index 000000000..616fc5889 --- /dev/null +++ b/clients/aws-sdk-cloudformation/NOTICE @@ -0,0 +1 @@ +Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. diff --git a/clients/aws-sdk-cloudformation/README.md b/clients/aws-sdk-cloudformation/README.md index 4367c5e75..be06e0856 100644 --- a/clients/aws-sdk-cloudformation/README.md +++ b/clients/aws-sdk-cloudformation/README.md @@ -1,30 +1,22 @@ -## AWS CloudFormation Client +# AWS CloudFormation Client -aws_sdk_cloudformation client +The `aws-sdk-cloudformation` package provides a client for making +requests to AWS CloudFormation. -### Documentation +> **Note:** This SDK is experimental and in early development. Breaking changes +> may occur prior to the release of version 1.0.0. -CloudFormation allows you to create and manage Amazon Web Services -infrastructure deployments predictably and repeatedly. You can use -CloudFormation to leverage Amazon Web Services products, such as Amazon -Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple -Notification Service, Elastic Load Balancing, and Amazon EC2 Auto -Scaling to build highly reliable, highly scalable, cost-effective -applications without creating or configuring the underlying Amazon Web -Services infrastructure. +## Installation -With CloudFormation, you declare all your resources and dependencies in -a template file. The template defines a collection of resources as a -single unit called a stack. CloudFormation creates and deletes all -member resources of the stack together and manages all dependencies -between the resources for you. +```bash +python -m pip install aws-sdk-cloudformation +``` -For more information about CloudFormation, see the [CloudFormation -product page](http://aws.amazon.com/cloudformation/). +## Documentation -CloudFormation makes use of other Amazon Web Services products. If you -need additional technical information about a specific Amazon Web -Services product, you can find the product's technical documentation at -[docs.aws.amazon.com](https://docs.aws.amazon.com/). +- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/cloudformation/) - + the CloudFormation client, available operations, and types. +- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - + configuration, authentication, and usage of the AWS SDK for Python v4. diff --git a/clients/aws-sdk-cloudfront-keyvaluestore/NOTICE b/clients/aws-sdk-cloudfront-keyvaluestore/NOTICE new file mode 100644 index 000000000..616fc5889 --- /dev/null +++ b/clients/aws-sdk-cloudfront-keyvaluestore/NOTICE @@ -0,0 +1 @@ +Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. diff --git a/clients/aws-sdk-cloudfront-keyvaluestore/README.md b/clients/aws-sdk-cloudfront-keyvaluestore/README.md index 45c383425..86e7b03d7 100644 --- a/clients/aws-sdk-cloudfront-keyvaluestore/README.md +++ b/clients/aws-sdk-cloudfront-keyvaluestore/README.md @@ -1,10 +1,22 @@ -## Amazon CloudFront KeyValueStore Client +# Amazon CloudFront KeyValueStore Client -aws_sdk_cloudfront_keyvaluestore client +The `aws-sdk-cloudfront-keyvaluestore` package provides a client for making +requests to Amazon CloudFront KeyValueStore. -### Documentation +> **Note:** This SDK is experimental and in early development. Breaking changes +> may occur prior to the release of version 1.0.0. -Amazon CloudFront KeyValueStore Service to View and Update Data in a KVS -Resource +## Installation + +```bash +python -m pip install aws-sdk-cloudfront-keyvaluestore +``` + +## Documentation + +- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/cloudfront-keyvaluestore/) - + the CloudFront KeyValueStore client, available operations, and types. +- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - + configuration, authentication, and usage of the AWS SDK for Python v4. diff --git a/clients/aws-sdk-cloudfront/NOTICE b/clients/aws-sdk-cloudfront/NOTICE new file mode 100644 index 000000000..616fc5889 --- /dev/null +++ b/clients/aws-sdk-cloudfront/NOTICE @@ -0,0 +1 @@ +Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. diff --git a/clients/aws-sdk-cloudfront/README.md b/clients/aws-sdk-cloudfront/README.md index e8f6f1baa..3064e2823 100644 --- a/clients/aws-sdk-cloudfront/README.md +++ b/clients/aws-sdk-cloudfront/README.md @@ -1,13 +1,22 @@ -## Amazon CloudFront Client +# Amazon CloudFront Client -aws_sdk_cloudfront client +The `aws-sdk-cloudfront` package provides a client for making +requests to Amazon CloudFront. -### Documentation +> **Note:** This SDK is experimental and in early development. Breaking changes +> may occur prior to the release of version 1.0.0. -This is the *Amazon CloudFront API Reference*. This guide is for -developers who need detailed information about CloudFront API actions, -data types, and errors. For detailed information about CloudFront -features, see the [Amazon CloudFront Developer -Guide](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Introduction.html). +## Installation + +```bash +python -m pip install aws-sdk-cloudfront +``` + +## Documentation + +- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/cloudfront/) - + the CloudFront client, available operations, and types. +- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - + configuration, authentication, and usage of the AWS SDK for Python v4. diff --git a/clients/aws-sdk-cloudtrail/README.md b/clients/aws-sdk-cloudtrail/README.md index 17d428299..88608df82 100644 --- a/clients/aws-sdk-cloudtrail/README.md +++ b/clients/aws-sdk-cloudtrail/README.md @@ -1,3 +1,5 @@ + + # AWS CloudTrail Client The `aws-sdk-cloudtrail` package provides a client for making diff --git a/clients/aws-sdk-cognito-identity/README.md b/clients/aws-sdk-cognito-identity/README.md index ed470e530..03a867517 100644 --- a/clients/aws-sdk-cognito-identity/README.md +++ b/clients/aws-sdk-cognito-identity/README.md @@ -1,3 +1,5 @@ + + # Amazon Cognito Identity Client The `aws-sdk-cognito-identity` package provides a client for making diff --git a/clients/aws-sdk-connecthealth/README.md b/clients/aws-sdk-connecthealth/README.md index a024b197d..077486708 100644 --- a/clients/aws-sdk-connecthealth/README.md +++ b/clients/aws-sdk-connecthealth/README.md @@ -1,3 +1,5 @@ + + # Connect Health Client The `aws-sdk-connecthealth` package provides a client for making diff --git a/clients/aws-sdk-dynamodb/README.md b/clients/aws-sdk-dynamodb/README.md index 7c4bbb2be..6a31bce5c 100644 --- a/clients/aws-sdk-dynamodb/README.md +++ b/clients/aws-sdk-dynamodb/README.md @@ -1,3 +1,5 @@ + + # Amazon DynamoDB Client The `aws-sdk-dynamodb` package provides a client for making diff --git a/clients/aws-sdk-ec2/NOTICE b/clients/aws-sdk-ec2/NOTICE new file mode 100644 index 000000000..616fc5889 --- /dev/null +++ b/clients/aws-sdk-ec2/NOTICE @@ -0,0 +1 @@ +Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. diff --git a/clients/aws-sdk-ec2/README.md b/clients/aws-sdk-ec2/README.md index 41db48b82..02f5d4747 100644 --- a/clients/aws-sdk-ec2/README.md +++ b/clients/aws-sdk-ec2/README.md @@ -1,46 +1,22 @@ -## Amazon Elastic Compute Cloud Client +# Amazon Elastic Compute Cloud Client -aws_sdk_ec2 client +The `aws-sdk-ec2` package provides a client for making +requests to Amazon Elastic Compute Cloud. -### Documentation +> **Note:** This SDK is experimental and in early development. Breaking changes +> may occur prior to the release of version 1.0.0. -This is the *Amazon EC2 API Reference*. It provides descriptions, API -request parameters, and the XML response for each of the Amazon EC2 -Query API actions. Note that the Amazon EC2 API includes actions for -Amazon EC2 plus additional services, such as Amazon EBS and Amazon VPC. +## Installation -**Learn more** +```bash +python -m pip install aws-sdk-ec2 +``` -- To learn about using the Query API, see [Using the API for Amazon - EC2](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-low-level-api.html). +## Documentation -- To learn about the permissions required to call an Amazon EC2 API - action, see [Actions, resources, and condition keys for Amazon - EC2](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonec2.html). - -- To get the list of API actions by service and resource, see [Actions - by - service](https://docs.aws.amazon.com/ec2/latest/devguide/OperationList-query.html). - -- To get the alphabetical list of API actions, see . - -- To get descriptions of the API error codes, see [Error codes for the - Amazon EC2 - API](https://docs.aws.amazon.com/ec2/latest/devguide/errors-overview.html). - -Alternatively, use one of the following methods to access the Amazon EC2 -API, instead of using the Query API directly: - -- [Amazon Web Services CLI Command Reference - ec2 - commands](https://docs.aws.amazon.com/cli/latest/reference/ec2/) - -- [CloudFormation - Amazon EC2 resource type - reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/AWS_EC2.html) - -- [Amazon Web Services Tools for PowerShell Cmdlet Reference - Amazon - EC2 - cmdlets](https://docs.aws.amazon.com/powershell/v5/reference/items/EC2_cmdlets.html) - -- [Amazon Web Services SDKs](https://builder.aws.com/build/tools) +- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/ec2/) - + the EC2 client, available operations, and types. +- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - + configuration, authentication, and usage of the AWS SDK for Python v4. diff --git a/clients/aws-sdk-ecs/NOTICE b/clients/aws-sdk-ecs/NOTICE new file mode 100644 index 000000000..616fc5889 --- /dev/null +++ b/clients/aws-sdk-ecs/NOTICE @@ -0,0 +1 @@ +Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. diff --git a/clients/aws-sdk-ecs/README.md b/clients/aws-sdk-ecs/README.md index 1898010ba..887b7a2c6 100644 --- a/clients/aws-sdk-ecs/README.md +++ b/clients/aws-sdk-ecs/README.md @@ -1,26 +1,22 @@ -## Amazon EC2 Container Service Client +# Amazon EC2 Container Service Client -aws_sdk_ecs client +The `aws-sdk-ecs` package provides a client for making +requests to Amazon EC2 Container Service. -### Documentation +> **Note:** This SDK is experimental and in early development. Breaking changes +> may occur prior to the release of version 1.0.0. -Amazon Elastic Container Service (Amazon ECS) is a highly scalable, -fast, container management service. It makes it easy to run, stop, and -manage Docker containers. You can host your cluster on a serverless -infrastructure that's managed by Amazon ECS by launching your services -or tasks on Fargate. For more control, you can host your tasks on a -cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External -(on-premises) instances that you manage. +## Installation -Amazon ECS makes it easy to launch and stop container-based applications -with simple API calls. This makes it easy to get the state of your -cluster from a centralized service, and gives you access to many -familiar Amazon EC2 features. +```bash +python -m pip install aws-sdk-ecs +``` -You can use Amazon ECS to schedule the placement of containers across -your cluster based on your resource needs, isolation policies, and -availability requirements. With Amazon ECS, you don't need to operate -your own cluster management and configuration management systems. You -also don't need to worry about scaling your management infrastructure. +## Documentation + +- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/ecs/) - + the ECS client, available operations, and types. +- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - + configuration, authentication, and usage of the AWS SDK for Python v4. diff --git a/clients/aws-sdk-guardduty/README.md b/clients/aws-sdk-guardduty/README.md index f38bc9e55..e7b47cc06 100644 --- a/clients/aws-sdk-guardduty/README.md +++ b/clients/aws-sdk-guardduty/README.md @@ -1,3 +1,5 @@ + + # Amazon GuardDuty Client The `aws-sdk-guardduty` package provides a client for making diff --git a/clients/aws-sdk-iam/NOTICE b/clients/aws-sdk-iam/NOTICE new file mode 100644 index 000000000..616fc5889 --- /dev/null +++ b/clients/aws-sdk-iam/NOTICE @@ -0,0 +1 @@ +Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. diff --git a/clients/aws-sdk-iam/README.md b/clients/aws-sdk-iam/README.md index 4fe6bdeac..a066fdc95 100644 --- a/clients/aws-sdk-iam/README.md +++ b/clients/aws-sdk-iam/README.md @@ -1,71 +1,22 @@ -## AWS Identity and Access Management Client +# AWS Identity and Access Management Client -aws_sdk_iam client +The `aws-sdk-iam` package provides a client for making +requests to AWS Identity and Access Management. -### Documentation +> **Note:** This SDK is experimental and in early development. Breaking changes +> may occur prior to the release of version 1.0.0. -Identity and Access Management (IAM) is a web service for securely -controlling access to Amazon Web Services services. With IAM, you can -centrally manage users, security credentials such as access keys, and -permissions that control which Amazon Web Services resources users and -applications can access. For more information about IAM, see [Identity -and Access Management (IAM)](http://aws.amazon.com/iam/) and the -[Identity and Access Management User -Guide](https://docs.aws.amazon.com/IAM/latest/UserGuide/). +## Installation -**Programmatic access to IAM** +```bash +python -m pip install aws-sdk-iam +``` -We recommend that you use the Amazon Web Services SDKs to make -programmatic API calls to IAM. The Amazon Web Services SDKs consist of -libraries and sample code for various programming languages and -platforms (for example, Java, Ruby, .NET, iOS, and Android). The SDKs -provide a convenient way to create programmatic access to IAM and Amazon -Web Services. For example, the SDKs take care of tasks such as -cryptographically signing requests, managing errors, and retrying -requests automatically. For more information, see [Tools to build on -Amazon Web Services](http://aws.amazon.com/tools/). +## Documentation -Alternatively, you can also use the IAM Query API to make direct calls -to the IAM service. For more information about calling the IAM Query -API, see [Making query -requests](https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html) -in the *Identity and Access Management User Guide*. IAM supports GET and -POST requests for all actions. That is, the API does not require you to -use GET for some actions and POST for others. However, GET requests are -subject to the limitation size of a URL. Therefore, for operations that -require larger sizes, use a POST request. - -**Signing requests** - -Requests must be signed using an access key ID and a secret access key. -We strongly recommend that you do not use your Amazon Web Services -account access key ID and secret access key for everyday work with IAM. -You can use the access key ID and secret access key for an IAM user or -you can use the Security Token Service to generate temporary security -credentials and use those to sign requests. - -To sign requests, we recommend that you use [Signature Version -4](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). -If you have an existing application that uses Signature Version 2, you -do not have to update it to use Signature Version 4. However, some -operations now require Signature Version 4. The documentation for -operations that require version 4 indicate this requirement. - -**Additional resources** - -- [Amazon Web Services security - credentials](https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html). - This topic provides general information about the types of credentials - used for accessing Amazon Web Services. - -- [IAM best - practices](https://docs.aws.amazon.com/IAM/latest/UserGuide/IAMBestPractices.html). - This topic presents a list of suggestions for using the IAM service to - help secure your Amazon Web Services resources. - -- [Signing Amazon Web Services API - requests](https://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html). - This set of topics walk you through the process of signing a request - using an access key ID and secret access key. +- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/iam/) - + the IAM client, available operations, and types. +- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - + configuration, authentication, and usage of the AWS SDK for Python v4. diff --git a/clients/aws-sdk-kinesis/NOTICE b/clients/aws-sdk-kinesis/NOTICE new file mode 100644 index 000000000..616fc5889 --- /dev/null +++ b/clients/aws-sdk-kinesis/NOTICE @@ -0,0 +1 @@ +Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. diff --git a/clients/aws-sdk-kinesis/README.md b/clients/aws-sdk-kinesis/README.md index e3cda2cb9..8a7af71aa 100644 --- a/clients/aws-sdk-kinesis/README.md +++ b/clients/aws-sdk-kinesis/README.md @@ -1,10 +1,22 @@ -## Amazon Kinesis Client +# Amazon Kinesis Client -aws_sdk_kinesis client +The `aws-sdk-kinesis` package provides a client for making +requests to Amazon Kinesis. -### Documentation +> **Note:** This SDK is experimental and in early development. Breaking changes +> may occur prior to the release of version 1.0.0. -Amazon Kinesis Data Streams is a managed service that scales elastically -for real-time processing of streaming big data. +## Installation + +```bash +python -m pip install aws-sdk-kinesis +``` + +## Documentation + +- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/kinesis/) - + the Kinesis client, available operations, and types. +- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - + configuration, authentication, and usage of the AWS SDK for Python v4. diff --git a/clients/aws-sdk-kms/NOTICE b/clients/aws-sdk-kms/NOTICE new file mode 100644 index 000000000..616fc5889 --- /dev/null +++ b/clients/aws-sdk-kms/NOTICE @@ -0,0 +1 @@ +Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. diff --git a/clients/aws-sdk-kms/README.md b/clients/aws-sdk-kms/README.md index 8daa821dd..6d29ec9ed 100644 --- a/clients/aws-sdk-kms/README.md +++ b/clients/aws-sdk-kms/README.md @@ -1,123 +1,22 @@ -## AWS Key Management Service Client +# AWS Key Management Service Client -aws_sdk_kms client +The `aws-sdk-kms` package provides a client for making +requests to AWS Key Management Service. -### Documentation +> **Note:** This SDK is experimental and in early development. Breaking changes +> may occur prior to the release of version 1.0.0. -Key Management Service (KMS) is an encryption and key management web -service. This guide describes the KMS operations that you can call -programmatically. For general information about KMS, see the [*Key -Management Service Developer -Guide*](https://docs.aws.amazon.com/kms/latest/developerguide/) . +## Installation -Note: - KMS has replaced the term *customer master key (CMK)* with *Key - Management Service key* and *KMS key*. The concept has not changed. To - prevent breaking changes, KMS is keeping some variations of this term. +```bash +python -m pip install aws-sdk-kms +``` - Amazon Web Services provides SDKs that consist of libraries and sample - code for various programming languages and platforms (Java, Rust, - Python, Ruby, .Net, macOS, Android, etc.). The SDKs provide a convenient - way to create programmatic access to KMS and other Amazon Web Services - services. For example, the SDKs take care of tasks such as signing - requests (see below), managing errors, and retrying requests - automatically. For more information about the Amazon Web Services SDKs, - including how to download and install them, see [Tools for Amazon Web - Services](http://aws.amazon.com/tools/). +## Documentation -We recommend that you use the Amazon Web Services SDKs to make -programmatic API calls to KMS. - -If you need to use FIPS 140-2 validated cryptographic modules when -communicating with Amazon Web Services, use one of the FIPS endpoints in -your preferred Amazon Web Services Region. If you need communicate over -IPv6, use the dual-stack endpoint in your preferred Amazon Web Services -Region. For more information see [Service -endpoints](https://docs.aws.amazon.com/general/latest/gr/kms.html#kms_region) -in the Key Management Service topic of the *Amazon Web Services General -Reference* and [Dual-stack endpoint -support](https://docs.aws.amazon.com/kms/latest/developerguide/ipv6-kms.html) -in the KMS Developer Guide. - -All KMS API calls must be signed and be transmitted using Transport -Layer Security (TLS). KMS recommends you always use the latest supported -TLS version. Clients must also support cipher suites with Perfect -Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman (DHE) or Elliptic -Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems such as Java -7 and later support these modes. - -Note: - With current technology, brute force attacks on KMS TLS cipher suite key - exchange mechanisms are not feasible. However, cipher suites that use - Rivest--Shamir--Adleman (RSA) or Diffie-Hellman (DH) key exchange will - be susceptible if large-scale quantum computing becomes practical. [NIST - IR 8547](https://nvlpubs.nist.gov/nistpubs/ir/2024/NIST.IR.8547.ipd.pdf) - on the NIST website establishes a timeline to phase out - quantum-vulnerable algorithms by 2030 and disallow them entirely by - 2035. If your applications rely on the long-term confidentiality of KMS - API traffic, we recommend that you [use post-quantum TLS with - KMS](https://docs.aws.amazon.com/kms/latest/developerguide/pqtls.html). - For more information about post-quantum cybersecurity, see [Post-Quantum - Cybersecurity - Resources](https://www.nsa.gov/Cybersecurity/Post-Quantum-Cybersecurity-Resources/) - on the National Security Agency (NSA) website. - -**Signing Requests** - -Requests must be signed using an access key ID and a secret access key. -We strongly recommend that you do not use your Amazon Web Services -account root access key ID and secret access key for everyday work. You -can use the access key ID and secret access key for an IAM user or you -can use the Security Token Service (STS) to generate temporary security -credentials and use those to sign requests. - -All KMS requests must be signed with [Signature Version -4](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). - -**Logging API Requests** - -KMS supports CloudTrail, a service that logs Amazon Web Services API -calls and related events for your Amazon Web Services account and -delivers them to an Amazon S3 bucket that you specify. By using the -information collected by CloudTrail, you can determine what requests -were made to KMS, who made the request, when it was made, and so on. To -learn more about CloudTrail, including how to turn it on and find your -log files, see the [CloudTrail User -Guide](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/). - -**Additional Resources** - -For more information about credentials and request signing, see the -following: - -- [Amazon Web Services Security - Credentials](https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html) - - This topic provides general information about the types of credentials - used to access Amazon Web Services. - -- [Temporary Security - Credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html) - - This section of the *IAM User Guide* describes how to create and use - temporary security credentials. - -- [Signature Version 4 Signing - Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) - - This set of topics walks you through the process of signing a request - using an access key ID and a secret access key. - -**Commonly Used API Operations** - -Of the API operations discussed in this guide, the following will prove -the most useful for most applications. You will likely perform -operations other than these, such as creating keys and assigning -policies, by using the console. - -- Encrypt - -- Decrypt - -- GenerateDataKey - -- GenerateDataKeyWithoutPlaintext +- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/kms/) - + the KMS client, available operations, and types. +- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - + configuration, authentication, and usage of the AWS SDK for Python v4. diff --git a/clients/aws-sdk-lambda/README.md b/clients/aws-sdk-lambda/README.md index 224711aa0..0a93a403c 100644 --- a/clients/aws-sdk-lambda/README.md +++ b/clients/aws-sdk-lambda/README.md @@ -1,3 +1,5 @@ + + # AWS Lambda Client The `aws-sdk-lambda` package provides a client for making diff --git a/clients/aws-sdk-lex-runtime-v2/README.md b/clients/aws-sdk-lex-runtime-v2/README.md index f3f9145fd..1610fadd2 100644 --- a/clients/aws-sdk-lex-runtime-v2/README.md +++ b/clients/aws-sdk-lex-runtime-v2/README.md @@ -1,3 +1,5 @@ + + # Amazon Lex Runtime V2 Client The `aws-sdk-lex-runtime-v2` package provides a client for making diff --git a/clients/aws-sdk-polly/README.md b/clients/aws-sdk-polly/README.md index 9b270de16..44330a555 100644 --- a/clients/aws-sdk-polly/README.md +++ b/clients/aws-sdk-polly/README.md @@ -1,3 +1,5 @@ + + # Amazon Polly Client The `aws-sdk-polly` package provides a client for making diff --git a/clients/aws-sdk-qbusiness/README.md b/clients/aws-sdk-qbusiness/README.md index 1af7325a6..0c9824953 100644 --- a/clients/aws-sdk-qbusiness/README.md +++ b/clients/aws-sdk-qbusiness/README.md @@ -1,3 +1,5 @@ + + # QBusiness Client The `aws-sdk-qbusiness` package provides a client for making diff --git a/clients/aws-sdk-rds/NOTICE b/clients/aws-sdk-rds/NOTICE new file mode 100644 index 000000000..616fc5889 --- /dev/null +++ b/clients/aws-sdk-rds/NOTICE @@ -0,0 +1 @@ +Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. diff --git a/clients/aws-sdk-rds/README.md b/clients/aws-sdk-rds/README.md index a919d89bb..939211391 100644 --- a/clients/aws-sdk-rds/README.md +++ b/clients/aws-sdk-rds/README.md @@ -1,58 +1,22 @@ -## Amazon Relational Database Service Client +# Amazon Relational Database Service Client -aws_sdk_rds client +The `aws-sdk-rds` package provides a client for making +requests to Amazon Relational Database Service. -### Documentation +> **Note:** This SDK is experimental and in early development. Breaking changes +> may occur prior to the release of version 1.0.0. -Amazon Relational Database Service (Amazon RDS) is a web service that -makes it easier to set up, operate, and scale a relational database in -the cloud. It provides cost-efficient, resizeable capacity for an -industry-standard relational database and manages common database -administration tasks, freeing up developers to focus on what makes their -applications and businesses unique. +## Installation -Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, -PostgreSQL, Microsoft SQL Server, Oracle, Db2, or Amazon Aurora database -server. These capabilities mean that the code, applications, and tools -you already use today with your existing databases work with Amazon RDS -without modification. Amazon RDS automatically backs up your database -and maintains the database software that powers your DB instance. Amazon -RDS is flexible: you can scale your DB instance's compute resources and -storage capacity to meet your application's demand. As with all Amazon -Web Services, there are no up-front investments, and you pay only for -the resources you use. +```bash +python -m pip install aws-sdk-rds +``` -This interface reference for Amazon RDS contains documentation for a -programming or command line interface you can use to manage Amazon RDS. -Amazon RDS is asynchronous, which means that some interfaces might -require techniques such as polling or callback functions to determine -when a command has been applied. In this reference, the parameter -descriptions indicate whether a command is applied immediately, on the -next instance reboot, or during the maintenance window. The reference -structure is as follows, and we list following some related topics from -the user guide. +## Documentation -**Amazon RDS API Reference** - -- For the alphabetical list of API actions, see [API - Actions](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Operations.html). - -- For the alphabetical list of data types, see [Data - Types](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Types.html). - -- For a list of common query parameters, see [Common - Parameters](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/CommonParameters.html). - -- For descriptions of the error codes, see [Common - Errors](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/CommonErrors.html). - -**Amazon RDS User Guide** - -- For a summary of the Amazon RDS interfaces, see [Available RDS - Interfaces](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Welcome.html#Welcome.Interfaces). - -- For more information about how to use the Query API, see [Using the - Query - API](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Using_the_Query_API.html). +- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/rds/) - + the RDS client, available operations, and types. +- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - + configuration, authentication, and usage of the AWS SDK for Python v4. diff --git a/clients/aws-sdk-s3/NOTICE b/clients/aws-sdk-s3/NOTICE new file mode 100644 index 000000000..616fc5889 --- /dev/null +++ b/clients/aws-sdk-s3/NOTICE @@ -0,0 +1 @@ +Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. diff --git a/clients/aws-sdk-s3/README.md b/clients/aws-sdk-s3/README.md index 2ef46b83e..b37251e7b 100644 --- a/clients/aws-sdk-s3/README.md +++ b/clients/aws-sdk-s3/README.md @@ -1,41 +1,22 @@ -## Amazon Simple Storage Service Client +# Amazon Simple Storage Service Client -aws_sdk_s3 client +The `aws-sdk-s3` package provides a client for making +requests to Amazon Simple Storage Service. -### Documentation +> **Note:** This SDK is experimental and in early development. Breaking changes +> may occur prior to the release of version 1.0.0. -Note: - For information about using the Amazon S3 API---including - authentication, signing requests, code examples, and error - handling---see the [Amazon S3 Developer - Guide](https://docs.aws.amazon.com/AmazonS3/latest/developerguide/Welcome.html). +## Installation -Welcome to the *Amazon S3 API Reference*. This guide explains the Amazon -Simple Storage Service (Amazon S3) application programming interface -(API). +```bash +python -m pip install aws-sdk-s3 +``` -Welcome to the *Amazon S3 API Reference*. This guide explains the Amazon -Simple Storage Service (Amazon S3) application programming interface -(API). +## Documentation -You can use any toolkit that supports HTTP to use the REST API. You can -even use a browser to fetch objects, as long as they are anonymously -readable. - -The REST API uses the standard HTTP headers and status codes, so that -standard browsers and toolkits work as expected. In some areas, we have -added functionality to HTTP (for example, we added headers to support -access control). In these cases, we have done our best to add the new -functionality in a way that matched the style of standard HTTP usage. - -The current version of the Amazon S3 API is `2006-03-01`. - -Amazon S3 supports the REST API. - -Note: - Support for SOAP over HTTP is deprecated, but it is still available over - HTTPS. However, new Amazon S3 features will not be supported for SOAP. - We recommend that you use either this REST API or the Amazon Web - Services SDKs. +- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/s3/) - + the S3 client, available operations, and types. +- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - + configuration, authentication, and usage of the AWS SDK for Python v4. diff --git a/clients/aws-sdk-sagemaker-runtime-http2/README.md b/clients/aws-sdk-sagemaker-runtime-http2/README.md index 90db86cd6..1df4e399c 100644 --- a/clients/aws-sdk-sagemaker-runtime-http2/README.md +++ b/clients/aws-sdk-sagemaker-runtime-http2/README.md @@ -1,3 +1,5 @@ + + # Amazon SageMaker Runtime HTTP2 Client The `aws-sdk-sagemaker-runtime-http2` package provides a client for making diff --git a/clients/aws-sdk-secrets-manager/README.md b/clients/aws-sdk-secrets-manager/README.md index bc43fa379..daf79833b 100644 --- a/clients/aws-sdk-secrets-manager/README.md +++ b/clients/aws-sdk-secrets-manager/README.md @@ -1,3 +1,5 @@ + + # AWS Secrets Manager Client The `aws-sdk-secrets-manager` package provides a client for making diff --git a/clients/aws-sdk-signin/README.md b/clients/aws-sdk-signin/README.md index 0c6b2081e..96bb7c922 100644 --- a/clients/aws-sdk-signin/README.md +++ b/clients/aws-sdk-signin/README.md @@ -1,3 +1,5 @@ + + # AWS Sign-In Service Client The `aws-sdk-signin` package provides a client for making diff --git a/clients/aws-sdk-sns/README.md b/clients/aws-sdk-sns/README.md index b7ca3e8ee..b56773df9 100644 --- a/clients/aws-sdk-sns/README.md +++ b/clients/aws-sdk-sns/README.md @@ -1,3 +1,5 @@ + + # Amazon Simple Notification Service Client The `aws-sdk-sns` package provides a client for making diff --git a/clients/aws-sdk-sqs/README.md b/clients/aws-sdk-sqs/README.md index 94acaa459..6019986f8 100644 --- a/clients/aws-sdk-sqs/README.md +++ b/clients/aws-sdk-sqs/README.md @@ -1,3 +1,5 @@ + + # Amazon Simple Queue Service Client The `aws-sdk-sqs` package provides a client for making diff --git a/clients/aws-sdk-sts/README.md b/clients/aws-sdk-sts/README.md index 0d323c641..8578097f9 100644 --- a/clients/aws-sdk-sts/README.md +++ b/clients/aws-sdk-sts/README.md @@ -1,3 +1,5 @@ + + # AWS Security Token Service Client The `aws-sdk-sts` package provides a client for making diff --git a/clients/aws-sdk-transcribe-streaming/README.md b/clients/aws-sdk-transcribe-streaming/README.md index 68d083902..ca5fc82de 100644 --- a/clients/aws-sdk-transcribe-streaming/README.md +++ b/clients/aws-sdk-transcribe-streaming/README.md @@ -1,3 +1,5 @@ + + # Amazon Transcribe Streaming Service Client The `aws-sdk-transcribe-streaming` package provides a client for making diff --git a/codegen/build.gradle.kts b/codegen/build.gradle.kts index 678499179..c71ee1c82 100644 --- a/codegen/build.gradle.kts +++ b/codegen/build.gradle.kts @@ -23,16 +23,22 @@ fun readVersion(file: File, regex: Regex): String = ?.firstNotNullOfOrNull { regex.find(it)?.groupValues?.get(1) } ?: error("cannot read ${regex.pattern} from $file; set SMITHY_PYTHON to a smithy-python checkout") -val codegenVersion = readVersion( - smithyPython.resolve("codegen/build.gradle.kts"), - Regex("""version\s*=\s*"([^"]+)""""), +val codegenVersion by extra( + readVersion( + smithyPython.resolve("codegen/build.gradle.kts"), + Regex("""version\s*=\s*"([^"]+)""""), + ) ) -val smithyVersion = readVersion( - smithyPython.resolve("codegen/gradle/libs.versions.toml"), - Regex("""^smithy\s*=\s*"([^"]+)""""), +val smithyVersion by extra( + readVersion( + smithyPython.resolve("codegen/gradle/libs.versions.toml"), + Regex("""^smithy\s*=\s*"([^"]+)""""), + ) ) dependencies { + smithyBuild(project(":integrations")) + // The build plugin (`python-client-codegen`) and AWS customizations must be // on the smithy build classpath for the projection to resolve them. smithyBuild("software.amazon.smithy.python.codegen:core:$codegenVersion") diff --git a/codegen/gen_client.py b/codegen/gen_client.py index 624d46a7d..d68cc6dc3 100644 --- a/codegen/gen_client.py +++ b/codegen/gen_client.py @@ -32,12 +32,11 @@ PINNED_DIR = CODEGEN_DIR / ".smithy-python" # Paths codegen never emits; they survive the pre-generation delete. A path codegen -# does emit but that must differ from codegen output belongs in client-overlays. +# does emit but that must differ from codegen output belongs in codegen/integrations, +# or in client-overlays when the difference is one client's hand edit. KEEP = ( ".changes", "CHANGELOG.md", - "LICENSE", - "NOTICE", "examples", "tests/integration", ) diff --git a/codegen/integrations/build.gradle.kts b/codegen/integrations/build.gradle.kts new file mode 100644 index 000000000..d2800176d --- /dev/null +++ b/codegen/integrations/build.gradle.kts @@ -0,0 +1,45 @@ +// AWS SDK customizations of smithy-python client codegen, loaded by the harness +// in the parent project through the PythonIntegration service loader. + +plugins { + `java-library` +} + +repositories { + mavenLocal() + mavenCentral() +} + +val codegenVersion: String by rootProject.extra +val smithyVersion: String by rootProject.extra + +dependencies { + implementation("software.amazon.smithy.python.codegen:core:$codegenVersion") + implementation("software.amazon.smithy:smithy-aws-traits:$smithyVersion") + + testImplementation(platform("org.junit:junit-bom:6.1.3")) + testImplementation("org.junit.jupiter:junit-jupiter-api") + testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine") + testRuntimeOnly("org.junit.platform:junit-platform-launcher") +} + +java { + toolchain { + languageVersion = JavaLanguageVersion.of(17) + } +} + +val repoRoot = rootProject.projectDir.parentFile + +tasks.processResources { + // The repository root's LICENSE and NOTICE are the single source for every client. + from(repoRoot) { + include("LICENSE", "NOTICE") + into("software/amazon/aws/sdk/python/codegen") + } +} + +tasks.test { + useJUnitPlatform() + systemProperty("repoRoot", repoRoot.absolutePath) +} 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 new file mode 100644 index 000000000..c4580e945 --- /dev/null +++ b/codegen/integrations/src/main/java/software/amazon/aws/sdk/python/codegen/AwsSdkPackageFilesIntegration.java @@ -0,0 +1,86 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ +package software.amazon.aws.sdk.python.codegen; + +import java.util.List; +import software.amazon.smithy.aws.traits.ServiceTrait; +import software.amazon.smithy.model.traits.TitleTrait; +import software.amazon.smithy.python.codegen.GenerationContext; +import software.amazon.smithy.python.codegen.integrations.PythonIntegration; +import software.amazon.smithy.python.codegen.sections.ReadmeSection; +import software.amazon.smithy.python.codegen.writer.PythonWriter; +import software.amazon.smithy.utils.CodeInterceptor; +import software.amazon.smithy.utils.CodeSection; + +/** + * Writes the AWS SDK README, LICENSE, and NOTICE into each generated client package. + */ +public final class AwsSdkPackageFilesIntegration implements PythonIntegration { + + // Copied from the repository root at build time; see build.gradle.kts. + private static final List LEGAL_FILES = List.of("LICENSE", "NOTICE"); + + @Override + public List> interceptors( + GenerationContext context + ) { + return List.of(new ReadmeInterceptor(context)); + } + + @Override + public void customize(GenerationContext context) { + for (var name : LEGAL_FILES) { + context.fileManifest().writeFile(name, AwsSdkPackageFilesIntegration.class, name); + } + } + + private static final class ReadmeInterceptor implements CodeInterceptor { + + private final GenerationContext context; + + ReadmeInterceptor(GenerationContext context) { + this.context = context; + } + + @Override + public Class sectionType() { + return ReadmeSection.class; + } + + @Override + public void write(PythonWriter writer, String previousText, ReadmeSection section) { + var service = context.settings().service(context.model()); + var title = service.expectTrait(TitleTrait.class).getValue(); + var sdkId = service.expectTrait(ServiceTrait.class).getSdkId(); + var packageName = context.settings().moduleName().replace('_', '-'); + var docsSlug = packageName.substring("aws-sdk-".length()); + writer.write(""" + # $1L Client + + 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. + + ## Installation + + ```bash + python -m pip install $2L + ``` + + ## Documentation + + - [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/$3L/) - + the $4L client, available operations, and types. + - [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - + configuration, authentication, and usage of the AWS SDK for Python v4.""", + title, + packageName, + docsSlug, + sdkId); + } + } +} diff --git a/codegen/integrations/src/main/resources/META-INF/services/software.amazon.smithy.python.codegen.integrations.PythonIntegration b/codegen/integrations/src/main/resources/META-INF/services/software.amazon.smithy.python.codegen.integrations.PythonIntegration new file mode 100644 index 000000000..2ff490ff3 --- /dev/null +++ b/codegen/integrations/src/main/resources/META-INF/services/software.amazon.smithy.python.codegen.integrations.PythonIntegration @@ -0,0 +1 @@ +software.amazon.aws.sdk.python.codegen.AwsSdkPackageFilesIntegration 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 new file mode 100644 index 000000000..bf7d56246 --- /dev/null +++ b/codegen/integrations/src/test/java/software/amazon/aws/sdk/python/codegen/AwsSdkPackageFilesIntegrationTest.java @@ -0,0 +1,112 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ +package software.amazon.aws.sdk.python.codegen; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.ArrayList; +import java.util.List; +import org.junit.jupiter.api.Test; +import software.amazon.smithy.aws.traits.ServiceTrait; +import software.amazon.smithy.build.MockManifest; +import software.amazon.smithy.model.Model; +import software.amazon.smithy.model.shapes.ServiceShape; +import software.amazon.smithy.model.traits.TitleTrait; +import software.amazon.smithy.python.codegen.GenerationContext; +import software.amazon.smithy.python.codegen.PythonSettings; +import software.amazon.smithy.python.codegen.PythonSymbolProvider; +import software.amazon.smithy.python.codegen.generators.SetupGenerator; +import software.amazon.smithy.python.codegen.writer.PythonDelegator; +import software.amazon.smithy.python.codegen.writer.PythonWriter; +import software.amazon.smithy.utils.CodeInterceptor; +import software.amazon.smithy.utils.CodeSection; + +public class AwsSdkPackageFilesIntegrationTest { + + private static final Path REPO_ROOT = Path.of(System.getProperty("repoRoot")); + + @Test + public void readmeUsesTitleSdkIdAndPackageName() { + var manifest = generate(); + + assertEquals(""" + + + # AWS Secrets Manager Client + + 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. + + ## Installation + + ```bash + python -m pip install aws-sdk-secrets-manager + ``` + + ## Documentation + + - [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/secrets-manager/) - + the Secrets Manager client, available operations, and types. + - [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - + configuration, authentication, and usage of the AWS SDK for Python v4. + """, manifest.expectFileString("README.md")); + } + + @Test + public void legalFilesMatchRepositoryRoot() throws IOException { + var manifest = generate(); + + for (var name : List.of("LICENSE", "NOTICE")) { + assertEquals(Files.readString(REPO_ROOT.resolve(name)), manifest.expectFileString(name), name); + } + } + + @SuppressWarnings("unchecked") + private static MockManifest generate() { + var service = ServiceShape.builder() + .id("com.amazonaws.secretsmanager#secretsmanager") + .version("2017-10-17") + .addTrait(new TitleTrait("AWS Secrets Manager")) + .addTrait(ServiceTrait.builder() + .sdkId("Secrets Manager") + .arnNamespace("secretsmanager") + .cloudFormationName("SecretsManager") + .cloudTrailEventSource("secretsmanager.amazonaws.com") + .endpointPrefix("secretsmanager") + .build()) + .build(); + var model = Model.builder().addShape(service).build(); + var settings = PythonSettings.builder() + .service(service.getId()) + .moduleName("aws_sdk_secrets_manager") + .moduleVersion("0.0.1") + .build(); + var manifest = new MockManifest(); + var delegator = new PythonDelegator(manifest, new PythonSymbolProvider(model, settings), settings); + var context = GenerationContext.builder() + .model(model) + .settings(settings) + .fileManifest(manifest) + .writerDelegator(delegator) + .build(); + + var integration = new AwsSdkPackageFilesIntegration(); + var interceptors = new ArrayList>(); + for (var interceptor : integration.interceptors(context)) { + interceptors.add((CodeInterceptor) interceptor); + } + delegator.setInterceptors(interceptors); + SetupGenerator.generateSetup(settings, context); + integration.customize(context); + delegator.flushWriters(); + return manifest; + } +} diff --git a/codegen/settings.gradle.kts b/codegen/settings.gradle.kts index 232fc7b9c..0bce4787a 100644 --- a/codegen/settings.gradle.kts +++ b/codegen/settings.gradle.kts @@ -1 +1,3 @@ rootProject.name = "aws-sdk-python-codegen" + +include("integrations") diff --git a/scripts/client-overlays/.gitkeep b/scripts/client-overlays/.gitkeep new file mode 100644 index 000000000..e69de29bb diff --git a/scripts/client-overlays/aws-sdk-api-gateway/README.md b/scripts/client-overlays/aws-sdk-api-gateway/README.md deleted file mode 100644 index 7477ff62d..000000000 --- a/scripts/client-overlays/aws-sdk-api-gateway/README.md +++ /dev/null @@ -1,20 +0,0 @@ -# Amazon API Gateway Client - -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. - -## Installation - -```bash -python -m pip install aws-sdk-api-gateway -``` - -## Documentation - -- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/api-gateway/) - - the API Gateway client, available operations, and types. -- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - - configuration, authentication, and usage of the AWS SDK for Python v4. diff --git a/scripts/client-overlays/aws-sdk-bedrock-agent-runtime/README.md b/scripts/client-overlays/aws-sdk-bedrock-agent-runtime/README.md deleted file mode 100644 index 6ea75cfc8..000000000 --- a/scripts/client-overlays/aws-sdk-bedrock-agent-runtime/README.md +++ /dev/null @@ -1,20 +0,0 @@ -# Agents for Amazon Bedrock Runtime Client - -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. - -## Installation - -```bash -python -m pip install aws-sdk-bedrock-agent-runtime -``` - -## Documentation - -- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/bedrock-agent-runtime/) - - the Bedrock Agent Runtime client, available operations, and types. -- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - - configuration, authentication, and usage of the AWS SDK for Python v4. diff --git a/scripts/client-overlays/aws-sdk-bedrock-agent/README.md b/scripts/client-overlays/aws-sdk-bedrock-agent/README.md deleted file mode 100644 index c340b92de..000000000 --- a/scripts/client-overlays/aws-sdk-bedrock-agent/README.md +++ /dev/null @@ -1,20 +0,0 @@ -# Agents for Amazon Bedrock Client - -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. - -## Installation - -```bash -python -m pip install aws-sdk-bedrock-agent -``` - -## Documentation - -- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/bedrock-agent/) - - the Bedrock Agent client, available operations, and types. -- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - - configuration, authentication, and usage of the AWS SDK for Python v4. diff --git a/scripts/client-overlays/aws-sdk-bedrock-agentcore-control/README.md b/scripts/client-overlays/aws-sdk-bedrock-agentcore-control/README.md deleted file mode 100644 index e64c6a9bf..000000000 --- a/scripts/client-overlays/aws-sdk-bedrock-agentcore-control/README.md +++ /dev/null @@ -1,20 +0,0 @@ -# Amazon Bedrock AgentCore Control Client - -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. - -## Installation - -```bash -python -m pip install aws-sdk-bedrock-agentcore-control -``` - -## Documentation - -- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/bedrock-agentcore-control/) - - the Bedrock AgentCore Control client, available operations, and types. -- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - - configuration, authentication, and usage of the AWS SDK for Python v4. diff --git a/scripts/client-overlays/aws-sdk-bedrock-agentcore/README.md b/scripts/client-overlays/aws-sdk-bedrock-agentcore/README.md deleted file mode 100644 index 3a12d46ce..000000000 --- a/scripts/client-overlays/aws-sdk-bedrock-agentcore/README.md +++ /dev/null @@ -1,20 +0,0 @@ -# Amazon Bedrock AgentCore Client - -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. - -## Installation - -```bash -python -m pip install aws-sdk-bedrock-agentcore -``` - -## Documentation - -- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/bedrock-agentcore/) - - the Bedrock AgentCore client, available operations, and types. -- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - - configuration, authentication, and usage of the AWS SDK for Python v4. diff --git a/scripts/client-overlays/aws-sdk-bedrock-data-automation-runtime/README.md b/scripts/client-overlays/aws-sdk-bedrock-data-automation-runtime/README.md deleted file mode 100644 index ac52f1b77..000000000 --- a/scripts/client-overlays/aws-sdk-bedrock-data-automation-runtime/README.md +++ /dev/null @@ -1,20 +0,0 @@ -# Runtime for Amazon Bedrock Data Automation Client - -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. - -## Installation - -```bash -python -m pip install aws-sdk-bedrock-data-automation-runtime -``` - -## Documentation - -- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/bedrock-data-automation-runtime/) - - the Bedrock Data Automation Runtime client, available operations, and types. -- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - - configuration, authentication, and usage of the AWS SDK for Python v4. diff --git a/scripts/client-overlays/aws-sdk-bedrock-data-automation/README.md b/scripts/client-overlays/aws-sdk-bedrock-data-automation/README.md deleted file mode 100644 index 8a5a9cf48..000000000 --- a/scripts/client-overlays/aws-sdk-bedrock-data-automation/README.md +++ /dev/null @@ -1,20 +0,0 @@ -# Data Automation for Amazon Bedrock Client - -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. - -## Installation - -```bash -python -m pip install aws-sdk-bedrock-data-automation -``` - -## Documentation - -- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/bedrock-data-automation/) - - the Bedrock Data Automation client, available operations, and types. -- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - - configuration, authentication, and usage of the AWS SDK for Python v4. diff --git a/scripts/client-overlays/aws-sdk-bedrock-runtime/README.md b/scripts/client-overlays/aws-sdk-bedrock-runtime/README.md deleted file mode 100644 index 9fc85a634..000000000 --- a/scripts/client-overlays/aws-sdk-bedrock-runtime/README.md +++ /dev/null @@ -1,20 +0,0 @@ -# Amazon Bedrock Runtime Client - -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. - -## Installation - -```bash -python -m pip install aws-sdk-bedrock-runtime -``` - -## Documentation - -- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/bedrock-runtime/) - - the Bedrock Runtime client, available operations, and types. -- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - - configuration, authentication, and usage of the AWS SDK for Python v4. diff --git a/scripts/client-overlays/aws-sdk-bedrock/README.md b/scripts/client-overlays/aws-sdk-bedrock/README.md deleted file mode 100644 index 6a6262982..000000000 --- a/scripts/client-overlays/aws-sdk-bedrock/README.md +++ /dev/null @@ -1,20 +0,0 @@ -# Amazon Bedrock Client - -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. - -## Installation - -```bash -python -m pip install aws-sdk-bedrock -``` - -## Documentation - -- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/bedrock/) - - the Bedrock client, available operations, and types. -- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - - configuration, authentication, and usage of the AWS SDK for Python v4. diff --git a/scripts/client-overlays/aws-sdk-cloudtrail/README.md b/scripts/client-overlays/aws-sdk-cloudtrail/README.md deleted file mode 100644 index 17d428299..000000000 --- a/scripts/client-overlays/aws-sdk-cloudtrail/README.md +++ /dev/null @@ -1,20 +0,0 @@ -# AWS CloudTrail Client - -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. - -## Installation - -```bash -python -m pip install aws-sdk-cloudtrail -``` - -## Documentation - -- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/cloudtrail/) - - the CloudTrail client, available operations, and types. -- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - - configuration, authentication, and usage of the AWS SDK for Python v4. diff --git a/scripts/client-overlays/aws-sdk-cognito-identity/README.md b/scripts/client-overlays/aws-sdk-cognito-identity/README.md deleted file mode 100644 index ed470e530..000000000 --- a/scripts/client-overlays/aws-sdk-cognito-identity/README.md +++ /dev/null @@ -1,20 +0,0 @@ -# Amazon Cognito Identity Client - -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. - -## Installation - -```bash -python -m pip install aws-sdk-cognito-identity -``` - -## Documentation - -- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/cognito-identity/) - - the Cognito Identity client, available operations, and types. -- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - - configuration, authentication, and usage of the AWS SDK for Python v4. diff --git a/scripts/client-overlays/aws-sdk-connecthealth/README.md b/scripts/client-overlays/aws-sdk-connecthealth/README.md deleted file mode 100644 index a024b197d..000000000 --- a/scripts/client-overlays/aws-sdk-connecthealth/README.md +++ /dev/null @@ -1,20 +0,0 @@ -# Connect Health Client - -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. - -## Installation - -```bash -python -m pip install aws-sdk-connecthealth -``` - -## Documentation - -- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/connecthealth/) - - the ConnectHealth client, available operations, and types. -- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - - configuration, authentication, and usage of the AWS SDK for Python v4. diff --git a/scripts/client-overlays/aws-sdk-dynamodb/README.md b/scripts/client-overlays/aws-sdk-dynamodb/README.md deleted file mode 100644 index 7c4bbb2be..000000000 --- a/scripts/client-overlays/aws-sdk-dynamodb/README.md +++ /dev/null @@ -1,20 +0,0 @@ -# Amazon DynamoDB Client - -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. - -## Installation - -```bash -python -m pip install aws-sdk-dynamodb -``` - -## Documentation - -- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/dynamodb/) - - the DynamoDB client, available operations, and types. -- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - - configuration, authentication, and usage of the AWS SDK for Python v4. diff --git a/scripts/client-overlays/aws-sdk-guardduty/README.md b/scripts/client-overlays/aws-sdk-guardduty/README.md deleted file mode 100644 index f38bc9e55..000000000 --- a/scripts/client-overlays/aws-sdk-guardduty/README.md +++ /dev/null @@ -1,20 +0,0 @@ -# Amazon GuardDuty Client - -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. - -## Installation - -```bash -python -m pip install aws-sdk-guardduty -``` - -## Documentation - -- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/guardduty/) - - the GuardDuty client, available operations, and types. -- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - - configuration, authentication, and usage of the AWS SDK for Python v4. diff --git a/scripts/client-overlays/aws-sdk-lambda/README.md b/scripts/client-overlays/aws-sdk-lambda/README.md deleted file mode 100644 index 224711aa0..000000000 --- a/scripts/client-overlays/aws-sdk-lambda/README.md +++ /dev/null @@ -1,20 +0,0 @@ -# AWS Lambda Client - -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. - -## Installation - -```bash -python -m pip install aws-sdk-lambda -``` - -## Documentation - -- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/lambda/) - - the Lambda client, available operations, and types. -- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - - configuration, authentication, and usage of the AWS SDK for Python v4. diff --git a/scripts/client-overlays/aws-sdk-lex-runtime-v2/README.md b/scripts/client-overlays/aws-sdk-lex-runtime-v2/README.md deleted file mode 100644 index f3f9145fd..000000000 --- a/scripts/client-overlays/aws-sdk-lex-runtime-v2/README.md +++ /dev/null @@ -1,20 +0,0 @@ -# Amazon Lex Runtime V2 Client - -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. - -## Installation - -```bash -python -m pip install aws-sdk-lex-runtime-v2 -``` - -## Documentation - -- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/lex-runtime-v2/) - - the Lex Runtime V2 client, available operations, and types. -- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - - configuration, authentication, and usage of the AWS SDK for Python v4. diff --git a/scripts/client-overlays/aws-sdk-polly/README.md b/scripts/client-overlays/aws-sdk-polly/README.md deleted file mode 100644 index 9b270de16..000000000 --- a/scripts/client-overlays/aws-sdk-polly/README.md +++ /dev/null @@ -1,20 +0,0 @@ -# Amazon Polly Client - -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. - -## Installation - -```bash -python -m pip install aws-sdk-polly -``` - -## Documentation - -- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/polly/) - - the Polly client, available operations, and types. -- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - - configuration, authentication, and usage of the AWS SDK for Python v4. diff --git a/scripts/client-overlays/aws-sdk-qbusiness/README.md b/scripts/client-overlays/aws-sdk-qbusiness/README.md deleted file mode 100644 index 1af7325a6..000000000 --- a/scripts/client-overlays/aws-sdk-qbusiness/README.md +++ /dev/null @@ -1,20 +0,0 @@ -# QBusiness Client - -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. - -## Installation - -```bash -python -m pip install aws-sdk-qbusiness -``` - -## Documentation - -- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/qbusiness/) - - the QBusiness client, available operations, and types. -- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - - configuration, authentication, and usage of the AWS SDK for Python v4. diff --git a/scripts/client-overlays/aws-sdk-sagemaker-runtime-http2/README.md b/scripts/client-overlays/aws-sdk-sagemaker-runtime-http2/README.md deleted file mode 100644 index 90db86cd6..000000000 --- a/scripts/client-overlays/aws-sdk-sagemaker-runtime-http2/README.md +++ /dev/null @@ -1,20 +0,0 @@ -# Amazon SageMaker Runtime HTTP2 Client - -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. - -## Installation - -```bash -python -m pip install aws-sdk-sagemaker-runtime-http2 -``` - -## Documentation - -- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/sagemaker-runtime-http2/) - - the SageMaker Runtime HTTP2 client, available operations, and types. -- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - - configuration, authentication, and usage of the AWS SDK for Python v4. diff --git a/scripts/client-overlays/aws-sdk-secrets-manager/README.md b/scripts/client-overlays/aws-sdk-secrets-manager/README.md deleted file mode 100644 index bc43fa379..000000000 --- a/scripts/client-overlays/aws-sdk-secrets-manager/README.md +++ /dev/null @@ -1,20 +0,0 @@ -# AWS Secrets Manager Client - -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. - -## Installation - -```bash -python -m pip install aws-sdk-secrets-manager -``` - -## Documentation - -- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/secrets-manager/) - - the Secrets Manager client, available operations, and types. -- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - - configuration, authentication, and usage of the AWS SDK for Python v4. diff --git a/scripts/client-overlays/aws-sdk-signin/README.md b/scripts/client-overlays/aws-sdk-signin/README.md deleted file mode 100644 index 0c6b2081e..000000000 --- a/scripts/client-overlays/aws-sdk-signin/README.md +++ /dev/null @@ -1,20 +0,0 @@ -# AWS Sign-In Service Client - -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. - -## Installation - -```bash -python -m pip install aws-sdk-signin -``` - -## Documentation - -- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/signin/) - - the Signin client, available operations, and types. -- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - - configuration, authentication, and usage of the AWS SDK for Python v4. diff --git a/scripts/client-overlays/aws-sdk-sns/README.md b/scripts/client-overlays/aws-sdk-sns/README.md deleted file mode 100644 index b7ca3e8ee..000000000 --- a/scripts/client-overlays/aws-sdk-sns/README.md +++ /dev/null @@ -1,20 +0,0 @@ -# Amazon Simple Notification Service Client - -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. - -## Installation - -```bash -python -m pip install aws-sdk-sns -``` - -## Documentation - -- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/sns/) - - the SNS client, available operations, and types. -- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - - configuration, authentication, and usage of the AWS SDK for Python v4. diff --git a/scripts/client-overlays/aws-sdk-sqs/README.md b/scripts/client-overlays/aws-sdk-sqs/README.md deleted file mode 100644 index 94acaa459..000000000 --- a/scripts/client-overlays/aws-sdk-sqs/README.md +++ /dev/null @@ -1,20 +0,0 @@ -# Amazon Simple Queue Service Client - -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. - -## Installation - -```bash -python -m pip install aws-sdk-sqs -``` - -## Documentation - -- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/sqs/) - - the SQS client, available operations, and types. -- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - - configuration, authentication, and usage of the AWS SDK for Python v4. diff --git a/scripts/client-overlays/aws-sdk-sts/README.md b/scripts/client-overlays/aws-sdk-sts/README.md deleted file mode 100644 index 0d323c641..000000000 --- a/scripts/client-overlays/aws-sdk-sts/README.md +++ /dev/null @@ -1,20 +0,0 @@ -# AWS Security Token Service Client - -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. - -## Installation - -```bash -python -m pip install aws-sdk-sts -``` - -## Documentation - -- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/sts/) - - the STS client, available operations, and types. -- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - - configuration, authentication, and usage of the AWS SDK for Python v4. diff --git a/scripts/client-overlays/aws-sdk-transcribe-streaming/README.md b/scripts/client-overlays/aws-sdk-transcribe-streaming/README.md deleted file mode 100644 index 68d083902..000000000 --- a/scripts/client-overlays/aws-sdk-transcribe-streaming/README.md +++ /dev/null @@ -1,20 +0,0 @@ -# Amazon Transcribe Streaming Service Client - -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. - -## Installation - -```bash -python -m pip install aws-sdk-transcribe-streaming -``` - -## Documentation - -- [API Reference](https://docs.aws.amazon.com/sdk-for-python/v4/reference/clients/transcribe-streaming/) - - the Transcribe Streaming client, available operations, and types. -- [Developer Guide](https://docs.aws.amazon.com/sdk-for-python/v4/guide/) - - configuration, authentication, and usage of the AWS SDK for Python v4.