Struct aws_sdk_ssoadmin::client::Client
source · pub struct Client { /* private fields */ }
Expand description
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 values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Builder
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§
source§impl Client
impl Client
sourcepub fn attach_customer_managed_policy_reference_to_permission_set(
&self,
) -> AttachCustomerManagedPolicyReferenceToPermissionSetFluentBuilder
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: trueThe 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: trueThe ARN of the
PermissionSet
.customer_managed_policy_reference(CustomerManagedPolicyReference)
/set_customer_managed_policy_reference(Option<CustomerManagedPolicyReference>)
:
required: trueSpecifies 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>
source§impl Client
impl Client
sourcepub fn attach_managed_policy_to_permission_set(
&self,
) -> AttachManagedPolicyToPermissionSetFluentBuilder
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: trueThe 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: trueThe 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: trueThe Amazon Web Services managed policy ARN to be attached to a permission set.
- On success, responds with
AttachManagedPolicyToPermissionSetOutput
- On failure, responds with
SdkError<AttachManagedPolicyToPermissionSetError>
source§impl Client
impl Client
sourcepub fn create_account_assignment(&self) -> CreateAccountAssignmentFluentBuilder
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: trueThe 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: trueTargetID is an Amazon Web Services account identifier, (For example, 123456789012).
target_type(TargetType)
/set_target_type(Option<TargetType>)
:
required: trueThe entity type for which the assignment will be created.
permission_set_arn(impl Into<String>)
/set_permission_set_arn(Option<String>)
:
required: trueThe ARN of the permission set that the admin wants to grant the principal access to.
principal_type(PrincipalType)
/set_principal_type(Option<PrincipalType>)
:
required: trueThe entity type for which the assignment will be created.
principal_id(impl Into<String>)
/set_principal_id(Option<String>)
:
required: trueAn 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>
source§impl Client
impl Client
sourcepub fn create_application(&self) -> CreateApplicationFluentBuilder
pub fn create_application(&self) -> CreateApplicationFluentBuilder
Constructs a fluent builder for the CreateApplication
operation.
- The fluent builder is configurable:
instance_arn(impl Into<String>)
/set_instance_arn(Option<String>)
:
required: trueThe ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
application_provider_arn(impl Into<String>)
/set_application_provider_arn(Option<String>)
:
required: trueThe ARN of the application provider under which the operation will run.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the .
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the .
portal_options(PortalOptions)
/set_portal_options(Option<PortalOptions>)
:
required: falseA structure that describes the options for the portal associated with an application.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseSpecifies tags to be attached to the application.
status(ApplicationStatus)
/set_status(Option<ApplicationStatus>)
:
required: falseSpecifies whether the application is enabled or disabled.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseSpecifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don’t provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same
ClientToken
, but with different parameters, the retry fails with anIdempotentParameterMismatch
error.
- On success, responds with
CreateApplicationOutput
with field(s):application_arn(Option<String>)
:Specifies the ARN of the application.
- On failure, responds with
SdkError<CreateApplicationError>
source§impl Client
impl Client
sourcepub fn create_application_assignment(
&self,
) -> CreateApplicationAssignmentFluentBuilder
pub fn create_application_assignment( &self, ) -> CreateApplicationAssignmentFluentBuilder
Constructs a fluent builder for the CreateApplicationAssignment
operation.
- The fluent builder is configurable:
application_arn(impl Into<String>)
/set_application_arn(Option<String>)
:
required: trueThe ARN of the application provider under which the operation will run.
principal_id(impl Into<String>)
/set_principal_id(Option<String>)
:
required: trueAn 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.
principal_type(PrincipalType)
/set_principal_type(Option<PrincipalType>)
:
required: trueThe entity type for which the assignment will be created.
- On success, responds with
CreateApplicationAssignmentOutput
- On failure, responds with
SdkError<CreateApplicationAssignmentError>
source§impl Client
impl Client
sourcepub fn create_instance(&self) -> CreateInstanceFluentBuilder
pub fn create_instance(&self) -> CreateInstanceFluentBuilder
Constructs a fluent builder for the CreateInstance
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseThe name of the instance of IAM Identity Center.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseSpecifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don’t provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same
ClientToken
, but with different parameters, the retry fails with anIdempotentParameterMismatch
error.tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseSpecifies tags to be attached to the instance of IAM Identity Center.
- On success, responds with
CreateInstanceOutput
with field(s):instance_arn(Option<String>)
:The ARN of the instance of IAM Identity Center under which the operation will run.
For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
- On failure, responds with
SdkError<CreateInstanceError>
source§impl Client
impl Client
sourcepub fn create_instance_access_control_attribute_configuration(
&self,
) -> CreateInstanceAccessControlAttributeConfigurationFluentBuilder
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: trueThe 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: trueSpecifies 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>
source§impl Client
impl Client
sourcepub fn create_permission_set(&self) -> CreatePermissionSetFluentBuilder
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: trueThe name of the
PermissionSet
.description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the
PermissionSet
.instance_arn(impl Into<String>)
/set_instance_arn(Option<String>)
:
required: trueThe 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: falseThe 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: falseUsed to redirect users within the application during the federation authentication process.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn create_trusted_token_issuer(
&self,
) -> CreateTrustedTokenIssuerFluentBuilder
pub fn create_trusted_token_issuer( &self, ) -> CreateTrustedTokenIssuerFluentBuilder
Constructs a fluent builder for the CreateTrustedTokenIssuer
operation.
- The fluent builder is configurable:
instance_arn(impl Into<String>)
/set_instance_arn(Option<String>)
:
required: trueSpecifies the ARN of the instance of IAM Identity Center to contain the new trusted token issuer configuration.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueSpecifies the name of the new trusted token issuer configuration.
trusted_token_issuer_type(TrustedTokenIssuerType)
/set_trusted_token_issuer_type(Option<TrustedTokenIssuerType>)
:
required: trueSpecifies the type of the new trusted token issuer.
trusted_token_issuer_configuration(TrustedTokenIssuerConfiguration)
/set_trusted_token_issuer_configuration(Option<TrustedTokenIssuerConfiguration>)
:
required: trueSpecifies settings that apply to the new trusted token issuer configuration. The settings that are available depend on what
TrustedTokenIssuerType
you specify.client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseSpecifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..
If you don’t provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same
ClientToken
, but with different parameters, the retry fails with anIdempotentParameterMismatch
error.tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseSpecifies tags to be attached to the new trusted token issuer configuration.
- On success, responds with
CreateTrustedTokenIssuerOutput
with field(s):trusted_token_issuer_arn(Option<String>)
:The ARN of the new trusted token issuer configuration.
- On failure, responds with
SdkError<CreateTrustedTokenIssuerError>
source§impl Client
impl Client
sourcepub fn delete_account_assignment(&self) -> DeleteAccountAssignmentFluentBuilder
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: trueThe 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: trueTargetID is an Amazon Web Services account identifier, (For example, 123456789012).
target_type(TargetType)
/set_target_type(Option<TargetType>)
:
required: trueThe entity type for which the assignment will be deleted.
permission_set_arn(impl Into<String>)
/set_permission_set_arn(Option<String>)
:
required: trueThe ARN of the permission set that will be used to remove access.
principal_type(PrincipalType)
/set_principal_type(Option<PrincipalType>)
:
required: trueThe entity type for which the assignment will be deleted.
principal_id(impl Into<String>)
/set_principal_id(Option<String>)
:
required: trueAn 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>
source§impl Client
impl Client
sourcepub fn delete_application(&self) -> DeleteApplicationFluentBuilder
pub fn delete_application(&self) -> DeleteApplicationFluentBuilder
Constructs a fluent builder for the DeleteApplication
operation.
- The fluent builder is configurable:
application_arn(impl Into<String>)
/set_application_arn(Option<String>)
:
required: trueSpecifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
- On success, responds with
DeleteApplicationOutput
- On failure, responds with
SdkError<DeleteApplicationError>
source§impl Client
impl Client
sourcepub fn delete_application_access_scope(
&self,
) -> DeleteApplicationAccessScopeFluentBuilder
pub fn delete_application_access_scope( &self, ) -> DeleteApplicationAccessScopeFluentBuilder
Constructs a fluent builder for the DeleteApplicationAccessScope
operation.
- The fluent builder is configurable:
application_arn(impl Into<String>)
/set_application_arn(Option<String>)
:
required: trueSpecifies the ARN of the application with the access scope to delete.
scope(impl Into<String>)
/set_scope(Option<String>)
:
required: trueSpecifies the name of the access scope to remove from the application.
- On success, responds with
DeleteApplicationAccessScopeOutput
- On failure, responds with
SdkError<DeleteApplicationAccessScopeError>
source§impl Client
impl Client
sourcepub fn delete_application_assignment(
&self,
) -> DeleteApplicationAssignmentFluentBuilder
pub fn delete_application_assignment( &self, ) -> DeleteApplicationAssignmentFluentBuilder
Constructs a fluent builder for the DeleteApplicationAssignment
operation.
- The fluent builder is configurable:
application_arn(impl Into<String>)
/set_application_arn(Option<String>)
:
required: trueSpecifies the ARN of the application.
principal_id(impl Into<String>)
/set_principal_id(Option<String>)
:
required: trueAn 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.
principal_type(PrincipalType)
/set_principal_type(Option<PrincipalType>)
:
required: trueThe entity type for which the assignment will be deleted.
- On success, responds with
DeleteApplicationAssignmentOutput
- On failure, responds with
SdkError<DeleteApplicationAssignmentError>
source§impl Client
impl Client
sourcepub fn delete_application_authentication_method(
&self,
) -> DeleteApplicationAuthenticationMethodFluentBuilder
pub fn delete_application_authentication_method( &self, ) -> DeleteApplicationAuthenticationMethodFluentBuilder
Constructs a fluent builder for the DeleteApplicationAuthenticationMethod
operation.
- The fluent builder is configurable:
application_arn(impl Into<String>)
/set_application_arn(Option<String>)
:
required: trueSpecifies the ARN of the application with the authentication method to delete.
authentication_method_type(AuthenticationMethodType)
/set_authentication_method_type(Option<AuthenticationMethodType>)
:
required: trueSpecifies the authentication method type to delete from the application.
- On success, responds with
DeleteApplicationAuthenticationMethodOutput
- On failure, responds with
SdkError<DeleteApplicationAuthenticationMethodError>
source§impl Client
impl Client
sourcepub fn delete_application_grant(&self) -> DeleteApplicationGrantFluentBuilder
pub fn delete_application_grant(&self) -> DeleteApplicationGrantFluentBuilder
Constructs a fluent builder for the DeleteApplicationGrant
operation.
- The fluent builder is configurable:
application_arn(impl Into<String>)
/set_application_arn(Option<String>)
:
required: trueSpecifies the ARN of the application with the grant to delete.
grant_type(GrantType)
/set_grant_type(Option<GrantType>)
:
required: trueSpecifies the type of grant to delete from the application.
- On success, responds with
DeleteApplicationGrantOutput
- On failure, responds with
SdkError<DeleteApplicationGrantError>
source§impl Client
impl Client
sourcepub fn delete_inline_policy_from_permission_set(
&self,
) -> DeleteInlinePolicyFromPermissionSetFluentBuilder
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: trueThe 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: trueThe ARN of the permission set that will be used to remove access.
- On success, responds with
DeleteInlinePolicyFromPermissionSetOutput
- On failure, responds with
SdkError<DeleteInlinePolicyFromPermissionSetError>
source§impl Client
impl Client
sourcepub fn delete_instance(&self) -> DeleteInstanceFluentBuilder
pub fn delete_instance(&self) -> DeleteInstanceFluentBuilder
Constructs a fluent builder for the DeleteInstance
operation.
- The fluent builder is configurable:
instance_arn(impl Into<String>)
/set_instance_arn(Option<String>)
:
required: trueThe ARN of the instance of IAM Identity Center under which the operation will run.
- On success, responds with
DeleteInstanceOutput
- On failure, responds with
SdkError<DeleteInstanceError>
source§impl Client
impl Client
sourcepub fn delete_instance_access_control_attribute_configuration(
&self,
) -> DeleteInstanceAccessControlAttributeConfigurationFluentBuilder
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: trueThe 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>
source§impl Client
impl Client
sourcepub fn delete_permission_set(&self) -> DeletePermissionSetFluentBuilder
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: trueThe 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: trueThe ARN of the permission set that should be deleted.
- On success, responds with
DeletePermissionSetOutput
- On failure, responds with
SdkError<DeletePermissionSetError>
source§impl Client
impl Client
sourcepub fn delete_permissions_boundary_from_permission_set(
&self,
) -> DeletePermissionsBoundaryFromPermissionSetFluentBuilder
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: trueThe 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: trueThe ARN of the
PermissionSet
.
- On success, responds with
DeletePermissionsBoundaryFromPermissionSetOutput
- On failure, responds with
SdkError<DeletePermissionsBoundaryFromPermissionSetError>
source§impl Client
impl Client
sourcepub fn delete_trusted_token_issuer(
&self,
) -> DeleteTrustedTokenIssuerFluentBuilder
pub fn delete_trusted_token_issuer( &self, ) -> DeleteTrustedTokenIssuerFluentBuilder
Constructs a fluent builder for the DeleteTrustedTokenIssuer
operation.
- The fluent builder is configurable:
trusted_token_issuer_arn(impl Into<String>)
/set_trusted_token_issuer_arn(Option<String>)
:
required: trueSpecifies the ARN of the trusted token issuer configuration to delete.
- On success, responds with
DeleteTrustedTokenIssuerOutput
- On failure, responds with
SdkError<DeleteTrustedTokenIssuerError>
source§impl Client
impl Client
sourcepub fn describe_account_assignment_creation_status(
&self,
) -> DescribeAccountAssignmentCreationStatusFluentBuilder
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: trueThe 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: trueThe 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>
source§impl Client
impl Client
sourcepub fn describe_account_assignment_deletion_status(
&self,
) -> DescribeAccountAssignmentDeletionStatusFluentBuilder
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: trueThe 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: trueThe 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>
source§impl Client
impl Client
sourcepub fn describe_application(&self) -> DescribeApplicationFluentBuilder
pub fn describe_application(&self) -> DescribeApplicationFluentBuilder
Constructs a fluent builder for the DescribeApplication
operation.
- The fluent builder is configurable:
application_arn(impl Into<String>)
/set_application_arn(Option<String>)
:
required: trueSpecifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
- On success, responds with
DescribeApplicationOutput
with field(s):application_arn(Option<String>)
:Specifies the ARN of the application.
application_provider_arn(Option<String>)
:The ARN of the application provider under which the operation will run.
name(Option<String>)
:The application name.
application_account(Option<String>)
:The account ID.
instance_arn(Option<String>)
:The ARN of the IAM Identity Center application under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
status(Option<ApplicationStatus>)
:Specifies whether the application is enabled or disabled.
portal_options(Option<PortalOptions>)
:A structure that describes the options for the portal associated with an application.
description(Option<String>)
:The description of the .
created_date(Option<DateTime>)
:The date the application was created.
- On failure, responds with
SdkError<DescribeApplicationError>
source§impl Client
impl Client
sourcepub fn describe_application_assignment(
&self,
) -> DescribeApplicationAssignmentFluentBuilder
pub fn describe_application_assignment( &self, ) -> DescribeApplicationAssignmentFluentBuilder
Constructs a fluent builder for the DescribeApplicationAssignment
operation.
- The fluent builder is configurable:
application_arn(impl Into<String>)
/set_application_arn(Option<String>)
:
required: trueSpecifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
principal_id(impl Into<String>)
/set_principal_id(Option<String>)
:
required: trueAn 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.
principal_type(PrincipalType)
/set_principal_type(Option<PrincipalType>)
:
required: trueThe entity type for which the assignment will be created.
- On success, responds with
DescribeApplicationAssignmentOutput
with field(s):principal_type(Option<PrincipalType>)
:The entity type for which the assignment will be created.
principal_id(Option<String>)
: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.
application_arn(Option<String>)
:Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
- On failure, responds with
SdkError<DescribeApplicationAssignmentError>
source§impl Client
impl Client
sourcepub fn describe_application_provider(
&self,
) -> DescribeApplicationProviderFluentBuilder
pub fn describe_application_provider( &self, ) -> DescribeApplicationProviderFluentBuilder
Constructs a fluent builder for the DescribeApplicationProvider
operation.
- The fluent builder is configurable:
application_provider_arn(impl Into<String>)
/set_application_provider_arn(Option<String>)
:
required: trueSpecifies the ARN of the application provider for which you want details.
- On success, responds with
DescribeApplicationProviderOutput
with field(s):application_provider_arn(String)
:The ARN of the application provider.
federation_protocol(Option<FederationProtocol>)
:The protocol used to federate to the application provider.
display_data(Option<DisplayData>)
:A structure with details about the display data for the application provider.
resource_server_config(Option<ResourceServerConfig>)
:A structure with details about the receiving application.
- On failure, responds with
SdkError<DescribeApplicationProviderError>
source§impl Client
impl Client
sourcepub fn describe_instance(&self) -> DescribeInstanceFluentBuilder
pub fn describe_instance(&self) -> DescribeInstanceFluentBuilder
Constructs a fluent builder for the DescribeInstance
operation.
- The fluent builder is configurable:
instance_arn(impl Into<String>)
/set_instance_arn(Option<String>)
:
required: trueThe ARN of the instance of IAM Identity Center under which the operation will run.
- On success, responds with
DescribeInstanceOutput
with field(s):instance_arn(Option<String>)
:The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
identity_store_id(Option<String>)
:The identifier of the identity store that is connected to the instance of IAM Identity Center.
owner_account_id(Option<String>)
:The identifier of the Amazon Web Services account for which the instance was created.
name(Option<String>)
:Specifies the instance name.
created_date(Option<DateTime>)
:The date the instance was created.
status(Option<InstanceStatus>)
:The status of the instance.
- On failure, responds with
SdkError<DescribeInstanceError>
source§impl Client
impl Client
sourcepub fn describe_instance_access_control_attribute_configuration(
&self,
) -> DescribeInstanceAccessControlAttributeConfigurationFluentBuilder
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: trueThe 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>
source§impl Client
impl Client
sourcepub fn describe_permission_set(&self) -> DescribePermissionSetFluentBuilder
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: trueThe 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: trueThe 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>
source§impl Client
impl Client
sourcepub fn describe_permission_set_provisioning_status(
&self,
) -> DescribePermissionSetProvisioningStatusFluentBuilder
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: trueThe 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: trueThe 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>
source§impl Client
impl Client
sourcepub fn describe_trusted_token_issuer(
&self,
) -> DescribeTrustedTokenIssuerFluentBuilder
pub fn describe_trusted_token_issuer( &self, ) -> DescribeTrustedTokenIssuerFluentBuilder
Constructs a fluent builder for the DescribeTrustedTokenIssuer
operation.
- The fluent builder is configurable:
trusted_token_issuer_arn(impl Into<String>)
/set_trusted_token_issuer_arn(Option<String>)
:
required: trueSpecifies the ARN of the trusted token issuer configuration that you want details about.
- On success, responds with
DescribeTrustedTokenIssuerOutput
with field(s):trusted_token_issuer_arn(Option<String>)
:The ARN of the trusted token issuer configuration.
name(Option<String>)
:The name of the trusted token issuer configuration.
trusted_token_issuer_type(Option<TrustedTokenIssuerType>)
:The type of the trusted token issuer.
trusted_token_issuer_configuration(Option<TrustedTokenIssuerConfiguration>)
:A structure the describes the settings that apply of this trusted token issuer.
- On failure, responds with
SdkError<DescribeTrustedTokenIssuerError>
source§impl Client
impl Client
sourcepub fn detach_customer_managed_policy_reference_from_permission_set(
&self,
) -> DetachCustomerManagedPolicyReferenceFromPermissionSetFluentBuilder
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: trueThe 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: trueThe ARN of the
PermissionSet
.customer_managed_policy_reference(CustomerManagedPolicyReference)
/set_customer_managed_policy_reference(Option<CustomerManagedPolicyReference>)
:
required: trueSpecifies 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>
source§impl Client
impl Client
sourcepub fn detach_managed_policy_from_permission_set(
&self,
) -> DetachManagedPolicyFromPermissionSetFluentBuilder
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: trueThe 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: trueThe ARN of the
PermissionSet
from which the policy should be detached.managed_policy_arn(impl Into<String>)
/set_managed_policy_arn(Option<String>)
:
required: trueThe Amazon Web Services managed policy ARN to be detached from a permission set.
- On success, responds with
DetachManagedPolicyFromPermissionSetOutput
- On failure, responds with
SdkError<DetachManagedPolicyFromPermissionSetError>
source§impl Client
impl Client
sourcepub fn get_application_access_scope(
&self,
) -> GetApplicationAccessScopeFluentBuilder
pub fn get_application_access_scope( &self, ) -> GetApplicationAccessScopeFluentBuilder
Constructs a fluent builder for the GetApplicationAccessScope
operation.
- The fluent builder is configurable:
application_arn(impl Into<String>)
/set_application_arn(Option<String>)
:
required: trueSpecifies the ARN of the application with the access scope that you want to retrieve.
scope(impl Into<String>)
/set_scope(Option<String>)
:
required: trueSpecifies the name of the access scope for which you want the authorized targets.
- On success, responds with
GetApplicationAccessScopeOutput
with field(s):scope(String)
:The name of the access scope that can be used with the authorized targets.
authorized_targets(Option<Vec::<String>>)
:An array of authorized targets associated with this access scope.
- On failure, responds with
SdkError<GetApplicationAccessScopeError>
source§impl Client
impl Client
sourcepub fn get_application_assignment_configuration(
&self,
) -> GetApplicationAssignmentConfigurationFluentBuilder
pub fn get_application_assignment_configuration( &self, ) -> GetApplicationAssignmentConfigurationFluentBuilder
Constructs a fluent builder for the GetApplicationAssignmentConfiguration
operation.
- The fluent builder is configurable:
application_arn(impl Into<String>)
/set_application_arn(Option<String>)
:
required: trueSpecifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
- On success, responds with
GetApplicationAssignmentConfigurationOutput
with field(s):assignment_required(bool)
:If
AssignmentsRequired
istrue
(default value), users don’t have access to the application unless an assignment is created using the CreateApplicationAssignment API. Iffalse
, all users have access to the application.
- On failure, responds with
SdkError<GetApplicationAssignmentConfigurationError>
source§impl Client
impl Client
sourcepub fn get_application_authentication_method(
&self,
) -> GetApplicationAuthenticationMethodFluentBuilder
pub fn get_application_authentication_method( &self, ) -> GetApplicationAuthenticationMethodFluentBuilder
Constructs a fluent builder for the GetApplicationAuthenticationMethod
operation.
- The fluent builder is configurable:
application_arn(impl Into<String>)
/set_application_arn(Option<String>)
:
required: trueSpecifies the ARN of the application.
authentication_method_type(AuthenticationMethodType)
/set_authentication_method_type(Option<AuthenticationMethodType>)
:
required: trueSpecifies the type of authentication method for which you want details.
- On success, responds with
GetApplicationAuthenticationMethodOutput
with field(s):authentication_method(Option<AuthenticationMethod>)
:A structure that contains details about the requested authentication method.
- On failure, responds with
SdkError<GetApplicationAuthenticationMethodError>
source§impl Client
impl Client
sourcepub fn get_application_grant(&self) -> GetApplicationGrantFluentBuilder
pub fn get_application_grant(&self) -> GetApplicationGrantFluentBuilder
Constructs a fluent builder for the GetApplicationGrant
operation.
- The fluent builder is configurable:
application_arn(impl Into<String>)
/set_application_arn(Option<String>)
:
required: trueSpecifies the ARN of the application that contains the grant.
grant_type(GrantType)
/set_grant_type(Option<GrantType>)
:
required: trueSpecifies the type of grant.
- On success, responds with
GetApplicationGrantOutput
with field(s):grant(Option<Grant>)
:A structure that describes the requested grant.
- On failure, responds with
SdkError<GetApplicationGrantError>
source§impl Client
impl Client
sourcepub fn get_inline_policy_for_permission_set(
&self,
) -> GetInlinePolicyForPermissionSetFluentBuilder
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: trueThe 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: trueThe 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>
source§impl Client
impl Client
sourcepub fn get_permissions_boundary_for_permission_set(
&self,
) -> GetPermissionsBoundaryForPermissionSetFluentBuilder
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: trueThe 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: trueThe 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>
source§impl Client
impl Client
sourcepub fn list_account_assignment_creation_status(
&self,
) -> ListAccountAssignmentCreationStatusFluentBuilder
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: trueThe 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: falseThe maximum number of results to display for the assignment.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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: falseFilters 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>
source§impl Client
impl Client
sourcepub fn list_account_assignment_deletion_status(
&self,
) -> ListAccountAssignmentDeletionStatusFluentBuilder
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: trueThe 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: falseThe maximum number of results to display for the assignment.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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: falseFilters 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>
source§impl Client
impl Client
sourcepub fn list_account_assignments(&self) -> ListAccountAssignmentsFluentBuilder
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: trueThe 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: trueThe 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: trueThe ARN of the permission set from which to list assignments.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to display for the assignment.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn list_account_assignments_for_principal(
&self,
) -> ListAccountAssignmentsForPrincipalFluentBuilder
pub fn list_account_assignments_for_principal( &self, ) -> ListAccountAssignmentsForPrincipalFluentBuilder
Constructs a fluent builder for the ListAccountAssignmentsForPrincipal
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
instance_arn(impl Into<String>)
/set_instance_arn(Option<String>)
:
required: trueSpecifies the ARN of the instance of IAM Identity Center that contains the principal.
principal_id(impl Into<String>)
/set_principal_id(Option<String>)
:
required: trueSpecifies the principal for which you want to retrieve the list of account assignments.
principal_type(PrincipalType)
/set_principal_type(Option<PrincipalType>)
:
required: trueSpecifies the type of the principal.
filter(ListAccountAssignmentsFilter)
/set_filter(Option<ListAccountAssignmentsFilter>)
:
required: falseSpecifies an Amazon Web Services account ID number. Results are filtered to only those that match this ID number.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseSpecifies that you want to receive the next page of results. Valid only if you received a
NextToken
response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call’sNextToken
response to request the next page of results.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseSpecifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the
NextToken
response element is returned with a value (not null). Include the specified value as theNextToken
request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should checkNextToken
after every operation to ensure that you receive all of the results.
- On success, responds with
ListAccountAssignmentsForPrincipalOutput
with field(s):account_assignments(Option<Vec::<AccountAssignmentForPrincipal>>)
:An array list of the account assignments for the principal.
next_token(Option<String>)
:If present, this value indicates that more output is available than is included in the current response. Use this value in the
NextToken
request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until theNextToken
response element comes back asnull
. This indicates that this is the last page of results.
- On failure, responds with
SdkError<ListAccountAssignmentsForPrincipalError>
source§impl Client
impl Client
sourcepub fn list_accounts_for_provisioned_permission_set(
&self,
) -> ListAccountsForProvisionedPermissionSetFluentBuilder
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: trueThe 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: trueThe ARN of the
PermissionSet
from which the associated Amazon Web Services accounts will be listed.provisioning_status(ProvisioningStatus)
/set_provisioning_status(Option<ProvisioningStatus>)
:
required: falseThe permission set provisioning status for an Amazon Web Services account.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to display for the
PermissionSet
.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn list_application_access_scopes(
&self,
) -> ListApplicationAccessScopesFluentBuilder
pub fn list_application_access_scopes( &self, ) -> ListApplicationAccessScopesFluentBuilder
Constructs a fluent builder for the ListApplicationAccessScopes
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
application_arn(impl Into<String>)
/set_application_arn(Option<String>)
:
required: trueSpecifies the ARN of the application.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseSpecifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the
NextToken
response element is returned with a value (not null). Include the specified value as theNextToken
request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should checkNextToken
after every operation to ensure that you receive all of the results.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseSpecifies that you want to receive the next page of results. Valid only if you received a
NextToken
response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call’sNextToken
response to request the next page of results.
- On success, responds with
ListApplicationAccessScopesOutput
with field(s):scopes(Vec::<ScopeDetails>)
:An array list of access scopes and their authorized targets that are associated with the application.
next_token(Option<String>)
:If present, this value indicates that more output is available than is included in the current response. Use this value in the
NextToken
request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until theNextToken
response element comes back asnull
. This indicates that this is the last page of results.
- On failure, responds with
SdkError<ListApplicationAccessScopesError>
source§impl Client
impl Client
sourcepub fn list_application_assignments(
&self,
) -> ListApplicationAssignmentsFluentBuilder
pub fn list_application_assignments( &self, ) -> ListApplicationAssignmentsFluentBuilder
Constructs a fluent builder for the ListApplicationAssignments
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
application_arn(impl Into<String>)
/set_application_arn(Option<String>)
:
required: trueSpecifies the ARN of the application.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseSpecifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the
NextToken
response element is returned with a value (not null). Include the specified value as theNextToken
request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should checkNextToken
after every operation to ensure that you receive all of the results.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseSpecifies that you want to receive the next page of results. Valid only if you received a
NextToken
response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call’sNextToken
response to request the next page of results.
- On success, responds with
ListApplicationAssignmentsOutput
with field(s):application_assignments(Option<Vec::<ApplicationAssignment>>)
:The list of users assigned to an application.
next_token(Option<String>)
:If present, this value indicates that more output is available than is included in the current response. Use this value in the
NextToken
request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until theNextToken
response element comes back asnull
. This indicates that this is the last page of results.
- On failure, responds with
SdkError<ListApplicationAssignmentsError>
source§impl Client
impl Client
sourcepub fn list_application_assignments_for_principal(
&self,
) -> ListApplicationAssignmentsForPrincipalFluentBuilder
pub fn list_application_assignments_for_principal( &self, ) -> ListApplicationAssignmentsForPrincipalFluentBuilder
Constructs a fluent builder for the ListApplicationAssignmentsForPrincipal
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
instance_arn(impl Into<String>)
/set_instance_arn(Option<String>)
:
required: trueSpecifies the instance of IAM Identity Center that contains principal and applications.
principal_id(impl Into<String>)
/set_principal_id(Option<String>)
:
required: trueSpecifies the unique identifier of the principal for which you want to retrieve its assignments.
principal_type(PrincipalType)
/set_principal_type(Option<PrincipalType>)
:
required: trueSpecifies the type of the principal for which you want to retrieve its assignments.
filter(ListApplicationAssignmentsFilter)
/set_filter(Option<ListApplicationAssignmentsFilter>)
:
required: falseFilters the output to include only assignments associated with the application that has the specified ARN.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseSpecifies that you want to receive the next page of results. Valid only if you received a
NextToken
response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call’sNextToken
response to request the next page of results.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseSpecifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the
NextToken
response element is returned with a value (not null). Include the specified value as theNextToken
request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should checkNextToken
after every operation to ensure that you receive all of the results.
- On success, responds with
ListApplicationAssignmentsForPrincipalOutput
with field(s):application_assignments(Option<Vec::<ApplicationAssignmentForPrincipal>>)
:An array list of the application assignments for the specified principal.
next_token(Option<String>)
:If present, this value indicates that more output is available than is included in the current response. Use this value in the
NextToken
request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until theNextToken
response element comes back asnull
. This indicates that this is the last page of results.
- On failure, responds with
SdkError<ListApplicationAssignmentsForPrincipalError>
source§impl Client
impl Client
sourcepub fn list_application_authentication_methods(
&self,
) -> ListApplicationAuthenticationMethodsFluentBuilder
pub fn list_application_authentication_methods( &self, ) -> ListApplicationAuthenticationMethodsFluentBuilder
Constructs a fluent builder for the ListApplicationAuthenticationMethods
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
application_arn(impl Into<String>)
/set_application_arn(Option<String>)
:
required: trueSpecifies the ARN of the application with the authentication methods you want to list.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseSpecifies that you want to receive the next page of results. Valid only if you received a
NextToken
response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call’sNextToken
response to request the next page of results.
- On success, responds with
ListApplicationAuthenticationMethodsOutput
with field(s):authentication_methods(Option<Vec::<AuthenticationMethodItem>>)
:An array list of authentication methods for the specified application.
next_token(Option<String>)
:If present, this value indicates that more output is available than is included in the current response. Use this value in the
NextToken
request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until theNextToken
response element comes back asnull
. This indicates that this is the last page of results.
- On failure, responds with
SdkError<ListApplicationAuthenticationMethodsError>
source§impl Client
impl Client
sourcepub fn list_application_grants(&self) -> ListApplicationGrantsFluentBuilder
pub fn list_application_grants(&self) -> ListApplicationGrantsFluentBuilder
Constructs a fluent builder for the ListApplicationGrants
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
application_arn(impl Into<String>)
/set_application_arn(Option<String>)
:
required: trueSpecifies the ARN of the application whose grants you want to list.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseSpecifies that you want to receive the next page of results. Valid only if you received a
NextToken
response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call’sNextToken
response to request the next page of results.
- On success, responds with
ListApplicationGrantsOutput
with field(s):grants(Vec::<GrantItem>)
:An array list of structures that describe the requested grants.
next_token(Option<String>)
:If present, this value indicates that more output is available than is included in the current response. Use this value in the
NextToken
request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until theNextToken
response element comes back asnull
. This indicates that this is the last page of results.
- On failure, responds with
SdkError<ListApplicationGrantsError>
source§impl Client
impl Client
sourcepub fn list_application_providers(
&self,
) -> ListApplicationProvidersFluentBuilder
pub fn list_application_providers( &self, ) -> ListApplicationProvidersFluentBuilder
Constructs a fluent builder for the ListApplicationProviders
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseSpecifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the
NextToken
response element is returned with a value (not null). Include the specified value as theNextToken
request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should checkNextToken
after every operation to ensure that you receive all of the results.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseSpecifies that you want to receive the next page of results. Valid only if you received a
NextToken
response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call’sNextToken
response to request the next page of results.
- On success, responds with
ListApplicationProvidersOutput
with field(s):application_providers(Option<Vec::<ApplicationProvider>>)
:An array list of structures that describe application providers.
next_token(Option<String>)
:If present, this value indicates that more output is available than is included in the current response. Use this value in the
NextToken
request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until theNextToken
response element comes back asnull
. This indicates that this is the last page of results.
- On failure, responds with
SdkError<ListApplicationProvidersError>
source§impl Client
impl Client
sourcepub fn list_applications(&self) -> ListApplicationsFluentBuilder
pub fn list_applications(&self) -> ListApplicationsFluentBuilder
Constructs a fluent builder for the ListApplications
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
instance_arn(impl Into<String>)
/set_instance_arn(Option<String>)
:
required: trueThe ARN of the IAM Identity Center application under which the operation will run. 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: falseSpecifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the
NextToken
response element is returned with a value (not null). Include the specified value as theNextToken
request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should checkNextToken
after every operation to ensure that you receive all of the results.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseSpecifies that you want to receive the next page of results. Valid only if you received a
NextToken
response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call’sNextToken
response to request the next page of results.filter(ListApplicationsFilter)
/set_filter(Option<ListApplicationsFilter>)
:
required: falseFilters response results.
- On success, responds with
ListApplicationsOutput
with field(s):applications(Option<Vec::<Application>>)
:Retrieves all applications associated with the instance.
next_token(Option<String>)
:If present, this value indicates that more output is available than is included in the current response. Use this value in the
NextToken
request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until theNextToken
response element comes back asnull
. This indicates that this is the last page of results.
- On failure, responds with
SdkError<ListApplicationsError>
source§impl Client
impl Client
sourcepub fn list_customer_managed_policy_references_in_permission_set(
&self,
) -> ListCustomerManagedPolicyReferencesInPermissionSetFluentBuilder
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: trueThe 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: trueThe ARN of the
PermissionSet
.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to display for the list call.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn list_instances(&self) -> ListInstancesFluentBuilder
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: falseThe maximum number of results to display for the instance.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn list_managed_policies_in_permission_set(
&self,
) -> ListManagedPoliciesInPermissionSetFluentBuilder
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: trueThe 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: trueThe ARN of the
PermissionSet
whose managed policies will be listed.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to display for the
PermissionSet
.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn list_permission_set_provisioning_status(
&self,
) -> ListPermissionSetProvisioningStatusFluentBuilder
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: trueThe 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: falseThe maximum number of results to display for the assignment.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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: falseFilters 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>
source§impl Client
impl Client
sourcepub fn list_permission_sets(&self) -> ListPermissionSetsFluentBuilder
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: trueThe 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: falseThe 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: falseThe 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>
source§impl Client
impl Client
sourcepub fn list_permission_sets_provisioned_to_account(
&self,
) -> ListPermissionSetsProvisionedToAccountFluentBuilder
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: trueThe 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: trueThe identifier of the Amazon Web Services account from which to list the assignments.
provisioning_status(ProvisioningStatus)
/set_provisioning_status(Option<ProvisioningStatus>)
:
required: falseThe status object for the permission set provisioning operation.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to display for the assignment.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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>
source§impl Client
impl Client
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: falseThe 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: trueThe ARN of the resource with the tags to be listed.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn list_trusted_token_issuers(&self) -> ListTrustedTokenIssuersFluentBuilder
pub fn list_trusted_token_issuers(&self) -> ListTrustedTokenIssuersFluentBuilder
Constructs a fluent builder for the ListTrustedTokenIssuers
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
instance_arn(impl Into<String>)
/set_instance_arn(Option<String>)
:
required: trueSpecifies the ARN of the instance of IAM Identity Center with the trusted token issuer configurations that you want to list.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseSpecifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the
NextToken
response element is returned with a value (not null). Include the specified value as theNextToken
request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should checkNextToken
after every operation to ensure that you receive all of the results.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseSpecifies that you want to receive the next page of results. Valid only if you received a
NextToken
response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call’sNextToken
response to request the next page of results.
- On success, responds with
ListTrustedTokenIssuersOutput
with field(s):trusted_token_issuers(Option<Vec::<TrustedTokenIssuerMetadata>>)
:An array list of the trusted token issuer configurations.
next_token(Option<String>)
:If present, this value indicates that more output is available than is included in the current response. Use this value in the
NextToken
request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until theNextToken
response element comes back asnull
. This indicates that this is the last page of results.
- On failure, responds with
SdkError<ListTrustedTokenIssuersError>
source§impl Client
impl Client
sourcepub fn provision_permission_set(&self) -> ProvisionPermissionSetFluentBuilder
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: trueThe 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: trueThe ARN of the permission set.
target_id(impl Into<String>)
/set_target_id(Option<String>)
:
required: falseTargetID is an Amazon Web Services account identifier, (For example, 123456789012).
target_type(ProvisionTargetType)
/set_target_type(Option<ProvisionTargetType>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn put_application_access_scope(
&self,
) -> PutApplicationAccessScopeFluentBuilder
pub fn put_application_access_scope( &self, ) -> PutApplicationAccessScopeFluentBuilder
Constructs a fluent builder for the PutApplicationAccessScope
operation.
- The fluent builder is configurable:
scope(impl Into<String>)
/set_scope(Option<String>)
:
required: trueSpecifies the name of the access scope to be associated with the specified targets.
authorized_targets(impl Into<String>)
/set_authorized_targets(Option<Vec::<String>>)
:
required: falseSpecifies an array list of ARNs that represent the authorized targets for this access scope.
application_arn(impl Into<String>)
/set_application_arn(Option<String>)
:
required: trueSpecifies the ARN of the application with the access scope with the targets to add or update.
- On success, responds with
PutApplicationAccessScopeOutput
- On failure, responds with
SdkError<PutApplicationAccessScopeError>
source§impl Client
impl Client
sourcepub fn put_application_assignment_configuration(
&self,
) -> PutApplicationAssignmentConfigurationFluentBuilder
pub fn put_application_assignment_configuration( &self, ) -> PutApplicationAssignmentConfigurationFluentBuilder
Constructs a fluent builder for the PutApplicationAssignmentConfiguration
operation.
- The fluent builder is configurable:
application_arn(impl Into<String>)
/set_application_arn(Option<String>)
:
required: trueSpecifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
assignment_required(bool)
/set_assignment_required(Option<bool>)
:
required: trueIf
AssignmentsRequired
istrue
(default value), users don’t have access to the application unless an assignment is created using the CreateApplicationAssignment API. Iffalse
, all users have access to the application.
- On success, responds with
PutApplicationAssignmentConfigurationOutput
- On failure, responds with
SdkError<PutApplicationAssignmentConfigurationError>
source§impl Client
impl Client
sourcepub fn put_application_authentication_method(
&self,
) -> PutApplicationAuthenticationMethodFluentBuilder
pub fn put_application_authentication_method( &self, ) -> PutApplicationAuthenticationMethodFluentBuilder
Constructs a fluent builder for the PutApplicationAuthenticationMethod
operation.
- The fluent builder is configurable:
application_arn(impl Into<String>)
/set_application_arn(Option<String>)
:
required: trueSpecifies the ARN of the application with the authentication method to add or update.
authentication_method_type(AuthenticationMethodType)
/set_authentication_method_type(Option<AuthenticationMethodType>)
:
required: trueSpecifies the type of the authentication method that you want to add or update.
authentication_method(AuthenticationMethod)
/set_authentication_method(Option<AuthenticationMethod>)
:
required: trueSpecifies a structure that describes the authentication method to add or update. The structure type you provide is determined by the
AuthenticationMethodType
parameter.
- On success, responds with
PutApplicationAuthenticationMethodOutput
- On failure, responds with
SdkError<PutApplicationAuthenticationMethodError>
source§impl Client
impl Client
sourcepub fn put_application_grant(&self) -> PutApplicationGrantFluentBuilder
pub fn put_application_grant(&self) -> PutApplicationGrantFluentBuilder
Constructs a fluent builder for the PutApplicationGrant
operation.
- The fluent builder is configurable:
application_arn(impl Into<String>)
/set_application_arn(Option<String>)
:
required: trueSpecifies the ARN of the application to update.
grant_type(GrantType)
/set_grant_type(Option<GrantType>)
:
required: trueSpecifies the type of grant to update.
grant(Grant)
/set_grant(Option<Grant>)
:
required: trueSpecifies a structure that describes the grant to update.
- On success, responds with
PutApplicationGrantOutput
- On failure, responds with
SdkError<PutApplicationGrantError>
source§impl Client
impl Client
sourcepub fn put_inline_policy_to_permission_set(
&self,
) -> PutInlinePolicyToPermissionSetFluentBuilder
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: trueThe 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: trueThe ARN of the permission set.
inline_policy(impl Into<String>)
/set_inline_policy(Option<String>)
:
required: trueThe inline policy to attach to a
PermissionSet
.
- On success, responds with
PutInlinePolicyToPermissionSetOutput
- On failure, responds with
SdkError<PutInlinePolicyToPermissionSetError>
source§impl Client
impl Client
sourcepub fn put_permissions_boundary_to_permission_set(
&self,
) -> PutPermissionsBoundaryToPermissionSetFluentBuilder
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: trueThe 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: trueThe ARN of the
PermissionSet
.permissions_boundary(PermissionsBoundary)
/set_permissions_boundary(Option<PermissionsBoundary>)
:
required: trueThe permissions boundary that you want to attach to a
PermissionSet
.
- On success, responds with
PutPermissionsBoundaryToPermissionSetOutput
- On failure, responds with
SdkError<PutPermissionsBoundaryToPermissionSetError>
source§impl Client
impl Client
sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
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: falseThe 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: trueThe ARN of the resource with the tags to be listed.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: trueA set of key-value pairs that are used to manage the resource.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
source§impl Client
impl Client
sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
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: falseThe 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: trueThe ARN of the resource with the tags to be listed.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueThe keys of tags that are attached to the resource.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
source§impl Client
impl Client
sourcepub fn update_application(&self) -> UpdateApplicationFluentBuilder
pub fn update_application(&self) -> UpdateApplicationFluentBuilder
Constructs a fluent builder for the UpdateApplication
operation.
- The fluent builder is configurable:
application_arn(impl Into<String>)
/set_application_arn(Option<String>)
:
required: trueSpecifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseSpecifies the updated name for the application.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the .
status(ApplicationStatus)
/set_status(Option<ApplicationStatus>)
:
required: falseSpecifies whether the application is enabled or disabled.
portal_options(UpdateApplicationPortalOptions)
/set_portal_options(Option<UpdateApplicationPortalOptions>)
:
required: falseA structure that describes the options for the portal associated with an application.
- On success, responds with
UpdateApplicationOutput
- On failure, responds with
SdkError<UpdateApplicationError>
source§impl Client
impl Client
sourcepub fn update_instance(&self) -> UpdateInstanceFluentBuilder
pub fn update_instance(&self) -> UpdateInstanceFluentBuilder
Constructs a fluent builder for the UpdateInstance
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueUpdates the instance name.
instance_arn(impl Into<String>)
/set_instance_arn(Option<String>)
:
required: trueThe ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
- On success, responds with
UpdateInstanceOutput
- On failure, responds with
SdkError<UpdateInstanceError>
source§impl Client
impl Client
sourcepub fn update_instance_access_control_attribute_configuration(
&self,
) -> UpdateInstanceAccessControlAttributeConfigurationFluentBuilder
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: trueThe 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: trueUpdates the attributes for your ABAC configuration.
- On success, responds with
UpdateInstanceAccessControlAttributeConfigurationOutput
- On failure, responds with
SdkError<UpdateInstanceAccessControlAttributeConfigurationError>
source§impl Client
impl Client
sourcepub fn update_permission_set(&self) -> UpdatePermissionSetFluentBuilder
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: trueThe 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: trueThe ARN of the permission set.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the
PermissionSet
.session_duration(impl Into<String>)
/set_session_duration(Option<String>)
:
required: falseThe 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: falseUsed to redirect users within the application during the federation authentication process.
- On success, responds with
UpdatePermissionSetOutput
- On failure, responds with
SdkError<UpdatePermissionSetError>
source§impl Client
impl Client
sourcepub fn update_trusted_token_issuer(
&self,
) -> UpdateTrustedTokenIssuerFluentBuilder
pub fn update_trusted_token_issuer( &self, ) -> UpdateTrustedTokenIssuerFluentBuilder
Constructs a fluent builder for the UpdateTrustedTokenIssuer
operation.
- The fluent builder is configurable:
trusted_token_issuer_arn(impl Into<String>)
/set_trusted_token_issuer_arn(Option<String>)
:
required: trueSpecifies the ARN of the trusted token issuer configuration that you want to update.
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseSpecifies the updated name to be applied to the trusted token issuer configuration.
trusted_token_issuer_configuration(TrustedTokenIssuerUpdateConfiguration)
/set_trusted_token_issuer_configuration(Option<TrustedTokenIssuerUpdateConfiguration>)
:
required: falseSpecifies a structure with settings to apply to the specified trusted token issuer. The settings that you can provide are determined by the type of the trusted token issuer that you are updating.
- On success, responds with
UpdateTrustedTokenIssuerOutput
- On failure, responds with
SdkError<UpdateTrustedTokenIssuerError>
source§impl Client
impl Client
sourcepub fn from_conf(conf: Config) -> Self
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
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
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 thesleep_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 thehttp_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, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
source§fn underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);