Struct aws_sdk_ssoadmin::client::Client

pub struct Client<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* 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.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_ssoadmin::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
    let shared_config = aws_config::load_from_env().await;
    let config = aws_sdk_ssoadmin::config::Builder::from(&shared_config)
        .retry_config(RetryConfig::disabled())
        .build();
    let client = aws_sdk_ssoadmin::Client::from_conf(config);

Implementations

impl<C, M, R> Client<C, M, R>

pub fn with_config(client: Client<C, M, R>, conf: Config) -> Self

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl<C, M, R> Client<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub fn attach_managed_policy_to_permission_set(
    &self
) -> AttachManagedPolicyToPermissionSet<C, M, R>

Constructs a fluent builder for the AttachManagedPolicyToPermissionSet operation.

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

    The ARN of the SSO 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>):

    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>):

    The IAM managed policy ARN to be attached to a permission set.

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

pub fn create_account_assignment(&self) -> CreateAccountAssignment<C, M, R>

Constructs a fluent builder for the CreateAccountAssignment operation.

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

    The ARN of the SSO 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>):

    TargetID is an Amazon Web Services account identifier, typically a 10-12 digit string (For example, 123456789012).

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

    The entity type for which the assignment will be created.

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

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

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

    The entity type for which the assignment will be created.

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

    An identifier for an object in Amazon Web Services SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in Amazon Web Services SSO, see the Amazon Web Services SSO 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>

pub fn create_instance_access_control_attribute_configuration(
    &self
) -> CreateInstanceAccessControlAttributeConfiguration<C, M, R>

Constructs a fluent builder for the CreateInstanceAccessControlAttributeConfiguration operation.

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

    The ARN of the SSO instance under which the operation will be executed.

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

    Specifies the Amazon Web Services SSO 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 Amazon Web Services SSO identity store. If a SAML assertion passes any of these attributes, Amazon Web Services SSO will replace the attribute value with the value from the Amazon Web Services SSO identity store.

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

pub fn create_permission_set(&self) -> CreatePermissionSet<C, M, R>

Constructs a fluent builder for the CreatePermissionSet operation.

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

    The name of the PermissionSet.

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

    The description of the PermissionSet.

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

    The ARN of the SSO 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>):

    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>):

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

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

    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>

pub fn delete_account_assignment(&self) -> DeleteAccountAssignment<C, M, R>

Constructs a fluent builder for the DeleteAccountAssignment operation.

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

    The ARN of the SSO 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>):

    TargetID is an Amazon Web Services account identifier, typically a 10-12 digit string (For example, 123456789012).

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

    The entity type for which the assignment will be deleted.

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

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

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

    The entity type for which the assignment will be deleted.

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

    An identifier for an object in Amazon Web Services SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in Amazon Web Services SSO, see the Amazon Web Services SSO 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>

pub fn delete_inline_policy_from_permission_set(
    &self
) -> DeleteInlinePolicyFromPermissionSet<C, M, R>

Constructs a fluent builder for the DeleteInlinePolicyFromPermissionSet operation.

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

    The ARN of the SSO 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>):

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

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

pub fn delete_instance_access_control_attribute_configuration(
    &self
) -> DeleteInstanceAccessControlAttributeConfiguration<C, M, R>

Constructs a fluent builder for the DeleteInstanceAccessControlAttributeConfiguration operation.

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

    The ARN of the SSO instance under which the operation will be executed.

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

pub fn delete_permission_set(&self) -> DeletePermissionSet<C, M, R>

Constructs a fluent builder for the DeletePermissionSet operation.

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

    The ARN of the SSO 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>):

    The ARN of the permission set that should be deleted.

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

pub fn describe_account_assignment_creation_status(
    &self
) -> DescribeAccountAssignmentCreationStatus<C, M, R>

Constructs a fluent builder for the DescribeAccountAssignmentCreationStatus operation.

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

    The ARN of the SSO 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>):

    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>

pub fn describe_account_assignment_deletion_status(
    &self
) -> DescribeAccountAssignmentDeletionStatus<C, M, R>

Constructs a fluent builder for the DescribeAccountAssignmentDeletionStatus operation.

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

    The ARN of the SSO 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>):

    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>

pub fn describe_instance_access_control_attribute_configuration(
    &self
) -> DescribeInstanceAccessControlAttributeConfiguration<C, M, R>

Constructs a fluent builder for the DescribeInstanceAccessControlAttributeConfiguration operation.

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

    The ARN of the SSO 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 Amazon Web Services SSO identity store attributes that have been added to your ABAC configuration.

• On failure, responds with SdkError<DescribeInstanceAccessControlAttributeConfigurationError>

pub fn describe_permission_set(&self) -> DescribePermissionSet<C, M, R>

Constructs a fluent builder for the DescribePermissionSet operation.

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

    The ARN of the SSO 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>):

    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>

pub fn describe_permission_set_provisioning_status(
    &self
) -> DescribePermissionSetProvisioningStatus<C, M, R>

Constructs a fluent builder for the DescribePermissionSetProvisioningStatus operation.

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

    The ARN of the SSO 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>):

    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>

pub fn detach_managed_policy_from_permission_set(
    &self
) -> DetachManagedPolicyFromPermissionSet<C, M, R>

Constructs a fluent builder for the DetachManagedPolicyFromPermissionSet operation.

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

    The ARN of the SSO 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>):

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

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

    The IAM managed policy ARN to be attached to a permission set.

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

pub fn get_inline_policy_for_permission_set(
    &self
) -> GetInlinePolicyForPermissionSet<C, M, R>

Constructs a fluent builder for the GetInlinePolicyForPermissionSet operation.

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

    The ARN of the SSO 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>):

    The ARN of the permission set.

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

    The IAM inline policy that is attached to the permission set.

• On failure, responds with SdkError<GetInlinePolicyForPermissionSetError>

pub fn list_account_assignment_creation_status(
    &self
) -> ListAccountAssignmentCreationStatus<C, M, R>

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>):

    The ARN of the SSO 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>):

    The maximum number of results to display for the assignment.

  • next_token(impl Into<String>) / 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.

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

    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>

pub fn list_account_assignment_deletion_status(
    &self
) -> ListAccountAssignmentDeletionStatus<C, M, R>

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>):

    The ARN of the SSO 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>):

    The maximum number of results to display for the assignment.

  • next_token(impl Into<String>) / 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.

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

    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>

pub fn list_account_assignments(&self) -> ListAccountAssignments<C, M, R>

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>):

    The ARN of the SSO 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>):

    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>):

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

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

    The maximum number of results to display for the assignment.

  • next_token(impl Into<String>) / 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 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>

pub fn list_accounts_for_provisioned_permission_set(
    &self
) -> ListAccountsForProvisionedPermissionSet<C, M, R>

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>):

    The ARN of the SSO 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>):

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

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

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

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

    The maximum number of results to display for the PermissionSet.

  • next_token(impl Into<String>) / 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 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>

pub fn list_instances(&self) -> ListInstances<C, M, R>

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>):

    The maximum number of results to display for the instance.

  • next_token(impl Into<String>) / 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 success, responds with ListInstancesOutput with field(s):
  • instances(Option<Vec<InstanceMetadata>>):

    Lists the SSO 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>

pub fn list_managed_policies_in_permission_set(
    &self
) -> ListManagedPoliciesInPermissionSet<C, M, R>

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>):

    The ARN of the SSO 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>):

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

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

    The maximum number of results to display for the PermissionSet.

  • next_token(impl Into<String>) / 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 success, responds with ListManagedPoliciesInPermissionSetOutput with field(s):
  • attached_managed_policies(Option<Vec<AttachedManagedPolicy>>):

    The 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>

pub fn list_permission_set_provisioning_status(
    &self
) -> ListPermissionSetProvisioningStatus<C, M, R>

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>):

    The ARN of the SSO 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>):

    The maximum number of results to display for the assignment.

  • next_token(impl Into<String>) / 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.

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

    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>

pub fn list_permission_sets(&self) -> ListPermissionSets<C, M, R>

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>):

    The ARN of the SSO 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>):

    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>):

    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>

pub fn list_permission_sets_provisioned_to_account(
    &self
) -> ListPermissionSetsProvisionedToAccount<C, M, R>

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>):

    The ARN of the SSO 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>):

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

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

    The status object for the permission set provisioning operation.

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

    The maximum number of results to display for the assignment.

  • next_token(impl Into<String>) / 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 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>

pub fn list_tags_for_resource(&self) -> ListTagsForResource<C, M, R>

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>):

    The ARN of the SSO 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>):

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

  • next_token(impl Into<String>) / 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 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>

pub fn provision_permission_set(&self) -> ProvisionPermissionSet<C, M, R>

Constructs a fluent builder for the ProvisionPermissionSet operation.

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

    The ARN of the SSO 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>):

    The ARN of the permission set.

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

    TargetID is an Amazon Web Services account identifier, typically a 10-12 digit string (For example, 123456789012).

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

    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>

pub fn put_inline_policy_to_permission_set(
    &self
) -> PutInlinePolicyToPermissionSet<C, M, R>

Constructs a fluent builder for the PutInlinePolicyToPermissionSet operation.

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

    The ARN of the SSO 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>):

    The ARN of the permission set.

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

    The IAM inline policy to attach to a PermissionSet.

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

pub fn tag_resource(&self) -> TagResource<C, M, R>

Constructs a fluent builder for the TagResource operation.

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

    The ARN of the SSO 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>):

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

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

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

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

pub fn untag_resource(&self) -> UntagResource<C, M, R>

Constructs a fluent builder for the UntagResource operation.

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

    The ARN of the SSO 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>):

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

  • tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):

    The keys of tags that are attached to the resource.

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

pub fn update_instance_access_control_attribute_configuration(
    &self
) -> UpdateInstanceAccessControlAttributeConfiguration<C, M, R>

Constructs a fluent builder for the UpdateInstanceAccessControlAttributeConfiguration operation.

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

    The ARN of the SSO instance under which the operation will be executed.

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

    Updates the attributes for your ABAC configuration.

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

pub fn update_permission_set(&self) -> UpdatePermissionSet<C, M, R>

Constructs a fluent builder for the UpdatePermissionSet operation.

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

    The ARN of the SSO 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>):

    The ARN of the permission set.

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

    The description of the PermissionSet.

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

    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>):

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

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

impl<C> Client<C, DefaultMiddleware, Standard>

pub fn from_conf_conn(conf: Config, conn: C) -> Self

Creates a client with the given service config and connector override.

impl Client<DynConnector, DefaultMiddleware, Standard>

pub fn new(config: &Config) -> Self

Creates a new client from a shared config.

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Trait Implementations

impl<C, M, R> Clone for Client<C, M, R>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for Client<C, M, R>

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

Formats the value using the given formatter.

impl<C, M, R> From<Client<C, M, R>> for Client<C, M, R>

fn from(client: Client<C, M, R>) -> Self

Performs the conversion.