Skip to content

Commit fe88df5

Browse files
alfonsofalfonsof
committed
Updated README.md
1 parent f5a8931 commit fe88df5

File tree

26 files changed

+425
-373
lines changed

26 files changed

+425
-373
lines changed

‎awsec2instances-capi/README.md

+13-11
Original file line numberDiff line numberDiff line change
@@ -33,41 +33,43 @@ Manage Amazon EC2 Instances using the Client API (low-level) of Boto 3.
3333

3434
Setting your credentials for use by the AWS SDK for Java can be done in a number of ways, but here are the recommended approaches:
3535

36-
* The default credential profiles file
36+
* The default credential profiles file.
3737

3838
Set credentials in the AWS credentials profile file on your local system, located at:
3939

40-
`~/.aws/credentials` on Linux, macOS, or Unix
40+
* `~/.aws/credentials` on Linux, macOS, or Unix.
4141

42-
`C:\Users\USERNAME\.aws\credentials` on Windows
42+
* `C:\Users\USERNAME\.aws\credentials` on Windows.
4343

4444
This file should contain lines in the following format:
4545

4646
```bash
4747
[default]
48-
aws_access_key_id = <your_access_key_id>
49-
aws_secret_access_key = <your_secret_access_key>
48+
aws_access_key_id = <YOUR_ACCESS_KEY_ID>
49+
aws_secret_access_key = <YOUR_SECRET_ACCESS_KEY>
5050
```
51-
Substitute your own AWS credentials values for the values `<your_access_key_id>` and `<your_secret_access_key>`.
51+
Replace the values of `<YOUR_ACCESS_KEY_ID>` and `<YOUR_SECRET_ACCESS_KEY>` by your AWS credentials.
5252

53-
* Environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`
53+
* Environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`.
5454

5555
Set the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables.
5656

5757
To set these variables on Linux, macOS, or Unix, use `export`:
5858

5959
```bash
60-
export AWS_ACCESS_KEY_ID=<your_access_key_id>
61-
export AWS_SECRET_ACCESS_KEY=<your_secret_access_key>
60+
export AWS_ACCESS_KEY_ID=<YOUR_ACCESS_KEY_ID>
61+
export AWS_SECRET_ACCESS_KEY=<YOUR_SECRET_ACCESS_KEY>
6262
```
6363

6464
To set these variables on Windows, use `set`:
6565

6666
```bash
67-
set AWS_ACCESS_KEY_ID=<your_access_key_id>
68-
set AWS_SECRET_ACCESS_KEY=<your_secret_access_key>
67+
set AWS_ACCESS_KEY_ID=<YOUR_ACCESS_KEY_ID>
68+
set AWS_SECRET_ACCESS_KEY=<YOUR_SECRET_ACCESS_KEY>
6969
```
7070

71+
Replace the values of `<YOUR_ACCESS_KEY_ID>` and `<YOUR_SECRET_ACCESS_KEY>` by your AWS credentials.
72+
7173
* Run the code.
7274

7375
Run application:

‎awsec2instances-rapi/README.md

+13-11
Original file line numberDiff line numberDiff line change
@@ -33,41 +33,43 @@ Manage Amazon EC2 Instances using the Resource API (high-level) of Boto 3.
3333

3434
Setting your credentials for use by the AWS SDK for Java can be done in a number of ways, but here are the recommended approaches:
3535

36-
* The default credential profiles file
36+
* The default credential profiles file.
3737

3838
Set credentials in the AWS credentials profile file on your local system, located at:
3939

40-
`~/.aws/credentials` on Linux, macOS, or Unix
40+
* `~/.aws/credentials` on Linux, macOS, or Unix.
4141

42-
`C:\Users\USERNAME\.aws\credentials` on Windows
42+
* `C:\Users\USERNAME\.aws\credentials` on Windows.
4343

4444
This file should contain lines in the following format:
4545

4646
```bash
4747
[default]
48-
aws_access_key_id = <your_access_key_id>
49-
aws_secret_access_key = <your_secret_access_key>
48+
aws_access_key_id = <YOUR_ACCESS_KEY_ID>
49+
aws_secret_access_key = <YOUR_SECRET_ACCESS_KEY>
5050
```
51-
Substitute your own AWS credentials values for the values `<your_access_key_id>` and `<your_secret_access_key>`.
51+
Replace the values of `<YOUR_ACCESS_KEY_ID>` and `<YOUR_SECRET_ACCESS_KEY>` by your AWS credentials.
5252

53-
* Environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`
53+
* Environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`.
5454

5555
Set the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables.
5656

5757
To set these variables on Linux, macOS, or Unix, use `export`:
5858

5959
```bash
60-
export AWS_ACCESS_KEY_ID=<your_access_key_id>
61-
export AWS_SECRET_ACCESS_KEY=<your_secret_access_key>
60+
export AWS_ACCESS_KEY_ID=<YOUR_ACCESS_KEY_ID>
61+
export AWS_SECRET_ACCESS_KEY=<YOUR_SECRET_ACCESS_KEY>
6262
```
6363

6464
To set these variables on Windows, use `set`:
6565

6666
```bash
67-
set AWS_ACCESS_KEY_ID=<your_access_key_id>
68-
set AWS_SECRET_ACCESS_KEY=<your_secret_access_key>
67+
set AWS_ACCESS_KEY_ID=<YOUR_ACCESS_KEY_ID>
68+
set AWS_SECRET_ACCESS_KEY=<YOUR_SECRET_ACCESS_KEY>
6969
```
7070

71+
Replace the values of `<YOUR_ACCESS_KEY_ID>` and `<YOUR_SECRET_ACCESS_KEY>` by your AWS credentials.
72+
7173
* Run the code.
7274

7375
Run application:

‎awslambdacreate-capi/README.md

+19-17
Original file line numberDiff line numberDiff line change
@@ -33,41 +33,43 @@ Create an AWS Lambda function using the Client API (low-level) of Boto 3.
3333

3434
Setting your credentials for use by the AWS SDK for Java can be done in a number of ways, but here are the recommended approaches:
3535

36-
* The default credential profiles file
36+
* The default credential profiles file.
3737

3838
Set credentials in the AWS credentials profile file on your local system, located at:
3939

40-
`~/.aws/credentials` on Linux, macOS, or Unix
40+
* `~/.aws/credentials` on Linux, macOS, or Unix.
4141

42-
`C:\Users\USERNAME\.aws\credentials` on Windows
42+
* `C:\Users\USERNAME\.aws\credentials` on Windows.
4343

4444
This file should contain lines in the following format:
4545

4646
```bash
4747
[default]
48-
aws_access_key_id = <your_access_key_id>
49-
aws_secret_access_key = <your_secret_access_key>
48+
aws_access_key_id = <YOUR_ACCESS_KEY_ID>
49+
aws_secret_access_key = <YOUR_SECRET_ACCESS_KEY>
5050
```
51-
Substitute your own AWS credentials values for the values `<your_access_key_id>` and `<your_secret_access_key>`.
51+
Replace the values of `<YOUR_ACCESS_KEY_ID>` and `<YOUR_SECRET_ACCESS_KEY>` by your AWS credentials.
5252

53-
* Environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`
53+
* Environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`.
5454

5555
Set the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables.
5656

5757
To set these variables on Linux, macOS, or Unix, use `export`:
5858

5959
```bash
60-
export AWS_ACCESS_KEY_ID=<your_access_key_id>
61-
export AWS_SECRET_ACCESS_KEY=<your_secret_access_key>
60+
export AWS_ACCESS_KEY_ID=<YOUR_ACCESS_KEY_ID>
61+
export AWS_SECRET_ACCESS_KEY=<YOUR_SECRET_ACCESS_KEY>
6262
```
6363

6464
To set these variables on Windows, use `set`:
6565

6666
```bash
67-
set AWS_ACCESS_KEY_ID=<your_access_key_id>
68-
set AWS_SECRET_ACCESS_KEY=<your_secret_access_key>
67+
set AWS_ACCESS_KEY_ID=<YOUR_ACCESS_KEY_ID>
68+
set AWS_SECRET_ACCESS_KEY=<YOUR_SECRET_ACCESS_KEY>
6969
```
7070

71+
Replace the values of `<YOUR_ACCESS_KEY_ID>` and `<YOUR_SECRET_ACCESS_KEY>` by your AWS credentials.
72+
7173
* You need a `.py` file where the code of the Lambda function is located.
7274

7375
You can use the code obtained from the AWS Lambda Function Hello World JSON Java example: [awslambdahellojson](/awslambdahellojson).
@@ -80,17 +82,17 @@ Create an AWS Lambda function using the Client API (low-level) of Boto 3.
8082

8183
* Run the code.
8284

83-
You must provide 4 parameters:
85+
You must provide 4 parameters, replace the values of:
8486

85-
* `<FUNCTION_NAME>` = Lambda function name
86-
* `<FUNCTION_FILE>` = The path to the `.py` file where the code of the Lambda function is located
87-
* `<FUNCTION_ROLE>` = The role ARN that has Lambda permissions
88-
* `<FUNCTION_HANDLER>` = The fully qualifed method name (Ex: lambda_function.lambda_handler)
87+
* `<FUNCTION_NAME>` by Lambda function name.
88+
* `<FUNCTION_FILE>` by path to the `.py` file where the code of the Lambda function is located.
89+
* `<FUNCTION_ROLE>` by role ARN that has Lambda permissions.
90+
* `<FUNCTION_HANDLER>` by fully qualifed method name (Ex: lambda_function.lambda_handler).
8991

9092
Run application:
9193

9294
```bash
93-
python lambdacreate.py lambda-name lambda-file lambda-role lambda-handler
95+
python lambdacreate.py <FUNCTION_NAME> <FUNCTION_FILE> <FUNCTION_ROLE> <FUNCTION_HANDLER>
9496
```
9597

9698
You must use as a function role the ARN.

‎awslambdadelete-capi/README.md

+16-14
Original file line numberDiff line numberDiff line change
@@ -33,41 +33,43 @@ Delete an AWS Lambda function using the Client API (low-level) of Boto 3.
3333

3434
Setting your credentials for use by the AWS SDK for Java can be done in a number of ways, but here are the recommended approaches:
3535

36-
* The default credential profiles file
36+
* The default credential profiles file.
3737

3838
Set credentials in the AWS credentials profile file on your local system, located at:
3939

40-
`~/.aws/credentials` on Linux, macOS, or Unix
40+
* `~/.aws/credentials` on Linux, macOS, or Unix.
4141

42-
`C:\Users\USERNAME\.aws\credentials` on Windows
42+
* `C:\Users\USERNAME\.aws\credentials` on Windows.
4343

4444
This file should contain lines in the following format:
4545

4646
```bash
4747
[default]
48-
aws_access_key_id = <your_access_key_id>
49-
aws_secret_access_key = <your_secret_access_key>
48+
aws_access_key_id = <YOUR_ACCESS_KEY_ID>
49+
aws_secret_access_key = <YOUR_SECRET_ACCESS_KEY>
5050
```
51-
Substitute your own AWS credentials values for the values `<your_access_key_id>` and `<your_secret_access_key>`.
51+
Replace the values of `<YOUR_ACCESS_KEY_ID>` and `<YOUR_SECRET_ACCESS_KEY>` by your AWS credentials.
5252

53-
* Environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`
53+
* Environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`.
5454

5555
Set the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables.
5656

5757
To set these variables on Linux, macOS, or Unix, use `export`:
5858

5959
```bash
60-
export AWS_ACCESS_KEY_ID=<your_access_key_id>
61-
export AWS_SECRET_ACCESS_KEY=<your_secret_access_key>
60+
export AWS_ACCESS_KEY_ID=<YOUR_ACCESS_KEY_ID>
61+
export AWS_SECRET_ACCESS_KEY=<YOUR_SECRET_ACCESS_KEY>
6262
```
6363

6464
To set these variables on Windows, use `set`:
6565

6666
```bash
67-
set AWS_ACCESS_KEY_ID=<your_access_key_id>
68-
set AWS_SECRET_ACCESS_KEY=<your_secret_access_key>
67+
set AWS_ACCESS_KEY_ID=<YOUR_ACCESS_KEY_ID>
68+
set AWS_SECRET_ACCESS_KEY=<YOUR_SECRET_ACCESS_KEY>
6969
```
7070

71+
Replace the values of `<YOUR_ACCESS_KEY_ID>` and `<YOUR_SECRET_ACCESS_KEY>` by your AWS credentials.
72+
7173
* You can create a Lambda function on AWS.
7274

7375
You can use the AWS Lambda Function Hello World JSON Python example: [awslambdahellojson](/awslambdahellojson).
@@ -76,14 +78,14 @@ Delete an AWS Lambda function using the Client API (low-level) of Boto 3.
7678

7779
* Run the code.
7880

79-
You must provide 1 parameter:
81+
You must provide 1 parameter, replace the value of:
8082

81-
* `<FUNCTION_NAME>` = Lambda function name
83+
* `<FUNCTION_NAME>` by Lambda function name.
8284

8385
Run application:
8486

8587
```bash
86-
python lambdadelete.py function-name
88+
python lambdadelete.py <FUNCTION_NAME>
8789
```
8890

8991
You can use as name of the Lambda function 2 name formats:

‎awslambdainvoke-capi/README.md

+16-14
Original file line numberDiff line numberDiff line change
@@ -33,41 +33,43 @@ Invoke an AWS Lambda function using the Client API (low-level) of Boto 3.
3333

3434
Setting your credentials for use by the AWS SDK for Java can be done in a number of ways, but here are the recommended approaches:
3535

36-
* The default credential profiles file
36+
* The default credential profiles file.
3737

3838
Set credentials in the AWS credentials profile file on your local system, located at:
3939

40-
`~/.aws/credentials` on Linux, macOS, or Unix
40+
* `~/.aws/credentials` on Linux, macOS, or Unix.
4141

42-
`C:\Users\USERNAME\.aws\credentials` on Windows
42+
* `C:\Users\USERNAME\.aws\credentials` on Windows.
4343

4444
This file should contain lines in the following format:
4545

4646
```bash
4747
[default]
48-
aws_access_key_id = <your_access_key_id>
49-
aws_secret_access_key = <your_secret_access_key>
48+
aws_access_key_id = <YOUR_ACCESS_KEY_ID>
49+
aws_secret_access_key = <YOUR_SECRET_ACCESS_KEY>
5050
```
51-
Substitute your own AWS credentials values for the values `<your_access_key_id>` and `<your_secret_access_key>`.
51+
Replace the values of `<YOUR_ACCESS_KEY_ID>` and `<YOUR_SECRET_ACCESS_KEY>` by your AWS credentials.
5252

53-
* Environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`
53+
* Environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`.
5454

5555
Set the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables.
5656

5757
To set these variables on Linux, macOS, or Unix, use `export`:
5858

5959
```bash
60-
export AWS_ACCESS_KEY_ID=<your_access_key_id>
61-
export AWS_SECRET_ACCESS_KEY=<your_secret_access_key>
60+
export AWS_ACCESS_KEY_ID=<YOUR_ACCESS_KEY_ID>
61+
export AWS_SECRET_ACCESS_KEY=<YOUR_SECRET_ACCESS_KEY>
6262
```
6363

6464
To set these variables on Windows, use `set`:
6565

6666
```bash
67-
set AWS_ACCESS_KEY_ID=<your_access_key_id>
68-
set AWS_SECRET_ACCESS_KEY=<your_secret_access_key>
67+
set AWS_ACCESS_KEY_ID=<YOUR_ACCESS_KEY_ID>
68+
set AWS_SECRET_ACCESS_KEY=<YOUR_SECRET_ACCESS_KEY>
6969
```
7070

71+
Replace the values of `<YOUR_ACCESS_KEY_ID>` and `<YOUR_SECRET_ACCESS_KEY>` by your AWS credentials.
72+
7173
* You can create a Lambda function on AWS.
7274

7375
You can use the AWS Lambda Function Hello World JSON Python example: [awslambdahellojson](/awslambdahellojson).
@@ -85,14 +87,14 @@ Invoke an AWS Lambda function using the Client API (low-level) of Boto 3.
8587

8688
* Run the code.
8789

88-
You must provide 1 parameter:
90+
You must provide 1 parameter, replace the value of:
8991

90-
* `<FUNCTION_NAME>` = Lambda function name
92+
* `<FUNCTION_NAME>` by the Lambda function name.
9193

9294
Run application:
9395

9496
```bash
95-
python lambdainvoke.py function-name
97+
python lambdainvoke.py <FUNCTION_NAME>
9698
```
9799

98100
You can use as name of the Lambda function 2 name formats:

0 commit comments

Comments
 (0)