@@ -105,16 +105,29 @@ public AWSLambdaClient(ClientConfiguration clientConfiguration) {
105105 * Constructs a new client to invoke service methods on AWSLambda using the
106106 * specified AWS account credentials.
107107 * <p>
108- * If AWS session credentials are passed in, then those credentials will be
109- * used to authenticate requests. Otherwise, if AWS long-term credentials
110- * are passed in, then session management will be handled automatically by
111- * the SDK. Callers are encouraged to use long-term credentials and let the
112- * SDK handle starting and renewing sessions.
113- * <p>
114- * Automatically managed sessions will be shared among all clients that use
115- * the same credentials and service endpoint. To opt out of this behavior,
116- * explicitly provide an instance of {@link AWSCredentialsProvider} that
117- * returns {@link AWSSessionCredentials}.
108+ * The client requests are authenticated using the {@link AWSCredentials}
109+ * provided in this constructor. Static AWSCredentials can be passed for
110+ * quick testing. However, it is strongly recommended to use Amazon Cognito
111+ * vended temporary credentials for use in production. This can be achieved
112+ * by using {@link AWSMobileClient}. Please see
113+ * https://aws-amplify.github.io/docs/android/authentication for
114+ * instructions on how to enable {@link AWSMobileClient}.
115+ *
116+ * <pre>
117+ * {@code
118+ * AWSMobileClient.getInstance.initialize(getApplicationContext(), new Callback<UserStateDetails>() {
119+ * @Override
120+ * public void onResult(final UserStateDetails details) {
121+ * AWSLambdaClient client = new AWSLambdaClient(AWSMobileClient.getInstance());
122+ * }
123+ *
124+ * @Override
125+ * public void onError(final Exception e) {
126+ * e.printStackTrace();
127+ * }
128+ * });
129+ * }
130+ * </pre>
118131 * <p>
119132 * All service calls made using this new client object are blocking, and
120133 * will not return until the service call completes.
@@ -130,16 +143,29 @@ public AWSLambdaClient(AWSCredentials awsCredentials) {
130143 * Constructs a new client to invoke service methods on AWSLambda using the
131144 * specified AWS account credentials and client configuration options.
132145 * <p>
133- * If AWS session credentials are passed in, then those credentials will be
134- * used to authenticate requests. Otherwise, if AWS long-term credentials
135- * are passed in, then session management will be handled automatically by
136- * the SDK. Callers are encouraged to use long-term credentials and let the
137- * SDK handle starting and renewing sessions.
138- * <p>
139- * Automatically managed sessions will be shared among all clients that use
140- * the same credentials and service endpoint. To opt out of this behavior,
141- * explicitly provide an instance of {@link AWSCredentialsProvider} that
142- * returns {@link AWSSessionCredentials}.
146+ * The client requests are authenticated using the {@link AWSCredentials}
147+ * provided in this constructor. Static AWSCredentials can be passed for
148+ * quick testing. However, it is strongly recommended to use Amazon Cognito
149+ * vended temporary credentials for use in production. This can be achieved
150+ * by using {@link AWSMobileClient}. Please see
151+ * https://aws-amplify.github.io/docs/android/authentication for
152+ * instructions on how to enable {@link AWSMobileClient}.
153+ *
154+ * <pre>
155+ * {@code
156+ * AWSMobileClient.getInstance.initialize(getApplicationContext(), new Callback<UserStateDetails>() {
157+ * @Override
158+ * public void onResult(final UserStateDetails details) {
159+ * AWSLambdaClient client = new AWSLambdaClient(AWSMobileClient.getInstance());
160+ * }
161+ *
162+ * @Override
163+ * public void onError(final Exception e) {
164+ * e.printStackTrace();
165+ * }
166+ * });
167+ * }
168+ * </pre>
143169 * <p>
144170 * All service calls made using this new client object are blocking, and
145171 * will not return until the service call completes.
@@ -158,16 +184,29 @@ public AWSLambdaClient(AWSCredentials awsCredentials, ClientConfiguration client
158184 * Constructs a new client to invoke service methods on AWSLambda using the
159185 * specified AWS account credentials provider.
160186 * <p>
161- * If AWS session credentials are passed in, then those credentials will be
162- * used to authenticate requests. Otherwise, if AWS long-term credentials
163- * are passed in, then session management will be handled automatically by
164- * the SDK. Callers are encouraged to use long-term credentials and let the
165- * SDK handle starting and renewing sessions.
166- * <p>
167- * Automatically managed sessions will be shared among all clients that use
168- * the same credentials and service endpoint. To opt out of this behavior,
169- * explicitly provide an instance of {@link AWSCredentialsProvider} that
170- * returns {@link AWSSessionCredentials}.
187+ * The client requests are authenticated using the {@link AWSCredentials}
188+ * provided by the {@link AWSCredentialsProvider}. Static AWSCredentials can
189+ * be passed for quick testing. However, it is strongly recommended to use
190+ * Amazon Cognito vended temporary credentials for use in production. This
191+ * can be achieved by using {@link AWSMobileClient}. Please see
192+ * https://aws-amplify.github.io/docs/android/authentication for
193+ * instructions on how to enable {@link AWSMobileClient}.
194+ *
195+ * <pre>
196+ * {@code
197+ * AWSMobileClient.getInstance.initialize(getApplicationContext(), new Callback<UserStateDetails>() {
198+ * @Override
199+ * public void onResult(final UserStateDetails details) {
200+ * AWSLambdaClient client = new AWSLambdaClient(AWSMobileClient.getInstance());
201+ * }
202+ *
203+ * @Override
204+ * public void onError(final Exception e) {
205+ * e.printStackTrace();
206+ * }
207+ * });
208+ * }
209+ * </pre>
171210 * <p>
172211 * All service calls made using this new client object are blocking, and
173212 * will not return until the service call completes.
@@ -185,16 +224,29 @@ public AWSLambdaClient(AWSCredentialsProvider awsCredentialsProvider) {
185224 * specified AWS account credentials provider and client configuration
186225 * options.
187226 * <p>
188- * If AWS session credentials are passed in, then those credentials will be
189- * used to authenticate requests. Otherwise, if AWS long-term credentials
190- * are passed in, then session management will be handled automatically by
191- * the SDK. Callers are encouraged to use long-term credentials and let the
192- * SDK handle starting and renewing sessions.
193- * <p>
194- * Automatically managed sessions will be shared among all clients that use
195- * the same credentials and service endpoint. To opt out of this behavior,
196- * explicitly provide an instance of {@link AWSCredentialsProvider} that
197- * returns {@link AWSSessionCredentials}.
227+ * The client requests are authenticated using the {@link AWSCredentials}
228+ * provided by the {@link AWSCredentialsProvider}. Static AWSCredentials can
229+ * be passed for quick testing. However, it is strongly recommended to use
230+ * Amazon Cognito vended temporary credentials for use in production. This
231+ * can be achieved by using {@link AWSMobileClient}. Please see
232+ * https://aws-amplify.github.io/docs/android/authentication for
233+ * instructions on how to enable {@link AWSMobileClient}.
234+ *
235+ * <pre>
236+ * {@code
237+ * AWSMobileClient.getInstance.initialize(getApplicationContext(), new Callback<UserStateDetails>() {
238+ * @Override
239+ * public void onResult(final UserStateDetails details) {
240+ * AWSLambdaClient client = new AWSLambdaClient(AWSMobileClient.getInstance());
241+ * }
242+ *
243+ * @Override
244+ * public void onError(final Exception e) {
245+ * e.printStackTrace();
246+ * }
247+ * });
248+ * }
249+ * </pre>
198250 * <p>
199251 * All service calls made using this new client object are blocking, and
200252 * will not return until the service call completes.
@@ -243,6 +295,30 @@ public AWSLambdaClient(AWSCredentialsProvider awsCredentialsProvider,
243295 * specified AWS account credentials provider, client configuration options
244296 * and request metric collector.
245297 * <p>
298+ * The client requests are authenticated using the {@link AWSCredentials}
299+ * provided by the {@link AWSCredentialsProvider}. Static AWSCredentials can
300+ * be passed for quick testing. However, it is strongly recommended to use
301+ * Amazon Cognito vended temporary credentials for use in production. This
302+ * can be achieved by using {@link AWSMobileClient}. Please see
303+ * https://aws-amplify.github.io/docs/android/authentication for
304+ * instructions on how to enable {@link AWSMobileClient}.
305+ *
306+ * <pre>
307+ * {@code
308+ * AWSMobileClient.getInstance.initialize(getApplicationContext(), new Callback<UserStateDetails>() {
309+ * @Override
310+ * public void onResult(final UserStateDetails details) {
311+ * AWSLambdaClient client = new AWSLambdaClient(AWSMobileClient.getInstance());
312+ * }
313+ *
314+ * @Override
315+ * public void onError(final Exception e) {
316+ * e.printStackTrace();
317+ * }
318+ * });
319+ * }
320+ * </pre>
321+ * <p>
246322 * All service calls made using this new client object are blocking, and
247323 * will not return until the service call completes.
248324 *
0 commit comments