diff --git a/awscli/examples/sts/assume-role.rst b/awscli/examples/sts/assume-role.rst new file mode 100644 index 000000000000..18be67c5ef89 --- /dev/null +++ b/awscli/examples/sts/assume-role.rst @@ -0,0 +1,22 @@ +To assume a role:: + + aws sts assume-role --role-arn arn:aws:iam::123456789012:role/xaccounts3access --role-session-name s3-access-example + +The output of the command contains an access key, secret key, and session token that you can use to authenticate to AWS:: + + { + "AssumedRoleUser": { + "AssumedRoleId": "AROA3XFRBF535PLBIFPI4:s3-access-example", + "Arn": "arn:aws:sts::123456789012:assumed-role/xaccounts3access/s3-access-example" + }, + "Credentials": { + "SecretAccessKey": "9drTJvcXLB89EXAMPLELB8923FB892xMFI", + "SessionToken": "AQoXdzELDDY//////////wEaoAK1wvxJY12r2IrDFT2IvAzTCn3zHoZ7YNtpiQLF0MqZye/qwjzP2iEXAMPLEbw/m3hsj8VBTkPORGvr9jM5sgP+w9IZWZnU+LWhmg+a5fDi2oTGUYcdg9uexQ4mtCHIHfi4citgqZTgco40Yqr4lIlo4V2b2Dyauk0eYFNebHtYlFVgAUj+7Indz3LU0aTWk1WKIjHmmMCIoTkyYp/k7kUG7moeEYKSitwQIi6Gjn+nyzM+PtoA3685ixzv0R7i5rjQi0YE0lf1oeie3bDiNHncmzosRM6SFiPzSvp6h/32xQuZsjcypmwsPSDtTPYcs0+YN/8BRi2/IcrxSpnWEXAMPLEXSDFTAQAM6Dl9zR0tXoybnlrZIwMLlMi1Kcgo5OytwU=", + "Expiration": "2016-03-15T00:05:07Z", + "AccessKeyId": "ASIAJEXAMPLEXEG2JICEA" + } + } + +For AWS CLI use, you can set up a named profile associated with a role. When you use the profile, the AWS CLI will call assume-role and manage credentials for you. See `Assuming a Role`_ in the *AWS CLI User Guide* for instructions. + +.. _`Assuming a Role`: http://docs.aws.amazon.com/cli/latest/userguide/cli-roles.html \ No newline at end of file