This is the AWS CodeCommit API Reference. This reference provides descriptions of the operations and data types for AWS CodeCommit API along with usage examples.
You can use the AWS CodeCommit API to work with the following objects:
Repositories, by calling the following:
BatchGetRepositories, which returns information about one or more repositories associated with your AWS account.
CreateRepository, which creates an AWS CodeCommit repository.
DeleteRepository, which deletes an AWS CodeCommit repository.
GetRepository, which returns information about a specified repository.
ListRepositories, which lists all AWS CodeCommit repositories associated with your AWS account.
UpdateRepositoryDescription, which sets or updates the description of the repository.
UpdateRepositoryName, which changes the name of the repository. If you change the name of a repository, no other users of that repository will be able to access it until you send them the new HTTPS or SSH URL to use.
Branches, by calling the following:
CreateBranch, which creates a new branch in a specified repository.
DeleteBranch, which deletes the specified branch in a repository unless it is the default branch.
GetBranch, which returns information about a specified branch.
ListBranches, which lists all branches for a specified repository.
UpdateDefaultBranch, which changes the default branch for a repository.
Files, by calling the following:
DeleteFile, which deletes the content of a specified file from a specified branch.
GetFile, which returns the base-64 encoded content of a specified file.
GetFolder, which returns the contents of a specified folder or directory.
PutFile, which adds or modifies a file in a specified repository and branch.
Information about committed code in a repository, by calling the following:
GetBlob, which returns the base-64 encoded content of an individual Git blob object within a repository.
GetCommit, which returns information about a commit, including commit messages and author and committer information.
GetDifferences, which returns information about the differences in a valid commit specifier (such as a branch, tag, HEAD, commit ID or other fully qualified reference).
Pull requests, by calling the following:
CreatePullRequest, which creates a pull request in a specified repository.
DescribePullRequestEvents, which returns information about one or more pull request events.
GetCommentsForPullRequest, which returns information about comments on a specified pull request.
GetMergeConflicts, which returns information about merge conflicts between the source and destination branch in a pull request.
GetPullRequest, which returns information about a specified pull request.
ListPullRequests, which lists all pull requests for a repository.
MergePullRequestByFastForward, which merges the source destination branch of a pull request into the specified destination branch for that pull request using the fast-forward merge option.
PostCommentForPullRequest, which posts a comment to a pull request at the specified line, file, or request.
UpdatePullRequestDescription, which updates the description of a pull request.
UpdatePullRequestStatus, which updates the status of a pull request.
UpdatePullRequestTitle, which updates the title of a pull request.
Information about comments in a repository, by calling the following:
DeleteCommentContent, which deletes the content of a comment on a commit in a repository.
GetComment, which returns information about a comment on a commit.
GetCommentsForComparedCommit, which returns information about comments on the comparison between two commit specifiers in a repository.
PostCommentForComparedCommit, which creates a comment on the comparison between two commit specifiers in a repository.
PostCommentReply, which creates a reply to a comment.
UpdateComment, which updates the content of a comment on a commit in a repository.
Triggers, by calling the following:
GetRepositoryTriggers, which returns information about triggers configured for a repository.
PutRepositoryTriggers, which replaces all triggers for a repository and can be used to create or delete triggers.
TestRepositoryTriggers, which tests the functionality of a repository trigger by sending data to the trigger target.
For information about how to use AWS CodeCommit, see the AWS CodeCommit User Guide.
diff --git a/packages/client-cognito-identity-browser/README.md b/packages/client-cognito-identity-browser/README.md index 6b2c1f56b060..6dcddf15eb99 100644 --- a/packages/client-cognito-identity-browser/README.md +++ b/packages/client-cognito-identity-browser/README.md @@ -1,5 +1,8 @@ # @aws-sdk/client-cognito-identity-browser +[](https://www.npmjs.com/package/@aws-sdk/client-cognito-identity-browser) +[](https://www.npmjs.com/package/@aws-sdk/client-cognito-identity-browser) + ## DescriptionAmazon Cognito is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments. Amazon Cognito uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application.
Using Amazon Cognito, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon), and you can also choose to support unauthenticated access from your app. Cognito delivers a unique identifier for each user and acts as an OpenID token provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS credentials.
To provide end-user credentials, first make an unsigned call to GetId. If the end user is authenticated with one of the supported identity providers, set the Logins map with the identity provider token. GetId returns a unique identifier for the user.
Next, make an unsigned call to GetCredentialsForIdentity. This call expects the same Logins map as the GetId call, as well as the IdentityID originally returned by GetId. Assuming your identity pool has been configured via the SetIdentityPoolRoles operation, GetCredentialsForIdentity will return AWS credentials for your use. If your pool has not been configured with SetIdentityPoolRoles, or if you want to follow legacy flow, make an unsigned call to GetOpenIdToken, which returns the OpenID token necessary to call STS and retrieve AWS credentials. This call expects the same Logins map as the GetId call, as well as the IdentityID originally returned by GetId. The token returned by GetOpenIdToken can be passed to the STS operation AssumeRoleWithWebIdentity to retrieve AWS credentials.
If you want to use Amazon Cognito in an Android, iOS, or Unity application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the AWS Mobile SDK Developer Guide.
diff --git a/packages/client-documentation-generator/README.md b/packages/client-documentation-generator/README.md index a553d125ae51..72c3bc939ca5 100644 --- a/packages/client-documentation-generator/README.md +++ b/packages/client-documentation-generator/README.md @@ -1 +1,4 @@ -# client-documentation-generator +# @aws-sdk/client-documentation-generator + +[](https://www.npmjs.com/package/@aws-sdk/client-documentation-generator) +[](https://www.npmjs.com/package/@aws-sdk/client-documentation-generator) diff --git a/packages/client-dynamodb-browser/README.md b/packages/client-dynamodb-browser/README.md index b05349424f99..5a226d039802 100644 --- a/packages/client-dynamodb-browser/README.md +++ b/packages/client-dynamodb-browser/README.md @@ -1,5 +1,8 @@ # @aws-sdk/client-dynamodb-browser +[](https://www.npmjs.com/package/@aws-sdk/client-dynamodb-browser) +[](https://www.npmjs.com/package/@aws-sdk/client-dynamodb-browser) + ## DescriptionAmazon DynamoDB is a fully managed NoSQL database service that provides fast and predictable performance with seamless scalability. DynamoDB lets you offload the administrative burdens of operating and scaling a distributed database, so that you don't have to worry about hardware provisioning, setup and configuration, replication, software patching, or cluster scaling.
With DynamoDB, you can create database tables that can store and retrieve any amount of data, and serve any level of request traffic. You can scale up or scale down your tables' throughput capacity without downtime or performance degradation, and use the AWS Management Console to monitor resource utilization and performance metrics.
DynamoDB automatically spreads the data and traffic for your tables over a sufficient number of servers to handle your throughput and storage requirements, while maintaining consistent and fast performance. All of your data is stored on solid state disks (SSDs) and automatically replicated across multiple Availability Zones in an AWS region, providing built-in high availability and data durability.
diff --git a/packages/client-dynamodb-node/README.md b/packages/client-dynamodb-node/README.md index 967708847018..dddd953a3096 100644 --- a/packages/client-dynamodb-node/README.md +++ b/packages/client-dynamodb-node/README.md @@ -1,5 +1,8 @@ # @aws-sdk/client-dynamodb-node +[](https://www.npmjs.com/package/@aws-sdk/client-dynamodb-node) +[](https://www.npmjs.com/package/@aws-sdk/client-dynamodb-node) + ## DescriptionAmazon DynamoDB is a fully managed NoSQL database service that provides fast and predictable performance with seamless scalability. DynamoDB lets you offload the administrative burdens of operating and scaling a distributed database, so that you don't have to worry about hardware provisioning, setup and configuration, replication, software patching, or cluster scaling.
With DynamoDB, you can create database tables that can store and retrieve any amount of data, and serve any level of request traffic. You can scale up or scale down your tables' throughput capacity without downtime or performance degradation, and use the AWS Management Console to monitor resource utilization and performance metrics.
DynamoDB automatically spreads the data and traffic for your tables over a sufficient number of servers to handle your throughput and storage requirements, while maintaining consistent and fast performance. All of your data is stored on solid state disks (SSDs) and automatically replicated across multiple Availability Zones in an AWS region, providing built-in high availability and data durability.
diff --git a/packages/client-glacier-node/README.md b/packages/client-glacier-node/README.md index 50463509a3a5..d94dd0f964e7 100644 --- a/packages/client-glacier-node/README.md +++ b/packages/client-glacier-node/README.md @@ -1,5 +1,8 @@ # @aws-sdk/client-glacier-node +[](https://www.npmjs.com/package/@aws-sdk/client-glacier-node) +[](https://www.npmjs.com/package/@aws-sdk/client-glacier-node) + ## DescriptionAmazon Glacier is a storage solution for "cold data."
Amazon Glacier is an extremely low-cost storage service that provides secure, durable, and easy-to-use storage for data backup and archival. With Amazon Glacier, customers can store their data cost effectively for months, years, or decades. Amazon Glacier also enables customers to offload the administrative burdens of operating and scaling storage to AWS, so they don't have to worry about capacity planning, hardware provisioning, data replication, hardware failure and recovery, or time-consuming hardware migrations.
Amazon Glacier is a great storage choice when low storage cost is paramount and your data is rarely retrieved. If your application requires fast or frequent access to your data, consider using Amazon S3. For more information, see Amazon Simple Storage Service (Amazon S3).
You can store any kind of data in any format. There is no maximum limit on the total amount of data you can store in Amazon Glacier.
If you are a first-time user of Amazon Glacier, we recommend that you begin by reading the following sections in the Amazon Glacier Developer Guide:
What is Amazon Glacier - This section of the Developer Guide describes the underlying data model, the operations it supports, and the AWS SDKs that you can use to interact with the service.
Getting Started with Amazon Glacier - The Getting Started section walks you through the process of creating a vault, uploading archives, creating jobs to download archives, retrieving the job output, and deleting archives.
Amazon Kinesis Data Streams is a managed service that scales elastically for real-time processing of streaming big data.
diff --git a/packages/client-kms-browser/README.md b/packages/client-kms-browser/README.md index 07789e47294d..338d051d8f9c 100644 --- a/packages/client-kms-browser/README.md +++ b/packages/client-kms-browser/README.md @@ -1,5 +1,8 @@ # @aws-sdk/client-kms-browser +[](https://www.npmjs.com/package/@aws-sdk/client-kms-browser) +[](https://www.npmjs.com/package/@aws-sdk/client-kms-browser) + ## DescriptionAWS Key Management Service (AWS KMS) is an encryption and key management web service. This guide describes the AWS KMS operations that you can call programmatically. For general information about AWS KMS, see the AWS Key Management Service Developer Guide.
AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, macOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS KMS and other AWS 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 AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.
We recommend that you use the AWS SDKs to make programmatic API calls to AWS KMS.
Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. 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.
Signing Requests
Requests must be signed by using an access key ID and a secret access key. We strongly recommend that you do not use your AWS account (root) access key ID and secret key for everyday work with AWS KMS. Instead, use the access key ID and secret access key for an IAM user. You can also use the AWS Security Token Service to generate temporary security credentials that you can use to sign requests.
All AWS KMS operations require Signature Version 4.
Logging API Requests
AWS KMS supports AWS CloudTrail, a service that logs AWS API calls and related events for your AWS 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 AWS 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 AWS CloudTrail User Guide.
Additional Resources
For more information about credentials and request signing, see the following:
AWS Security Credentials - This topic provides general information about the types of credentials used for accessing AWS.
Temporary Security Credentials - This section of the IAM User Guide describes how to create and use temporary security credentials.
Signature Version 4 Signing Process - 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.
diff --git a/packages/client-kms-node/README.md b/packages/client-kms-node/README.md index 697dbb049c8d..3a4425649bfd 100644 --- a/packages/client-kms-node/README.md +++ b/packages/client-kms-node/README.md @@ -1,5 +1,8 @@ # @aws-sdk/client-kms-node +[](https://www.npmjs.com/package/@aws-sdk/client-kms-node) +[](https://www.npmjs.com/package/@aws-sdk/client-kms-node) + ## DescriptionAWS Key Management Service (AWS KMS) is an encryption and key management web service. This guide describes the AWS KMS operations that you can call programmatically. For general information about AWS KMS, see the AWS Key Management Service Developer Guide.
AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, macOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS KMS and other AWS 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 AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.
We recommend that you use the AWS SDKs to make programmatic API calls to AWS KMS.
Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. 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.
Signing Requests
Requests must be signed by using an access key ID and a secret access key. We strongly recommend that you do not use your AWS account (root) access key ID and secret key for everyday work with AWS KMS. Instead, use the access key ID and secret access key for an IAM user. You can also use the AWS Security Token Service to generate temporary security credentials that you can use to sign requests.
All AWS KMS operations require Signature Version 4.
Logging API Requests
AWS KMS supports AWS CloudTrail, a service that logs AWS API calls and related events for your AWS 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 AWS 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 AWS CloudTrail User Guide.
Additional Resources
For more information about credentials and request signing, see the following:
AWS Security Credentials - This topic provides general information about the types of credentials used for accessing AWS.
Temporary Security Credentials - This section of the IAM User Guide describes how to create and use temporary security credentials.
Signature Version 4 Signing Process - 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.
diff --git a/packages/client-lambda-node/README.md b/packages/client-lambda-node/README.md index 47d900f31c73..6a5b32da5db4 100644 --- a/packages/client-lambda-node/README.md +++ b/packages/client-lambda-node/README.md @@ -1,5 +1,8 @@ # @aws-sdk/client-lambda-node +[](https://www.npmjs.com/package/@aws-sdk/client-lambda-node) +[](https://www.npmjs.com/package/@aws-sdk/client-lambda-node) + ## DescriptionOverview
This is the AWS Lambda API Reference. The AWS Lambda Developer Guide provides additional information. For the service overview, see What is AWS Lambda, and for information about how the service works, see AWS Lambda: How it Works in the AWS Lambda Developer Guide.
diff --git a/packages/client-pinpoint-browser/README.md b/packages/client-pinpoint-browser/README.md index 7433b92c0d24..0c576db6b1cf 100644 --- a/packages/client-pinpoint-browser/README.md +++ b/packages/client-pinpoint-browser/README.md @@ -1,5 +1,8 @@ # @aws-sdk/client-pinpoint-browser +[](https://www.npmjs.com/package/@aws-sdk/client-pinpoint-browser) +[](https://www.npmjs.com/package/@aws-sdk/client-pinpoint-browser) + ## Description Amazon Pinpoint diff --git a/packages/client-s3-browser/README.md b/packages/client-s3-browser/README.md index 19d74ee10a3c..c5265c7b2e0d 100644 --- a/packages/client-s3-browser/README.md +++ b/packages/client-s3-browser/README.md @@ -1,5 +1,8 @@ # @aws-sdk/client-s3-browser +[](https://www.npmjs.com/package/@aws-sdk/client-s3-browser) +[](https://www.npmjs.com/package/@aws-sdk/client-s3-browser) + ## Description Amazon Simple Storage Service service diff --git a/packages/client-s3-node/README.md b/packages/client-s3-node/README.md index b113f94965d0..437c1dc7c71c 100644 --- a/packages/client-s3-node/README.md +++ b/packages/client-s3-node/README.md @@ -1,5 +1,8 @@ # @aws-sdk/client-s3-node +[](https://www.npmjs.com/package/@aws-sdk/client-s3-node) +[](https://www.npmjs.com/package/@aws-sdk/client-s3-node) + ## Description Amazon Simple Storage Service service diff --git a/packages/client-sqs-node/README.md b/packages/client-sqs-node/README.md index 86edb8dfa7f3..494d4273bc8c 100644 --- a/packages/client-sqs-node/README.md +++ b/packages/client-sqs-node/README.md @@ -1,5 +1,8 @@ # @aws-sdk/client-sqs-node +[](https://www.npmjs.com/package/@aws-sdk/client-sqs-node) +[](https://www.npmjs.com/package/@aws-sdk/client-sqs-node) + ## DescriptionWelcome to the Amazon Simple Queue Service API Reference.
Amazon Simple Queue Service (Amazon SQS) is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.
Standard queues are available in all regions. FIFO queues are available in the US East (N. Virginia), US East (Ohio), US West (Oregon), and EU (Ireland) regions.
You can use AWS SDKs to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:
Cryptographically sign your service requests
Retry requests
Handle error responses
Additional Information
Amazon Simple Queue Service Developer Guide
Amazon Web Services General Reference
AWS X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.
diff --git a/packages/config-resolver/README.md b/packages/config-resolver/README.md index 4a04a24f62c4..158a3e904e78 100644 --- a/packages/config-resolver/README.md +++ b/packages/config-resolver/README.md @@ -1 +1,4 @@ -# config-resolver +# @aws-sdk/config-resolver + +[](https://www.npmjs.com/package/@aws-sdk/config-resolver) +[](https://www.npmjs.com/package/@aws-sdk/config-resolver) diff --git a/packages/core-handler/README.md b/packages/core-handler/README.md index 6366c62398f8..663eb09cd369 100644 --- a/packages/core-handler/README.md +++ b/packages/core-handler/README.md @@ -1 +1,4 @@ -# core-handler +# @aws-sdk/core-handler + +[](https://www.npmjs.com/package/@aws-sdk/core-handler) +[](https://www.npmjs.com/package/@aws-sdk/core-handler) diff --git a/packages/credential-provider-cognito-identity/README.md b/packages/credential-provider-cognito-identity/README.md index 353d89d01a7e..18889a3d5ee9 100644 --- a/packages/credential-provider-cognito-identity/README.md +++ b/packages/credential-provider-cognito-identity/README.md @@ -1 +1,4 @@ -# credential-provider-cognito-identity +# @aws-sdk/credential-provider-cognito-identity + +[](https://www.npmjs.com/package/@aws-sdk/credential-provider-cognito-identity) +[](https://www.npmjs.com/package/@aws-sdk/credential-provider-cognito-identity) diff --git a/packages/credential-provider-env/README.md b/packages/credential-provider-env/README.md index c68afcb3e996..9b9a08723bcc 100644 --- a/packages/credential-provider-env/README.md +++ b/packages/credential-provider-env/README.md @@ -1,5 +1,8 @@ # AWS Credential Provider for Node.JS - Environment Variables +[](https://www.npmjs.com/package/@aws-sdk/credential-provider-env) +[](https://www.npmjs.com/package/@aws-sdk/credential-provider-env) + This module provides a `CredentialProvider` function, `fromEnv`, that reads from the following environment variables: diff --git a/packages/credential-provider-imds/README.md b/packages/credential-provider-imds/README.md index e0da2aef9eb4..9cfe5a282287 100644 --- a/packages/credential-provider-imds/README.md +++ b/packages/credential-provider-imds/README.md @@ -1,5 +1,8 @@ # AWS Credential Provider for Node.JS - Instance and Container Metadata +[](https://www.npmjs.com/package/@aws-sdk/credential-provider-imds) +[](https://www.npmjs.com/package/@aws-sdk/credential-provider-imds) + This module provides two `CredentialProvider` factory functions, `fromContainerMetadata` and `fromInstanceMetadata`, that will create `CredentialProvider` functions that read from the ECS container metadata service diff --git a/packages/credential-provider-ini/README.md b/packages/credential-provider-ini/README.md index 102c8abdb4a0..fc4e5a01a4b9 100644 --- a/packages/credential-provider-ini/README.md +++ b/packages/credential-provider-ini/README.md @@ -1,5 +1,8 @@ # AWS Credential Provider for Node.JS - Shared Configuration Files +[](https://www.npmjs.com/package/@aws-sdk/credential-provider-ini) +[](https://www.npmjs.com/package/@aws-sdk/credential-provider-ini) + This module provides a function, `fromSharedConfigFiles` that will create `CredentialProvider` functions that read from a shared credentials file at `~/.aws/credentials` and a shared configuration file at `~/.aws/config`. Both diff --git a/packages/credential-provider-node/README.md b/packages/credential-provider-node/README.md index 513097901659..dccb9a01503f 100644 --- a/packages/credential-provider-node/README.md +++ b/packages/credential-provider-node/README.md @@ -1,5 +1,8 @@ # AWS Credential Provider for Node.JS +[](https://www.npmjs.com/package/@aws-sdk/credential-provider-node) +[](https://www.npmjs.com/package/@aws-sdk/credential-provider-node) + This module provides a factory function, `fromEnv`, that will attempt to source AWS credentials from a Node.JS environment. It will attempt to find credentials from the following sources (listed in order of precedence): diff --git a/packages/credential-provider-process/README.md b/packages/credential-provider-process/README.md index 468b19aa318e..c930ee4fb3ec 100644 --- a/packages/credential-provider-process/README.md +++ b/packages/credential-provider-process/README.md @@ -1,5 +1,8 @@ # AWS Credential Provider for Node.JS - Shared Configuration Files +[](https://www.npmjs.com/package/@aws-sdk/credential-provider-process) +[](https://www.npmjs.com/package/@aws-sdk/credential-provider-process) + This module provides a function, `fromSharedConfigFiles` that will create `CredentialProvider` functions that read from a shared credentials file at `~/.aws/credentials` and a shared configuration file at `~/.aws/config`. Both diff --git a/packages/ec2-error-unmarshaller/README.md b/packages/ec2-error-unmarshaller/README.md index 85fa128548d2..3ecc1e24ebcc 100644 --- a/packages/ec2-error-unmarshaller/README.md +++ b/packages/ec2-error-unmarshaller/README.md @@ -1 +1,4 @@ -# ec2-error-unmarshaller +# @aws-sdk/ec2-error-unmarshaller + +[](https://www.npmjs.com/package/@aws-sdk/ec2-error-unmarshaller) +[](https://www.npmjs.com/package/@aws-sdk/ec2-error-unmarshaller) diff --git a/packages/eventstream-marshaller/README.md b/packages/eventstream-marshaller/README.md index 7a9430e62ab9..fb8dd5d645af 100644 --- a/packages/eventstream-marshaller/README.md +++ b/packages/eventstream-marshaller/README.md @@ -1 +1,4 @@ # @aws-sdk/eventstream-marshaller + +[](https://www.npmjs.com/package/@aws-sdk/eventstream-marshaller) +[](https://www.npmjs.com/package/@aws-sdk/eventstream-marshaller) diff --git a/packages/fetch-http-handler/README.md b/packages/fetch-http-handler/README.md new file mode 100644 index 000000000000..22d963692f7c --- /dev/null +++ b/packages/fetch-http-handler/README.md @@ -0,0 +1,4 @@ +# @aws-sdk/fetch-http-handler + +[](https://www.npmjs.com/package/@aws-sdk/fetch-http-handler) +[](https://www.npmjs.com/package/@aws-sdk/fetch-http-handler) diff --git a/packages/hash-blob-browser/README.md b/packages/hash-blob-browser/README.md index 7b61891ed75c..8fc67ad2f326 100644 --- a/packages/hash-blob-browser/README.md +++ b/packages/hash-blob-browser/README.md @@ -1 +1,4 @@ # sha256-blob-browser + +[](https://www.npmjs.com/package/@aws-sdk/hash-blob-browser) +[](https://www.npmjs.com/package/@aws-sdk/hash-blob-browser) diff --git a/packages/hash-node/README.md b/packages/hash-node/README.md index b03bc4fb70b8..2b16be790963 100644 --- a/packages/hash-node/README.md +++ b/packages/hash-node/README.md @@ -1 +1,4 @@ # md5-node + +[](https://www.npmjs.com/package/@aws-sdk/hash-node) +[](https://www.npmjs.com/package/@aws-sdk/hash-node) diff --git a/packages/hash-stream-node/README.md b/packages/hash-stream-node/README.md index 29c1686cd2c1..995664598336 100644 --- a/packages/hash-stream-node/README.md +++ b/packages/hash-stream-node/README.md @@ -1,4 +1,7 @@ -# hash-stream-node +# @aws-sdk/hash-stream-node + +[](https://www.npmjs.com/package/@aws-sdk/hash-stream-node) +[](https://www.npmjs.com/package/@aws-sdk/hash-stream-node) A utility for calculating the hash of Node.JS readable streams. This package is currently only compatible with file streams, as no other stream type can be diff --git a/packages/http-headers/README.md b/packages/http-headers/README.md index 63a260c6a1b9..e2946e7591a3 100644 --- a/packages/http-headers/README.md +++ b/packages/http-headers/README.md @@ -1 +1,4 @@ # @aws-sdk/http-headers + +[](https://www.npmjs.com/package/@aws-sdk/http-headers) +[](https://www.npmjs.com/package/@aws-sdk/http-headers) diff --git a/packages/http-serialization/README.md b/packages/http-serialization/README.md index 42329216da00..c687200f286b 100644 --- a/packages/http-serialization/README.md +++ b/packages/http-serialization/README.md @@ -1 +1,4 @@ -# http-serialization +# @aws-sdk/http-serialization + +[](https://www.npmjs.com/package/@aws-sdk/http-serialization) +[](https://www.npmjs.com/package/@aws-sdk/http-serialization) diff --git a/packages/is-array-buffer/README.md b/packages/is-array-buffer/README.md new file mode 100644 index 000000000000..2548d8a5c886 --- /dev/null +++ b/packages/is-array-buffer/README.md @@ -0,0 +1,4 @@ +# @aws-sdk/is-array-buffer + +[](https://www.npmjs.com/package/@aws-sdk/is-array-buffer) +[](https://www.npmjs.com/package/@aws-sdk/is-array-buffer) diff --git a/packages/is-iterable/README.md b/packages/is-iterable/README.md new file mode 100644 index 000000000000..9bf8301994c8 --- /dev/null +++ b/packages/is-iterable/README.md @@ -0,0 +1,4 @@ +# @aws-sdk/is-iterable + +[](https://www.npmjs.com/package/@aws-sdk/is-iterable) +[](https://www.npmjs.com/package/@aws-sdk/is-iterable) diff --git a/packages/is-node/README.md b/packages/is-node/README.md new file mode 100644 index 000000000000..daa6fd5fc528 --- /dev/null +++ b/packages/is-node/README.md @@ -0,0 +1,4 @@ +# @aws-sdk/is-node + +[](https://www.npmjs.com/package/@aws-sdk/is-node) +[](https://www.npmjs.com/package/@aws-sdk/is-node) diff --git a/packages/json-builder/README.md b/packages/json-builder/README.md new file mode 100644 index 000000000000..e9ff15570084 --- /dev/null +++ b/packages/json-builder/README.md @@ -0,0 +1,4 @@ +# @aws-sdk/json-builder + +[](https://www.npmjs.com/package/@aws-sdk/json-builder) +[](https://www.npmjs.com/package/@aws-sdk/json-builder) diff --git a/packages/json-error-unmarshaller/README.md b/packages/json-error-unmarshaller/README.md index dea4db78d31d..f5f06a92e8fc 100644 --- a/packages/json-error-unmarshaller/README.md +++ b/packages/json-error-unmarshaller/README.md @@ -1 +1,4 @@ -# json-error-unmarshaller +# @aws-sdk/json-error-unmarshaller + +[](https://www.npmjs.com/package/@aws-sdk/json-error-unmarshaller) +[](https://www.npmjs.com/package/@aws-sdk/json-error-unmarshaller) diff --git a/packages/json-parser/README.md b/packages/json-parser/README.md new file mode 100644 index 000000000000..d1866dc2336e --- /dev/null +++ b/packages/json-parser/README.md @@ -0,0 +1,4 @@ +# @aws-sdk/json-parser + +[](https://www.npmjs.com/package/@aws-sdk/json-parser) +[](https://www.npmjs.com/package/@aws-sdk/json-parser) diff --git a/packages/karma-credential-loader/README.md b/packages/karma-credential-loader/README.md index 6108091bd7bf..1d9b28eccf1a 100644 --- a/packages/karma-credential-loader/README.md +++ b/packages/karma-credential-loader/README.md @@ -1 +1,4 @@ # @aws-sdk/karma-credential-loader + +[](https://www.npmjs.com/package/@aws-sdk/karma-credential-loader) +[](https://www.npmjs.com/package/@aws-sdk/karma-credential-loader) diff --git a/packages/location-constraint-middleware/README.md b/packages/location-constraint-middleware/README.md index 7943105244db..e2531b3c187d 100644 --- a/packages/location-constraint-middleware/README.md +++ b/packages/location-constraint-middleware/README.md @@ -1 +1,4 @@ -# location-constraint-middleware +# @aws-sdk/location-constraint-middleware + +[](https://www.npmjs.com/package/@aws-sdk/location-constraint-middleware) +[](https://www.npmjs.com/package/@aws-sdk/location-constraint-middleware) diff --git a/packages/logger/README.md b/packages/logger/README.md index 736f344d748e..355ad5b9ec62 100644 --- a/packages/logger/README.md +++ b/packages/logger/README.md @@ -1 +1,4 @@ -# logger +# @aws-sdk/logger + +[](https://www.npmjs.com/package/@aws-sdk/logger) +[](https://www.npmjs.com/package/@aws-sdk/logger) diff --git a/packages/md5-js/README.md b/packages/md5-js/README.md index 780222633b67..27fd588ca7c1 100644 --- a/packages/md5-js/README.md +++ b/packages/md5-js/README.md @@ -1 +1,4 @@ -# md5-js +# @aws-sdk/md5-js + +[](https://www.npmjs.com/package/@aws-sdk/md5-js) +[](https://www.npmjs.com/package/@aws-sdk/md5-js) diff --git a/packages/md5-universal/README.md b/packages/md5-universal/README.md index 93cc43e57165..f2c7d5708d57 100644 --- a/packages/md5-universal/README.md +++ b/packages/md5-universal/README.md @@ -1 +1,4 @@ -# md5-universal +# @aws-sdk/md5-universal + +[](https://www.npmjs.com/package/@aws-sdk/md5-universal) +[](https://www.npmjs.com/package/@aws-sdk/md5-universal) diff --git a/packages/middleware-content-length/README.md b/packages/middleware-content-length/README.md index 50b128377c64..3274ba65cd54 100644 --- a/packages/middleware-content-length/README.md +++ b/packages/middleware-content-length/README.md @@ -1 +1,4 @@ -# middleware-content-length +# @aws-sdk/middleware-content-length + +[](https://www.npmjs.com/package/@aws-sdk/middleware-content-length) +[](https://www.npmjs.com/package/@aws-sdk/middleware-content-length) diff --git a/packages/middleware-ec2-copysnapshot/README.md b/packages/middleware-ec2-copysnapshot/README.md index 98734485a4eb..4f76f0428057 100755 --- a/packages/middleware-ec2-copysnapshot/README.md +++ b/packages/middleware-ec2-copysnapshot/README.md @@ -1 +1,4 @@ -# middleware-ec2-copysnapshot +# @aws-sdk/middleware-ec2-copysnapshot + +[](https://www.npmjs.com/package/@aws-sdk/middleware-ec2-copysnapshot) +[](https://www.npmjs.com/package/@aws-sdk/middleware-ec2-copysnapshot) diff --git a/packages/middleware-expect-continue/README.md b/packages/middleware-expect-continue/README.md index 4f30b6077f27..3b61cb191c95 100644 --- a/packages/middleware-expect-continue/README.md +++ b/packages/middleware-expect-continue/README.md @@ -1 +1,4 @@ # @aws-sdk/middleware-expect-continue + +[](https://www.npmjs.com/package/@aws-sdk/middleware-expect-continue) +[](https://www.npmjs.com/package/@aws-sdk/middleware-expect-continue) diff --git a/packages/middleware-header-default/README.md b/packages/middleware-header-default/README.md index 59a70a2499d6..6fa77d8f509d 100644 --- a/packages/middleware-header-default/README.md +++ b/packages/middleware-header-default/README.md @@ -1 +1,4 @@ -# middleware-header-default +# @aws-sdk/middleware-header-default + +[](https://www.npmjs.com/package/@aws-sdk/middleware-header-default) +[](https://www.npmjs.com/package/@aws-sdk/middleware-header-default) diff --git a/packages/middleware-input-default/README.md b/packages/middleware-input-default/README.md index 5abba03fecd7..72a4425c1b6f 100644 --- a/packages/middleware-input-default/README.md +++ b/packages/middleware-input-default/README.md @@ -1 +1,4 @@ -# middleware-input-default +# @aws-sdk/middleware-input-default + +[](https://www.npmjs.com/package/@aws-sdk/middleware-input-default) +[](https://www.npmjs.com/package/@aws-sdk/middleware-input-default) diff --git a/packages/middleware-operation-logging/README.md b/packages/middleware-operation-logging/README.md index 3e1b6236fd5d..661915b8a1d4 100644 --- a/packages/middleware-operation-logging/README.md +++ b/packages/middleware-operation-logging/README.md @@ -1 +1,4 @@ -# middleware-operation-logging +# @aws-sdk/middleware-operation-logging + +[](https://www.npmjs.com/package/@aws-sdk/middleware-operation-logging) +[](https://www.npmjs.com/package/@aws-sdk/middleware-operation-logging) diff --git a/packages/middleware-rds-presignedurl/README.md b/packages/middleware-rds-presignedurl/README.md index 56c6d39c95f6..655ba6fdae33 100644 --- a/packages/middleware-rds-presignedurl/README.md +++ b/packages/middleware-rds-presignedurl/README.md @@ -1 +1,4 @@ -# middleware-rds-presignedurl +# @aws-sdk/middleware-rds-presignedurl + +[](https://www.npmjs.com/package/@aws-sdk/middleware-rds-presignedurl) +[](https://www.npmjs.com/package/@aws-sdk/middleware-rds-presignedurl) diff --git a/packages/middleware-sdk-api-gateway/README.md b/packages/middleware-sdk-api-gateway/README.md index 9b4ee70829ed..faa60109c6d6 100644 --- a/packages/middleware-sdk-api-gateway/README.md +++ b/packages/middleware-sdk-api-gateway/README.md @@ -1 +1,4 @@ # middleware-sdk-apigateway + +[](https://www.npmjs.com/package/@aws-sdk/middleware-sdk-api-gateway) +[](https://www.npmjs.com/package/@aws-sdk/middleware-sdk-api-gateway) diff --git a/packages/middleware-sdk-glacier/README.md b/packages/middleware-sdk-glacier/README.md index 99869ddd6db8..d8df92004c69 100644 --- a/packages/middleware-sdk-glacier/README.md +++ b/packages/middleware-sdk-glacier/README.md @@ -1 +1,4 @@ -# middleware-sdk-glacier +# @aws-sdk/middleware-sdk-glacier + +[](https://www.npmjs.com/package/@aws-sdk/middleware-sdk-glacier) +[](https://www.npmjs.com/package/@aws-sdk/middleware-sdk-glacier) diff --git a/packages/middleware-serializer/README.md b/packages/middleware-serializer/README.md index 67597224de6d..47f4c1b57bb3 100644 --- a/packages/middleware-serializer/README.md +++ b/packages/middleware-serializer/README.md @@ -1,3 +1,6 @@ -# middleware-serializer +# @aws-sdk/middleware-serializer + +[](https://www.npmjs.com/package/@aws-sdk/middleware-serializer) +[](https://www.npmjs.com/package/@aws-sdk/middleware-serializer) Provides the middleware serializer for the AWS SDK diff --git a/packages/middleware-stack/README.md b/packages/middleware-stack/README.md new file mode 100644 index 000000000000..bca083e6fb93 --- /dev/null +++ b/packages/middleware-stack/README.md @@ -0,0 +1,4 @@ +# @aws-sdk/middleware-stack + +[](https://www.npmjs.com/package/@aws-sdk/middleware-stack) +[](https://www.npmjs.com/package/@aws-sdk/middleware-stack) diff --git a/packages/modeled-endpoint-middleware/README.md b/packages/modeled-endpoint-middleware/README.md index 61ebbb5c4ddd..a8eaf525d233 100644 --- a/packages/modeled-endpoint-middleware/README.md +++ b/packages/modeled-endpoint-middleware/README.md @@ -1 +1,4 @@ -# modeled-endpoint-middleware +# @aws-sdk/modeled-endpoint-middleware + +[](https://www.npmjs.com/package/@aws-sdk/modeled-endpoint-middleware) +[](https://www.npmjs.com/package/@aws-sdk/modeled-endpoint-middleware) diff --git a/packages/node-http-handler/README.md b/packages/node-http-handler/README.md new file mode 100644 index 000000000000..c97a0e24ad20 --- /dev/null +++ b/packages/node-http-handler/README.md @@ -0,0 +1,4 @@ +# @aws-sdk/node-http-handler + +[](https://www.npmjs.com/package/@aws-sdk/node-http-handler) +[](https://www.npmjs.com/package/@aws-sdk/node-http-handler) diff --git a/packages/package-generator/README.md b/packages/package-generator/README.md new file mode 100644 index 000000000000..d268d433671f --- /dev/null +++ b/packages/package-generator/README.md @@ -0,0 +1 @@ +# @aws-sdk/package-generator diff --git a/packages/package-generator/src/ModuleGenerator.spec.ts b/packages/package-generator/src/ModuleGenerator.spec.ts index 1de124d480e9..4e1d279a7f2c 100644 --- a/packages/package-generator/src/ModuleGenerator.spec.ts +++ b/packages/package-generator/src/ModuleGenerator.spec.ts @@ -118,7 +118,8 @@ describe("ModuleGenerator", () => { for (const [filename, contents] of generator) { if (filename === "README.md") { found = true; - expect(contents).toBe(`# ${name}\n\n${description}\n`); + expect(contents.indexOf(`# @aws-sdk/${name}`)).toBeGreaterThan(-1); + expect(contents.indexOf(description)).toBeGreaterThan(-1); } } @@ -132,7 +133,7 @@ describe("ModuleGenerator", () => { for (const [filename, contents] of generator) { if (filename === "README.md") { found = true; - expect(contents).toBe(`# ${name}\n`); + expect(contents.indexOf(`# @aws-sdk/${name}`)).toBeGreaterThan(-1); } } diff --git a/packages/package-generator/src/ModuleGenerator.ts b/packages/package-generator/src/ModuleGenerator.ts index c5be99e4eb0c..f4fbda537c53 100644 --- a/packages/package-generator/src/ModuleGenerator.ts +++ b/packages/package-generator/src/ModuleGenerator.ts @@ -97,7 +97,14 @@ export class ModuleGenerator { protected readme(): string { return ` -# ${this.name} +# @aws-sdk/${this.name} + +[](https://www.npmjs.com/package/@aws-sdk/${this.name}) +[](https://www.npmjs.com/package/@aws-sdk/${this.name}) ${this.description || ""} `.trim(); diff --git a/packages/property-provider/README.md b/packages/property-provider/README.md index e4e541455541..fd126419b13c 100644 --- a/packages/property-provider/README.md +++ b/packages/property-provider/README.md @@ -1 +1,4 @@ -# property-provider +# @aws-sdk/property-provider + +[](https://www.npmjs.com/package/@aws-sdk/property-provider) +[](https://www.npmjs.com/package/@aws-sdk/property-provider) diff --git a/packages/protocol-json-rpc/README.md b/packages/protocol-json-rpc/README.md new file mode 100644 index 000000000000..d75eb0916afd --- /dev/null +++ b/packages/protocol-json-rpc/README.md @@ -0,0 +1,4 @@ +# @aws-sdk/protocol-json-rpc + +[](https://www.npmjs.com/package/@aws-sdk/protocol-json-rpc) +[](https://www.npmjs.com/package/@aws-sdk/protocol-json-rpc) diff --git a/packages/protocol-query/README.md b/packages/protocol-query/README.md index a2aed8597b90..12623032a820 100644 --- a/packages/protocol-query/README.md +++ b/packages/protocol-query/README.md @@ -1 +1,4 @@ -# protocol-query +# @aws-sdk/protocol-query + +[](https://www.npmjs.com/package/@aws-sdk/protocol-query) +[](https://www.npmjs.com/package/@aws-sdk/protocol-query) diff --git a/packages/protocol-rest/README.md b/packages/protocol-rest/README.md new file mode 100644 index 000000000000..7eed68c0ab1e --- /dev/null +++ b/packages/protocol-rest/README.md @@ -0,0 +1,4 @@ +# @aws-sdk/protocol-rest + +[](https://www.npmjs.com/package/@aws-sdk/protocol-rest) +[](https://www.npmjs.com/package/@aws-sdk/protocol-rest) diff --git a/packages/protocol-timestamp/README.md b/packages/protocol-timestamp/README.md new file mode 100644 index 000000000000..98bc339e340f --- /dev/null +++ b/packages/protocol-timestamp/README.md @@ -0,0 +1,4 @@ +# @aws-sdk/protocol-timestamp + +[](https://www.npmjs.com/package/@aws-sdk/protocol-timestamp) +[](https://www.npmjs.com/package/@aws-sdk/protocol-timestamp) diff --git a/packages/query-builder/README.md b/packages/query-builder/README.md new file mode 100644 index 000000000000..b3e5f3e72b5a --- /dev/null +++ b/packages/query-builder/README.md @@ -0,0 +1,4 @@ +# @aws-sdk/query-builder + +[](https://www.npmjs.com/package/@aws-sdk/query-builder) +[](https://www.npmjs.com/package/@aws-sdk/query-builder) diff --git a/packages/query-error-unmarshaller/README.md b/packages/query-error-unmarshaller/README.md index 8ac457e8253f..0dd86ab63e23 100644 --- a/packages/query-error-unmarshaller/README.md +++ b/packages/query-error-unmarshaller/README.md @@ -1 +1,4 @@ -# query-error-unmarshaller +# @aws-sdk/query-error-unmarshaller + +[](https://www.npmjs.com/package/@aws-sdk/query-error-unmarshaller) +[](https://www.npmjs.com/package/@aws-sdk/query-error-unmarshaller) diff --git a/packages/query-request-presigner/README.md b/packages/query-request-presigner/README.md index 2f9800b7cb85..d9ec04e8b989 100644 --- a/packages/query-request-presigner/README.md +++ b/packages/query-request-presigner/README.md @@ -1 +1,4 @@ -# query-request-presigner +# @aws-sdk/query-request-presigner + +[](https://www.npmjs.com/package/@aws-sdk/query-request-presigner) +[](https://www.npmjs.com/package/@aws-sdk/query-request-presigner) diff --git a/packages/querystring-builder/README.md b/packages/querystring-builder/README.md index d73f34a7ee38..eb19838038dc 100644 --- a/packages/querystring-builder/README.md +++ b/packages/querystring-builder/README.md @@ -1 +1,4 @@ -# querystring-builder +# @aws-sdk/querystring-builder + +[](https://www.npmjs.com/package/@aws-sdk/querystring-builder) +[](https://www.npmjs.com/package/@aws-sdk/querystring-builder) diff --git a/packages/querystring-parser/README.md b/packages/querystring-parser/README.md index 41aa513c8d8e..f61f16f57539 100644 --- a/packages/querystring-parser/README.md +++ b/packages/querystring-parser/README.md @@ -1 +1,4 @@ -# querystring-parser +# @aws-sdk/querystring-parser + +[](https://www.npmjs.com/package/@aws-sdk/querystring-parser) +[](https://www.npmjs.com/package/@aws-sdk/querystring-parser) diff --git a/packages/region-provider/README.md b/packages/region-provider/README.md new file mode 100644 index 000000000000..55abc40cd400 --- /dev/null +++ b/packages/region-provider/README.md @@ -0,0 +1,4 @@ +# @aws-sdk/region-provider + +[](https://www.npmjs.com/package/@aws-sdk/region-provider) +[](https://www.npmjs.com/package/@aws-sdk/region-provider) diff --git a/packages/remove-sensitive-logs/README.md b/packages/remove-sensitive-logs/README.md index 530c7e57a2d3..8151310749b0 100644 --- a/packages/remove-sensitive-logs/README.md +++ b/packages/remove-sensitive-logs/README.md @@ -1 +1,4 @@ -# remove-sensitive-logs +# @aws-sdk/remove-sensitive-logs + +[](https://www.npmjs.com/package/@aws-sdk/remove-sensitive-logs) +[](https://www.npmjs.com/package/@aws-sdk/remove-sensitive-logs) diff --git a/packages/response-metadata-extractor/README.md b/packages/response-metadata-extractor/README.md new file mode 100644 index 000000000000..dcf99999fe12 --- /dev/null +++ b/packages/response-metadata-extractor/README.md @@ -0,0 +1,4 @@ +# @aws-sdk/response-metadata-extractor + +[](https://www.npmjs.com/package/@aws-sdk/response-metadata-extractor) +[](https://www.npmjs.com/package/@aws-sdk/response-metadata-extractor) diff --git a/packages/retry-middleware/README.md b/packages/retry-middleware/README.md index 774c7107aed9..9d29d7ed957c 100644 --- a/packages/retry-middleware/README.md +++ b/packages/retry-middleware/README.md @@ -1 +1,4 @@ -# retry-middleware +# @aws-sdk/retry-middleware + +[](https://www.npmjs.com/package/@aws-sdk/retry-middleware) +[](https://www.npmjs.com/package/@aws-sdk/retry-middleware) diff --git a/packages/route53-id-normalizer-middleware/README.md b/packages/route53-id-normalizer-middleware/README.md index b05e98b82534..4a31a2bbdd4b 100644 --- a/packages/route53-id-normalizer-middleware/README.md +++ b/packages/route53-id-normalizer-middleware/README.md @@ -1 +1,4 @@ -# route53-id-normalizer-middleware +# @aws-sdk/route53-id-normalizer-middleware + +[](https://www.npmjs.com/package/@aws-sdk/route53-id-normalizer-middleware) +[](https://www.npmjs.com/package/@aws-sdk/route53-id-normalizer-middleware) diff --git a/packages/service-error-classification/README.md b/packages/service-error-classification/README.md index 209a3fc01507..c6da23a2542b 100644 --- a/packages/service-error-classification/README.md +++ b/packages/service-error-classification/README.md @@ -1 +1,4 @@ -# service-error-classification +# @aws-sdk/service-error-classification + +[](https://www.npmjs.com/package/@aws-sdk/service-error-classification) +[](https://www.npmjs.com/package/@aws-sdk/service-error-classification) diff --git a/packages/service-model/README.md b/packages/service-model/README.md new file mode 100644 index 000000000000..d4057b57d353 --- /dev/null +++ b/packages/service-model/README.md @@ -0,0 +1 @@ +# @aws-sdk/service-model diff --git a/packages/service-types-generator/README.md b/packages/service-types-generator/README.md new file mode 100644 index 000000000000..189db8356c88 --- /dev/null +++ b/packages/service-types-generator/README.md @@ -0,0 +1 @@ +# @aws-sdk/service-types-generator diff --git a/packages/service-types-generator/src/clientReadme.ts b/packages/service-types-generator/src/clientReadme.ts index 6d3ee8a2d14c..ac69ea8ea6c3 100644 --- a/packages/service-types-generator/src/clientReadme.ts +++ b/packages/service-types-generator/src/clientReadme.ts @@ -33,6 +33,9 @@ export function readme({ model, name: packageName, runtime }: ReadmeInterface) { // console.log(Object.keys(model.operations)[0], '____', exampleCommand) return `# ${packageName} +[](https://www.npmjs.com/package/${packageName}) +[](https://www.npmjs.com/package/${packageName}) + ## Description ${description} diff --git a/packages/sha256-tree-hash/README.md b/packages/sha256-tree-hash/README.md index 4b6a64c1b62a..fd105984eb1f 100644 --- a/packages/sha256-tree-hash/README.md +++ b/packages/sha256-tree-hash/README.md @@ -1 +1,4 @@ -# sha256-tree-hash +# @aws-sdk/sha256-tree-hash + +[](https://www.npmjs.com/package/@aws-sdk/sha256-tree-hash) +[](https://www.npmjs.com/package/@aws-sdk/sha256-tree-hash) diff --git a/packages/shared-ini-file-loader/README.md b/packages/shared-ini-file-loader/README.md index 387b8dc9e67d..072ff6babaa1 100644 --- a/packages/shared-ini-file-loader/README.md +++ b/packages/shared-ini-file-loader/README.md @@ -1,5 +1,8 @@ # AWS Shared Configuration File Loader +[](https://www.npmjs.com/package/@aws-sdk/shared-ini-file-loader) +[](https://www.npmjs.com/package/@aws-sdk/shared-ini-file-loader) + This module provides a function that reads from AWS SDK configuration files and returns a promise that will resolve with a hash of the parsed contents of the AWS credentials file and of the AWS config file. Given the [sample diff --git a/packages/signature-v4-browser/README.md b/packages/signature-v4-browser/README.md index 0175d52eda20..36df5d44af0b 100644 --- a/packages/signature-v4-browser/README.md +++ b/packages/signature-v4-browser/README.md @@ -1,3 +1,6 @@ -# signature-v4-browser +# @aws-sdk/signature-v4-browser + +[](https://www.npmjs.com/package/@aws-sdk/signature-v4-browser) +[](https://www.npmjs.com/package/@aws-sdk/signature-v4-browser) A standalone AWS Signature V4 request signer for browser JavaScript diff --git a/packages/signature-v4-node/README.md b/packages/signature-v4-node/README.md index dcfb156be724..6da66b11f327 100644 --- a/packages/signature-v4-node/README.md +++ b/packages/signature-v4-node/README.md @@ -1,5 +1,8 @@ # AWS Signature V4 Signer for Node.JS +[](https://www.npmjs.com/package/@aws-sdk/signature-v4-node) +[](https://www.npmjs.com/package/@aws-sdk/signature-v4-node) + This module provides a class, `SignatureV4`, that will attempt to sign requests. ## Supported configuration diff --git a/packages/signature-v4-universal/README.md b/packages/signature-v4-universal/README.md index 8d7e34025ad1..68e1b0a87d2a 100644 --- a/packages/signature-v4-universal/README.md +++ b/packages/signature-v4-universal/README.md @@ -1,3 +1,6 @@ -# signature-v4-universal +# @aws-sdk/signature-v4-universal + +[](https://www.npmjs.com/package/@aws-sdk/signature-v4-universal) +[](https://www.npmjs.com/package/@aws-sdk/signature-v4-universal) A standalone AWS Signature V4 request signer targeting all JS environments diff --git a/packages/signature-v4/README.md b/packages/signature-v4/README.md new file mode 100644 index 000000000000..5bc06e4f9f64 --- /dev/null +++ b/packages/signature-v4/README.md @@ -0,0 +1,4 @@ +# @aws-sdk/signature-v4 + +[](https://www.npmjs.com/package/@aws-sdk/signature-v4) +[](https://www.npmjs.com/package/@aws-sdk/signature-v4) diff --git a/packages/signing-middleware/README.md b/packages/signing-middleware/README.md index a482d2157fc5..9f24b3cd7569 100644 --- a/packages/signing-middleware/README.md +++ b/packages/signing-middleware/README.md @@ -1 +1,4 @@ # signer-middleware + +[](https://www.npmjs.com/package/@aws-sdk/signing-middleware) +[](https://www.npmjs.com/package/@aws-sdk/signing-middleware) diff --git a/packages/ssec-middleware/README.md b/packages/ssec-middleware/README.md index 3e5224565959..2bbf327f91e8 100644 --- a/packages/ssec-middleware/README.md +++ b/packages/ssec-middleware/README.md @@ -1 +1,4 @@ -# ssec-middleware +# @aws-sdk/ssec-middleware + +[](https://www.npmjs.com/package/@aws-sdk/ssec-middleware) +[](https://www.npmjs.com/package/@aws-sdk/ssec-middleware) diff --git a/packages/stream-collector-browser/README.md b/packages/stream-collector-browser/README.md new file mode 100644 index 000000000000..208c938739e4 --- /dev/null +++ b/packages/stream-collector-browser/README.md @@ -0,0 +1,4 @@ +# @aws-sdk/stream-collector-browser + +[](https://www.npmjs.com/package/@aws-sdk/stream-collector-browser) +[](https://www.npmjs.com/package/@aws-sdk/stream-collector-browser) diff --git a/packages/stream-collector-node/README.md b/packages/stream-collector-node/README.md new file mode 100644 index 000000000000..7bfc69719cdc --- /dev/null +++ b/packages/stream-collector-node/README.md @@ -0,0 +1,4 @@ +# @aws-sdk/stream-collector-node + +[](https://www.npmjs.com/package/@aws-sdk/stream-collector-node) +[](https://www.npmjs.com/package/@aws-sdk/stream-collector-node) diff --git a/packages/test-protocol-rest-json/README.md b/packages/test-protocol-rest-json/README.md index 95ad233a348e..a828b035eb28 100644 --- a/packages/test-protocol-rest-json/README.md +++ b/packages/test-protocol-rest-json/README.md @@ -1 +1 @@ -# test-protocol-rest-json +# @aws-sdk/test-protocol-rest-json diff --git a/packages/test-protocol-rest-xml/README.md b/packages/test-protocol-rest-xml/README.md index fa8882d784d6..7afeb2b651e5 100644 --- a/packages/test-protocol-rest-xml/README.md +++ b/packages/test-protocol-rest-xml/README.md @@ -1 +1 @@ -# test-protocol-rest-xml +# @aws-sdk/test-protocol-rest-xml diff --git a/packages/types/README.md b/packages/types/README.md new file mode 100644 index 000000000000..a0f57c1f48db --- /dev/null +++ b/packages/types/README.md @@ -0,0 +1,4 @@ +# @aws-sdk/types + +[](https://www.npmjs.com/package/@aws-sdk/types) +[](https://www.npmjs.com/package/@aws-sdk/types) diff --git a/packages/url-parser-browser/README.md b/packages/url-parser-browser/README.md index b6d8fb32f0b9..9d101f9e900d 100644 --- a/packages/url-parser-browser/README.md +++ b/packages/url-parser-browser/README.md @@ -1 +1,4 @@ -# url-parser-browser +# @aws-sdk/url-parser-browser + +[](https://www.npmjs.com/package/@aws-sdk/url-parser-browser) +[](https://www.npmjs.com/package/@aws-sdk/url-parser-browser) diff --git a/packages/url-parser-node/README.md b/packages/url-parser-node/README.md index e71d15b8a844..5b431be8146c 100644 --- a/packages/url-parser-node/README.md +++ b/packages/url-parser-node/README.md @@ -1 +1,4 @@ -# url-parser-node +# @aws-sdk/url-parser-node + +[](https://www.npmjs.com/package/@aws-sdk/url-parser-node) +[](https://www.npmjs.com/package/@aws-sdk/url-parser-node) diff --git a/packages/url-parser-universal/README.md b/packages/url-parser-universal/README.md index 567c20896e9f..662f6db52522 100644 --- a/packages/url-parser-universal/README.md +++ b/packages/url-parser-universal/README.md @@ -1 +1,4 @@ -# url-parser-universal +# @aws-sdk/url-parser-universal + +[](https://www.npmjs.com/package/@aws-sdk/url-parser-universal) +[](https://www.npmjs.com/package/@aws-sdk/url-parser-universal) diff --git a/packages/util-base64-browser/README.md b/packages/util-base64-browser/README.md new file mode 100644 index 000000000000..d251d4e72abf --- /dev/null +++ b/packages/util-base64-browser/README.md @@ -0,0 +1,4 @@ +# @aws-sdk/util-base64-browser + +[](https://www.npmjs.com/package/@aws-sdk/util-base64-browser) +[](https://www.npmjs.com/package/@aws-sdk/util-base64-browser) diff --git a/packages/util-base64-node/README.md b/packages/util-base64-node/README.md new file mode 100644 index 000000000000..fe06691ebe2c --- /dev/null +++ b/packages/util-base64-node/README.md @@ -0,0 +1,4 @@ +# @aws-sdk/util-base64-node + +[](https://www.npmjs.com/package/@aws-sdk/util-base64-node) +[](https://www.npmjs.com/package/@aws-sdk/util-base64-node) diff --git a/packages/util-base64-universal/README.md b/packages/util-base64-universal/README.md new file mode 100644 index 000000000000..bdbbfe45c678 --- /dev/null +++ b/packages/util-base64-universal/README.md @@ -0,0 +1,4 @@ +# @aws-sdk/util-base64-universal + +[](https://www.npmjs.com/package/@aws-sdk/util-base64-universal) +[](https://www.npmjs.com/package/@aws-sdk/util-base64-universal) diff --git a/packages/util-body-length-browser/README.md b/packages/util-body-length-browser/README.md index 8ac1debe49a5..62bc2753db29 100644 --- a/packages/util-body-length-browser/README.md +++ b/packages/util-body-length-browser/README.md @@ -1,3 +1,6 @@ -# util-body-length-browser +# @aws-sdk/util-body-length-browser + +[](https://www.npmjs.com/package/@aws-sdk/util-body-length-browser) +[](https://www.npmjs.com/package/@aws-sdk/util-body-length-browser) Determines the length of a request body in browsers diff --git a/packages/util-body-length-node/README.md b/packages/util-body-length-node/README.md index fe2f6c9ed8dc..6429d52fd2c7 100644 --- a/packages/util-body-length-node/README.md +++ b/packages/util-body-length-node/README.md @@ -1,3 +1,6 @@ -# util-body-length-node +# @aws-sdk/util-body-length-node Determines the length of a request body in node.js + +[](https://www.npmjs.com/package/@aws-sdk/util-body-length-node) +[](https://www.npmjs.com/package/@aws-sdk/util-body-length-node) diff --git a/packages/util-buffer-from/README.md b/packages/util-buffer-from/README.md new file mode 100644 index 000000000000..b5a8b9ecfd45 --- /dev/null +++ b/packages/util-buffer-from/README.md @@ -0,0 +1,4 @@ +# @aws-sdk/util-buffer-from + +[](https://www.npmjs.com/package/@aws-sdk/util-buffer-from) +[](https://www.npmjs.com/package/@aws-sdk/util-buffer-from) diff --git a/packages/util-error-constructor/README.md b/packages/util-error-constructor/README.md index 06cd185c7b53..60897758477d 100644 --- a/packages/util-error-constructor/README.md +++ b/packages/util-error-constructor/README.md @@ -1 +1,4 @@ -# util-error-constructor +# @aws-sdk/util-error-constructor + +[](https://www.npmjs.com/package/@aws-sdk/util-error-constructor) +[](https://www.npmjs.com/package/@aws-sdk/util-error-constructor) diff --git a/packages/util-format-url/README.md b/packages/util-format-url/README.md index fb3a75236f30..3e1046ae924b 100644 --- a/packages/util-format-url/README.md +++ b/packages/util-format-url/README.md @@ -1 +1,4 @@ -# util-format-url +# @aws-sdk/util-format-url + +[](https://www.npmjs.com/package/@aws-sdk/util-format-url) +[](https://www.npmjs.com/package/@aws-sdk/util-format-url) diff --git a/packages/util-hex-encoding/README.md b/packages/util-hex-encoding/README.md new file mode 100644 index 000000000000..6951c5b01318 --- /dev/null +++ b/packages/util-hex-encoding/README.md @@ -0,0 +1,4 @@ +# @aws-sdk/util-hex-encoding + +[](https://www.npmjs.com/package/@aws-sdk/util-hex-encoding) +[](https://www.npmjs.com/package/@aws-sdk/util-hex-encoding) diff --git a/packages/util-locate-window/README.md b/packages/util-locate-window/README.md new file mode 100644 index 000000000000..cec3051c4fa3 --- /dev/null +++ b/packages/util-locate-window/README.md @@ -0,0 +1,4 @@ +# @aws-sdk/util-locate-window + +[](https://www.npmjs.com/package/@aws-sdk/util-locate-window) +[](https://www.npmjs.com/package/@aws-sdk/util-locate-window) diff --git a/packages/util-uri-escape/README.md b/packages/util-uri-escape/README.md index d9983c0bd637..cc337d2c3511 100644 --- a/packages/util-uri-escape/README.md +++ b/packages/util-uri-escape/README.md @@ -1 +1,4 @@ # util-uri-encode + +[](https://www.npmjs.com/package/@aws-sdk/util-uri-escape) +[](https://www.npmjs.com/package/@aws-sdk/util-uri-escape) diff --git a/packages/util-user-agent-browser/README.md b/packages/util-user-agent-browser/README.md index 11b5881d1e18..735459580eaf 100644 --- a/packages/util-user-agent-browser/README.md +++ b/packages/util-user-agent-browser/README.md @@ -1 +1,4 @@ # @aws-sdk/util-user-agent-browser + +[](https://www.npmjs.com/package/@aws-sdk/util-user-agent-browser) +[](https://www.npmjs.com/package/@aws-sdk/util-user-agent-browser) diff --git a/packages/util-user-agent-node/README.md b/packages/util-user-agent-node/README.md index 83432860957b..bb5d56d93ea8 100644 --- a/packages/util-user-agent-node/README.md +++ b/packages/util-user-agent-node/README.md @@ -1 +1,4 @@ # @aws-sdk/util-user-agent-node + +[](https://www.npmjs.com/package/@aws-sdk/util-user-agent-node) +[](https://www.npmjs.com/package/@aws-sdk/util-user-agent-node) diff --git a/packages/util-utf8-browser/README.md b/packages/util-utf8-browser/README.md new file mode 100644 index 000000000000..307c13e0c5ef --- /dev/null +++ b/packages/util-utf8-browser/README.md @@ -0,0 +1,4 @@ +# @aws-sdk/util-utf8-browser + +[](https://www.npmjs.com/package/@aws-sdk/util-utf8-browser) +[](https://www.npmjs.com/package/@aws-sdk/util-utf8-browser) diff --git a/packages/util-utf8-node/README.md b/packages/util-utf8-node/README.md new file mode 100644 index 000000000000..a5c67d7cb60f --- /dev/null +++ b/packages/util-utf8-node/README.md @@ -0,0 +1,4 @@ +# @aws-sdk/util-utf8-node + +[](https://www.npmjs.com/package/@aws-sdk/util-utf8-node) +[](https://www.npmjs.com/package/@aws-sdk/util-utf8-node) diff --git a/packages/util-utf8-universal/README.md b/packages/util-utf8-universal/README.md new file mode 100644 index 000000000000..5d0e0cf41062 --- /dev/null +++ b/packages/util-utf8-universal/README.md @@ -0,0 +1,4 @@ +# @aws-sdk/util-utf8-universal + +[](https://www.npmjs.com/package/@aws-sdk/util-utf8-universal) +[](https://www.npmjs.com/package/@aws-sdk/util-utf8-universal) diff --git a/packages/xml-body-builder/README.md b/packages/xml-body-builder/README.md new file mode 100644 index 000000000000..ad88e48c5a91 --- /dev/null +++ b/packages/xml-body-builder/README.md @@ -0,0 +1,4 @@ +# @aws-sdk/xml-body-builder + +[](https://www.npmjs.com/package/@aws-sdk/xml-body-builder) +[](https://www.npmjs.com/package/@aws-sdk/xml-body-builder) diff --git a/packages/xml-body-parser/README.md b/packages/xml-body-parser/README.md new file mode 100644 index 000000000000..e20900398ee6 --- /dev/null +++ b/packages/xml-body-parser/README.md @@ -0,0 +1,4 @@ +# @aws-sdk/xml-body-parser + +[](https://www.npmjs.com/package/@aws-sdk/xml-body-parser) +[](https://www.npmjs.com/package/@aws-sdk/xml-body-parser) diff --git a/packages/xml-builder/README.md b/packages/xml-builder/README.md new file mode 100644 index 000000000000..a39448532353 --- /dev/null +++ b/packages/xml-builder/README.md @@ -0,0 +1,4 @@ +# @aws-sdk/xml-builder + +[](https://www.npmjs.com/package/@aws-sdk/xml-builder) +[](https://www.npmjs.com/package/@aws-sdk/xml-builder)