View a markdown version of this page

Authenticate when using the AMS API/CLI - AMS Advanced User Guide

End of support notice: On June 30, 2027, AWS will end support for AMS Advanced. After June 30, 2027, you will no longer be able to access the AMS Advanced console or AMS Advanced resources. For more information, see AMS Advanced end of support.

Authenticate when using the AMS API/CLI

When you use the AMS API/CLI, you must authenticate with temporary credentials. To request temporary security credentials for federated users, cal GetFederationToken, AssumeRole, AssumeRoleWithSAML, or AssumeRoleWithWebIdentity AWS security token service (STS) APIs.

A common choice is SAML. After set up, you add an argument to each operation that you call. For example: aws --profile saml amscm list-change-type-categories.

A shortcut for SAML 2.0 profiles is to set the profile variable at the start of each API/CLI with set AWS_DEFAULT_PROFILE=saml (for Windows; for Linux it would be export AWS_DEFAULT_PROFILE=saml). For information about setting CLI environment variables, see Configuring the AWS Command Line Interface, Environment Variables.