Skip to content

Commit 203c428

Browse files
authoredDec 1, 2023
add custom client documentation (aws#2764)
1 parent 916ccdb commit 203c428

File tree

1 file changed

+21
-7
lines changed

1 file changed

+21
-7
lines changed
 

‎docs/Advanced_topics.md

+21-7
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Advance Topics and tips
22

33
__This section includes the following topics:__
4-
* [Uninstalling (auto build only)](#Uninstalling)
5-
* [Overriding Your HTTP Client](#Overriding-your-Http-Client)
6-
* [Error Handling](#Error-Handling)
4+
* [Uninstalling (auto build only)](#uninstalling)
5+
* [Overriding Your HTTP Client](#overriding-your-http-client)
6+
* [Error Handling](#error-handling)
77
* [Provided Utilities](#provided-utilities)
8-
* [Controlling IOStreams used by the HttpClient and the AWSClient](#Controlling-IOStreams-used-by-the-HttpClient-and-the-AWSClient)
9-
* [Known Limitations](#Known-Limitations)
10-
8+
* [Controlling IOStreams used by the HttpClient and the AWSClient](#controlling-iostreams-used-by-the-httpclient-and-the-awsclient)
9+
* [Known Limitations](#known-limitations)
10+
* [Generating custom clients](#generating-custom-clients)
1111

1212

1313
### Uninstalling:
@@ -127,4 +127,18 @@ auto getObjectOutcome = s3Client->GetObject(getObjectRequest);
127127
128128
#### Aws::StringStream max size
129129
130-
[`Aws::StringStream`](https://github.com/aws/aws-sdk-cpp/blob/main/aws-cpp-sdk-core/include/aws/core/utils/memory/stl/AWSStringStream.h) is an alias to [`std::basic_stringstream`](https://en.cppreference.com/w/cpp/io/basic_stringstream) which effectively stores an instance of std::basic_string and performs the input and output operations on it. That being known the max size limitation of a string stream is the maximum size for a string in that toolchain [`std::basic_string::max_size`](https://en.cppreference.com/w/cpp/string/basic_string/max_size).
130+
[`Aws::StringStream`](https://github.com/aws/aws-sdk-cpp/blob/main/aws-cpp-sdk-core/include/aws/core/utils/memory/stl/AWSStringStream.h) is an alias to [`std::basic_stringstream`](https://en.cppreference.com/w/cpp/io/basic_stringstream) which effectively stores an instance of std::basic_string and performs the input and output operations on it. That being known the max size limitation of a string stream is the maximum size for a string in that toolchain [`std::basic_string::max_size`](https://en.cppreference.com/w/cpp/string/basic_string/max_size).
131+
132+
### Generating Custom Clients
133+
#### Requirements
134+
python3, jdk (1.8+), maven
135+
#### Steps
136+
Place your new model files in the correct folders:
137+
- c2j model (looks like this: `mycustomservice-2020-08-01.normal.json`)
138+
- In this path: `aws-sdk-cpp/tools/code-generation/api-descriptions`
139+
- endpoints models (looks like this: `mycustomservice-2020-08-01.endpoint-tests.json mycustomservice-2020-08-01.endpoint-rule-set.json ect.`)
140+
- In this path: `aws-sdk-cpp/tools/code-generation/endpoints`
141+
Run code generation
142+
```sh
143+
$ python3 tools/scripts/run_code_generation.py --client_list mycustomservice
144+
```

0 commit comments

Comments
 (0)
Please sign in to comment.