

# Setting up Amazon OpenSearch Service
<a name="setting-up"></a>

## Grant permissions
<a name="setting-up-iam"></a>

In production environments, we recommend that you use finer-grained policies. To learn more about access management, see [Access management for Amazon resources](https://docs.amazonaws.cn/IAM/latest/UserGuide/access.html) in the IAM User Guide.

To provide access, add permissions to your users, groups, or roles:
+ Users managed in IAM through an identity provider:

  Create a role for identity federation. Follow the instructions in [Create a role for a third-party identity provider (federation)](https://docs.amazonaws.cn//IAM/latest/UserGuide/id_roles_create_for-idp.html) in the *IAM User Guide*.
+ IAM users:
  + Create a role that your user can assume. Follow the instructions in [Create a role for an IAM user](https://docs.amazonaws.cn//IAM/latest/UserGuide/id_roles_create_for-user.html) in the *IAM User Guide*.
  + (Not recommended) Attach a policy directly to a user or add a user to a user group. Follow the instructions in [Adding permissions to a user (console)](https://docs.amazonaws.cn//IAM/latest/UserGuide/id_users_change-permissions.html#users_change_permissions-add-console) in the *IAM User Guide*.

### Grant programmatic access
<a name="setting-up-access"></a>

Users need programmatic access if they want to interact with Amazon outside of the Amazon Web Services Management Console. The Amazon APIs and the Amazon Command Line Interface require access keys. Whenever possible, create temporary credentials that consist of an access key ID, a secret access key, and a security token that indicates when the credentials expire.

To grant users programmatic access, choose one of the following options.


****  

| Which user needs programmatic access? | To | By | 
| --- | --- | --- | 
| IAM | Use short-term credentials to sign programmatic requests to the Amazon CLI or Amazon APIs (directly or by using the Amazon SDKs). | Following the instructions in [Using temporary credentials with Amazon resources](https://docs.amazonaws.cn//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 Amazon CLI or Amazon APIs (directly or by using the Amazon SDKs). | Following the instructions in [Managing access keys for IAM users](https://docs.amazonaws.cn//IAM/latest/UserGuide/id_credentials_access-keys.html) in the IAM User Guide. | 

## Install and configure the Amazon CLI
<a name="setting-up-cli"></a>

If you want to use OpenSearch Service APIs, you must install the latest version of the Amazon Command Line Interface (Amazon CLI). You don't need the Amazon CLI to use OpenSearch Service from the console, and you can get started without the CLI by following the steps in [Getting started with Amazon OpenSearch Service](gsg.md).

**To set up the Amazon CLI**

1. To install the latest version of the Amazon CLI for macOS, Linux, or Windows, see [Installing or updating the latest version of the Amazon CLI](https://docs.amazonaws.cn/cli/latest/userguide/getting-started-install.html).

1. To configure the Amazon CLI and secure setup of your access to Amazon Web Services services, including OpenSearch Service, see [Quick configuration with `aws configure`](https://docs.amazonaws.cn/cli/latest/userguide/cli-configure-quickstart.html#cli-configure-quickstart-config).

1. To verify the setup, enter the following DataBrew command at the command prompt.

   ```
   aws opensearch help
   ```

   Amazon CLI commands use the default Amazon Web Services Region from your configuration, unless you set it with a parameter or a profile. To set your Amazon Web Services Region with a parameter, you can add the `--region` parameter to each command.

   To set your Amazon Web Services Region with a profile, first add a named profile in the `~/.aws/config` file or the `%UserProfile%/.aws/config` file (for Microsoft Windows). Follow the steps in [Named profiles for the Amazon CLI](https://docs.amazonaws.cn/cli/latest/userguide/cli-configure-profiles.html). Next, set your Amazon Web Services Region and other settings with a command similar to the one in the following example.

   ```
   [profile opensearch]
   aws_access_key_id = ACCESS-KEY-ID-OF-IAM-USER
   aws_secret_access_key = SECRET-ACCESS-KEY-ID-OF-IAM-USER
   region = us-east-1
   output = text
   ```

## Open the console
<a name="opening-console"></a>

Most of the console-oriented topics in this section start from the [OpenSearch Service console](https://console.amazonaws.cn/aos/home). If you aren't already signed in to your Amazon Web Services account, sign in, then open the [OpenSearch Service console](https://console.amazonaws.cn/aos/home) and continue to the next section to continue getting started with OpenSearch Service.