Install the AMS CLIs - AMS Advanced Onboarding Guide

Install the AMS CLIs

For an example of installing the AWS Managed Services (AMS) CLI to use with SAML, see Appendix: ActiveDirectory Federation Services (ADFS) claim rule and SAML settings.

If you need temporary access, in order to get and install the AWS Managed Services (AMS) SDKs, see Temporary AMS console access.

Note

You must have administrator credentials for this procedure.

The AWS CLI is a prerequisite for using the AWS Managed Services (AMS) CLIs (Change Management and SKMS).

  1. To install the AWS CLI, see Installing the AWS Command Line Interface, and follow the appropriate instructions. Note that at the bottom of that page there are instructions for using different installers, Linux, MS Windows, macOS, Virtual Environment, Bundled Installer (Linux, macOS, or Unix).

    After the installation, run aws help to verify the installation.

  2. Once the AWS CLI is installed, to install or upgrade the AMS CLI, download either the AMS AMS CLI or AMS SDK distributables zip file and unzip. You can access the AMS CLI distributables through the Developer's Resources link in the left nav of the AMS console.

  3. The README file provides instructions for any install.

    Open either:

    • CLI zip: Provides the AMS CLI only.

    • SDK zip: Provides all of the AMS APIs and the AMS CLI.

    For Windows, run the appropriate installer (only 32 or 64 bits systems):

    • 32 Bits: ManagedCloudAPI_x86.msi

    • 64 Bits: ManagedCloudAPI_x64.msi

    For Mac/Linux, run the file named: AWSManagedServices_InstallCLI.sh by running this command: sh AWSManagedServices_InstallCLI.sh. Note that the amscm and amsskms directories and their contents must be in the same directory as the AWSManagedServices_InstallCLI.sh file.

  4. If your corporate credentials are used through federation with AWS (the AMS default configuration) you must install a credential management tool that can access your federation service. For example, you can use this AWS Security Blog How to Implement Federated API and CLI Access Using SAML 2.0 and AD FS for help configuring your credential management tooling.

  5. After the installation, run aws amscm help and aws amsskms help to see commands and options.

    Note

    The AMS CLI must be installed for these commands to work. To install the AMS API or CLI, go to the AMS console Developers Resources page. For reference material on the AMS CM API or AMS SKMS API, see the AMS Information Resources section in the User Guide. You may need to add a --profile option for authentication; for example, aws amsskms ams-cli-command --profile SAML. You may also need to add the --region option as all AMS commands run out of us-east-1; for example aws amscm ams-cli-command --region=us-east-1.