@@ -96,16 +96,29 @@ public AmazonTranscribeClient(ClientConfiguration clientConfiguration) {
9696 * Constructs a new client to invoke service methods on AmazonTranscribe
9797 * using the specified AWS account credentials.
9898 * <p>
99- * If AWS session credentials are passed in, then those credentials will be
100- * used to authenticate requests. Otherwise, if AWS long-term credentials
101- * are passed in, then session management will be handled automatically by
102- * the SDK. Callers are encouraged to use long-term credentials and let the
103- * SDK handle starting and renewing sessions.
104- * <p>
105- * Automatically managed sessions will be shared among all clients that use
106- * the same credentials and service endpoint. To opt out of this behavior,
107- * explicitly provide an instance of {@link AWSCredentialsProvider} that
108- * returns {@link AWSSessionCredentials}.
99+ * The client requests are authenticated using the {@link AWSCredentials}
100+ * provided in this constructor. Static AWSCredentials can be passed for
101+ * quick testing. However, it is strongly recommended to use Amazon Cognito
102+ * vended temporary credentials for use in production. This can be achieved
103+ * by using {@link AWSMobileClient}. Please see
104+ * https://aws-amplify.github.io/docs/android/authentication for
105+ * instructions on how to enable {@link AWSMobileClient}.
106+ *
107+ * <pre>
108+ * {@code
109+ * AWSMobileClient.getInstance.initialize(getApplicationContext(), new Callback<UserStateDetails>() {
110+ * @Override
111+ * public void onResult(final UserStateDetails details) {
112+ * AmazonTranscribeClient client = new AmazonTranscribeClient(AWSMobileClient.getInstance());
113+ * }
114+ *
115+ * @Override
116+ * public void onError(final Exception e) {
117+ * e.printStackTrace();
118+ * }
119+ * });
120+ * }
121+ * </pre>
109122 * <p>
110123 * All service calls made using this new client object are blocking, and
111124 * will not return until the service call completes.
@@ -122,16 +135,29 @@ public AmazonTranscribeClient(AWSCredentials awsCredentials) {
122135 * using the specified AWS account credentials and client configuration
123136 * options.
124137 * <p>
125- * If AWS session credentials are passed in, then those credentials will be
126- * used to authenticate requests. Otherwise, if AWS long-term credentials
127- * are passed in, then session management will be handled automatically by
128- * the SDK. Callers are encouraged to use long-term credentials and let the
129- * SDK handle starting and renewing sessions.
130- * <p>
131- * Automatically managed sessions will be shared among all clients that use
132- * the same credentials and service endpoint. To opt out of this behavior,
133- * explicitly provide an instance of {@link AWSCredentialsProvider} that
134- * returns {@link AWSSessionCredentials}.
138+ * The client requests are authenticated using the {@link AWSCredentials}
139+ * provided in this constructor. Static AWSCredentials can be passed for
140+ * quick testing. However, it is strongly recommended to use Amazon Cognito
141+ * vended temporary credentials for use in production. This can be achieved
142+ * by using {@link AWSMobileClient}. Please see
143+ * https://aws-amplify.github.io/docs/android/authentication for
144+ * instructions on how to enable {@link AWSMobileClient}.
145+ *
146+ * <pre>
147+ * {@code
148+ * AWSMobileClient.getInstance.initialize(getApplicationContext(), new Callback<UserStateDetails>() {
149+ * @Override
150+ * public void onResult(final UserStateDetails details) {
151+ * AmazonTranscribeClient client = new AmazonTranscribeClient(AWSMobileClient.getInstance());
152+ * }
153+ *
154+ * @Override
155+ * public void onError(final Exception e) {
156+ * e.printStackTrace();
157+ * }
158+ * });
159+ * }
160+ * </pre>
135161 * <p>
136162 * All service calls made using this new client object are blocking, and
137163 * will not return until the service call completes.
@@ -151,16 +177,29 @@ public AmazonTranscribeClient(AWSCredentials awsCredentials,
151177 * Constructs a new client to invoke service methods on AmazonTranscribe
152178 * using the specified AWS account credentials provider.
153179 * <p>
154- * If AWS session credentials are passed in, then those credentials will be
155- * used to authenticate requests. Otherwise, if AWS long-term credentials
156- * are passed in, then session management will be handled automatically by
157- * the SDK. Callers are encouraged to use long-term credentials and let the
158- * SDK handle starting and renewing sessions.
159- * <p>
160- * Automatically managed sessions will be shared among all clients that use
161- * the same credentials and service endpoint. To opt out of this behavior,
162- * explicitly provide an instance of {@link AWSCredentialsProvider} that
163- * returns {@link AWSSessionCredentials}.
180+ * The client requests are authenticated using the {@link AWSCredentials}
181+ * provided by the {@link AWSCredentialsProvider}. Static AWSCredentials can
182+ * be passed for quick testing. However, it is strongly recommended to use
183+ * Amazon Cognito vended temporary credentials for use in production. This
184+ * can be achieved by using {@link AWSMobileClient}. Please see
185+ * https://aws-amplify.github.io/docs/android/authentication for
186+ * instructions on how to enable {@link AWSMobileClient}.
187+ *
188+ * <pre>
189+ * {@code
190+ * AWSMobileClient.getInstance.initialize(getApplicationContext(), new Callback<UserStateDetails>() {
191+ * @Override
192+ * public void onResult(final UserStateDetails details) {
193+ * AmazonTranscribeClient client = new AmazonTranscribeClient(AWSMobileClient.getInstance());
194+ * }
195+ *
196+ * @Override
197+ * public void onError(final Exception e) {
198+ * e.printStackTrace();
199+ * }
200+ * });
201+ * }
202+ * </pre>
164203 * <p>
165204 * All service calls made using this new client object are blocking, and
166205 * will not return until the service call completes.
@@ -178,16 +217,29 @@ public AmazonTranscribeClient(AWSCredentialsProvider awsCredentialsProvider) {
178217 * using the specified AWS account credentials provider and client
179218 * configuration options.
180219 * <p>
181- * If AWS session credentials are passed in, then those credentials will be
182- * used to authenticate requests. Otherwise, if AWS long-term credentials
183- * are passed in, then session management will be handled automatically by
184- * the SDK. Callers are encouraged to use long-term credentials and let the
185- * SDK handle starting and renewing sessions.
186- * <p>
187- * Automatically managed sessions will be shared among all clients that use
188- * the same credentials and service endpoint. To opt out of this behavior,
189- * explicitly provide an instance of {@link AWSCredentialsProvider} that
190- * returns {@link AWSSessionCredentials}.
220+ * The client requests are authenticated using the {@link AWSCredentials}
221+ * provided by the {@link AWSCredentialsProvider}. Static AWSCredentials can
222+ * be passed for quick testing. However, it is strongly recommended to use
223+ * Amazon Cognito vended temporary credentials for use in production. This
224+ * can be achieved by using {@link AWSMobileClient}. Please see
225+ * https://aws-amplify.github.io/docs/android/authentication for
226+ * instructions on how to enable {@link AWSMobileClient}.
227+ *
228+ * <pre>
229+ * {@code
230+ * AWSMobileClient.getInstance.initialize(getApplicationContext(), new Callback<UserStateDetails>() {
231+ * @Override
232+ * public void onResult(final UserStateDetails details) {
233+ * AmazonTranscribeClient client = new AmazonTranscribeClient(AWSMobileClient.getInstance());
234+ * }
235+ *
236+ * @Override
237+ * public void onError(final Exception e) {
238+ * e.printStackTrace();
239+ * }
240+ * });
241+ * }
242+ * </pre>
191243 * <p>
192244 * All service calls made using this new client object are blocking, and
193245 * will not return until the service call completes.
@@ -236,6 +288,30 @@ public AmazonTranscribeClient(AWSCredentialsProvider awsCredentialsProvider,
236288 * using the specified AWS account credentials provider, client
237289 * configuration options and request metric collector.
238290 * <p>
291+ * The client requests are authenticated using the {@link AWSCredentials}
292+ * provided by the {@link AWSCredentialsProvider}. Static AWSCredentials can
293+ * be passed for quick testing. However, it is strongly recommended to use
294+ * Amazon Cognito vended temporary credentials for use in production. This
295+ * can be achieved by using {@link AWSMobileClient}. Please see
296+ * https://aws-amplify.github.io/docs/android/authentication for
297+ * instructions on how to enable {@link AWSMobileClient}.
298+ *
299+ * <pre>
300+ * {@code
301+ * AWSMobileClient.getInstance.initialize(getApplicationContext(), new Callback<UserStateDetails>() {
302+ * @Override
303+ * public void onResult(final UserStateDetails details) {
304+ * AmazonTranscribeClient client = new AmazonTranscribeClient(AWSMobileClient.getInstance());
305+ * }
306+ *
307+ * @Override
308+ * public void onError(final Exception e) {
309+ * e.printStackTrace();
310+ * }
311+ * });
312+ * }
313+ * </pre>
314+ * <p>
239315 * All service calls made using this new client object are blocking, and
240316 * will not return until the service call completes.
241317 *
0 commit comments