cdk-amazon-chime-resources
Version:
77 lines (76 loc) • 5.55 kB
TypeScript
import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
import { GetRoleCredentialsCommandInput, GetRoleCredentialsCommandOutput } from "./commands/GetRoleCredentialsCommand";
import { ListAccountRolesCommandInput, ListAccountRolesCommandOutput } from "./commands/ListAccountRolesCommand";
import { ListAccountsCommandInput, ListAccountsCommandOutput } from "./commands/ListAccountsCommand";
import { LogoutCommandInput, LogoutCommandOutput } from "./commands/LogoutCommand";
import { SSOClient } from "./SSOClient";
/**
* @public
* <p>AWS IAM Identity Center (successor to AWS Single Sign-On) Portal is a web service that makes it easy for you to assign user access to
* IAM Identity Center resources such as the AWS access portal. Users can get AWS account applications and roles
* assigned to them and get federated into the application.</p>
*
* <note>
* <p>Although AWS Single Sign-On was renamed, the <code>sso</code> and
* <code>identitystore</code> API namespaces will continue to retain their original name for
* backward compatibility purposes. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed">IAM Identity Center rename</a>.</p>
* </note>
*
* <p>This reference guide describes the IAM Identity Center Portal operations that you can call
* programatically and includes detailed information on data types and errors.</p>
*
* <note>
* <p>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 IAM Identity Center and other AWS services. For more
* information about the AWS SDKs, including how to download and install them, see <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a>.</p>
* </note>
*/
export declare class SSO extends SSOClient {
/**
* @public
* <p>Returns the STS short-term credentials for a given role name that is assigned to the
* user.</p>
*/
getRoleCredentials(args: GetRoleCredentialsCommandInput, options?: __HttpHandlerOptions): Promise<GetRoleCredentialsCommandOutput>;
getRoleCredentials(args: GetRoleCredentialsCommandInput, cb: (err: any, data?: GetRoleCredentialsCommandOutput) => void): void;
getRoleCredentials(args: GetRoleCredentialsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRoleCredentialsCommandOutput) => void): void;
/**
* @public
* <p>Lists all roles that are assigned to the user for a given AWS account.</p>
*/
listAccountRoles(args: ListAccountRolesCommandInput, options?: __HttpHandlerOptions): Promise<ListAccountRolesCommandOutput>;
listAccountRoles(args: ListAccountRolesCommandInput, cb: (err: any, data?: ListAccountRolesCommandOutput) => void): void;
listAccountRoles(args: ListAccountRolesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccountRolesCommandOutput) => void): void;
/**
* @public
* <p>Lists all AWS accounts assigned to the user. These AWS accounts are assigned by the
* administrator of the account. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/useraccess.html#assignusers">Assign User Access</a> in the <i>IAM Identity Center User Guide</i>. This operation
* returns a paginated response.</p>
*/
listAccounts(args: ListAccountsCommandInput, options?: __HttpHandlerOptions): Promise<ListAccountsCommandOutput>;
listAccounts(args: ListAccountsCommandInput, cb: (err: any, data?: ListAccountsCommandOutput) => void): void;
listAccounts(args: ListAccountsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccountsCommandOutput) => void): void;
/**
* @public
* <p>Removes the locally stored SSO tokens from the client-side cache and sends an API call to
* the IAM Identity Center service to invalidate the corresponding server-side IAM Identity Center sign in
* session.</p>
*
* <note>
* <p>If a user uses IAM Identity Center to access the AWS CLI, the user’s IAM Identity Center sign in session is
* used to obtain an IAM session, as specified in the corresponding IAM Identity Center permission set.
* More specifically, IAM Identity Center assumes an IAM role in the target account on behalf of the user,
* and the corresponding temporary AWS credentials are returned to the client.</p>
*
* <p>After user logout, any existing IAM role sessions that were created by using IAM Identity Center
* permission sets continue based on the duration configured in the permission set.
* For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/authconcept.html">User
* authentications</a> in the <i>IAM Identity Center User
* Guide</i>.</p>
* </note>
*/
logout(args: LogoutCommandInput, options?: __HttpHandlerOptions): Promise<LogoutCommandOutput>;
logout(args: LogoutCommandInput, cb: (err: any, data?: LogoutCommandOutput) => void): void;
logout(args: LogoutCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: LogoutCommandOutput) => void): void;
}