Struct aws_sdk_ssoadmin::Client

pub struct Client { /* private fields */ }

Client for AWS Single Sign-On Admin

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

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_ssoadmin::Client::new(&config);

Occasionally, SDKs may have additional service-specific that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_ssoadmin::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the AttachCustomerManagedPolicyReferenceToPermissionSet operation has a Client::attach_customer_managed_policy_reference_to_permission_set, 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.attach_customer_managed_policy_reference_to_permission_set()
    .instance_arn("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 attach_customer_managed_policy_reference_to_permission_set( &self ) -> AttachCustomerManagedPolicyReferenceToPermissionSetFluentBuilder

Constructs a fluent builder for the AttachCustomerManagedPolicyReferenceToPermissionSet operation.

• The fluent builder is configurable:
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: true
    

    The ARN of the IAM Identity Center instance under which the operation will be executed.

    
    
  • permission_set_arn(impl Into<String>) / set_permission_set_arn(Option<String>):
    required: true
    

    The ARN of the PermissionSet.

    
    
  • customer_managed_policy_reference(CustomerManagedPolicyReference) / set_customer_managed_policy_reference(Option<CustomerManagedPolicyReference>):
    required: true
    

    Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each Amazon Web Services account where you want to deploy your permission set.

    
    
• On success, responds with AttachCustomerManagedPolicyReferenceToPermissionSetOutput
• On failure, responds with SdkError<AttachCustomerManagedPolicyReferenceToPermissionSetError>

impl Client

pub fn attach_managed_policy_to_permission_set( &self ) -> AttachManagedPolicyToPermissionSetFluentBuilder

Constructs a fluent builder for the AttachManagedPolicyToPermissionSet operation.

• The fluent builder is configurable:
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: true
    

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

    
    
  • permission_set_arn(impl Into<String>) / set_permission_set_arn(Option<String>):
    required: true
    

    The ARN of the PermissionSet that the managed policy should be attached to.

    
    
  • managed_policy_arn(impl Into<String>) / set_managed_policy_arn(Option<String>):
    required: true
    

    The Amazon Web Services managed policy ARN to be attached to a permission set.

    
    
• On success, responds with AttachManagedPolicyToPermissionSetOutput
• On failure, responds with SdkError<AttachManagedPolicyToPermissionSetError>

impl Client

pub fn create_account_assignment(&self) -> CreateAccountAssignmentFluentBuilder

Constructs a fluent builder for the CreateAccountAssignment operation.

• The fluent builder is configurable:
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: true
    

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

    
    
  • target_id(impl Into<String>) / set_target_id(Option<String>):
    required: true
    

    TargetID is an Amazon Web Services account identifier, (For example, 123456789012).

    
    
  • target_type(TargetType) / set_target_type(Option<TargetType>):
    required: true
    

    The entity type for which the assignment will be created.

    
    
  • permission_set_arn(impl Into<String>) / set_permission_set_arn(Option<String>):
    required: true
    

    The ARN of the permission set that the admin wants to grant the principal access to.

    
    
  • principal_type(PrincipalType) / set_principal_type(Option<PrincipalType>):
    required: true
    

    The entity type for which the assignment will be created.

    
    
  • principal_id(impl Into<String>) / set_principal_id(Option<String>):
    required: true
    

    An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.

    
    
• On success, responds with CreateAccountAssignmentOutput with field(s):
  • account_assignment_creation_status(Option<AccountAssignmentOperationStatus>):

    The status object for the account assignment creation operation.

• On failure, responds with SdkError<CreateAccountAssignmentError>

impl Client

pub fn create_instance_access_control_attribute_configuration( &self ) -> CreateInstanceAccessControlAttributeConfigurationFluentBuilder

Constructs a fluent builder for the CreateInstanceAccessControlAttributeConfiguration operation.

• The fluent builder is configurable:
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: true
    

    The ARN of the IAM Identity Center instance under which the operation will be executed.

    
    
  • instance_access_control_attribute_configuration(InstanceAccessControlAttributeConfiguration) / set_instance_access_control_attribute_configuration(Option<InstanceAccessControlAttributeConfiguration>):
    required: true
    

    Specifies the IAM Identity Center identity store attributes to add to your ABAC configuration. When using an external identity provider as an identity source, you can pass attributes through the SAML assertion. Doing so provides an alternative to configuring attributes from the IAM Identity Center identity store. If a SAML assertion passes any of these attributes, IAM Identity Center will replace the attribute value with the value from the IAM Identity Center identity store.

    
    
• On success, responds with CreateInstanceAccessControlAttributeConfigurationOutput
• On failure, responds with SdkError<CreateInstanceAccessControlAttributeConfigurationError>

impl Client

pub fn create_permission_set(&self) -> CreatePermissionSetFluentBuilder

Constructs a fluent builder for the CreatePermissionSet operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the PermissionSet.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the PermissionSet.

    
    
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: true
    

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

    
    
  • session_duration(impl Into<String>) / set_session_duration(Option<String>):
    required: false
    

    The length of time that the application user sessions are valid in the ISO-8601 standard.

    
    
  • relay_state(impl Into<String>) / set_relay_state(Option<String>):
    required: false
    

    Used to redirect users within the application during the federation authentication process.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags to attach to the new PermissionSet.

    
    
• On success, responds with CreatePermissionSetOutput with field(s):
  • permission_set(Option<PermissionSet>):

    Defines the level of access on an Amazon Web Services account.

• On failure, responds with SdkError<CreatePermissionSetError>

impl Client

pub fn delete_account_assignment(&self) -> DeleteAccountAssignmentFluentBuilder

Constructs a fluent builder for the DeleteAccountAssignment operation.

• The fluent builder is configurable:
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: true
    

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

    
    
  • target_id(impl Into<String>) / set_target_id(Option<String>):
    required: true
    

    TargetID is an Amazon Web Services account identifier, (For example, 123456789012).

    
    
  • target_type(TargetType) / set_target_type(Option<TargetType>):
    required: true
    

    The entity type for which the assignment will be deleted.

    
    
  • permission_set_arn(impl Into<String>) / set_permission_set_arn(Option<String>):
    required: true
    

    The ARN of the permission set that will be used to remove access.

    
    
  • principal_type(PrincipalType) / set_principal_type(Option<PrincipalType>):
    required: true
    

    The entity type for which the assignment will be deleted.

    
    
  • principal_id(impl Into<String>) / set_principal_id(Option<String>):
    required: true
    

    An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.

    
    
• On success, responds with DeleteAccountAssignmentOutput with field(s):
  • account_assignment_deletion_status(Option<AccountAssignmentOperationStatus>):

    The status object for the account assignment deletion operation.

• On failure, responds with SdkError<DeleteAccountAssignmentError>

impl Client

pub fn delete_inline_policy_from_permission_set( &self ) -> DeleteInlinePolicyFromPermissionSetFluentBuilder

Constructs a fluent builder for the DeleteInlinePolicyFromPermissionSet operation.

• The fluent builder is configurable:
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: true
    

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

    
    
  • permission_set_arn(impl Into<String>) / set_permission_set_arn(Option<String>):
    required: true
    

    The ARN of the permission set that will be used to remove access.

    
    
• On success, responds with DeleteInlinePolicyFromPermissionSetOutput
• On failure, responds with SdkError<DeleteInlinePolicyFromPermissionSetError>

impl Client

pub fn delete_instance_access_control_attribute_configuration( &self ) -> DeleteInstanceAccessControlAttributeConfigurationFluentBuilder

Constructs a fluent builder for the DeleteInstanceAccessControlAttributeConfiguration operation.

• The fluent builder is configurable:
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: true
    

    The ARN of the IAM Identity Center instance under which the operation will be executed.

    
    
• On success, responds with DeleteInstanceAccessControlAttributeConfigurationOutput
• On failure, responds with SdkError<DeleteInstanceAccessControlAttributeConfigurationError>

impl Client

pub fn delete_permission_set(&self) -> DeletePermissionSetFluentBuilder

Constructs a fluent builder for the DeletePermissionSet operation.

• The fluent builder is configurable:
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: true
    

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

    
    
  • permission_set_arn(impl Into<String>) / set_permission_set_arn(Option<String>):
    required: true
    

    The ARN of the permission set that should be deleted.

    
    
• On success, responds with DeletePermissionSetOutput
• On failure, responds with SdkError<DeletePermissionSetError>

impl Client

pub fn delete_permissions_boundary_from_permission_set( &self ) -> DeletePermissionsBoundaryFromPermissionSetFluentBuilder

Constructs a fluent builder for the DeletePermissionsBoundaryFromPermissionSet operation.

• The fluent builder is configurable:
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: true
    

    The ARN of the IAM Identity Center instance under which the operation will be executed.

    
    
  • permission_set_arn(impl Into<String>) / set_permission_set_arn(Option<String>):
    required: true
    

    The ARN of the PermissionSet.

    
    
• On success, responds with DeletePermissionsBoundaryFromPermissionSetOutput
• On failure, responds with SdkError<DeletePermissionsBoundaryFromPermissionSetError>

impl Client

pub fn describe_account_assignment_creation_status( &self ) -> DescribeAccountAssignmentCreationStatusFluentBuilder

Constructs a fluent builder for the DescribeAccountAssignmentCreationStatus operation.

• The fluent builder is configurable:
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: true
    

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

    
    
  • account_assignment_creation_request_id(impl Into<String>) / set_account_assignment_creation_request_id(Option<String>):
    required: true
    

    The identifier that is used to track the request operation progress.

    
    
• On success, responds with DescribeAccountAssignmentCreationStatusOutput with field(s):
  • account_assignment_creation_status(Option<AccountAssignmentOperationStatus>):

    The status object for the account assignment creation operation.

• On failure, responds with SdkError<DescribeAccountAssignmentCreationStatusError>

impl Client

pub fn describe_account_assignment_deletion_status( &self ) -> DescribeAccountAssignmentDeletionStatusFluentBuilder

Constructs a fluent builder for the DescribeAccountAssignmentDeletionStatus operation.

• The fluent builder is configurable:
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: true
    

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

    
    
  • account_assignment_deletion_request_id(impl Into<String>) / set_account_assignment_deletion_request_id(Option<String>):
    required: true
    

    The identifier that is used to track the request operation progress.

    
    
• On success, responds with DescribeAccountAssignmentDeletionStatusOutput with field(s):
  • account_assignment_deletion_status(Option<AccountAssignmentOperationStatus>):

    The status object for the account assignment deletion operation.

• On failure, responds with SdkError<DescribeAccountAssignmentDeletionStatusError>

impl Client

pub fn describe_instance_access_control_attribute_configuration( &self ) -> DescribeInstanceAccessControlAttributeConfigurationFluentBuilder

Constructs a fluent builder for the DescribeInstanceAccessControlAttributeConfiguration operation.

• The fluent builder is configurable:
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: true
    

    The ARN of the IAM Identity Center instance under which the operation will be executed.

    
    
• On success, responds with DescribeInstanceAccessControlAttributeConfigurationOutput with field(s):
  • status(Option<InstanceAccessControlAttributeConfigurationStatus>):

    The status of the attribute configuration process.

  • status_reason(Option<String>):

    Provides more details about the current status of the specified attribute.

  • instance_access_control_attribute_configuration(Option<InstanceAccessControlAttributeConfiguration>):

    Gets the list of IAM Identity Center identity store attributes that have been added to your ABAC configuration.

• On failure, responds with SdkError<DescribeInstanceAccessControlAttributeConfigurationError>

impl Client

pub fn describe_permission_set(&self) -> DescribePermissionSetFluentBuilder

Constructs a fluent builder for the DescribePermissionSet operation.

• The fluent builder is configurable:
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: true
    

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

    
    
  • permission_set_arn(impl Into<String>) / set_permission_set_arn(Option<String>):
    required: true
    

    The ARN of the permission set.

    
    
• On success, responds with DescribePermissionSetOutput with field(s):
  • permission_set(Option<PermissionSet>):

    Describes the level of access on an Amazon Web Services account.

• On failure, responds with SdkError<DescribePermissionSetError>

impl Client

pub fn describe_permission_set_provisioning_status( &self ) -> DescribePermissionSetProvisioningStatusFluentBuilder

Constructs a fluent builder for the DescribePermissionSetProvisioningStatus operation.

• The fluent builder is configurable:
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: true
    

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

    
    
  • provision_permission_set_request_id(impl Into<String>) / set_provision_permission_set_request_id(Option<String>):
    required: true
    

    The identifier that is provided by the ProvisionPermissionSet call to retrieve the current status of the provisioning workflow.

    
    
• On success, responds with DescribePermissionSetProvisioningStatusOutput with field(s):
  • permission_set_provisioning_status(Option<PermissionSetProvisioningStatus>):

    The status object for the permission set provisioning operation.

• On failure, responds with SdkError<DescribePermissionSetProvisioningStatusError>

impl Client

pub fn detach_customer_managed_policy_reference_from_permission_set( &self ) -> DetachCustomerManagedPolicyReferenceFromPermissionSetFluentBuilder

Constructs a fluent builder for the DetachCustomerManagedPolicyReferenceFromPermissionSet operation.

• The fluent builder is configurable:
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: true
    

    The ARN of the IAM Identity Center instance under which the operation will be executed.

    
    
  • permission_set_arn(impl Into<String>) / set_permission_set_arn(Option<String>):
    required: true
    

    The ARN of the PermissionSet.

    
    
  • customer_managed_policy_reference(CustomerManagedPolicyReference) / set_customer_managed_policy_reference(Option<CustomerManagedPolicyReference>):
    required: true
    

    Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each Amazon Web Services account where you want to deploy your permission set.

    
    
• On success, responds with DetachCustomerManagedPolicyReferenceFromPermissionSetOutput
• On failure, responds with SdkError<DetachCustomerManagedPolicyReferenceFromPermissionSetError>

impl Client

pub fn detach_managed_policy_from_permission_set( &self ) -> DetachManagedPolicyFromPermissionSetFluentBuilder

Constructs a fluent builder for the DetachManagedPolicyFromPermissionSet operation.

• The fluent builder is configurable:
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: true
    

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

    
    
  • permission_set_arn(impl Into<String>) / set_permission_set_arn(Option<String>):
    required: true
    

    The ARN of the PermissionSet from which the policy should be detached.

    
    
  • managed_policy_arn(impl Into<String>) / set_managed_policy_arn(Option<String>):
    required: true
    

    The Amazon Web Services managed policy ARN to be detached from a permission set.

    
    
• On success, responds with DetachManagedPolicyFromPermissionSetOutput
• On failure, responds with SdkError<DetachManagedPolicyFromPermissionSetError>

impl Client

pub fn get_inline_policy_for_permission_set( &self ) -> GetInlinePolicyForPermissionSetFluentBuilder

Constructs a fluent builder for the GetInlinePolicyForPermissionSet operation.

• The fluent builder is configurable:
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: true
    

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

    
    
  • permission_set_arn(impl Into<String>) / set_permission_set_arn(Option<String>):
    required: true
    

    The ARN of the permission set.

    
    
• On success, responds with GetInlinePolicyForPermissionSetOutput with field(s):
  • inline_policy(Option<String>):

    The inline policy that is attached to the permission set.

    For Length Constraints, if a valid ARN is provided for a permission set, it is possible for an empty inline policy to be returned.

• On failure, responds with SdkError<GetInlinePolicyForPermissionSetError>

impl Client

pub fn get_permissions_boundary_for_permission_set( &self ) -> GetPermissionsBoundaryForPermissionSetFluentBuilder

Constructs a fluent builder for the GetPermissionsBoundaryForPermissionSet operation.

• The fluent builder is configurable:
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: true
    

    The ARN of the IAM Identity Center instance under which the operation will be executed.

    
    
  • permission_set_arn(impl Into<String>) / set_permission_set_arn(Option<String>):
    required: true
    

    The ARN of the PermissionSet.

    
    
• On success, responds with GetPermissionsBoundaryForPermissionSetOutput with field(s):
  • permissions_boundary(Option<PermissionsBoundary>):

    The permissions boundary attached to the specified permission set.

• On failure, responds with SdkError<GetPermissionsBoundaryForPermissionSetError>

impl Client

pub fn list_account_assignment_creation_status( &self ) -> ListAccountAssignmentCreationStatusFluentBuilder

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

• The fluent builder is configurable:
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: true
    

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

    The maximum number of results to display for the assignment.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

    
    
  • filter(OperationStatusFilter) / set_filter(Option<OperationStatusFilter>):
    required: false
    

    Filters results based on the passed attribute value.

    
    
• On success, responds with ListAccountAssignmentCreationStatusOutput with field(s):
  • account_assignments_creation_status(Option<Vec::<AccountAssignmentOperationStatusMetadata>>):

    The status object for the account assignment creation operation.

  • next_token(Option<String>):

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

• On failure, responds with SdkError<ListAccountAssignmentCreationStatusError>

impl Client

pub fn list_account_assignment_deletion_status( &self ) -> ListAccountAssignmentDeletionStatusFluentBuilder

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

• The fluent builder is configurable:
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: true
    

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

    The maximum number of results to display for the assignment.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

    
    
  • filter(OperationStatusFilter) / set_filter(Option<OperationStatusFilter>):
    required: false
    

    Filters results based on the passed attribute value.

    
    
• On success, responds with ListAccountAssignmentDeletionStatusOutput with field(s):
  • account_assignments_deletion_status(Option<Vec::<AccountAssignmentOperationStatusMetadata>>):

    The status object for the account assignment deletion operation.

  • next_token(Option<String>):

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

• On failure, responds with SdkError<ListAccountAssignmentDeletionStatusError>

impl Client

pub fn list_account_assignments(&self) -> ListAccountAssignmentsFluentBuilder

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

• The fluent builder is configurable:
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: true
    

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

    The identifier of the Amazon Web Services account from which to list the assignments.

    
    
  • permission_set_arn(impl Into<String>) / set_permission_set_arn(Option<String>):
    required: true
    

    The ARN of the permission set from which to list assignments.

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

    The maximum number of results to display for the assignment.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

    
    
• On success, responds with ListAccountAssignmentsOutput with field(s):
  • account_assignments(Option<Vec::<AccountAssignment>>):

    The list of assignments that match the input Amazon Web Services account and permission set.

  • next_token(Option<String>):

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

• On failure, responds with SdkError<ListAccountAssignmentsError>

impl Client

pub fn list_accounts_for_provisioned_permission_set( &self ) -> ListAccountsForProvisionedPermissionSetFluentBuilder

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

• The fluent builder is configurable:
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: true
    

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

    
    
  • permission_set_arn(impl Into<String>) / set_permission_set_arn(Option<String>):
    required: true
    

    The ARN of the PermissionSet from which the associated Amazon Web Services accounts will be listed.

    
    
  • provisioning_status(ProvisioningStatus) / set_provisioning_status(Option<ProvisioningStatus>):
    required: false
    

    The permission set provisioning status for an Amazon Web Services account.

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

    The maximum number of results to display for the PermissionSet.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

    
    
• On success, responds with ListAccountsForProvisionedPermissionSetOutput with field(s):
  • account_ids(Option<Vec::<String>>):

    The list of Amazon Web Services AccountIds.

  • next_token(Option<String>):

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

• On failure, responds with SdkError<ListAccountsForProvisionedPermissionSetError>

impl Client

pub fn list_customer_managed_policy_references_in_permission_set( &self ) -> ListCustomerManagedPolicyReferencesInPermissionSetFluentBuilder

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

• The fluent builder is configurable:
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: true
    

    The ARN of the IAM Identity Center instance under which the operation will be executed.

    
    
  • permission_set_arn(impl Into<String>) / set_permission_set_arn(Option<String>):
    required: true
    

    The ARN of the PermissionSet.

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

    The maximum number of results to display for the list call.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

    
    
• On success, responds with ListCustomerManagedPolicyReferencesInPermissionSetOutput with field(s):
  • customer_managed_policy_references(Option<Vec::<CustomerManagedPolicyReference>>):

    Specifies the names and paths of the customer managed policies that you have attached to your permission set.

  • next_token(Option<String>):

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

• On failure, responds with SdkError<ListCustomerManagedPolicyReferencesInPermissionSetError>

impl Client

pub fn list_instances(&self) -> ListInstancesFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to display for the instance.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

    
    
• On success, responds with ListInstancesOutput with field(s):
  • instances(Option<Vec::<InstanceMetadata>>):

    Lists the IAM Identity Center instances that the caller has access to.

  • next_token(Option<String>):

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

• On failure, responds with SdkError<ListInstancesError>

impl Client

pub fn list_managed_policies_in_permission_set( &self ) -> ListManagedPoliciesInPermissionSetFluentBuilder

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

• The fluent builder is configurable:
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: true
    

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

    
    
  • permission_set_arn(impl Into<String>) / set_permission_set_arn(Option<String>):
    required: true
    

    The ARN of the PermissionSet whose managed policies will be listed.

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

    The maximum number of results to display for the PermissionSet.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

    
    
• On success, responds with ListManagedPoliciesInPermissionSetOutput with field(s):
  • attached_managed_policies(Option<Vec::<AttachedManagedPolicy>>):

    An array of the AttachedManagedPolicy data type object.

  • next_token(Option<String>):

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

• On failure, responds with SdkError<ListManagedPoliciesInPermissionSetError>

impl Client

pub fn list_permission_set_provisioning_status( &self ) -> ListPermissionSetProvisioningStatusFluentBuilder

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

• The fluent builder is configurable:
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: true
    

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

    The maximum number of results to display for the assignment.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

    
    
  • filter(OperationStatusFilter) / set_filter(Option<OperationStatusFilter>):
    required: false
    

    Filters results based on the passed attribute value.

    
    
• On success, responds with ListPermissionSetProvisioningStatusOutput with field(s):
  • permission_sets_provisioning_status(Option<Vec::<PermissionSetProvisioningStatusMetadata>>):

    The status object for the permission set provisioning operation.

  • next_token(Option<String>):

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

• On failure, responds with SdkError<ListPermissionSetProvisioningStatusError>

impl Client

pub fn list_permission_sets(&self) -> ListPermissionSetsFluentBuilder

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

• The fluent builder is configurable:
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: true
    

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

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

    The maximum number of results to display for the assignment.

    
    
• On success, responds with ListPermissionSetsOutput with field(s):
  • permission_sets(Option<Vec::<String>>):

    Defines the level of access on an Amazon Web Services account.

  • next_token(Option<String>):

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

• On failure, responds with SdkError<ListPermissionSetsError>

impl Client

pub fn list_permission_sets_provisioned_to_account( &self ) -> ListPermissionSetsProvisionedToAccountFluentBuilder

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

• The fluent builder is configurable:
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: true
    

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

    The identifier of the Amazon Web Services account from which to list the assignments.

    
    
  • provisioning_status(ProvisioningStatus) / set_provisioning_status(Option<ProvisioningStatus>):
    required: false
    

    The status object for the permission set provisioning operation.

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

    The maximum number of results to display for the assignment.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

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

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

  • permission_sets(Option<Vec::<String>>):

    Defines the level of access that an Amazon Web Services account has.

• On failure, responds with SdkError<ListPermissionSetsProvisionedToAccountError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

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

• The fluent builder is configurable:
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: true
    

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

    
    
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the resource with the tags to be listed.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<Vec::<Tag>>):

    A set of key-value pairs that are used to manage the resource.

  • next_token(Option<String>):

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn provision_permission_set(&self) -> ProvisionPermissionSetFluentBuilder

Constructs a fluent builder for the ProvisionPermissionSet operation.

• The fluent builder is configurable:
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: true
    

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

    
    
  • permission_set_arn(impl Into<String>) / set_permission_set_arn(Option<String>):
    required: true
    

    The ARN of the permission set.

    
    
  • target_id(impl Into<String>) / set_target_id(Option<String>):
    required: false
    

    TargetID is an Amazon Web Services account identifier, (For example, 123456789012).

    
    
  • target_type(ProvisionTargetType) / set_target_type(Option<ProvisionTargetType>):
    required: true
    

    The entity type for which the assignment will be created.

    
    
• On success, responds with ProvisionPermissionSetOutput with field(s):
  • permission_set_provisioning_status(Option<PermissionSetProvisioningStatus>):

    The status object for the permission set provisioning operation.

• On failure, responds with SdkError<ProvisionPermissionSetError>

impl Client

pub fn put_inline_policy_to_permission_set( &self ) -> PutInlinePolicyToPermissionSetFluentBuilder

Constructs a fluent builder for the PutInlinePolicyToPermissionSet operation.

• The fluent builder is configurable:
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: true
    

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

    
    
  • permission_set_arn(impl Into<String>) / set_permission_set_arn(Option<String>):
    required: true
    

    The ARN of the permission set.

    
    
  • inline_policy(impl Into<String>) / set_inline_policy(Option<String>):
    required: true
    

    The inline policy to attach to a PermissionSet.

    
    
• On success, responds with PutInlinePolicyToPermissionSetOutput
• On failure, responds with SdkError<PutInlinePolicyToPermissionSetError>

impl Client

pub fn put_permissions_boundary_to_permission_set( &self ) -> PutPermissionsBoundaryToPermissionSetFluentBuilder

Constructs a fluent builder for the PutPermissionsBoundaryToPermissionSet operation.

• The fluent builder is configurable:
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: true
    

    The ARN of the IAM Identity Center instance under which the operation will be executed.

    
    
  • permission_set_arn(impl Into<String>) / set_permission_set_arn(Option<String>):
    required: true
    

    The ARN of the PermissionSet.

    
    
  • permissions_boundary(PermissionsBoundary) / set_permissions_boundary(Option<PermissionsBoundary>):
    required: true
    

    The permissions boundary that you want to attach to a PermissionSet.

    
    
• On success, responds with PutPermissionsBoundaryToPermissionSetOutput
• On failure, responds with SdkError<PutPermissionsBoundaryToPermissionSetError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: true
    

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

    
    
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the resource with the tags to be listed.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    A set of key-value pairs that are used to manage the resource.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: true
    

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

    
    
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the resource with the tags to be listed.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The keys of tags that are attached to the resource.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_instance_access_control_attribute_configuration( &self ) -> UpdateInstanceAccessControlAttributeConfigurationFluentBuilder

Constructs a fluent builder for the UpdateInstanceAccessControlAttributeConfiguration operation.

• The fluent builder is configurable:
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: true
    

    The ARN of the IAM Identity Center instance under which the operation will be executed.

    
    
  • instance_access_control_attribute_configuration(InstanceAccessControlAttributeConfiguration) / set_instance_access_control_attribute_configuration(Option<InstanceAccessControlAttributeConfiguration>):
    required: true
    

    Updates the attributes for your ABAC configuration.

    
    
• On success, responds with UpdateInstanceAccessControlAttributeConfigurationOutput
• On failure, responds with SdkError<UpdateInstanceAccessControlAttributeConfigurationError>

impl Client

pub fn update_permission_set(&self) -> UpdatePermissionSetFluentBuilder

Constructs a fluent builder for the UpdatePermissionSet operation.

• The fluent builder is configurable:
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: true
    

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

    
    
  • permission_set_arn(impl Into<String>) / set_permission_set_arn(Option<String>):
    required: true
    

    The ARN of the permission set.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the PermissionSet.

    
    
  • session_duration(impl Into<String>) / set_session_duration(Option<String>):
    required: false
    

    The length of time that the application user sessions are valid for in the ISO-8601 standard.

    
    
  • relay_state(impl Into<String>) / set_relay_state(Option<String>):
    required: false
    

    Used to redirect users within the application during the federation authentication process.

    
    
• On success, responds with UpdatePermissionSetOutput
• On failure, responds with SdkError<UpdatePermissionSetError>

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.

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.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

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.