AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Creates or updates an SSO profile with the configuration values required to use AWS SSO.

Syntax

Set-AWSSSOSessionConfiguration
-SessionName <String>
-StartUrl <String>
-SSORegion <String>
-RegistrationScopes <String[]>

Description

The Set-AWSSSOSessionConfiguration cmdlet creates or updates an sso-session section in a configuration file. The SSO session can then be associated with a profile to retrieve SSO access tokens and AWS credentials. The configuration is saved in the shared configuration file '~/.aws/config'.

Parameters

-RegistrationScopes <String[]>
List of scopes to be authorized for the SSO session. Scopes authorize access to IAM Identity Center bearer token authorized endpoints. Default value is sso:account:access.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SessionName <String>
Name of an sso-session section of the configuration file that is used to group configuration variables for acquiring SSO access tokens, which can then be used to acquire AWS credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SSORegion <String>
AWS Region that contains the AWS access portal host. This is separate from, and can be a different Region than, the profile region parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StartUrl <String>
URL that points to the organization's AWS access portal.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Outputs

None
This cmdlet does not generate any output.

Examples

Example 1

$params = @{
      SessionName = 'ssosessioneast'
      StartUrl = 'https://d-xxxxxxxxxx.awsapps.com/start/'
      SSORegion = 'us-east-1'
      RegistrationScopes = 'sso:account:access'
      };
      Set-AWSSSOSessionConfiguration @params
Creates or updates an sso-session section in the configuration file.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z