Commit 0ad0f331 authored by Doug's avatar Doug Committed by John DiSanti
Browse files

Refactored API Gateway code example (#738) 

* Refactored API Gateway code example to move operation out of main and into separate function.

* Added unit test and readme and updated change log with info about latest changes to ApiGateway code example

* Removed unit test from API Gateway code example.

* Updated API Gateway code example based on feedback.

* Remove `actix-rt` dependency
parent 421e5b1a

aws/SDK_CHANGELOG.md

+2 −0
Original line number Diff line number Diff line
@@ -13,6 +13,8 @@ vNext (Month Day, Year) 
- :tada: Add presigned request support and example for Polly SynthesizeSpeech (smithy-rs#735, aws-sdk-rust#139)

- :bug: Fix error when receiving `Cont` event from S3 SelectObjectContent (smithy-rs#736)

- :bug: Fix bug in event stream receiver that could cause the last events in the response stream to be lost when using S3 SelectObjectContent (smithy-rs#736)

- Updated Transcribe code example to take an audio file as a command-line option and added readme.

- Refactored API Gateway code example by moving operation out of main and into a separate function; added readme.

- Updated Auto Scaling code example to move operation from main to separate function; added readme.

- :tada: Add support for 6 new AWS services:

    - Wisdom

aws/sdk/examples/apigateway/README.md

0 → 100644
+38 −0
Original line number Diff line number Diff line 
# AWS SDK for Rust code examples for API Gateway



Amazon API Gateway (API Gateway) enables you to create and deploy your own REST and WebSocket APIs at any scale. You can create robust, secure, and scalable APIs that access Amazon Web Services or other web services, as well as data that’s stored in the AWS Cloud.



## Purpose



These examples demonstrate how to perform several API Gateway operations using the alpha version of the AWS SDK for Rust.



## Prerequisites



You must have an AWS account, and have configured your default credentials and AWS Region as described in [https://github.com/awslabs/aws-sdk-rust](https://github.com/awslabs/aws-sdk-rust).



## Running the code



### get_rest_apis



This example describes the API Gateway REST APIs in the Region.



`cargo run --bin get_rest_apis -- [-r REGION] [-v]`



- _REGION_ is name of the Region where the stacks are located.

  If not supplied, uses the value of the __AWS_REGION__ environment variable.

  If the environment variable is not set, defaults to __us-west-2__.

- __-v__ displays additional information.



### Notes



- We recommend that you grant this code least privilege,

  or at most the minimum permissions required to perform the task.

  For more information, see

  [Grant Least Privilege](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege)

  in the AWS Identity and Access Management User Guide.

- This code has not been tested in all AWS Regions.

  Some AWS services are available only in specific

  [Regions](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services).

- Running this code might result in charges to your AWS account.



Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0
 
 No newline at end of file

aws/sdk/examples/apigateway/src/bin/get_rest_apis.rs

+23 −18
Original line number Diff line number Diff line
@@ -18,6 +18,28 @@ struct Opt { 
    verbose: bool,

}



// Displays the Amazon API Gateway REST APIs in the Region.

async fn show_apis(client: &Client) -> Result<(), Error> {

    let resp = client.get_rest_apis().send().await?;



    for api in resp.items.unwrap_or_default() {

        println!("ID:          {}", api.id.as_deref().unwrap_or_default());

        println!("Name:        {}", api.name.as_deref().unwrap_or_default());

        println!(

            "Description: {}",

            api.description.as_deref().unwrap_or_default()

        );

        println!(

            "Version:     {}",

            api.version.as_deref().unwrap_or_default()

        );

        println!("Created:     {}", api.created_date.unwrap().to_chrono());

        println!();

    }



    Ok(())

}



/// Displays information about the Amazon API Gateway REST APIs in the Region.

///

/// # Arguments
@@ -49,22 +71,5 @@ async fn main() -> Result<(), Error> { 
    let shared_config = aws_config::from_env().region(region_provider).load().await;

    let client = Client::new(&shared_config);



    let resp = client.get_rest_apis().send().await?;



    for api in resp.items.unwrap_or_default() {

        println!("ID:          {}", api.id.as_deref().unwrap_or_default());

        println!("Name:        {}", api.name.as_deref().unwrap_or_default());

        println!(

            "Description: {}",

            api.description.as_deref().unwrap_or_default()

        );

        println!(

            "Version:     {}",

            api.version.as_deref().unwrap_or_default()

        );

        println!("Created:     {}", api.created_date.unwrap().to_chrono());

        println!();

    }



    Ok(())

    show_apis(&client).await

}