Struct aws_sdk_sso::client::Client

pub struct Client { /* private fields */ }

Client for AWS Single Sign-On

Client for invoking operations on AWS Single Sign-On. Each operation on AWS Single Sign-On is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Implementations

impl Client

pub fn with_config( client: Client<DynConnector, DynMiddleware<DynConnector>>, conf: Config ) -> Self

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn get_role_credentials(&self) -> GetRoleCredentials

Constructs a fluent builder for the GetRoleCredentials operation.

• The fluent builder is configurable:
  • role_name(impl Into<String>) / set_role_name(Option<String>):

    The friendly name of the role that is assigned to the user.

  • account_id(impl Into<String>) / set_account_id(Option<String>):

    The identifier for the AWS account that is assigned to the user.

  • access_token(impl Into<String>) / set_access_token(Option<String>):

    The token issued by the CreateToken API call. For more information, see CreateToken in the IAM Identity Center OIDC API Reference Guide.

• On success, responds with GetRoleCredentialsOutput with field(s):
  • role_credentials(Option<RoleCredentials>):

    The credentials for the role that is assigned to the user.

• On failure, responds with SdkError<GetRoleCredentialsError>

pub fn list_account_roles(&self) -> ListAccountRoles

Constructs a fluent builder for the ListAccountRoles operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The page token from the previous response output when you request subsequent pages.

  • max_results(i32) / set_max_results(Option<i32>):

    The number of items that clients can request per page.

  • access_token(impl Into<String>) / set_access_token(Option<String>):

    The token issued by the CreateToken API call. For more information, see CreateToken in the IAM Identity Center OIDC API Reference Guide.

  • account_id(impl Into<String>) / set_account_id(Option<String>):

    The identifier for the AWS account that is assigned to the user.

• On success, responds with ListAccountRolesOutput with field(s):
  • next_token(Option<String>):

    The page token client that is used to retrieve the list of accounts.

  • role_list(Option<Vec<RoleInfo>>):

    A paginated response with the list of roles and the next token if more results are available.

• On failure, responds with SdkError<ListAccountRolesError>

pub fn list_accounts(&self) -> ListAccounts

Constructs a fluent builder for the ListAccounts operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):

    (Optional) When requesting subsequent pages, this is the page token from the previous response output.

  • max_results(i32) / set_max_results(Option<i32>):

    This is the number of items clients can request per page.

  • access_token(impl Into<String>) / set_access_token(Option<String>):

    The token issued by the CreateToken API call. For more information, see CreateToken in the IAM Identity Center OIDC API Reference Guide.

• On success, responds with ListAccountsOutput with field(s):
  • next_token(Option<String>):

    The page token client that is used to retrieve the list of accounts.

  • account_list(Option<Vec<AccountInfo>>):

    A paginated response with the list of account information and the next token if more results are available.

• On failure, responds with SdkError<ListAccountsError>

pub fn logout(&self) -> Logout

Constructs a fluent builder for the Logout operation.

• The fluent builder is configurable:
  • access_token(impl Into<String>) / set_access_token(Option<String>):

    The token issued by the CreateToken API call. For more information, see CreateToken in the IAM Identity Center OIDC API Reference Guide.

• On success, responds with LogoutOutput
• On failure, responds with SdkError<LogoutError>

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

• This method will panic if the conf is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the conf is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client

fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self

Converts to this type from the input type.