AWS lexv2 documentation change
Summary
Updated account setup documentation with streamlined instructions, added troubleshooting guidance for common issues, and restructured programmatic access content. Removed detailed IAM programmatic access tables and added developer environment setup notes.
Security assessment
The changes emphasize IAM user permissions (e.g., 'administrator permissions are recommended'), warn against root console access, and link to security sections. However, there's no explicit evidence of addressing a specific security vulnerability. The removal of warnings about root user access and long-term credentials reduces security emphasis, but new troubleshooting guidance adds some security context.
Diff
diff --git a/lexv2/latest/dg/gs-account.md b/lexv2/latest/dg/gs-account.md index b07f129b3..0967a5388 100644 --- a//lexv2/latest/dg/gs-account.md +++ b//lexv2/latest/dg/gs-account.md @@ -30,7 +30 @@ If you already have an AWS account, skip to the next task. If you don't have an - 1. Open [https://portal.aws.amazon.com/billing/signup](https://portal.aws.amazon.com/billing/signup). - - 2. Follow the online instructions. - -Part of the sign-up procedure involves receiving a phone call or text message and entering a verification code on the phone keypad. - -When you sign up for an AWS account, an _AWS account root user_ is created. The root user has access to all AWS services and resources in the account. As a security best practice, assign administrative access to a user, and use only the root user to perform [tasks that require root user access](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_root-user.html#root-user-tasks). + * To create an AWS account, see [How do I create and activate a new AWS account?](https://portal.aws.amazon.com/gp/aws/developer/registration/index.html) in the AWS Knowledge Center. @@ -47 +41 @@ Services in AWS, such as Amazon Lex V2, require that you provide credentials whe -Create an IAM user account to access your account for Amazon Lex V2: +Create an IAM user account to access your account for Amazon Lex V2. For comprehensive guidance on IAM user creation, see [Getting started with IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/getting-started.html) in the _IAM User Guide_. @@ -71 +65 @@ The Getting Started exercises in this guide assume that you have a user (`adminu -For more information about IAM, see the following: +For more information about IAM, see the [IAM User Guide](https://docs.aws.amazon.com/IAM/latest/UserGuide/). @@ -73 +67 @@ For more information about IAM, see the following: - * [AWS Identity and Access Management (IAM)](https://aws.amazon.com/iam/) +### Common Setup Issues @@ -75 +69 @@ For more information about IAM, see the following: - * [Getting started with IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/getting-started.html) +If you encounter issues during account setup, here are common solutions: @@ -77 +71 @@ For more information about IAM, see the following: - * [IAM User Guide](https://docs.aws.amazon.com/IAM/latest/UserGuide/) + * **Permission Denied Errors** – Ensure your IAM user has the necessary Amazon Lex V2 permissions. For getting started, administrator permissions are recommended. For detailed information about Amazon Lex V2 permissions, see the Security section in this guide. @@ -78,0 +73 @@ For more information about IAM, see the following: + * **Console Access Issues** – Make sure you're signing in with the correct IAM user URL for your account, not the root AWS console. For more information about IAM best practices, see the Security section in this guide. @@ -79,0 +75 @@ For more information about IAM, see the following: + * **Region Availability** – Amazon Lex V2 is not available in all AWS regions. Check the [Amazon Lex endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/lex.html) to confirm availability in your preferred region. For information about supported locales, see [Languages and locales supported by Amazon Lex V2](./how-languages.html). @@ -80,0 +77 @@ For more information about IAM, see the following: + * **Free Tier Limits** – Monitor your usage to stay within free tier limits: 10,000 text requests and 5,000 speech requests per month. For detailed pricing information, see [Amazon Lex Pricing](https://aws.amazon.com/lex/pricing/). @@ -82,3 +79 @@ For more information about IAM, see the following: -## Grant programmatic access - -Users need programmatic access if they want to interact with AWS outside of the AWS Management Console. The way to grant programmatic access depends on the type of user that's accessing AWS. + * **Quota Limits** – If you encounter service limits, review the current quotas and request increases if needed. For more information, see [Guidelines and best practices](./quotas.html). @@ -86 +80,0 @@ Users need programmatic access if they want to interact with AWS outside of the -To grant users programmatic access, choose one of the following options. @@ -88,3 +81,0 @@ To grant users programmatic access, choose one of the following options. -Which user needs programmatic access? | To | By ----|---|--- -Workforce identity (Users managed in IAM Identity Center) | Use temporary credentials to sign programmatic requests to the AWS CLI, AWS SDKs, or AWS APIs. | Following the instructions for the interface that you want to use. @@ -92,2 +82,0 @@ Workforce identity (Users managed in IAM Identity Center) | Use temporary creden - * For the AWS CLI, see [Configuring the AWS CLI to use AWS IAM Identity Center](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-sso.html) in the _AWS Command Line Interface User Guide_. - * For AWS SDKs, tools, and AWS APIs, see [IAM Identity Center authentication](https://docs.aws.amazon.com/sdkref/latest/guide/access-sso.html) in the _AWS SDKs and Tools Reference Guide_. @@ -94,0 +84 @@ Workforce identity (Users managed in IAM Identity Center) | Use temporary creden +For additional troubleshooting help, see the Monitoring section in this guide for information about error logs and debugging. @@ -96,2 +86 @@ Workforce identity (Users managed in IAM Identity Center) | Use temporary creden -IAM | Use temporary credentials to sign programmatic requests to the AWS CLI, AWS SDKs, or AWS APIs. | Following the instructions in [Using temporary credentials with AWS resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html) in the _IAM User Guide_. -IAM | (Not recommended)Use long-term credentials to sign programmatic requests to the AWS CLI, AWS SDKs, or AWS APIs. | Following the instructions for the interface that you want to use. +## Grant programmatic access @@ -99,3 +88 @@ IAM | (Not recommended)Use long-term credentials to sign programmatic requests t - * For the AWS CLI, see [Authenticating using IAM user credentials](https://docs.aws.amazon.com/cli/latest/userguide/cli-authentication-user.html) in the _AWS Command Line Interface User Guide_. - * For AWS SDKs and tools, see [Authenticate using long-term credentials](https://docs.aws.amazon.com/sdkref/latest/guide/access-iam-users.html) in the _AWS SDKs and Tools Reference Guide_. - * For AWS APIs, see [Managing access keys for IAM users](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) in the _IAM User Guide_. +For information about how to get your access key ID and secret access key, see [Understanding and getting your AWS credentials](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys) in the AWS General Reference. @@ -102,0 +90 @@ IAM | (Not recommended)Use long-term credentials to sign programmatic requests t +### Developer Environment Setup @@ -103,0 +92 @@ IAM | (Not recommended)Use long-term credentials to sign programmatic requests t +**For Developers:** If you plan to use the AWS CLI or SDKs, you'll also want to configure your development environment. Install the AWS CLI and configure it with your access keys. For detailed instructions, see [Installing the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html). For SDK examples, see [Bot examples](./examples.html).