Struct Client 

pub struct Client { /* private fields */ }

Client for AWS Sign-In Service

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

Using the Client

A client has a function for every operation that can be performed by the service. For example, the DeleteConsoleAuthorizationConfiguration operation has a Client::delete_console_authorization_configuration, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.delete_console_authorization_configuration()
    .target_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn create_o_auth2_token(&self) -> CreateOAuth2TokenFluentBuilder

Constructs a fluent builder for the CreateOAuth2Token operation.

• The fluent builder is configurable:
  • token_input(CreateOAuth2TokenRequestBody) / set_token_input(Option<CreateOAuth2TokenRequestBody>):
    required: true
    Flattened token operation inputs The specific operation is determined by grant_type in the request body
    
• On success, responds with CreateOAuth2TokenOutput with field(s):
  • token_output(Option<CreateOAuth2TokenResponseBody>): Flattened token operation outputs The specific response fields depend on the grant_type used in the request
• On failure, responds with SdkError<CreateOAuth2TokenError>

impl Client

pub fn delete_console_authorization_configuration( &self, ) -> DeleteConsoleAuthorizationConfigurationFluentBuilder

Constructs a fluent builder for the DeleteConsoleAuthorizationConfiguration operation.

• The fluent builder is configurable:
  • target_id(impl Into<String>) / set_target_id(Option<String>):
    required: false
    Target account identifier
    
• On success, responds with DeleteConsoleAuthorizationConfigurationOutput with field(s):
  • target_id(String): Target account identifier
  • scope(String): Authorization scope
  • console_authorization_enabled(bool): Whether console authorization is enabled
• On failure, responds with SdkError<DeleteConsoleAuthorizationConfigurationError>

impl Client

pub fn delete_resource_permission_statement( &self, ) -> DeleteResourcePermissionStatementFluentBuilder

Constructs a fluent builder for the DeleteResourcePermissionStatement operation.

• The fluent builder is configurable:
  • statement_id(impl Into<String>) / set_statement_id(Option<String>):
    required: true
    Unique identifier of the permission statement to delete
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    Idempotency token for the request
    
• On success, responds with DeleteResourcePermissionStatementOutput
• On failure, responds with SdkError<DeleteResourcePermissionStatementError>

impl Client

pub fn get_console_authorization_configuration( &self, ) -> GetConsoleAuthorizationConfigurationFluentBuilder

Constructs a fluent builder for the GetConsoleAuthorizationConfiguration operation.

• The fluent builder is configurable:
  • target_id(impl Into<String>) / set_target_id(Option<String>):
    required: false
    Target account identifier
    
• On success, responds with GetConsoleAuthorizationConfigurationOutput with field(s):
  • target_id(String): Target account identifier
  • scope(String): Authorization scope
  • console_authorization_enabled(bool): Whether console authorization is enabled
• On failure, responds with SdkError<GetConsoleAuthorizationConfigurationError>

impl Client

pub fn get_resource_policy(&self) -> GetResourcePolicyFluentBuilder

Constructs a fluent builder for the GetResourcePolicy operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetResourcePolicyOutput with field(s):
  • signin_resource_based_policy(Option<SigninResourceBasedPolicy>): The account’s SignIn resource-based policy
• On failure, responds with SdkError<GetResourcePolicyError>

impl Client

pub fn list_resource_permission_statements( &self, ) -> ListResourcePermissionStatementsFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    Maximum number of results to return
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    Token for pagination
    
• On success, responds with ListResourcePermissionStatementsOutput with field(s):
  • permission_statements(Vec::<PermissionStatementSummary>): List of permission statement summaries
  • next_token(Option<String>): Token for next page of results
• On failure, responds with SdkError<ListResourcePermissionStatementsError>

impl Client

pub fn put_console_authorization_configuration( &self, ) -> PutConsoleAuthorizationConfigurationFluentBuilder

Constructs a fluent builder for the PutConsoleAuthorizationConfiguration operation.

• The fluent builder is configurable:
  • target_id(impl Into<String>) / set_target_id(Option<String>):
    required: false
    Target account identifier
    
• On success, responds with PutConsoleAuthorizationConfigurationOutput with field(s):
  • target_id(String): Target account identifier
  • scope(String): Authorization scope
  • console_authorization_enabled(bool): Whether console authorization is enabled
• On failure, responds with SdkError<PutConsoleAuthorizationConfigurationError>

impl Client

pub fn put_resource_permission_statement( &self, ) -> PutResourcePermissionStatementFluentBuilder

Constructs a fluent builder for the PutResourcePermissionStatement operation.

• The fluent builder is configurable:
  • source_vpc(impl Into<String>) / set_source_vpc(Option<String>):
    required: false
    VPC identifier to restrict console access
    
  • signin_source_vpce(impl Into<String>) / set_signin_source_vpce(Option<String>):
    required: false
    SignIn VPC endpoint identifier
    
  • console_source_vpce(impl Into<String>) / set_console_source_vpce(Option<String>):
    required: false
    Console VPC endpoint identifier
    
  • vpc_source_ip(impl Into<String>) / set_vpc_source_ip(Option<String>):
    required: false
    Source IP address within VPC
    
  • source_ip(impl Into<String>) / set_source_ip(Option<String>):
    required: false
    Source IP address
    
  • requested_region(impl Into<String>) / set_requested_region(Option<String>):
    required: false
    AWS region where the VPC and VPC endpoint reside Required when sourceVpc or signinSourceVpce/consoleSourceVpce is provided
    
  • excluded_principal(impl Into<String>) / set_excluded_principal(Option<String>):
    required: false
    Principal to exclude from the permission statement
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    Idempotency token for the request
    
• On success, responds with PutResourcePermissionStatementOutput with field(s):
  • statement_id(String): Unique identifier for the created permission statement
• On failure, responds with SdkError<PutResourcePermissionStatementError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

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.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate 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.