Skip to content

Commit 872498c

Browse files
Update documentation links from awslabs/aws-lambda-rust-runtime to aws/aws-lambda-rust-runtime (#1054)
* docs: point docs to aws/aws-lambda-rust-runtime instead of awslabs/ * Remove experimental
1 parent 578c533 commit 872498c

File tree

8 files changed

+13
-15
lines changed

8 files changed

+13
-15
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ information to effectively respond to your bug report or contribution.
1010

1111
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
1212

13-
When filing an issue, please check [existing open](https://github.com/awslabs/aws-lambda-rust-runtime/issues), or [recently closed](https://github.com/awslabs/aws-lambda-rust-runtime/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
13+
When filing an issue, please check [existing open](https://github.com/aws/aws-lambda-rust-runtime/issues), or [recently closed](https://github.com/aws/aws-lambda-rust-runtime/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
1414
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
1515

1616
* A reproducible test case or series of steps
@@ -40,7 +40,7 @@ GitHub provides additional document on [forking a repository](https://help.githu
4040

4141
## Finding contributions to work on
4242

43-
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/awslabs/aws-lambda-rust-runtime/labels/help%20wanted) issues is a great place to start.
43+
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/aws/aws-lambda-rust-runtime/labels/help%20wanted) issues is a great place to start.
4444

4545
## Code of Conduct
4646

@@ -54,6 +54,6 @@ If you discover a potential security issue in this project we ask that you notif
5454

5555
## Licensing
5656

57-
See the [LICENSE](https://github.com/awslabs/aws-lambda-rust-runtime/blob/main/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
57+
See the [LICENSE](https://github.com/aws/aws-lambda-rust-runtime/blob/main/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
5858

5959
We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Rust Runtime for AWS Lambda
22

3-
[![Build Status](https://github.com/awslabs/aws-lambda-rust-runtime/actions/workflows/check-examples.yml/badge.svg)](https://github.com/awslabs/aws-lambda-rust-runtime/actions)
3+
[![Build Status](https://github.com/aws/aws-lambda-rust-runtime/actions/workflows/check-examples.yml/badge.svg)](https://github.com/aws/aws-lambda-rust-runtime/actions)
44

55
This package makes it easy to run AWS Lambda Functions written in Rust. This workspace includes multiple crates:
66

@@ -10,8 +10,6 @@ This package makes it easy to run AWS Lambda Functions written in Rust. This wor
1010
- [![Docs](https://docs.rs/aws_lambda_events/badge.svg)](https://docs.rs/aws_lambda_events) **`lambda-events`** is a library with strongly-typed Lambda event structs in Rust.
1111
- [![Docs](https://docs.rs/lambda_runtime_api_client/badge.svg)](https://docs.rs/lambda_runtime_api_client) **`lambda-runtime-api-client`** is a shared library between the lambda runtime and lambda extension libraries that includes a common API client to talk with the AWS Lambda Runtime API.
1212

13-
The Rust runtime client is an experimental package. It is subject to change and intended only for evaluation purposes.
14-
1513
## Getting started
1614

1715
The easiest way to start writing Lambda functions with Rust is by using [Cargo Lambda](https://www.cargo-lambda.info/), a related project. Cargo Lambda is a Cargo plugin, or subcommand, that provides several commands to help you in your journey with Rust on AWS Lambda.
@@ -113,7 +111,7 @@ async fn handler(_event: LambdaEvent<()>) -> Result<(), ErrorResponse> {
113111
}
114112
```
115113

116-
We recommend you to use the [thiserror crate](https://crates.io/crates/thiserror) to declare your errors. You can see an example on how to integrate `thiserror` with the Runtime's diagnostics in our [example repository](https://github.com/awslabs/aws-lambda-rust-runtime/tree/main/examples/basic-error-thiserror)
114+
We recommend you to use the [thiserror crate](https://crates.io/crates/thiserror) to declare your errors. You can see an example on how to integrate `thiserror` with the Runtime's diagnostics in our [example repository](https://github.com/aws/aws-lambda-rust-runtime/tree/main/examples/basic-error-thiserror)
117115

118116
### Anyhow, Eyre, and Miette
119117

@@ -129,7 +127,7 @@ async fn handler(_event: LambdaEvent<Request>) -> Result<(), Diagnostic> {
129127
}
130128
```
131129

132-
You can see more examples on how to use these error crates in our [example repository](https://github.com/awslabs/aws-lambda-rust-runtime/tree/main/examples/basic-error-error-crates-integration).
130+
You can see more examples on how to use these error crates in our [example repository](https://github.com/aws/aws-lambda-rust-runtime/tree/main/examples/basic-error-error-crates-integration).
133131

134132
### Graceful shutdown
135133

@@ -370,7 +368,7 @@ Now you can use the `cargo lambda invoke` to send requests to your function. For
370368
cargo lambda invoke <lambda-function-name> --data-ascii '{ "command": "hi" }'
371369
```
372370

373-
Running the command on a HTTP function (Function URL, API Gateway, etc) will require you to use the appropriate scheme. You can find examples of these schemes [here](https://github.com/awslabs/aws-lambda-rust-runtime/tree/main/lambda-http/tests/data). Otherwise, you will be presented with the following error.
371+
Running the command on a HTTP function (Function URL, API Gateway, etc) will require you to use the appropriate scheme. You can find examples of these schemes [here](https://github.com/aws/aws-lambda-rust-runtime/tree/main/lambda-http/tests/data). Otherwise, you will be presented with the following error.
374372

375373
```rust,no_run
376374
Error: serde_json::error::Error

examples/basic-error-handling/src/main.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
/// See <https://github.com/awslabs/aws-lambda-rust-runtime> for more info on Rust runtime for AWS Lambda
1+
/// See <https://github.com/aws/aws-lambda-rust-runtime> for more info on Rust runtime for AWS Lambda
22
use lambda_runtime::{service_fn, tracing, Error, LambdaEvent};
33
use serde::{Deserialize, Serialize};
44
use serde_json::json;

examples/http-basic-lambda/src/main.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ use lambda_http::{run, service_fn, tracing, Body, Error, Request, Response};
33
/// This is the main body for the function.
44
/// Write your code inside it.
55
/// There are some code examples in the Runtime repository:
6-
/// - <https://github.com/awslabs/aws-lambda-rust-runtime/tree/main/examples>
6+
/// - <https://github.com/aws/aws-lambda-rust-runtime/tree/main/examples>
77
async fn function_handler(_event: Request) -> Result<Response<Body>, Error> {
88
// Extract some useful information from the request
99

examples/http-dynamodb/src/main.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ pub struct Item {
1515
/// This is the main body for the function.
1616
/// Write your code inside it.
1717
/// You can see more examples in Runtime's repository:
18-
/// - <https://github.com/awslabs/aws-lambda-rust-runtime/tree/main/examples>
18+
/// - <https://github.com/aws/aws-lambda-rust-runtime/tree/main/examples>
1919
async fn handle_request(db_client: &Client, event: Request) -> Result<Response<Body>, Error> {
2020
// Extract some useful information from the request
2121
let body = event.body();

examples/http-query-parameters/src/main.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ use lambda_http::{run, service_fn, tracing, Error, IntoResponse, Request, Reques
33
/// This is the main body for the function.
44
/// Write your code inside it.
55
/// You can see more examples in Runtime's repository:
6-
/// - <https://github.com/awslabs/aws-lambda-rust-runtime/tree/main/examples>
6+
/// - <https://github.com/aws/aws-lambda-rust-runtime/tree/main/examples>
77
async fn function_handler(event: Request) -> Result<impl IntoResponse, Error> {
88
// Extract some useful information from the request
99
Ok(

lambda-events/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The crate itself has no AWS Lambda handler logic and instead exists to serialize
1515
and deserialize AWS Lambda events into strongly-typed Rust structs.
1616

1717
The types
18-
defined in this crate are usually used with handlers / runtimes provided by the [official Rust runtime](https://github.com/awslabs/aws-lambda-rust-runtime).
18+
defined in this crate are usually used with handlers / runtimes provided by the [official Rust runtime](https://github.com/aws/aws-lambda-rust-runtime).
1919

2020
For a list of supported AWS Lambda events and services, see [the crate reference documentation](https://docs.rs/aws_lambda_events).
2121

lambda-http/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ pub fn custom_authorizer_response(effect: &str, principal: &str, method_arn: &st
169169
ApiGatewayCustomAuthorizerResponse {
170170
principal_id: Some(principal.to_owned()),
171171
policy_document: policy,
172-
context: json!({ "email": principal }), // https://github.com/awslabs/aws-lambda-rust-runtime/discussions/548
172+
context: json!({ "email": principal }), // https://github.com/aws/aws-lambda-rust-runtime/discussions/548
173173
usage_identifier_key: None,
174174
}
175175
}

0 commit comments

Comments
 (0)