Struct Client

Source
pub struct Client { /* private fields */ }
Expand description

Client for AWS Identity and Access Management

Client for invoking operations on AWS Identity and Access Management. Each operation on AWS Identity and Access Management 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_iam::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_iam::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 AddClientIDToOpenIDConnectProvider operation has a Client::add_client_id_to_open_id_connect_provider, 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.add_client_id_to_open_id_connect_provider()
    .open_id_connect_provider_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.

§Waiters

This client provides wait_until methods behind the Waiters trait. To use them, simply import the trait, and then call one of the wait_until methods. This will return a waiter fluent builder that takes various parameters, which are documented on the builder type. Once parameters have been provided, the wait method can be called to initiate waiting.

For example, if there was a wait_until_thing method, it could look like:

let result = client.wait_until_thing()
    .thing_id("someId")
    .wait(Duration::from_secs(120))
    .await;

Implementations§

Source§

impl Client

Source

pub fn add_client_id_to_open_id_connect_provider( &self, ) -> AddClientIDToOpenIDConnectProviderFluentBuilder

Constructs a fluent builder for the AddClientIDToOpenIDConnectProvider operation.

Source§

impl Client

Source

pub fn add_role_to_instance_profile( &self, ) -> AddRoleToInstanceProfileFluentBuilder

Constructs a fluent builder for the AddRoleToInstanceProfile operation.

Source§

impl Client

Source

pub fn add_user_to_group(&self) -> AddUserToGroupFluentBuilder

Constructs a fluent builder for the AddUserToGroup operation.

Source§

impl Client

Source

pub fn attach_group_policy(&self) -> AttachGroupPolicyFluentBuilder

Constructs a fluent builder for the AttachGroupPolicy operation.

Source§

impl Client

Source

pub fn attach_role_policy(&self) -> AttachRolePolicyFluentBuilder

Constructs a fluent builder for the AttachRolePolicy operation.

Source§

impl Client

Source

pub fn attach_user_policy(&self) -> AttachUserPolicyFluentBuilder

Constructs a fluent builder for the AttachUserPolicy operation.

Source§

impl Client

Source

pub fn change_password(&self) -> ChangePasswordFluentBuilder

Constructs a fluent builder for the ChangePassword operation.

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

      The IAM user’s current password.


    • new_password(impl Into<String>) / set_new_password(Option<String>):
      required: true

      The new password. The new password must conform to the Amazon Web Services account’s password policy, if one exists.

      The regex pattern that is used to validate this parameter is a string of characters. That string can include almost any printable ASCII character from the space (\u0020) through the end of the ASCII character range (\u00FF). You can also include the tab (\u0009), line feed (\u000A), and carriage return (\u000D) characters. Any of these characters are valid in a password. However, many tools, such as the Amazon Web Services Management Console, might restrict the ability to type certain characters because they have special meaning within that tool.


  • On success, responds with ChangePasswordOutput
  • On failure, responds with SdkError<ChangePasswordError>
Source§

impl Client

Source

pub fn create_access_key(&self) -> CreateAccessKeyFluentBuilder

Constructs a fluent builder for the CreateAccessKey operation.

Source§

impl Client

Source

pub fn create_account_alias(&self) -> CreateAccountAliasFluentBuilder

Constructs a fluent builder for the CreateAccountAlias operation.

Source§

impl Client

Source

pub fn create_group(&self) -> CreateGroupFluentBuilder

Constructs a fluent builder for the CreateGroup operation.

  • The fluent builder is configurable:
    • path(impl Into<String>) / set_path(Option<String>):
      required: false

      The path to the group. For more information about paths, see IAM identifiers in the IAM User Guide.

      This parameter is optional. If it is not included, it defaults to a slash (/).

      This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.


    • group_name(impl Into<String>) / set_group_name(Option<String>):
      required: true

      The name of the group to create. Do not include the path in this value.

      IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both “MyResource” and “myresource”.


  • On success, responds with CreateGroupOutput with field(s):
  • On failure, responds with SdkError<CreateGroupError>
Source§

impl Client

Source

pub fn create_instance_profile(&self) -> CreateInstanceProfileFluentBuilder

Constructs a fluent builder for the CreateInstanceProfile operation.

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

      The name of the instance profile to create.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • path(impl Into<String>) / set_path(Option<String>):
      required: false

      The path to the instance profile. For more information about paths, see IAM Identifiers in the IAM User Guide.

      This parameter is optional. If it is not included, it defaults to a slash (/).

      This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.


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

      A list of tags that you want to attach to the newly created IAM instance profile. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

      If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.


  • On success, responds with CreateInstanceProfileOutput with field(s):
  • On failure, responds with SdkError<CreateInstanceProfileError>
Source§

impl Client

Source

pub fn create_login_profile(&self) -> CreateLoginProfileFluentBuilder

Constructs a fluent builder for the CreateLoginProfile operation.

  • The fluent builder is configurable:
    • user_name(impl Into<String>) / set_user_name(Option<String>):
      required: false

      The name of the IAM user to create a password for. The user must already exist.

      This parameter is optional. If no user name is included, it defaults to the principal making the request. When you make this request with root user credentials, you must use an AssumeRoot session to omit the user name.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • password(impl Into<String>) / set_password(Option<String>):
      required: false

      The new password for the user.

      This parameter must be omitted when you make the request with an AssumeRoot session. It is required in all other cases.

      The regex pattern that is used to validate this parameter is a string of characters. That string can include almost any printable ASCII character from the space (\u0020) through the end of the ASCII character range (\u00FF). You can also include the tab (\u0009), line feed (\u000A), and carriage return (\u000D) characters. Any of these characters are valid in a password. However, many tools, such as the Amazon Web Services Management Console, might restrict the ability to type certain characters because they have special meaning within that tool.


    • password_reset_required(bool) / set_password_reset_required(Option<bool>):
      required: false

      Specifies whether the user is required to set a new password on next sign-in.


  • On success, responds with CreateLoginProfileOutput with field(s):
  • On failure, responds with SdkError<CreateLoginProfileError>
Source§

impl Client

Source

pub fn create_open_id_connect_provider( &self, ) -> CreateOpenIDConnectProviderFluentBuilder

Constructs a fluent builder for the CreateOpenIDConnectProvider operation.

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

      The URL of the identity provider. The URL must begin with https:// and should correspond to the iss claim in the provider’s OpenID Connect ID tokens. Per the OIDC standard, path components are allowed but query parameters are not. Typically the URL consists of only a hostname, like https://server.example.org or https://example.com. The URL should not contain a port number.

      You cannot register the same provider multiple times in a single Amazon Web Services account. If you try to submit a URL that has already been used for an OpenID Connect provider in the Amazon Web Services account, you will get an error.


    • client_id_list(impl Into<String>) / set_client_id_list(Option<Vec::<String>>):
      required: false

      Provides a list of client IDs, also known as audiences. When a mobile or web app registers with an OpenID Connect provider, they establish a value that identifies the application. This is the value that’s sent as the client_id parameter on OAuth requests.

      You can register multiple client IDs with the same provider. For example, you might have multiple applications that use the same OIDC provider. You cannot register more than 100 client IDs with a single IAM OIDC provider.

      There is no defined format for a client ID. The CreateOpenIDConnectProviderRequest operation accepts client IDs up to 255 characters long.


    • thumbprint_list(impl Into<String>) / set_thumbprint_list(Option<Vec::<String>>):
      required: false

      A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider’s server certificates. Typically this list includes only one entry. However, IAM lets you have up to five thumbprints for an OIDC provider. This lets you maintain multiple thumbprints if the identity provider is rotating certificates.

      This parameter is optional. If it is not included, IAM will retrieve and use the top intermediate certificate authority (CA) thumbprint of the OpenID Connect identity provider server certificate.

      The server certificate thumbprint is the hex-encoded SHA-1 hash value of the X.509 certificate used by the domain where the OpenID Connect provider makes its keys available. It is always a 40-character string.

      For example, assume that the OIDC provider is server.example.com and the provider stores its keys at https://keys.server.example.com/openid-connect. In that case, the thumbprint string would be the hex-encoded SHA-1 hash value of the certificate used by https://keys.server.example.com.

      For more information about obtaining the OIDC provider thumbprint, see Obtaining the thumbprint for an OpenID Connect provider in the IAM user Guide.


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

      A list of tags that you want to attach to the new IAM OpenID Connect (OIDC) provider. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

      If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.


  • On success, responds with CreateOpenIdConnectProviderOutput with field(s):
  • On failure, responds with SdkError<CreateOpenIDConnectProviderError>
Source§

impl Client

Source

pub fn create_policy(&self) -> CreatePolicyFluentBuilder

Constructs a fluent builder for the CreatePolicy operation.

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

      The friendly name of the policy.

      IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both “MyResource” and “myresource”.


    • path(impl Into<String>) / set_path(Option<String>):
      required: false

      The path for the policy.

      For more information about paths, see IAM identifiers in the IAM User Guide.

      This parameter is optional. If it is not included, it defaults to a slash (/).

      This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

      You cannot use an asterisk (*) in the path name.


    • policy_document(impl Into<String>) / set_policy_document(Option<String>):
      required: true

      The JSON policy document that you want to use as the content for the new policy.

      You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

      The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

      To learn more about JSON policy grammar, see Grammar of the IAM JSON policy language in the IAM User Guide.

      The regex pattern used to validate this parameter is a string of characters consisting of the following:

      • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range

      • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

      • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)


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

      A friendly description of the policy.

      Typically used to store information about the permissions defined in the policy. For example, “Grants access to production DynamoDB tables.”

      The policy description is immutable. After a value is assigned, it cannot be changed.


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

      A list of tags that you want to attach to the new IAM customer managed policy. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

      If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.


  • On success, responds with CreatePolicyOutput with field(s):
  • On failure, responds with SdkError<CreatePolicyError>
Source§

impl Client

Source

pub fn create_policy_version(&self) -> CreatePolicyVersionFluentBuilder

Constructs a fluent builder for the CreatePolicyVersion operation.

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

      The Amazon Resource Name (ARN) of the IAM policy to which you want to add a new version.

      For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.


    • policy_document(impl Into<String>) / set_policy_document(Option<String>):
      required: true

      The JSON policy document that you want to use as the content for this new version of the policy.

      You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

      The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

      The regex pattern used to validate this parameter is a string of characters consisting of the following:

      • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range

      • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

      • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)


    • set_as_default(bool) / set_set_as_default(Option<bool>):
      required: false

      Specifies whether to set this version as the policy’s default version.

      When this parameter is true, the new policy version becomes the operative version. That is, it becomes the version that is in effect for the IAM users, groups, and roles that the policy is attached to.

      For more information about managed policy versions, see Versioning for managed policies in the IAM User Guide.


  • On success, responds with CreatePolicyVersionOutput with field(s):
  • On failure, responds with SdkError<CreatePolicyVersionError>
Source§

impl Client

Source

pub fn create_role(&self) -> CreateRoleFluentBuilder

Constructs a fluent builder for the CreateRole operation.

  • The fluent builder is configurable:
    • path(impl Into<String>) / set_path(Option<String>):
      required: false

      The path to the role. For more information about paths, see IAM Identifiers in the IAM User Guide.

      This parameter is optional. If it is not included, it defaults to a slash (/).

      This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.


    • role_name(impl Into<String>) / set_role_name(Option<String>):
      required: true

      The name of the role to create.

      IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both “MyResource” and “myresource”.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • assume_role_policy_document(impl Into<String>) / set_assume_role_policy_document(Option<String>):
      required: true

      The trust relationship policy document that grants an entity permission to assume the role.

      In IAM, you must provide a JSON policy that has been converted to a string. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

      The regex pattern used to validate this parameter is a string of characters consisting of the following:

      • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range

      • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

      • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

      Upon success, the response includes the same trust policy in JSON format.


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

      A description of the role.


    • max_session_duration(i32) / set_max_session_duration(Option<i32>):
      required: false

      The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours.

      Anyone who assumes the role from the CLI or API can use the DurationSeconds API parameter or the duration-seconds CLI parameter to request a longer session. The MaxSessionDuration setting determines the maximum duration that can be requested using the DurationSeconds parameter. If users don’t specify a value for the DurationSeconds parameter, their security credentials are valid for one hour by default. This applies when you use the AssumeRole* API operations or the assume-role* CLI operations but does not apply when you use those operations to create a console URL. For more information, see Using IAM roles in the IAM User Guide.


    • permissions_boundary(impl Into<String>) / set_permissions_boundary(Option<String>):
      required: false

      The ARN of the managed policy that is used to set the permissions boundary for the role.

      A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide.

      For more information about policy types, see Policy types in the IAM User Guide.


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

      A list of tags that you want to attach to the new role. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

      If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.


  • On success, responds with CreateRoleOutput with field(s):
  • On failure, responds with SdkError<CreateRoleError>
Source§

impl Client

Source

pub fn create_saml_provider(&self) -> CreateSAMLProviderFluentBuilder

Constructs a fluent builder for the CreateSAMLProvider operation.

Source§

impl Client

Source

pub fn create_service_linked_role(&self) -> CreateServiceLinkedRoleFluentBuilder

Constructs a fluent builder for the CreateServiceLinkedRole operation.

Source§

impl Client

Source

pub fn create_service_specific_credential( &self, ) -> CreateServiceSpecificCredentialFluentBuilder

Constructs a fluent builder for the CreateServiceSpecificCredential operation.

Source§

impl Client

Source

pub fn create_user(&self) -> CreateUserFluentBuilder

Constructs a fluent builder for the CreateUser operation.

  • The fluent builder is configurable:
    • path(impl Into<String>) / set_path(Option<String>):
      required: false

      The path for the user name. For more information about paths, see IAM identifiers in the IAM User Guide.

      This parameter is optional. If it is not included, it defaults to a slash (/).

      This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.


    • user_name(impl Into<String>) / set_user_name(Option<String>):
      required: true

      The name of the user to create.

      IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both “MyResource” and “myresource”.


    • permissions_boundary(impl Into<String>) / set_permissions_boundary(Option<String>):
      required: false

      The ARN of the managed policy that is used to set the permissions boundary for the user.

      A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide.

      For more information about policy types, see Policy types in the IAM User Guide.


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

      A list of tags that you want to attach to the new user. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

      If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.


  • On success, responds with CreateUserOutput with field(s):
  • On failure, responds with SdkError<CreateUserError>
Source§

impl Client

Source

pub fn create_virtual_mfa_device(&self) -> CreateVirtualMFADeviceFluentBuilder

Constructs a fluent builder for the CreateVirtualMFADevice operation.

  • The fluent builder is configurable:
    • path(impl Into<String>) / set_path(Option<String>):
      required: false

      The path for the virtual MFA device. For more information about paths, see IAM identifiers in the IAM User Guide.

      This parameter is optional. If it is not included, it defaults to a slash (/).

      This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.


    • virtual_mfa_device_name(impl Into<String>) / set_virtual_mfa_device_name(Option<String>):
      required: true

      The name of the virtual MFA device, which must be unique. Use with path to uniquely identify a virtual MFA device.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


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

      A list of tags that you want to attach to the new IAM virtual MFA device. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

      If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.


  • On success, responds with CreateVirtualMfaDeviceOutput with field(s):
  • On failure, responds with SdkError<CreateVirtualMFADeviceError>
Source§

impl Client

Source

pub fn deactivate_mfa_device(&self) -> DeactivateMFADeviceFluentBuilder

Constructs a fluent builder for the DeactivateMFADevice operation.

  • The fluent builder is configurable:
    • user_name(impl Into<String>) / set_user_name(Option<String>):
      required: false

      The name of the user whose MFA device you want to deactivate.

      This parameter is optional. If no user name is included, it defaults to the principal making the request. When you make this request with root user credentials, you must use an AssumeRoot session to omit the user name.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • serial_number(impl Into<String>) / set_serial_number(Option<String>):
      required: true

      The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@:/-


  • On success, responds with DeactivateMfaDeviceOutput
  • On failure, responds with SdkError<DeactivateMFADeviceError>
Source§

impl Client

Source

pub fn delete_access_key(&self) -> DeleteAccessKeyFluentBuilder

Constructs a fluent builder for the DeleteAccessKey operation.

Source§

impl Client

Source

pub fn delete_account_alias(&self) -> DeleteAccountAliasFluentBuilder

Constructs a fluent builder for the DeleteAccountAlias operation.

Source§

impl Client

Source

pub fn delete_account_password_policy( &self, ) -> DeleteAccountPasswordPolicyFluentBuilder

Constructs a fluent builder for the DeleteAccountPasswordPolicy operation.

Source§

impl Client

Source

pub fn delete_group(&self) -> DeleteGroupFluentBuilder

Constructs a fluent builder for the DeleteGroup operation.

Source§

impl Client

Source

pub fn delete_group_policy(&self) -> DeleteGroupPolicyFluentBuilder

Constructs a fluent builder for the DeleteGroupPolicy operation.

Source§

impl Client

Source

pub fn delete_instance_profile(&self) -> DeleteInstanceProfileFluentBuilder

Constructs a fluent builder for the DeleteInstanceProfile operation.

Source§

impl Client

Source

pub fn delete_login_profile(&self) -> DeleteLoginProfileFluentBuilder

Constructs a fluent builder for the DeleteLoginProfile operation.

  • The fluent builder is configurable:
    • user_name(impl Into<String>) / set_user_name(Option<String>):
      required: false

      The name of the user whose password you want to delete.

      This parameter is optional. If no user name is included, it defaults to the principal making the request. When you make this request with root user credentials, you must use an AssumeRoot session to omit the user name.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


  • On success, responds with DeleteLoginProfileOutput
  • On failure, responds with SdkError<DeleteLoginProfileError>
Source§

impl Client

Source

pub fn delete_open_id_connect_provider( &self, ) -> DeleteOpenIDConnectProviderFluentBuilder

Constructs a fluent builder for the DeleteOpenIDConnectProvider operation.

Source§

impl Client

Source

pub fn delete_policy(&self) -> DeletePolicyFluentBuilder

Constructs a fluent builder for the DeletePolicy operation.

Source§

impl Client

Source

pub fn delete_policy_version(&self) -> DeletePolicyVersionFluentBuilder

Constructs a fluent builder for the DeletePolicyVersion operation.

Source§

impl Client

Source

pub fn delete_role(&self) -> DeleteRoleFluentBuilder

Constructs a fluent builder for the DeleteRole operation.

Source§

impl Client

Source

pub fn delete_role_permissions_boundary( &self, ) -> DeleteRolePermissionsBoundaryFluentBuilder

Constructs a fluent builder for the DeleteRolePermissionsBoundary operation.

Source§

impl Client

Source

pub fn delete_role_policy(&self) -> DeleteRolePolicyFluentBuilder

Constructs a fluent builder for the DeleteRolePolicy operation.

Source§

impl Client

Source

pub fn delete_saml_provider(&self) -> DeleteSAMLProviderFluentBuilder

Constructs a fluent builder for the DeleteSAMLProvider operation.

Source§

impl Client

Source

pub fn delete_server_certificate(&self) -> DeleteServerCertificateFluentBuilder

Constructs a fluent builder for the DeleteServerCertificate operation.

Source§

impl Client

Source

pub fn delete_service_linked_role(&self) -> DeleteServiceLinkedRoleFluentBuilder

Constructs a fluent builder for the DeleteServiceLinkedRole operation.

Source§

impl Client

Source

pub fn delete_service_specific_credential( &self, ) -> DeleteServiceSpecificCredentialFluentBuilder

Constructs a fluent builder for the DeleteServiceSpecificCredential operation.

Source§

impl Client

Source

pub fn delete_signing_certificate( &self, ) -> DeleteSigningCertificateFluentBuilder

Constructs a fluent builder for the DeleteSigningCertificate operation.

Source§

impl Client

Source

pub fn delete_ssh_public_key(&self) -> DeleteSSHPublicKeyFluentBuilder

Constructs a fluent builder for the DeleteSSHPublicKey operation.

Source§

impl Client

Source

pub fn delete_user(&self) -> DeleteUserFluentBuilder

Constructs a fluent builder for the DeleteUser operation.

Source§

impl Client

Source

pub fn delete_user_permissions_boundary( &self, ) -> DeleteUserPermissionsBoundaryFluentBuilder

Constructs a fluent builder for the DeleteUserPermissionsBoundary operation.

Source§

impl Client

Source

pub fn delete_user_policy(&self) -> DeleteUserPolicyFluentBuilder

Constructs a fluent builder for the DeleteUserPolicy operation.

Source§

impl Client

Source

pub fn delete_virtual_mfa_device(&self) -> DeleteVirtualMFADeviceFluentBuilder

Constructs a fluent builder for the DeleteVirtualMFADevice operation.

Source§

impl Client

Source

pub fn detach_group_policy(&self) -> DetachGroupPolicyFluentBuilder

Constructs a fluent builder for the DetachGroupPolicy operation.

Source§

impl Client

Source

pub fn detach_role_policy(&self) -> DetachRolePolicyFluentBuilder

Constructs a fluent builder for the DetachRolePolicy operation.

Source§

impl Client

Source

pub fn detach_user_policy(&self) -> DetachUserPolicyFluentBuilder

Constructs a fluent builder for the DetachUserPolicy operation.

Source§

impl Client

Source

pub fn disable_organizations_root_credentials_management( &self, ) -> DisableOrganizationsRootCredentialsManagementFluentBuilder

Constructs a fluent builder for the DisableOrganizationsRootCredentialsManagement operation.

Source§

impl Client

Source

pub fn disable_organizations_root_sessions( &self, ) -> DisableOrganizationsRootSessionsFluentBuilder

Constructs a fluent builder for the DisableOrganizationsRootSessions operation.

Source§

impl Client

Source

pub fn enable_mfa_device(&self) -> EnableMFADeviceFluentBuilder

Constructs a fluent builder for the EnableMFADevice operation.

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

      The name of the IAM user for whom you want to enable the MFA device.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • serial_number(impl Into<String>) / set_serial_number(Option<String>):
      required: true

      The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@:/-


    • authentication_code1(impl Into<String>) / set_authentication_code1(Option<String>):
      required: true

      An authentication code emitted by the device.

      The format for this parameter is a string of six digits.

      Submit your request immediately after generating the authentication codes. If you generate the codes and then wait too long to submit the request, the MFA device successfully associates with the user but the MFA device becomes out of sync. This happens because time-based one-time passwords (TOTP) expire after a short period of time. If this happens, you can resync the device.


    • authentication_code2(impl Into<String>) / set_authentication_code2(Option<String>):
      required: true

      A subsequent authentication code emitted by the device.

      The format for this parameter is a string of six digits.

      Submit your request immediately after generating the authentication codes. If you generate the codes and then wait too long to submit the request, the MFA device successfully associates with the user but the MFA device becomes out of sync. This happens because time-based one-time passwords (TOTP) expire after a short period of time. If this happens, you can resync the device.


  • On success, responds with EnableMfaDeviceOutput
  • On failure, responds with SdkError<EnableMFADeviceError>
Source§

impl Client

Source

pub fn enable_organizations_root_credentials_management( &self, ) -> EnableOrganizationsRootCredentialsManagementFluentBuilder

Constructs a fluent builder for the EnableOrganizationsRootCredentialsManagement operation.

Source§

impl Client

Source

pub fn enable_organizations_root_sessions( &self, ) -> EnableOrganizationsRootSessionsFluentBuilder

Constructs a fluent builder for the EnableOrganizationsRootSessions operation.

Source§

impl Client

Source

pub fn generate_credential_report( &self, ) -> GenerateCredentialReportFluentBuilder

Constructs a fluent builder for the GenerateCredentialReport operation.

Source§

impl Client

Source

pub fn generate_organizations_access_report( &self, ) -> GenerateOrganizationsAccessReportFluentBuilder

Constructs a fluent builder for the GenerateOrganizationsAccessReport operation.

Source§

impl Client

Source

pub fn generate_service_last_accessed_details( &self, ) -> GenerateServiceLastAccessedDetailsFluentBuilder

Constructs a fluent builder for the GenerateServiceLastAccessedDetails operation.

Source§

impl Client

Source

pub fn get_access_key_last_used(&self) -> GetAccessKeyLastUsedFluentBuilder

Constructs a fluent builder for the GetAccessKeyLastUsed operation.

Source§

impl Client

Source

pub fn get_account_authorization_details( &self, ) -> GetAccountAuthorizationDetailsFluentBuilder

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

  • The fluent builder is configurable:
    • filter(EntityType) / set_filter(Option<Vec::<EntityType>>):
      required: false

      A list of entity types used to filter the results. Only the entities that match the types you specify are included in the output. Use the value LocalManagedPolicy to include customer managed policies.

      The format for this parameter is a comma-separated (if more than one) list of strings. Each string value in the list must be one of the valid values listed below.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

      If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.


  • On success, responds with GetAccountAuthorizationDetailsOutput with field(s):
  • On failure, responds with SdkError<GetAccountAuthorizationDetailsError>
Source§

impl Client

Source

pub fn get_account_password_policy( &self, ) -> GetAccountPasswordPolicyFluentBuilder

Constructs a fluent builder for the GetAccountPasswordPolicy operation.

Source§

impl Client

Source

pub fn get_account_summary(&self) -> GetAccountSummaryFluentBuilder

Constructs a fluent builder for the GetAccountSummary operation.

Source§

impl Client

Source

pub fn get_context_keys_for_custom_policy( &self, ) -> GetContextKeysForCustomPolicyFluentBuilder

Constructs a fluent builder for the GetContextKeysForCustomPolicy operation.

Source§

impl Client

Source

pub fn get_context_keys_for_principal_policy( &self, ) -> GetContextKeysForPrincipalPolicyFluentBuilder

Constructs a fluent builder for the GetContextKeysForPrincipalPolicy operation.

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

      The ARN of a user, group, or role whose policies contain the context keys that you want listed. If you specify a user, the list includes context keys that are found in all policies that are attached to the user. The list also includes all groups that the user is a member of. If you pick a group or a role, then it includes only those context keys that are found in policies attached to that entity. Note that all parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as a part of a real HTML request.

      For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.


    • policy_input_list(impl Into<String>) / set_policy_input_list(Option<Vec::<String>>):
      required: false

      An optional list of additional policies for which you want the list of context keys that are referenced.

      The regex pattern used to validate this parameter is a string of characters consisting of the following:

      • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range

      • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

      • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)


  • On success, responds with GetContextKeysForPrincipalPolicyOutput with field(s):
  • On failure, responds with SdkError<GetContextKeysForPrincipalPolicyError>
Source§

impl Client

Source

pub fn get_credential_report(&self) -> GetCredentialReportFluentBuilder

Constructs a fluent builder for the GetCredentialReport operation.

Source§

impl Client

Source

pub fn get_group(&self) -> GetGroupFluentBuilder

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

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

      The name of the group.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

      If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.


  • On success, responds with GetGroupOutput with field(s):
    • group(Option<Group>):

      A structure that contains details about the group.

    • users(Vec::<User>):

      A list of users in the group.

    • is_truncated(bool):

      A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

    • marker(Option<String>):

      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • On failure, responds with SdkError<GetGroupError>
Source§

impl Client

Source

pub fn get_group_policy(&self) -> GetGroupPolicyFluentBuilder

Constructs a fluent builder for the GetGroupPolicy operation.

Source§

impl Client

Source

pub fn get_instance_profile(&self) -> GetInstanceProfileFluentBuilder

Constructs a fluent builder for the GetInstanceProfile operation.

Source§

impl Client

Source

pub fn get_login_profile(&self) -> GetLoginProfileFluentBuilder

Constructs a fluent builder for the GetLoginProfile operation.

  • The fluent builder is configurable:
    • user_name(impl Into<String>) / set_user_name(Option<String>):
      required: false

      The name of the user whose login profile you want to retrieve.

      This parameter is optional. If no user name is included, it defaults to the principal making the request. When you make this request with root user credentials, you must use an AssumeRoot session to omit the user name.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


  • On success, responds with GetLoginProfileOutput with field(s):
  • On failure, responds with SdkError<GetLoginProfileError>
Source§

impl Client

Source

pub fn get_mfa_device(&self) -> GetMFADeviceFluentBuilder

Constructs a fluent builder for the GetMFADevice operation.

Source§

impl Client

Source

pub fn get_open_id_connect_provider( &self, ) -> GetOpenIDConnectProviderFluentBuilder

Constructs a fluent builder for the GetOpenIDConnectProvider operation.

Source§

impl Client

Source

pub fn get_organizations_access_report( &self, ) -> GetOrganizationsAccessReportFluentBuilder

Constructs a fluent builder for the GetOrganizationsAccessReport operation.

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

      The identifier of the request generated by the GenerateOrganizationsAccessReport operation.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

      If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.


    • sort_key(SortKeyType) / set_sort_key(Option<SortKeyType>):
      required: false

      The key that is used to sort the results. If you choose the namespace key, the results are returned in alphabetical order. If you choose the time key, the results are sorted numerically by the date and time.


  • On success, responds with GetOrganizationsAccessReportOutput with field(s):
  • On failure, responds with SdkError<GetOrganizationsAccessReportError>
Source§

impl Client

Source

pub fn get_policy(&self) -> GetPolicyFluentBuilder

Constructs a fluent builder for the GetPolicy operation.

Source§

impl Client

Source

pub fn get_policy_version(&self) -> GetPolicyVersionFluentBuilder

Constructs a fluent builder for the GetPolicyVersion operation.

Source§

impl Client

Source

pub fn get_role(&self) -> GetRoleFluentBuilder

Constructs a fluent builder for the GetRole operation.

Source§

impl Client

Source

pub fn get_role_policy(&self) -> GetRolePolicyFluentBuilder

Constructs a fluent builder for the GetRolePolicy operation.

Source§

impl Client

Source

pub fn get_saml_provider(&self) -> GetSAMLProviderFluentBuilder

Constructs a fluent builder for the GetSAMLProvider operation.

Source§

impl Client

Source

pub fn get_server_certificate(&self) -> GetServerCertificateFluentBuilder

Constructs a fluent builder for the GetServerCertificate operation.

Source§

impl Client

Source

pub fn get_service_last_accessed_details( &self, ) -> GetServiceLastAccessedDetailsFluentBuilder

Constructs a fluent builder for the GetServiceLastAccessedDetails operation.

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

      The ID of the request generated by the GenerateServiceLastAccessedDetails operation. The JobId returned by GenerateServiceLastAccessedDetail must be used by the same role within a session, or by the same user when used to call GetServiceLastAccessedDetail.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

      If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.


  • On success, responds with GetServiceLastAccessedDetailsOutput with field(s):
    • job_status(JobStatusType):

      The status of the job.

    • job_type(Option<AccessAdvisorUsageGranularityType>):

      The type of job. Service jobs return information about when each service was last accessed. Action jobs also include information about when tracked actions within the service were last accessed.

    • job_creation_date(DateTime):

      The date and time, in ISO 8601 date-time format, when the report job was created.

    • services_last_accessed(Vec::<ServiceLastAccessed>):

      ServiceLastAccessed object that contains details about the most recent attempt to access the service.

    • job_completion_date(DateTime):

      The date and time, in ISO 8601 date-time format, when the generated report job was completed or failed.

      This field is null if the job is still in progress, as indicated by a job status value of IN_PROGRESS.

    • is_truncated(bool):

      A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

    • marker(Option<String>):

      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

    • error(Option<ErrorDetails>):

      An object that contains details about the reason the operation failed.

  • On failure, responds with SdkError<GetServiceLastAccessedDetailsError>
Source§

impl Client

Source

pub fn get_service_last_accessed_details_with_entities( &self, ) -> GetServiceLastAccessedDetailsWithEntitiesFluentBuilder

Constructs a fluent builder for the GetServiceLastAccessedDetailsWithEntities operation.

Source§

impl Client

Source

pub fn get_service_linked_role_deletion_status( &self, ) -> GetServiceLinkedRoleDeletionStatusFluentBuilder

Constructs a fluent builder for the GetServiceLinkedRoleDeletionStatus operation.

Source§

impl Client

Source

pub fn get_ssh_public_key(&self) -> GetSSHPublicKeyFluentBuilder

Constructs a fluent builder for the GetSSHPublicKey operation.

Source§

impl Client

Source

pub fn get_user(&self) -> GetUserFluentBuilder

Constructs a fluent builder for the GetUser operation.

  • The fluent builder is configurable:
    • user_name(impl Into<String>) / set_user_name(Option<String>):
      required: false

      The name of the user to get information about.

      This parameter is optional. If it is not included, it defaults to the user making the request. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


  • On success, responds with GetUserOutput with field(s):
    • user(Option<User>):

      A structure containing details about the IAM user.

      Due to a service issue, password last used data does not include password use from May 3, 2018 22:50 PDT to May 23, 2018 14:08 PDT. This affects last sign-in dates shown in the IAM console and password last used dates in the IAM credential report, and returned by this operation. If users signed in during the affected time, the password last used date that is returned is the date the user last signed in before May 3, 2018. For users that signed in after May 23, 2018 14:08 PDT, the returned password last used date is accurate.

      You can use password last used information to identify unused credentials for deletion. For example, you might delete users who did not sign in to Amazon Web Services in the last 90 days. In cases like this, we recommend that you adjust your evaluation window to include dates after May 23, 2018. Alternatively, if your users use access keys to access Amazon Web Services programmatically you can refer to access key last used information because it is accurate for all dates.

  • On failure, responds with SdkError<GetUserError>
Source§

impl Client

Source

pub fn get_user_policy(&self) -> GetUserPolicyFluentBuilder

Constructs a fluent builder for the GetUserPolicy operation.

Source§

impl Client

Source

pub fn list_access_keys(&self) -> ListAccessKeysFluentBuilder

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

  • The fluent builder is configurable:
    • user_name(impl Into<String>) / set_user_name(Option<String>):
      required: false

      The name of the user.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

      If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.


  • On success, responds with ListAccessKeysOutput with field(s):
    • access_key_metadata(Vec::<AccessKeyMetadata>):

      A list of objects containing metadata about the access keys.

    • is_truncated(bool):

      A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

    • marker(Option<String>):

      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • On failure, responds with SdkError<ListAccessKeysError>
Source§

impl Client

Source

pub fn list_account_aliases(&self) -> ListAccountAliasesFluentBuilder

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

  • The fluent builder is configurable:
    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

      If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.


  • On success, responds with ListAccountAliasesOutput with field(s):
    • account_aliases(Vec::<String>):

      A list of aliases associated with the account. Amazon Web Services supports only one alias per account.

    • is_truncated(bool):

      A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

    • marker(Option<String>):

      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • On failure, responds with SdkError<ListAccountAliasesError>
Source§

impl Client

Source

pub fn list_attached_group_policies( &self, ) -> ListAttachedGroupPoliciesFluentBuilder

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

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

      The name (friendly name, not ARN) of the group to list attached policies for.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • path_prefix(impl Into<String>) / set_path_prefix(Option<String>):
      required: false

      The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.

      This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

      If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.


  • On success, responds with ListAttachedGroupPoliciesOutput with field(s):
    • attached_policies(Option<Vec::<AttachedPolicy>>):

      A list of the attached policies.

    • is_truncated(bool):

      A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

    • marker(Option<String>):

      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • On failure, responds with SdkError<ListAttachedGroupPoliciesError>
Source§

impl Client

Source

pub fn list_attached_role_policies( &self, ) -> ListAttachedRolePoliciesFluentBuilder

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

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

      The name (friendly name, not ARN) of the role to list attached policies for.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • path_prefix(impl Into<String>) / set_path_prefix(Option<String>):
      required: false

      The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.

      This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

      If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.


  • On success, responds with ListAttachedRolePoliciesOutput with field(s):
    • attached_policies(Option<Vec::<AttachedPolicy>>):

      A list of the attached policies.

    • is_truncated(bool):

      A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

    • marker(Option<String>):

      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • On failure, responds with SdkError<ListAttachedRolePoliciesError>
Source§

impl Client

Source

pub fn list_attached_user_policies( &self, ) -> ListAttachedUserPoliciesFluentBuilder

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

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

      The name (friendly name, not ARN) of the user to list attached policies for.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • path_prefix(impl Into<String>) / set_path_prefix(Option<String>):
      required: false

      The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.

      This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

      If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.


  • On success, responds with ListAttachedUserPoliciesOutput with field(s):
    • attached_policies(Option<Vec::<AttachedPolicy>>):

      A list of the attached policies.

    • is_truncated(bool):

      A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

    • marker(Option<String>):

      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • On failure, responds with SdkError<ListAttachedUserPoliciesError>
Source§

impl Client

Source

pub fn list_entities_for_policy(&self) -> ListEntitiesForPolicyFluentBuilder

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

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

      The Amazon Resource Name (ARN) of the IAM policy for which you want the versions.

      For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.


    • entity_filter(EntityType) / set_entity_filter(Option<EntityType>):
      required: false

      The entity type to use for filtering the results.

      For example, when EntityFilter is Role, only the roles that are attached to the specified policy are returned. This parameter is optional. If it is not included, all attached entities (users, groups, and roles) are returned. The argument for this parameter must be one of the valid values listed below.


    • path_prefix(impl Into<String>) / set_path_prefix(Option<String>):
      required: false

      The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all entities.

      This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.


    • policy_usage_filter(PolicyUsageType) / set_policy_usage_filter(Option<PolicyUsageType>):
      required: false

      The policy usage method to use for filtering the results.

      To list only permissions policies, set PolicyUsageFilter to PermissionsPolicy. To list only the policies used to set permissions boundaries, set the value to PermissionsBoundary.

      This parameter is optional. If it is not included, all policies are returned.


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

      If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.


  • On success, responds with ListEntitiesForPolicyOutput with field(s):
    • policy_groups(Option<Vec::<PolicyGroup>>):

      A list of IAM groups that the policy is attached to.

    • policy_users(Option<Vec::<PolicyUser>>):

      A list of IAM users that the policy is attached to.

    • policy_roles(Option<Vec::<PolicyRole>>):

      A list of IAM roles that the policy is attached to.

    • is_truncated(bool):

      A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

    • marker(Option<String>):

      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • On failure, responds with SdkError<ListEntitiesForPolicyError>
Source§

impl Client

Source

pub fn list_group_policies(&self) -> ListGroupPoliciesFluentBuilder

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

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

      The name of the group to list policies for.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

      If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.


  • On success, responds with ListGroupPoliciesOutput with field(s):
    • policy_names(Vec::<String>):

      A list of policy names.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

    • is_truncated(bool):

      A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

    • marker(Option<String>):

      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • On failure, responds with SdkError<ListGroupPoliciesError>
Source§

impl Client

Source

pub fn list_groups(&self) -> ListGroupsFluentBuilder

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

  • The fluent builder is configurable:
    • path_prefix(impl Into<String>) / set_path_prefix(Option<String>):
      required: false

      The path prefix for filtering the results. For example, the prefix /division_abc/subdivision_xyz/ gets all groups whose path starts with /division_abc/subdivision_xyz/.

      This parameter is optional. If it is not included, it defaults to a slash (/), listing all groups. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

      If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.


  • On success, responds with ListGroupsOutput with field(s):
    • groups(Vec::<Group>):

      A list of groups.

    • is_truncated(bool):

      A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

    • marker(Option<String>):

      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • On failure, responds with SdkError<ListGroupsError>
Source§

impl Client

Source

pub fn list_groups_for_user(&self) -> ListGroupsForUserFluentBuilder

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

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

      The name of the user to list groups for.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

      If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.


  • On success, responds with ListGroupsForUserOutput with field(s):
    • groups(Vec::<Group>):

      A list of groups.

    • is_truncated(bool):

      A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

    • marker(Option<String>):

      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • On failure, responds with SdkError<ListGroupsForUserError>
Source§

impl Client

Source

pub fn list_instance_profile_tags(&self) -> ListInstanceProfileTagsFluentBuilder

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

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

      The name of the IAM instance profile whose tags you want to see.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

      If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.


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

      The list of tags that are currently attached to the IAM instance profile. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

    • is_truncated(bool):

      A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

    • marker(Option<String>):

      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • On failure, responds with SdkError<ListInstanceProfileTagsError>
Source§

impl Client

Source

pub fn list_instance_profiles(&self) -> ListInstanceProfilesFluentBuilder

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

  • The fluent builder is configurable:
    • path_prefix(impl Into<String>) / set_path_prefix(Option<String>):
      required: false

      The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/ gets all instance profiles whose path starts with /application_abc/component_xyz/.

      This parameter is optional. If it is not included, it defaults to a slash (/), listing all instance profiles. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

      If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.


  • On success, responds with ListInstanceProfilesOutput with field(s):
    • instance_profiles(Vec::<InstanceProfile>):

      A list of instance profiles.

    • is_truncated(bool):

      A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

    • marker(Option<String>):

      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • On failure, responds with SdkError<ListInstanceProfilesError>
Source§

impl Client

Source

pub fn list_instance_profiles_for_role( &self, ) -> ListInstanceProfilesForRoleFluentBuilder

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

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

      The name of the role to list instance profiles for.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

      If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.


  • On success, responds with ListInstanceProfilesForRoleOutput with field(s):
    • instance_profiles(Vec::<InstanceProfile>):

      A list of instance profiles.

    • is_truncated(bool):

      A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

    • marker(Option<String>):

      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • On failure, responds with SdkError<ListInstanceProfilesForRoleError>
Source§

impl Client

Source

pub fn list_mfa_device_tags(&self) -> ListMFADeviceTagsFluentBuilder

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

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

      The unique identifier for the IAM virtual MFA device whose tags you want to see. For virtual MFA devices, the serial number is the same as the ARN.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

      If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.


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

      The list of tags that are currently attached to the virtual MFA device. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

    • is_truncated(bool):

      A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

    • marker(Option<String>):

      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • On failure, responds with SdkError<ListMFADeviceTagsError>
Source§

impl Client

Source

pub fn list_mfa_devices(&self) -> ListMFADevicesFluentBuilder

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

  • The fluent builder is configurable:
    • user_name(impl Into<String>) / set_user_name(Option<String>):
      required: false

      The name of the user whose MFA devices you want to list.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

      If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.


  • On success, responds with ListMfaDevicesOutput with field(s):
    • mfa_devices(Vec::<MfaDevice>):

      A list of MFA devices.

    • is_truncated(bool):

      A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

    • marker(Option<String>):

      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • On failure, responds with SdkError<ListMFADevicesError>
Source§

impl Client

Source

pub fn list_open_id_connect_provider_tags( &self, ) -> ListOpenIDConnectProviderTagsFluentBuilder

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

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

      The ARN of the OpenID Connect (OIDC) identity provider whose tags you want to see.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

      If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.


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

      The list of tags that are currently attached to the OpenID Connect (OIDC) identity provider. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

    • is_truncated(bool):

      A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

    • marker(Option<String>):

      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • On failure, responds with SdkError<ListOpenIDConnectProviderTagsError>
Source§

impl Client

Source

pub fn list_open_id_connect_providers( &self, ) -> ListOpenIDConnectProvidersFluentBuilder

Constructs a fluent builder for the ListOpenIDConnectProviders operation.

Source§

impl Client

Source

pub fn list_organizations_features( &self, ) -> ListOrganizationsFeaturesFluentBuilder

Constructs a fluent builder for the ListOrganizationsFeatures operation.

Source§

impl Client

Source

pub fn list_policies(&self) -> ListPoliciesFluentBuilder

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

  • The fluent builder is configurable:
    • scope(PolicyScopeType) / set_scope(Option<PolicyScopeType>):
      required: false

      The scope to use for filtering the results.

      To list only Amazon Web Services managed policies, set Scope to AWS. To list only the customer managed policies in your Amazon Web Services account, set Scope to Local.

      This parameter is optional. If it is not included, or if it is set to All, all policies are returned.


    • only_attached(bool) / set_only_attached(Option<bool>):
      required: false

      A flag to filter the results to only the attached policies.

      When OnlyAttached is true, the returned list contains only the policies that are attached to an IAM user, group, or role. When OnlyAttached is false, or when the parameter is not included, all policies are returned.


    • path_prefix(impl Into<String>) / set_path_prefix(Option<String>):
      required: false

      The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.


    • policy_usage_filter(PolicyUsageType) / set_policy_usage_filter(Option<PolicyUsageType>):
      required: false

      The policy usage method to use for filtering the results.

      To list only permissions policies, set PolicyUsageFilter to PermissionsPolicy. To list only the policies used to set permissions boundaries, set the value to PermissionsBoundary.

      This parameter is optional. If it is not included, all policies are returned.


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

      If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.


  • On success, responds with ListPoliciesOutput with field(s):
    • policies(Option<Vec::<Policy>>):

      A list of policies.

    • is_truncated(bool):

      A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

    • marker(Option<String>):

      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • On failure, responds with SdkError<ListPoliciesError>
Source§

impl Client

Source

pub fn list_policies_granting_service_access( &self, ) -> ListPoliciesGrantingServiceAccessFluentBuilder

Constructs a fluent builder for the ListPoliciesGrantingServiceAccess operation.

Source§

impl Client

Source

pub fn list_policy_tags(&self) -> ListPolicyTagsFluentBuilder

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

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

      The ARN of the IAM customer managed policy whose tags you want to see.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

      If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.


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

      The list of tags that are currently attached to the IAM customer managed policy. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

    • is_truncated(bool):

      A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

    • marker(Option<String>):

      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • On failure, responds with SdkError<ListPolicyTagsError>
Source§

impl Client

Source

pub fn list_policy_versions(&self) -> ListPolicyVersionsFluentBuilder

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

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

      The Amazon Resource Name (ARN) of the IAM policy for which you want the versions.

      For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

      If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.


  • On success, responds with ListPolicyVersionsOutput with field(s):
    • versions(Option<Vec::<PolicyVersion>>):

      A list of policy versions.

      For more information about managed policy versions, see Versioning for managed policies in the IAM User Guide.

    • is_truncated(bool):

      A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

    • marker(Option<String>):

      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • On failure, responds with SdkError<ListPolicyVersionsError>
Source§

impl Client

Source

pub fn list_role_policies(&self) -> ListRolePoliciesFluentBuilder

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

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

      The name of the role to list policies for.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

      If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.


  • On success, responds with ListRolePoliciesOutput with field(s):
    • policy_names(Vec::<String>):

      A list of policy names.

    • is_truncated(bool):

      A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

    • marker(Option<String>):

      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • On failure, responds with SdkError<ListRolePoliciesError>
Source§

impl Client

Source

pub fn list_role_tags(&self) -> ListRoleTagsFluentBuilder

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

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

      The name of the IAM role for which you want to see the list of tags.

      This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

      If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.


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

      The list of tags that are currently attached to the role. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

    • is_truncated(bool):

      A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

    • marker(Option<String>):

      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • On failure, responds with SdkError<ListRoleTagsError>
Source§

impl Client

Source

pub fn list_roles(&self) -> ListRolesFluentBuilder

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

  • The fluent builder is configurable:
    • path_prefix(impl Into<String>) / set_path_prefix(Option<String>):
      required: false

      The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/ gets all roles whose path starts with /application_abc/component_xyz/.

      This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

      If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.


  • On success, responds with ListRolesOutput with field(s):
    • roles(Vec::<Role>):

      A list of roles.

    • is_truncated(bool):

      A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

    • marker(Option<String>):

      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • On failure, responds with SdkError<ListRolesError>
Source§

impl Client

Source

pub fn list_saml_provider_tags(&self) -> ListSAMLProviderTagsFluentBuilder

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

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

      The ARN of the Security Assertion Markup Language (SAML) identity provider whose tags you want to see.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

      If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.


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

      The list of tags that are currently attached to the Security Assertion Markup Language (SAML) identity provider. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

    • is_truncated(bool):

      A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

    • marker(Option<String>):

      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • On failure, responds with SdkError<ListSAMLProviderTagsError>
Source§

impl Client

Source

pub fn list_saml_providers(&self) -> ListSAMLProvidersFluentBuilder

Constructs a fluent builder for the ListSAMLProviders operation.

Source§

impl Client

Source

pub fn list_server_certificate_tags( &self, ) -> ListServerCertificateTagsFluentBuilder

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

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

      The name of the IAM server certificate whose tags you want to see.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

      If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.


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

      The list of tags that are currently attached to the IAM server certificate. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

    • is_truncated(bool):

      A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

    • marker(Option<String>):

      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • On failure, responds with SdkError<ListServerCertificateTagsError>
Source§

impl Client

Source

pub fn list_server_certificates(&self) -> ListServerCertificatesFluentBuilder

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

  • The fluent builder is configurable:
    • path_prefix(impl Into<String>) / set_path_prefix(Option<String>):
      required: false

      The path prefix for filtering the results. For example: /company/servercerts would get all server certificates for which the path starts with /company/servercerts.

      This parameter is optional. If it is not included, it defaults to a slash (/), listing all server certificates. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

      If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.


  • On success, responds with ListServerCertificatesOutput with field(s):
    • server_certificate_metadata_list(Vec::<ServerCertificateMetadata>):

      A list of server certificates.

    • is_truncated(bool):

      A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

    • marker(Option<String>):

      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • On failure, responds with SdkError<ListServerCertificatesError>
Source§

impl Client

Source

pub fn list_service_specific_credentials( &self, ) -> ListServiceSpecificCredentialsFluentBuilder

Constructs a fluent builder for the ListServiceSpecificCredentials operation.

Source§

impl Client

Source

pub fn list_signing_certificates(&self) -> ListSigningCertificatesFluentBuilder

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

  • The fluent builder is configurable:
    • user_name(impl Into<String>) / set_user_name(Option<String>):
      required: false

      The name of the IAM user whose signing certificates you want to examine.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

      If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.


  • On success, responds with ListSigningCertificatesOutput with field(s):
    • certificates(Vec::<SigningCertificate>):

      A list of the user’s signing certificate information.

    • is_truncated(bool):

      A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

    • marker(Option<String>):

      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • On failure, responds with SdkError<ListSigningCertificatesError>
Source§

impl Client

Source

pub fn list_ssh_public_keys(&self) -> ListSSHPublicKeysFluentBuilder

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

  • The fluent builder is configurable:
    • user_name(impl Into<String>) / set_user_name(Option<String>):
      required: false

      The name of the IAM user to list SSH public keys for. If none is specified, the UserName field is determined implicitly based on the Amazon Web Services access key used to sign the request.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

      If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.


  • On success, responds with ListSshPublicKeysOutput with field(s):
    • ssh_public_keys(Option<Vec::<SshPublicKeyMetadata>>):

      A list of the SSH public keys assigned to IAM user.

    • is_truncated(bool):

      A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

    • marker(Option<String>):

      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • On failure, responds with SdkError<ListSSHPublicKeysError>
Source§

impl Client

Source

pub fn list_user_policies(&self) -> ListUserPoliciesFluentBuilder

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

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

      The name of the user to list policies for.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

      If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.


  • On success, responds with ListUserPoliciesOutput with field(s):
    • policy_names(Vec::<String>):

      A list of policy names.

    • is_truncated(bool):

      A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

    • marker(Option<String>):

      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • On failure, responds with SdkError<ListUserPoliciesError>
Source§

impl Client

Source

pub fn list_user_tags(&self) -> ListUserTagsFluentBuilder

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

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

      The name of the IAM user whose tags you want to see.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

      If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.


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

      The list of tags that are currently attached to the user. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

    • is_truncated(bool):

      A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

    • marker(Option<String>):

      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • On failure, responds with SdkError<ListUserTagsError>
Source§

impl Client

Source

pub fn list_users(&self) -> ListUsersFluentBuilder

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

  • The fluent builder is configurable:
    • path_prefix(impl Into<String>) / set_path_prefix(Option<String>):
      required: false

      The path prefix for filtering the results. For example: /division_abc/subdivision_xyz/, which would get all user names whose path starts with /division_abc/subdivision_xyz/.

      This parameter is optional. If it is not included, it defaults to a slash (/), listing all user names. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

      If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.


  • On success, responds with ListUsersOutput with field(s):
    • users(Vec::<User>):

      A list of users.

    • is_truncated(bool):

      A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

    • marker(Option<String>):

      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • On failure, responds with SdkError<ListUsersError>
Source§

impl Client

Source

pub fn list_virtual_mfa_devices(&self) -> ListVirtualMFADevicesFluentBuilder

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

  • The fluent builder is configurable:
    • assignment_status(AssignmentStatusType) / set_assignment_status(Option<AssignmentStatusType>):
      required: false

      The status (Unassigned or Assigned) of the devices to list. If you do not specify an AssignmentStatus, the operation defaults to Any, which lists both assigned and unassigned virtual MFA devices.,


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

      If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.


  • On success, responds with ListVirtualMfaDevicesOutput with field(s):
    • virtual_mfa_devices(Vec::<VirtualMfaDevice>):

      The list of virtual MFA devices in the current account that match the AssignmentStatus value that was passed in the request.

    • is_truncated(bool):

      A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

    • marker(Option<String>):

      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • On failure, responds with SdkError<ListVirtualMFADevicesError>
Source§

impl Client

Source

pub fn put_group_policy(&self) -> PutGroupPolicyFluentBuilder

Constructs a fluent builder for the PutGroupPolicy operation.

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

      The name of the group to associate the policy with.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-.


    • policy_name(impl Into<String>) / set_policy_name(Option<String>):
      required: true

      The name of the policy document.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • policy_document(impl Into<String>) / set_policy_document(Option<String>):
      required: true

      The policy document.

      You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

      The regex pattern used to validate this parameter is a string of characters consisting of the following:

      • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range

      • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

      • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)


  • On success, responds with PutGroupPolicyOutput
  • On failure, responds with SdkError<PutGroupPolicyError>
Source§

impl Client

Source

pub fn put_role_permissions_boundary( &self, ) -> PutRolePermissionsBoundaryFluentBuilder

Constructs a fluent builder for the PutRolePermissionsBoundary operation.

Source§

impl Client

Source

pub fn put_role_policy(&self) -> PutRolePolicyFluentBuilder

Constructs a fluent builder for the PutRolePolicy operation.

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

      The name of the role to associate the policy with.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • policy_name(impl Into<String>) / set_policy_name(Option<String>):
      required: true

      The name of the policy document.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • policy_document(impl Into<String>) / set_policy_document(Option<String>):
      required: true

      The policy document.

      You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

      The regex pattern used to validate this parameter is a string of characters consisting of the following:

      • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range

      • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

      • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)


  • On success, responds with PutRolePolicyOutput
  • On failure, responds with SdkError<PutRolePolicyError>
Source§

impl Client

Source

pub fn put_user_permissions_boundary( &self, ) -> PutUserPermissionsBoundaryFluentBuilder

Constructs a fluent builder for the PutUserPermissionsBoundary operation.

Source§

impl Client

Source

pub fn put_user_policy(&self) -> PutUserPolicyFluentBuilder

Constructs a fluent builder for the PutUserPolicy operation.

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

      The name of the user to associate the policy with.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • policy_name(impl Into<String>) / set_policy_name(Option<String>):
      required: true

      The name of the policy document.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • policy_document(impl Into<String>) / set_policy_document(Option<String>):
      required: true

      The policy document.

      You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

      The regex pattern used to validate this parameter is a string of characters consisting of the following:

      • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range

      • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

      • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)


  • On success, responds with PutUserPolicyOutput
  • On failure, responds with SdkError<PutUserPolicyError>
Source§

impl Client

Source

pub fn remove_client_id_from_open_id_connect_provider( &self, ) -> RemoveClientIDFromOpenIDConnectProviderFluentBuilder

Constructs a fluent builder for the RemoveClientIDFromOpenIDConnectProvider operation.

Source§

impl Client

Source

pub fn remove_role_from_instance_profile( &self, ) -> RemoveRoleFromInstanceProfileFluentBuilder

Constructs a fluent builder for the RemoveRoleFromInstanceProfile operation.

Source§

impl Client

Source

pub fn remove_user_from_group(&self) -> RemoveUserFromGroupFluentBuilder

Constructs a fluent builder for the RemoveUserFromGroup operation.

Source§

impl Client

Source

pub fn reset_service_specific_credential( &self, ) -> ResetServiceSpecificCredentialFluentBuilder

Constructs a fluent builder for the ResetServiceSpecificCredential operation.

Source§

impl Client

Source

pub fn resync_mfa_device(&self) -> ResyncMFADeviceFluentBuilder

Constructs a fluent builder for the ResyncMFADevice operation.

Source§

impl Client

Source

pub fn set_default_policy_version(&self) -> SetDefaultPolicyVersionFluentBuilder

Constructs a fluent builder for the SetDefaultPolicyVersion operation.

Source§

impl Client

Source

pub fn set_security_token_service_preferences( &self, ) -> SetSecurityTokenServicePreferencesFluentBuilder

Constructs a fluent builder for the SetSecurityTokenServicePreferences operation.

Source§

impl Client

Source

pub fn simulate_custom_policy(&self) -> SimulateCustomPolicyFluentBuilder

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

  • The fluent builder is configurable:
    • policy_input_list(impl Into<String>) / set_policy_input_list(Option<Vec::<String>>):
      required: true

      A list of policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy. Do not include any resource-based policies in this parameter. Any resource-based policy must be submitted with the ResourcePolicy parameter. The policies cannot be “scope-down” policies, such as you could include in a call to GetFederationToken or one of the AssumeRole API operations. In other words, do not use policies designed to restrict what a user can do while using the temporary credentials.

      The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

      The regex pattern used to validate this parameter is a string of characters consisting of the following:

      • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range

      • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

      • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)


    • permissions_boundary_policy_input_list(impl Into<String>) / set_permissions_boundary_policy_input_list(Option<Vec::<String>>):
      required: false

      The IAM permissions boundary policy to simulate. The permissions boundary sets the maximum permissions that an IAM entity can have. You can input only one permissions boundary when you pass a policy to this operation. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. The policy input is specified as a string that contains the complete, valid JSON text of a permissions boundary policy.

      The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

      The regex pattern used to validate this parameter is a string of characters consisting of the following:

      • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range

      • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

      • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)


    • action_names(impl Into<String>) / set_action_names(Option<Vec::<String>>):
      required: true

      A list of names of API operations to evaluate in the simulation. Each operation is evaluated against each resource. Each operation must include the service identifier, such as iam:CreateUser. This operation does not support using wildcards (*) in an action name.


    • resource_arns(impl Into<String>) / set_resource_arns(Option<Vec::<String>>):
      required: false

      A list of ARNs of Amazon Web Services resources to include in the simulation. If this parameter is not provided, then the value defaults to * (all resources). Each API in the ActionNames parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response. You can simulate resources that don’t exist in your account.

      The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the ResourcePolicy parameter.

      If you include a ResourcePolicy, then it must be applicable to all of the resources included in the simulation or you receive an invalid input error.

      For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

      Simulation of resource-based policies isn’t supported for IAM roles.


    • resource_policy(impl Into<String>) / set_resource_policy(Option<String>):
      required: false

      A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.

      The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

      The regex pattern used to validate this parameter is a string of characters consisting of the following:

      • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range

      • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

      • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

      Simulation of resource-based policies isn’t supported for IAM roles.


    • resource_owner(impl Into<String>) / set_resource_owner(Option<String>):
      required: false

      An ARN representing the Amazon Web Services account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN. Examples of resource ARNs include an S3 bucket or object. If ResourceOwner is specified, it is also used as the account owner of any ResourcePolicy included in the simulation. If the ResourceOwner parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided in CallerArn. This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling user CallerArn.

      The ARN for an account uses the following syntax: arn:aws:iam::AWS-account-ID:root. For example, to represent the account with the 112233445566 ID, use the following ARN: arn:aws:iam::112233445566-ID:root.


    • caller_arn(impl Into<String>) / set_caller_arn(Option<String>):
      required: false

      The ARN of the IAM user that you want to use as the simulated caller of the API operations. CallerArn is required if you include a ResourcePolicy so that the policy’s Principal element has a value to use in evaluating the policy.

      You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal.


    • context_entries(ContextEntry) / set_context_entries(Option<Vec::<ContextEntry>>):
      required: false

      A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permissions policies, the corresponding value is supplied.


    • resource_handling_option(impl Into<String>) / set_resource_handling_option(Option<String>):
      required: false

      Specifies the type of simulation to run. Different API operations that support resource-based policies require different combinations of resources. By specifying the type of simulation to run, you enable the policy simulator to enforce the presence of the required resources to ensure reliable simulation results. If your simulation does not match one of the following scenarios, then you can omit this parameter. The following list shows each of the supported scenario values and the resources that you must define to run the simulation.

      Each of the Amazon EC2 scenarios requires that you specify instance, image, and security group resources. If your scenario includes an EBS volume, then you must specify that volume as a resource. If the Amazon EC2 scenario includes VPC, then you must supply the network interface resource. If it includes an IP subnet, then you must specify the subnet resource. For more information on the Amazon EC2 scenario options, see Supported platforms in the Amazon EC2 User Guide.

      • EC2-VPC-InstanceStore

        instance, image, security group, network interface

      • EC2-VPC-InstanceStore-Subnet

        instance, image, security group, network interface, subnet

      • EC2-VPC-EBS

        instance, image, security group, network interface, volume

      • EC2-VPC-EBS-Subnet

        instance, image, security group, network interface, subnet, volume


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

      If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.


  • On success, responds with SimulateCustomPolicyOutput with field(s):
    • evaluation_results(Option<Vec::<EvaluationResult>>):

      The results of the simulation.

    • is_truncated(bool):

      A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

    • marker(Option<String>):

      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • On failure, responds with SdkError<SimulateCustomPolicyError>
Source§

impl Client

Source

pub fn simulate_principal_policy(&self) -> SimulatePrincipalPolicyFluentBuilder

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

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

      The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to include in the simulation. If you specify a user, group, or role, the simulation includes all policies that are associated with that entity. If you specify a user, the simulation also includes all policies that are attached to any groups the user belongs to.

      The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

      For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.


    • policy_input_list(impl Into<String>) / set_policy_input_list(Option<Vec::<String>>):
      required: false

      An optional list of additional policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.

      The regex pattern used to validate this parameter is a string of characters consisting of the following:

      • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range

      • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

      • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)


    • permissions_boundary_policy_input_list(impl Into<String>) / set_permissions_boundary_policy_input_list(Option<Vec::<String>>):
      required: false

      The IAM permissions boundary policy to simulate. The permissions boundary sets the maximum permissions that the entity can have. You can input only one permissions boundary when you pass a policy to this operation. An IAM entity can only have one permissions boundary in effect at a time. For example, if a permissions boundary is attached to an entity and you pass in a different permissions boundary policy using this parameter, then the new permissions boundary policy is used for the simulation. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. The policy input is specified as a string containing the complete, valid JSON text of a permissions boundary policy.

      The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

      The regex pattern used to validate this parameter is a string of characters consisting of the following:

      • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range

      • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

      • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)


    • action_names(impl Into<String>) / set_action_names(Option<Vec::<String>>):
      required: true

      A list of names of API operations to evaluate in the simulation. Each operation is evaluated for each resource. Each operation must include the service identifier, such as iam:CreateUser.


    • resource_arns(impl Into<String>) / set_resource_arns(Option<Vec::<String>>):
      required: false

      A list of ARNs of Amazon Web Services resources to include in the simulation. If this parameter is not provided, then the value defaults to * (all resources). Each API in the ActionNames parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response. You can simulate resources that don’t exist in your account.

      The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the ResourcePolicy parameter.

      For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

      Simulation of resource-based policies isn’t supported for IAM roles.


    • resource_policy(impl Into<String>) / set_resource_policy(Option<String>):
      required: false

      A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.

      The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

      The regex pattern used to validate this parameter is a string of characters consisting of the following:

      • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range

      • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

      • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

      Simulation of resource-based policies isn’t supported for IAM roles.


    • resource_owner(impl Into<String>) / set_resource_owner(Option<String>):
      required: false

      An Amazon Web Services account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN. Examples of resource ARNs include an S3 bucket or object. If ResourceOwner is specified, it is also used as the account owner of any ResourcePolicy included in the simulation. If the ResourceOwner parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided in CallerArn. This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling user CallerArn.


    • caller_arn(impl Into<String>) / set_caller_arn(Option<String>):
      required: false

      The ARN of the IAM user that you want to specify as the simulated caller of the API operations. If you do not specify a CallerArn, it defaults to the ARN of the user that you specify in PolicySourceArn, if you specified a user. If you include both a PolicySourceArn (for example, arn:aws:iam::123456789012:user/David) and a CallerArn (for example, arn:aws:iam::123456789012:user/Bob), the result is that you simulate calling the API operations as Bob, as if Bob had David’s policies.

      You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal.

      CallerArn is required if you include a ResourcePolicy and the PolicySourceArn is not the ARN for an IAM user. This is required so that the resource-based policy’s Principal element has a value to use in evaluating the policy.

      For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.


    • context_entries(ContextEntry) / set_context_entries(Option<Vec::<ContextEntry>>):
      required: false

      A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permissions policies, the corresponding value is supplied.


    • resource_handling_option(impl Into<String>) / set_resource_handling_option(Option<String>):
      required: false

      Specifies the type of simulation to run. Different API operations that support resource-based policies require different combinations of resources. By specifying the type of simulation to run, you enable the policy simulator to enforce the presence of the required resources to ensure reliable simulation results. If your simulation does not match one of the following scenarios, then you can omit this parameter. The following list shows each of the supported scenario values and the resources that you must define to run the simulation.

      Each of the Amazon EC2 scenarios requires that you specify instance, image, and security group resources. If your scenario includes an EBS volume, then you must specify that volume as a resource. If the Amazon EC2 scenario includes VPC, then you must supply the network interface resource. If it includes an IP subnet, then you must specify the subnet resource. For more information on the Amazon EC2 scenario options, see Supported platforms in the Amazon EC2 User Guide.

      • EC2-VPC-InstanceStore

        instance, image, security group, network interface

      • EC2-VPC-InstanceStore-Subnet

        instance, image, security group, network interface, subnet

      • EC2-VPC-EBS

        instance, image, security group, network interface, volume

      • EC2-VPC-EBS-Subnet

        instance, image, security group, network interface, subnet, volume


    • max_items(i32) / set_max_items(Option<i32>):
      required: false

      Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

      If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.


  • On success, responds with SimulatePrincipalPolicyOutput with field(s):
    • evaluation_results(Option<Vec::<EvaluationResult>>):

      The results of the simulation.

    • is_truncated(bool):

      A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

    • marker(Option<String>):

      When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • On failure, responds with SdkError<SimulatePrincipalPolicyError>
Source§

impl Client

Source

pub fn tag_instance_profile(&self) -> TagInstanceProfileFluentBuilder

Constructs a fluent builder for the TagInstanceProfile operation.

Source§

impl Client

Source

pub fn tag_mfa_device(&self) -> TagMFADeviceFluentBuilder

Constructs a fluent builder for the TagMFADevice operation.

Source§

impl Client

Source

pub fn tag_open_id_connect_provider( &self, ) -> TagOpenIDConnectProviderFluentBuilder

Constructs a fluent builder for the TagOpenIDConnectProvider operation.

Source§

impl Client

Source

pub fn tag_policy(&self) -> TagPolicyFluentBuilder

Constructs a fluent builder for the TagPolicy operation.

Source§

impl Client

Source

pub fn tag_role(&self) -> TagRoleFluentBuilder

Constructs a fluent builder for the TagRole operation.

Source§

impl Client

Source

pub fn tag_saml_provider(&self) -> TagSAMLProviderFluentBuilder

Constructs a fluent builder for the TagSAMLProvider operation.

Source§

impl Client

Source

pub fn tag_server_certificate(&self) -> TagServerCertificateFluentBuilder

Constructs a fluent builder for the TagServerCertificate operation.

Source§

impl Client

Source

pub fn tag_user(&self) -> TagUserFluentBuilder

Constructs a fluent builder for the TagUser operation.

Source§

impl Client

Source

pub fn untag_instance_profile(&self) -> UntagInstanceProfileFluentBuilder

Constructs a fluent builder for the UntagInstanceProfile operation.

Source§

impl Client

Source

pub fn untag_mfa_device(&self) -> UntagMFADeviceFluentBuilder

Constructs a fluent builder for the UntagMFADevice operation.

Source§

impl Client

Source

pub fn untag_open_id_connect_provider( &self, ) -> UntagOpenIDConnectProviderFluentBuilder

Constructs a fluent builder for the UntagOpenIDConnectProvider operation.

Source§

impl Client

Source

pub fn untag_policy(&self) -> UntagPolicyFluentBuilder

Constructs a fluent builder for the UntagPolicy operation.

Source§

impl Client

Source

pub fn untag_role(&self) -> UntagRoleFluentBuilder

Constructs a fluent builder for the UntagRole operation.

Source§

impl Client

Source

pub fn untag_saml_provider(&self) -> UntagSAMLProviderFluentBuilder

Constructs a fluent builder for the UntagSAMLProvider operation.

Source§

impl Client

Source

pub fn untag_server_certificate(&self) -> UntagServerCertificateFluentBuilder

Constructs a fluent builder for the UntagServerCertificate operation.

Source§

impl Client

Source

pub fn untag_user(&self) -> UntagUserFluentBuilder

Constructs a fluent builder for the UntagUser operation.

Source§

impl Client

Source

pub fn update_access_key(&self) -> UpdateAccessKeyFluentBuilder

Constructs a fluent builder for the UpdateAccessKey operation.

Source§

impl Client

Source

pub fn update_account_password_policy( &self, ) -> UpdateAccountPasswordPolicyFluentBuilder

Constructs a fluent builder for the UpdateAccountPasswordPolicy operation.

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

      The minimum number of characters allowed in an IAM user password.

      If you do not specify a value for this parameter, then the operation uses the default value of 6.


    • require_symbols(bool) / set_require_symbols(Option<bool>):
      required: false

      Specifies whether IAM user passwords must contain at least one of the following non-alphanumeric characters:

      ! @ # $ % ^ & * ( ) _ + - = [ ] { } | ’

      If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one symbol character.


    • require_numbers(bool) / set_require_numbers(Option<bool>):
      required: false

      Specifies whether IAM user passwords must contain at least one numeric character (0 to 9).

      If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one numeric character.


    • require_uppercase_characters(bool) / set_require_uppercase_characters(Option<bool>):
      required: false

      Specifies whether IAM user passwords must contain at least one uppercase character from the ISO basic Latin alphabet (A to Z).

      If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one uppercase character.


    • require_lowercase_characters(bool) / set_require_lowercase_characters(Option<bool>):
      required: false

      Specifies whether IAM user passwords must contain at least one lowercase character from the ISO basic Latin alphabet (a to z).

      If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one lowercase character.


    • allow_users_to_change_password(bool) / set_allow_users_to_change_password(Option<bool>):
      required: false

      Allows all IAM users in your account to use the Amazon Web Services Management Console to change their own passwords. For more information, see Permitting IAM users to change their own passwords in the IAM User Guide.

      If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that IAM users in the account do not automatically have permissions to change their own password.


    • max_password_age(i32) / set_max_password_age(Option<i32>):
      required: false

      The number of days that an IAM user password is valid.

      If you do not specify a value for this parameter, then the operation uses the default value of 0. The result is that IAM user passwords never expire.


    • password_reuse_prevention(i32) / set_password_reuse_prevention(Option<i32>):
      required: false

      Specifies the number of previous passwords that IAM users are prevented from reusing.

      If you do not specify a value for this parameter, then the operation uses the default value of 0. The result is that IAM users are not prevented from reusing previous passwords.


    • hard_expiry(bool) / set_hard_expiry(Option<bool>):
      required: false

      Prevents IAM users who are accessing the account via the Amazon Web Services Management Console from setting a new console password after their password has expired. The IAM user cannot access the console until an administrator resets the password.

      If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that IAM users can change their passwords after they expire and continue to sign in as the user.

      In the Amazon Web Services Management Console, the custom password policy option Allow users to change their own password gives IAM users permissions to iam:ChangePassword for only their user and to the iam:GetAccountPasswordPolicy action. This option does not attach a permissions policy to each user, rather the permissions are applied at the account-level for all users by IAM. IAM users with iam:ChangePassword permission and active access keys can reset their own expired console password using the CLI or API.


  • On success, responds with UpdateAccountPasswordPolicyOutput
  • On failure, responds with SdkError<UpdateAccountPasswordPolicyError>
Source§

impl Client

Source

pub fn update_assume_role_policy(&self) -> UpdateAssumeRolePolicyFluentBuilder

Constructs a fluent builder for the UpdateAssumeRolePolicy operation.

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

      The name of the role to update with the new policy.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • policy_document(impl Into<String>) / set_policy_document(Option<String>):
      required: true

      The policy that grants an entity permission to assume the role.

      You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

      The regex pattern used to validate this parameter is a string of characters consisting of the following:

      • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range

      • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

      • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)


  • On success, responds with UpdateAssumeRolePolicyOutput
  • On failure, responds with SdkError<UpdateAssumeRolePolicyError>
Source§

impl Client

Source

pub fn update_group(&self) -> UpdateGroupFluentBuilder

Constructs a fluent builder for the UpdateGroup operation.

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

      Name of the IAM group to update. If you’re changing the name of the group, this is the original name.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • new_path(impl Into<String>) / set_new_path(Option<String>):
      required: false

      New path for the IAM group. Only include this if changing the group’s path.

      This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.


    • new_group_name(impl Into<String>) / set_new_group_name(Option<String>):
      required: false

      New name for the IAM group. Only include this if changing the group’s name.

      IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both “MyResource” and “myresource”.


  • On success, responds with UpdateGroupOutput
  • On failure, responds with SdkError<UpdateGroupError>
Source§

impl Client

Source

pub fn update_login_profile(&self) -> UpdateLoginProfileFluentBuilder

Constructs a fluent builder for the UpdateLoginProfile operation.

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

      The name of the user whose password you want to update.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • password(impl Into<String>) / set_password(Option<String>):
      required: false

      The new password for the specified IAM user.

      The regex pattern used to validate this parameter is a string of characters consisting of the following:

      • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range

      • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

      • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

      However, the format can be further restricted by the account administrator by setting a password policy on the Amazon Web Services account. For more information, see UpdateAccountPasswordPolicy.


    • password_reset_required(bool) / set_password_reset_required(Option<bool>):
      required: false

      Allows this new password to be used only once by requiring the specified IAM user to set a new password on next sign-in.


  • On success, responds with UpdateLoginProfileOutput
  • On failure, responds with SdkError<UpdateLoginProfileError>
Source§

impl Client

Source

pub fn update_open_id_connect_provider_thumbprint( &self, ) -> UpdateOpenIDConnectProviderThumbprintFluentBuilder

Constructs a fluent builder for the UpdateOpenIDConnectProviderThumbprint operation.

Source§

impl Client

Source

pub fn update_role(&self) -> UpdateRoleFluentBuilder

Constructs a fluent builder for the UpdateRole operation.

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

      The name of the role that you want to modify.


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

      The new description that you want to apply to the specified role.


    • max_session_duration(i32) / set_max_session_duration(Option<i32>):
      required: false

      The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours.

      Anyone who assumes the role from the CLI or API can use the DurationSeconds API parameter or the duration-seconds CLI parameter to request a longer session. The MaxSessionDuration setting determines the maximum duration that can be requested using the DurationSeconds parameter. If users don’t specify a value for the DurationSeconds parameter, their security credentials are valid for one hour by default. This applies when you use the AssumeRole* API operations or the assume-role* CLI operations but does not apply when you use those operations to create a console URL. For more information, see Using IAM roles in the IAM User Guide.

      IAM role credentials provided by Amazon EC2 instances assigned to the role are not subject to the specified maximum session duration.


  • On success, responds with UpdateRoleOutput
  • On failure, responds with SdkError<UpdateRoleError>
Source§

impl Client

Source

pub fn update_role_description(&self) -> UpdateRoleDescriptionFluentBuilder

Constructs a fluent builder for the UpdateRoleDescription operation.

Source§

impl Client

Source

pub fn update_saml_provider(&self) -> UpdateSAMLProviderFluentBuilder

Constructs a fluent builder for the UpdateSAMLProvider operation.

Source§

impl Client

Source

pub fn update_server_certificate(&self) -> UpdateServerCertificateFluentBuilder

Constructs a fluent builder for the UpdateServerCertificate operation.

Source§

impl Client

Source

pub fn update_service_specific_credential( &self, ) -> UpdateServiceSpecificCredentialFluentBuilder

Constructs a fluent builder for the UpdateServiceSpecificCredential operation.

Source§

impl Client

Source

pub fn update_signing_certificate( &self, ) -> UpdateSigningCertificateFluentBuilder

Constructs a fluent builder for the UpdateSigningCertificate operation.

Source§

impl Client

Source

pub fn update_ssh_public_key(&self) -> UpdateSSHPublicKeyFluentBuilder

Constructs a fluent builder for the UpdateSSHPublicKey operation.

Source§

impl Client

Source

pub fn update_user(&self) -> UpdateUserFluentBuilder

Constructs a fluent builder for the UpdateUser operation.

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

      Name of the user to update. If you’re changing the name of the user, this is the original user name.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • new_path(impl Into<String>) / set_new_path(Option<String>):
      required: false

      New path for the IAM user. Include this parameter only if you’re changing the user’s path.

      This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.


    • new_user_name(impl Into<String>) / set_new_user_name(Option<String>):
      required: false

      New name for the user. Include this parameter only if you’re changing the user’s name.

      IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both “MyResource” and “myresource”.


  • On success, responds with UpdateUserOutput
  • On failure, responds with SdkError<UpdateUserError>
Source§

impl Client

Source

pub fn upload_server_certificate(&self) -> UploadServerCertificateFluentBuilder

Constructs a fluent builder for the UploadServerCertificate operation.

  • The fluent builder is configurable:
    • path(impl Into<String>) / set_path(Option<String>):
      required: false

      The path for the server certificate. For more information about paths, see IAM identifiers in the IAM User Guide.

      This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

      If you are uploading a server certificate specifically for use with Amazon CloudFront distributions, you must specify a path using the path parameter. The path must begin with /cloudfront and must include a trailing slash (for example, /cloudfront/test/).


    • server_certificate_name(impl Into<String>) / set_server_certificate_name(Option<String>):
      required: true

      The name for the server certificate. Do not include the path in this value. The name of the certificate cannot contain any spaces.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • certificate_body(impl Into<String>) / set_certificate_body(Option<String>):
      required: true

      The contents of the public key certificate in PEM-encoded format.

      The regex pattern used to validate this parameter is a string of characters consisting of the following:

      • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range

      • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

      • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)


    • private_key(impl Into<String>) / set_private_key(Option<String>):
      required: true

      The contents of the private key in PEM-encoded format.

      The regex pattern used to validate this parameter is a string of characters consisting of the following:

      • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range

      • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

      • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)


    • certificate_chain(impl Into<String>) / set_certificate_chain(Option<String>):
      required: false

      The contents of the certificate chain. This is typically a concatenation of the PEM-encoded public key certificates of the chain.

      The regex pattern used to validate this parameter is a string of characters consisting of the following:

      • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range

      • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

      • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)


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

      A list of tags that you want to attach to the new IAM server certificate resource. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

      If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.


  • On success, responds with UploadServerCertificateOutput with field(s):
  • On failure, responds with SdkError<UploadServerCertificateError>
Source§

impl Client

Source

pub fn upload_signing_certificate( &self, ) -> UploadSigningCertificateFluentBuilder

Constructs a fluent builder for the UploadSigningCertificate operation.

Source§

impl Client

Source

pub fn upload_ssh_public_key(&self) -> UploadSSHPublicKeyFluentBuilder

Constructs a fluent builder for the UploadSSHPublicKey operation.

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

      The name of the IAM user to associate the SSH public key with.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-


    • ssh_public_key_body(impl Into<String>) / set_ssh_public_key_body(Option<String>):
      required: true

      The SSH public key. The public key must be encoded in ssh-rsa format or PEM format. The minimum bit-length of the public key is 2048 bits. For example, you can generate a 2048-bit key, and the resulting PEM file is 1679 bytes long.

      The regex pattern used to validate this parameter is a string of characters consisting of the following:

      • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range

      • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

      • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)


  • On success, responds with UploadSshPublicKeyOutput with field(s):
  • On failure, responds with SdkError<UploadSSHPublicKeyError>
Source§

impl Client

Source

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

§Panics

This method will panic in the following cases:

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

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

Source

pub fn config(&self) -> &Config

Returns the client’s configuration.

Source§

impl Client

Source

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

Creates a new client from an SDK Config.

§Panics
  • This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
  • This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
  • This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Client

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Waiters for Client

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> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Paint for T
where T: ?Sized,

Source§

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 primary(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Primary].

§Example
println!("{}", value.primary());
Source§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Fixed].

§Example
println!("{}", value.fixed(color));
Source§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Rgb].

§Example
println!("{}", value.rgb(r, g, b));
Source§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Black].

§Example
println!("{}", value.black());
Source§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Red].

§Example
println!("{}", value.red());
Source§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Green].

§Example
println!("{}", value.green());
Source§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Yellow].

§Example
println!("{}", value.yellow());
Source§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Blue].

§Example
println!("{}", value.blue());
Source§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Magenta].

§Example
println!("{}", value.magenta());
Source§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Cyan].

§Example
println!("{}", value.cyan());
Source§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: White].

§Example
println!("{}", value.white());
Source§

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>

Returns self with the fg() set to [Color :: BrightRed].

§Example
println!("{}", value.bright_red());
Source§

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>

Returns self with the fg() set to [Color :: BrightYellow].

§Example
println!("{}", value.bright_yellow());
Source§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlue].

§Example
println!("{}", value.bright_blue());
Source§

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>

Returns self with the fg() set to [Color :: BrightCyan].

§Example
println!("{}", value.bright_cyan());
Source§

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>

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>

Returns self with the bg() set to [Color :: Primary].

§Example
println!("{}", value.on_primary());
Source§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Fixed].

§Example
println!("{}", value.on_fixed(color));
Source§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Rgb].

§Example
println!("{}", value.on_rgb(r, g, b));
Source§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Black].

§Example
println!("{}", value.on_black());
Source§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Red].

§Example
println!("{}", value.on_red());
Source§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Green].

§Example
println!("{}", value.on_green());
Source§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Yellow].

§Example
println!("{}", value.on_yellow());
Source§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Blue].

§Example
println!("{}", value.on_blue());
Source§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Magenta].

§Example
println!("{}", value.on_magenta());
Source§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Cyan].

§Example
println!("{}", value.on_cyan());
Source§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: White].

§Example
println!("{}", value.on_white());
Source§

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>

Returns self with the bg() set to [Color :: BrightRed].

§Example
println!("{}", value.on_bright_red());
Source§

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>

Returns self with the bg() set to [Color :: BrightYellow].

§Example
println!("{}", value.on_bright_yellow());
Source§

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>

Returns self with the bg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.on_bright_magenta());
Source§

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>

Returns self with the bg() set to [Color :: BrightWhite].

§Example
println!("{}", value.on_bright_white());
Source§

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 bold(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Bold].

§Example
println!("{}", value.bold());
Source§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Dim].

§Example
println!("{}", value.dim());
Source§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Italic].

§Example
println!("{}", value.italic());
Source§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Underline].

§Example
println!("{}", value.underline());

Returns self with the attr() set to [Attribute :: Blink].

§Example
println!("{}", value.blink());

Returns self with the attr() set to [Attribute :: RapidBlink].

§Example
println!("{}", value.rapid_blink());
Source§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Invert].

§Example
println!("{}", value.invert());
Source§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Conceal].

§Example
println!("{}", value.conceal());
Source§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Strike].

§Example
println!("{}", value.strike());
Source§

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 mask(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Mask].

§Example
println!("{}", value.mask());
Source§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Wrap].

§Example
println!("{}", value.wrap());
Source§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Linger].

§Example
println!("{}", value.linger());
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.

Returns self with the quirk() set to [Quirk :: Clear].

§Example
println!("{}", value.clear());
Source§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Resetting].

§Example
println!("{}", value.resetting());
Source§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Bright].

§Example
println!("{}", value.bright());
Source§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: OnBright].

§Example
println!("{}", value.on_bright());
Source§

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);
Source§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more
Source§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,