Skip to content
This repository was archived by the owner on Jun 15, 2023. It is now read-only.

Commit bd00e96

Browse files
SCalwasSCalwas
committed
Add snippet IDs to code samples. Update copyright year.
1 parent 9fa91a8 commit bd00e96

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+354
-518
lines changed

‎LICENSE-SAMPLECODE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
1+
Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
22

33
Permission is hereby granted, free of charge, to any person obtaining a copy of this
44
software and associated documentation files (the "Software"), to deal in the Software

‎LICENSE-SUMMARY

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
1+
Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
22

33
The documentation is made available under the Creative Commons Attribution-ShareAlike 4.0 International License. See the LICENSE file.
44

‎Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# -*- coding: utf-8 -*-
22
#
3-
# Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
3+
# Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
44
#
55
# This file is licensed under the Apache License, Version 2.0 (the "License").
66
# You may not use this file except in compliance with the License. A copy of the

‎README.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
1+
.. Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
22
33
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0
44
International License (the "License"). You may not use this file except in compliance with the

‎doc_source/_includes.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
1+
.. Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
22

33
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0
44
International License (the "License"). You may not use this file except in compliance with the

‎doc_source/build-cmake.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
1+
.. Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
22
33
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0
44
International License (the "License"). You may not use this file except in compliance with the

‎doc_source/client-config.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
1+
.. Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
22
33
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0
44
International License (the "License"). You may not use this file except in compliance with the

‎doc_source/conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# -*- coding: utf-8 -*-
22
#
3-
# Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
3+
# Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
44
#
55
# Licensed under the Apache License, Version 2.0 (the "License"). You may not
66
# use this file except in compliance with the License. A copy of the License

‎doc_source/configuring-iostreams.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
1+
.. Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
22
33
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0
44
International License (the "License"). You may not use this file except in compliance with the

‎doc_source/configuring.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
1+
.. Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
22
33
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0
44
International License (the "License"). You may not use this file except in compliance with the

‎doc_source/credentials.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
1+
.. Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
22
33
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0
44
International License (the "License"). You may not use this file except in compliance with the

‎doc_source/document-history.rst

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
1+
.. Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
22
33
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0
44
International License (the "License"). You may not use this file except in compliance with the
@@ -13,8 +13,7 @@ Document History for the |sdk-cpp-dg|
1313
#####################################
1414

1515
.. meta::
16-
:description:
17-
AWS SDK for C++ Developer Guide documentation update history.
16+
:description: AWS SDK for C++ Developer Guide documentation update history.
1817
:keywords:
1918

2019
This topic lists major changes to the *AWS SDK for C++ Developer Guide* over the course of its

‎doc_source/error-handling.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
1+
.. Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
22
33
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0
44
International License (the "License"). You may not use this file except in compliance with the

‎doc_source/examples-dynamodb-items.rst

+10-16
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ Rules and Data Types <HowItWorks.NamingRulesDataTypes>` in the |ddb-dg|.
2323

2424
.. _dynamodb-get-item:
2525

26-
Retrieve (Get) an Item from a Table
27-
===================================
26+
Retrieve an Item from a Table
27+
=============================
2828

2929
Call the :aws-cpp-class:`DynamoDB client <aws_1_1_dynamo_d_b_1_1_dynamo_d_b_client>` :methodname:`GetItem`
3030
method. Pass it a :aws-cpp-class:`GetItemRequest <aws_1_1_dynamo_d_b_1_1_model_1_1_get_item_request>`
@@ -38,21 +38,19 @@ pairs associated with the item.
3838

3939
**Includes**
4040

41-
.. literalinclude:: example_code/dynamodb/get_item.cpp
42-
:lines: 14-19
41+
.. literalinclude:: dynamodb.cpp.get_item.inc.txt
4342

4443
**Code**
4544

46-
.. literalinclude:: example_code/dynamodb/get_item.cpp
47-
:lines: 62-94
45+
.. literalinclude:: dynamodb.cpp.get_item.code.txt
4846
:dedent: 8
4947

5048
See the :sdk-examples-cpp:`complete example <dynamodb/get_item.cpp>` on GitHub.
5149

5250
.. _dynamodb-add-item:
5351

54-
Add a New Item to a Table
55-
=========================
52+
Add an Item to a Table
53+
======================
5654

5755
Create key :classname:`Aws::String` and
5856
value :aws-cpp-class:`AttributeValue <aws_1_1_dynamo_d_b_1_1_model_1_1_attribute_value>` pairs that
@@ -63,13 +61,11 @@ the :methodname:`AddItem` method.
6361

6462
**Includes**
6563

66-
.. literalinclude:: example_code/dynamodb/put_item.cpp
67-
:lines: 14-20
64+
.. literalinclude:: dynamodb.cpp.put_item.inc.txt
6865

6966
**Code**
7067

71-
.. literalinclude:: example_code/dynamodb/put_item.cpp
72-
:lines: 59-92
68+
.. literalinclude:: dynamodb.cpp.put_item.code.txt
7369
:dedent: 8
7470

7571
See the :sdk-examples-cpp:`complete example <dynamodb/put_item.cpp>` on GitHub.
@@ -86,13 +82,11 @@ update and their corresponding value.
8682

8783
**Imports**
8884

89-
.. literalinclude:: example_code/dynamodb/update_item.cpp
90-
:lines: 14-19
85+
.. literalinclude:: dynamodb.cpp.update_item.inc.txt
9186

9287
**Code**
9388

94-
.. literalinclude:: example_code/dynamodb/update_item.cpp
95-
:lines: 61-96
89+
.. literalinclude:: dynamodb.cpp.update_item.code.txt
9690
:dedent: 8
9791

9892
See the :sdk-examples-cpp:`complete example <dynamodb/update_item.cpp>`.

‎doc_source/examples-dynamodb-tables.rst

+17-29
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
1+
.. Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
22
33
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0
44
International License (the "License"). You may not use this file except in compliance with the
@@ -65,13 +65,11 @@ This code creates a table with a simple primary key ("Name").
6565

6666
**Includes**
6767

68-
.. literalinclude:: example_code/dynamodb/create_table.cpp
69-
:lines: 14-22
68+
.. literalinclude:: dynamodb.cpp.create_table.inc.txt
7069

7170
**Code**
7271

73-
.. literalinclude:: example_code/dynamodb/create_table.cpp
74-
:lines: 52, 55, 60-86
72+
.. literalinclude:: dynamodb.cpp.create_table.code.txt
7573
:dedent: 8
7674

7775
See the :sdk-examples-cpp:`complete example <dynamodb/create_table.cpp>`.
@@ -88,13 +86,11 @@ Add another
8886

8987
**Includes**
9088

91-
.. literalinclude:: example_code/dynamodb/create_table_composite_key.cpp
92-
:lines: 14-22
89+
.. literalinclude:: dynamodb.cpp.create_table_composite_key.inc.txt
9390

9491
**Code**
9592

96-
.. literalinclude:: example_code/dynamodb/create_table_composite_key.cpp
97-
:lines: 59,62, 69-98
93+
.. literalinclude:: dynamodb.cpp.create_table_composite_key.code.txt
9894
:dedent: 8
9995

10096
See the :sdk-examples-cpp:`complete example <dynamodb/create_table_composite_key.cpp>` on GitHub.
@@ -109,13 +105,11 @@ You can list the tables in a particular region by calling the :aws-cpp-class:`Dy
109105

110106
**Includes**
111107

112-
.. literalinclude:: example_code/dynamodb/list_tables.cpp
113-
:lines: 14-19
108+
.. literalinclude:: dynamodb.cpp.list_tables.inc.txt
114109

115110
**Code**
116111

117-
.. literalinclude:: example_code/dynamodb/list_tables.cpp
118-
:lines: 36-52
112+
.. literalinclude:: dynamodb.cpp.list_tables.code.txt
119113
:dedent: 8
120114

121115
By default, up to 100 tables are returned per call. Use
@@ -127,43 +121,39 @@ See the :sdk-examples-cpp:`complete example <dynamodb/list_tables.cpp>`.
127121

128122
.. _dynamodb-describe-table:
129123

130-
Describe (Get Information about) a Table
131-
========================================
124+
Retrieve Information about a Table
125+
==================================
132126

133127
You can find out more about a table by calling the :aws-cpp-class:`DynamoDB client
134128
<aws_1_1_dynamo_d_b_1_1_dynamo_d_b_client>` :methodname:`DescribeTable` method.
135129

136130
**Includes**
137131

138-
.. literalinclude:: example_code/dynamodb/describe_table.cpp
139-
:lines: 14-18
132+
.. literalinclude:: dynamodb.cpp.describe_table.inc.txt
140133

141134
**Code**
142135

143-
.. literalinclude:: example_code/dynamodb/describe_table.cpp
144-
:lines: 53, 56-87
136+
.. literalinclude:: dynamodb.cpp.describe_table.code.txt
145137
:dedent: 8
146138

147139
See the :sdk-examples-cpp:`complete example <dynamodb/describe_table.cpp>` on GitHub.
148140

149141
.. _dynamodb-update-table:
150142

151-
Modify (Update) a Table
152-
=======================
143+
Modify a Table
144+
==============
153145

154146
You can modify your table's provisioned throughput values at any time by calling the
155147
:aws-cpp-class:`DynamoDB client <aws_1_1_dynamo_d_b_1_1_dynamo_d_b_client>`
156148
:methodname:`UpdateTable` method.
157149

158150
**Includes**
159151

160-
.. literalinclude:: example_code/dynamodb/update_table.cpp
161-
:lines: 14-19
152+
.. literalinclude:: dynamodb.cpp.update_table.inc.txt
162153

163154
**Code**
164155

165-
.. literalinclude:: example_code/dynamodb/update_table.cpp
166-
:lines: 56-74
156+
.. literalinclude:: dynamodb.cpp.update_table.code.txt
167157
:dedent: 8
168158

169159
See the :sdk-examples-cpp:`complete example <dynamodb/update_table.cpp>`.
@@ -178,13 +168,11 @@ Call the :aws-cpp-class:`DynamoDB client <aws_1_1_dynamo_d_b_1_1_dynamo_d_b_clie
178168

179169
**Includes**
180170

181-
.. literalinclude:: example_code/dynamodb/delete_table.cpp
182-
:lines: 14-18
171+
.. literalinclude:: dynamodb.cpp.delete_table.inc.txt
183172

184173
**Code**
185174

186-
.. literalinclude:: example_code/dynamodb/delete_table.cpp
187-
:lines: 55-72
175+
.. literalinclude:: dynamodb.cpp.delete_table.code.txt
188176
:dedent: 8
189177

190178
See the :sdk-examples-cpp:`complete example <dynamodb/delete_table.cpp>` on GitHub.

‎doc_source/examples-dynamodb.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
1+
.. Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
22
33
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0
44
International License (the "License"). You may not use this file except in compliance with the

‎doc_source/examples-ec2-elastic-ip.rst

+15-23
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
1+
.. Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
22
33
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0
44
International License (the "License"). You may not use this file except in compliance with the
@@ -13,15 +13,13 @@ Using Elastic IP Addresses in |EC2|
1313
###################################
1414

1515
.. meta::
16-
:description: How to allocate, use, list, and release Elastic IP addresses for EC2 instances with
17-
the AWS SDK for C++.
18-
:keywords: AWS SDK for C++, code examples, EC2, Elastic IP, allocate address, release address,
19-
assign address, associate address, list addresses
16+
:description: How to manage Elastic IP addresses for EC2 instances with the AWS SDK for C++.
17+
:keywords: ec2
2018

2119
.. include:: includes/examples-note.txt
2220

23-
Allocating an Elastic IP Address
24-
================================
21+
Allocate an Elastic IP Address
22+
==============================
2523

2624
To use an Elastic IP address, you first allocate one to your account, and then associate it with
2725
your instance or a network interface.
@@ -39,20 +37,18 @@ the |ec2client|'s :functionname:`AssociateAddress` function.
3937

4038
**Includes**
4139

42-
.. literalinclude:: example_code/ec2/allocate_address.cpp
43-
:lines: 14-20
40+
.. literalinclude:: ec2.cpp.allocate_address.inc.txt
4441

4542
**Code**
4643

47-
.. literalinclude:: example_code/ec2/allocate_address.cpp
48-
:lines: 24-53
44+
.. literalinclude:: ec2.cpp.allocate_address.code.txt
4945
:dedent: 4
5046

5147
See the :sdk-examples-cpp:`complete example <ec2/allocate_address.cpp>`.
5248

5349

54-
Describing Elastic IP Addresses
55-
===============================
50+
Describe Elastic IP Addresses
51+
=============================
5652

5753
To list the Elastic IP addresses assigned to your account, call the |ec2client|'s
5854
:functionname:`DescribeAddresses` function. It returns an outcome object that contains a
@@ -62,20 +58,18 @@ objects that represent the Elastic IP addresses on your account.
6258

6359
**Includes**
6460

65-
.. literalinclude:: example_code/ec2/describe_addresses.cpp
66-
:lines: 14-19
61+
.. literalinclude:: ec2.cpp.describe_addresses.inc.txt
6762

6863
**Code**
6964

70-
.. literalinclude:: example_code/ec2/describe_addresses.cpp
71-
:lines: 29-57
65+
.. literalinclude:: ec2.cpp.describe_addresses.code.txt
7266
:dedent: 8
7367

7468
See the :sdk-examples-cpp:`complete example <ec2/describe_addresses.cpp>`.
7569

7670

77-
Releasing an Elastic IP Address
78-
===============================
71+
Release an Elastic IP Address
72+
=============================
7973

8074
To release an Elastic IP address, call the |ec2client|'s :functionname:`ReleaseAddress` function,
8175
passing it a :aws-cpp-class:`ReleaseAddressRequest
@@ -84,13 +78,11 @@ address you want to release.
8478

8579
**Includes**
8680

87-
.. literalinclude:: example_code/ec2/release_address.cpp
88-
:lines: 14-17
81+
.. literalinclude:: ec2.cpp.release_address.inc.txt
8982

9083
**Code**
9184

92-
.. literalinclude:: example_code/ec2/release_address.cpp
93-
:lines: 35-54
85+
.. literalinclude:: ec2.cpp.release_address.code.txt
9486
:dedent: 8
9587

9688
After you release an Elastic IP address, it is released to the AWS IP address pool and might be

0 commit comments

Comments
 (0)