NAME

Paws::SSO - Perl Interface to AWS AWS Single Sign-On

SYNOPSIS

  use Paws;

  my $obj = Paws->service('SSO');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

AWS Single Sign-On Portal is a web service that makes it easy for you to assign user access to AWS SSO resources such as the user portal. Users can get AWS account applications and roles assigned to them and get federated into the application.

For general information about AWS SSO, see What is AWS Single Sign-On? (https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html) in the AWS SSO User Guide.

This API reference guide describes the AWS SSO Portal operations that you can call programatically and includes detailed information on data types and errors.

AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms, such as Java, Ruby, .Net, iOS, or Android. The SDKs provide a convenient way to create programmatic access to AWS SSO and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services (http://aws.amazon.com/tools/).

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/portal.sso-2019-06-10

METHODS

GetRoleCredentials

AccessToken => Str

AccountId => Str

RoleName => Str

Each argument is described in detail in: Paws::SSO::GetRoleCredentials

Returns: a Paws::SSO::GetRoleCredentialsResponse instance

Returns the STS short-term credentials for a given role name that is assigned to the user.

ListAccountRoles

AccessToken => Str

AccountId => Str

[MaxResults => Int]

[NextToken => Str]

Each argument is described in detail in: Paws::SSO::ListAccountRoles

Returns: a Paws::SSO::ListAccountRolesResponse instance

Lists all roles that are assigned to the user for a given AWS account.

ListAccounts

AccessToken => Str

[MaxResults => Int]

[NextToken => Str]

Each argument is described in detail in: Paws::SSO::ListAccounts

Returns: a Paws::SSO::ListAccountsResponse instance

Lists all AWS accounts assigned to the user. These AWS accounts are assigned by the administrator of the account. For more information, see Assign User Access (https://docs.aws.amazon.com/singlesignon/latest/userguide/useraccess.html#assignusers) in the AWS SSO User Guide. This operation returns a paginated response.

Logout

AccessToken => Str

Each argument is described in detail in: Paws::SSO::Logout

Returns: nothing

Removes the client- and server-side session that is associated with the user.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

ListAllAccountRoles(sub { },AccessToken => Str, AccountId => Str, [MaxResults => Int, NextToken => Str])

ListAllAccountRoles(AccessToken => Str, AccountId => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - roleList, passing the object as the first parameter, and the string 'roleList' as the second parameter 

If not, it will return a a Paws::SSO::ListAccountRolesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllAccounts(sub { },AccessToken => Str, [MaxResults => Int, NextToken => Str])

ListAllAccounts(AccessToken => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - accountList, passing the object as the first parameter, and the string 'accountList' as the second parameter 

If not, it will return a a Paws::SSO::ListAccountsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues

cpanm Paws

perl -MCPAN -e shell
install Paws