Class: Aws::IAM::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-iam/client.rb

Overview

An API client for IAM. To construct a client, you need to configure a ‘:region` and `:credentials`.

client = Aws::IAM::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements ‘Aws::CredentialProvider`, or instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

    • ‘ENV`, `ENV`, `ENV`, and `ENV`.

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting `ENV` to `true`.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: ‘sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV` or in shared config as `auth_scheme_preference`, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When ‘true`, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at ‘HOME/.aws/credentials`. When not specified, ’default’ is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • ‘when_supported` - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a `requestAlgorithmMember` is modeled.

    • ‘when_required` - When set, a checksum will only be calculated for request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` or where a `requestAlgorithmMember` is modeled and supplied.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • ‘when_supported` - (default) When set, checksum validation is performed on all response payloads of operations modeled with the `httpChecksum` trait where `responseAlgorithms` is modeled, except when no modeled checksum algorithms are supported.

    • ‘when_required` - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the `requestValidationModeMember` member is set to `ENABLED`.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements ‘Aws::TokenProvider`, or instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::IAM::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::IAM::EndpointParameters`.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.



473
474
475
 
# File 'lib/aws-sdk-iam/client.rb', line 473

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



14834
14835
14836
 
# File 'lib/aws-sdk-iam/client.rb', line 14834

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



14837
14838
14839
 
# File 'lib/aws-sdk-iam/client.rb', line 14837

def errors_module
  Errors
end

Instance Method Details

#accept_delegation_request(params = {}) ⇒ Struct

Accepts a delegation request, granting the requested temporary access.

Once the delegation request is accepted, it is eligible to send the exchange token to the partner. The [SendDelegationToken] API has to be explicitly called to send the delegation token.

At the time of acceptance, IAM records the details and the state of the identity that called this API. This is the identity that gets mapped to the delegated credential.

An accepted request may be rejected before the exchange token is sent to the partner.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_SendDelegationToken.html

Examples:

Request syntax with placeholder values


resp = client.accept_delegation_request({
  delegation_request_id: "delegationRequestIdType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :delegation_request_id (required, String) —

    The unique identifier of the delegation request to accept.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



511
512
513
514
 
# File 'lib/aws-sdk-iam/client.rb', line 511

def accept_delegation_request(params = {}, options = {})
  req = build_request(:accept_delegation_request, params)
  req.send_request(options)
end

#add_client_id_to_open_id_connect_provider(params = {}) ⇒ Struct

Adds a new client ID (also known as audience) to the list of client IDs already registered for the specified IAM OpenID Connect (OIDC) provider resource.

This operation is idempotent; it does not fail or return an error if you add an existing client ID to the provider.

Examples:

Example: To add a client ID (audience) to an Open-ID Connect (OIDC) provider


# The following add-client-id-to-open-id-connect-provider command adds the client ID my-application-ID to the OIDC
# provider named server.example.com:

resp = client.add_client_id_to_open_id_connect_provider({
  client_id: "my-application-ID", 
  open_id_connect_provider_arn: "arn:aws:iam::123456789012:oidc-provider/server.example.com", 
})

Request syntax with placeholder values


resp = client.add_client_id_to_open_id_connect_provider({
  open_id_connect_provider_arn: "arnType", # required
  client_id: "clientIDType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



560
561
562
563
 
# File 'lib/aws-sdk-iam/client.rb', line 560

def add_client_id_to_open_id_connect_provider(params = {}, options = {})
  req = build_request(:add_client_id_to_open_id_connect_provider, params)
  req.send_request(options)
end

#add_role_to_instance_profile(params = {}) ⇒ Struct

Adds the specified IAM role to the specified instance profile. An instance profile can contain only one role, and this quota cannot be increased. You can remove the existing role and then add a different role to an instance profile. You must then wait for the change to appear across all of Amazon Web Services because of [eventual consistency]. To force the change, you must [disassociate the instance profile] and then [associate the instance profile], or you can stop your instance and then restart it.

<note markdown=“1”> The caller of this operation must be granted the ‘PassRole` permission on the IAM role by a permissions policy.

</note>

When using the [iam:AssociatedResourceArn] condition in a policy to restrict the [PassRole] IAM action, special considerations apply if the policy is intended to define access for the ‘AddRoleToInstanceProfile` action. In this case, you cannot specify a Region or instance ID in the EC2 instance ARN. The ARN value must be `arn:aws:ec2::CallerAccountId:instance/`. Using any other ARN value may lead to unexpected evaluation results.

For more information about roles, see [IAM roles] in the *IAM User Guide*. For more information about instance profiles, see [Using instance profiles] in the *IAM User Guide*.

[1]: en.wikipedia.org/wiki/Eventual_consistency [2]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DisassociateIamInstanceProfile.html [3]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_AssociateIamInstanceProfile.html [4]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_iam-condition-keys.html#available-keys-for-iam [5]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html [6]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html [7]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html

Examples:

Example: To add a role to an instance profile


# The following command adds the role named S3Access to the instance profile named Webserver:

resp = client.add_role_to_instance_profile({
  instance_profile_name: "Webserver", 
  role_name: "S3Access", 
})

Request syntax with placeholder values


resp = client.add_role_to_instance_profile({
  instance_profile_name: "instanceProfileNameType", # required
  role_name: "roleNameType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_profile_name (required, String) —

    The name of the instance profile 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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :role_name (required, String) —

    The name of the role to add.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



648
649
650
651
 
# File 'lib/aws-sdk-iam/client.rb', line 648

def add_role_to_instance_profile(params = {}, options = {})
  req = build_request(:add_role_to_instance_profile, params)
  req.send_request(options)
end

#add_user_to_group(params = {}) ⇒ Struct

Adds the specified user to the specified group.

Examples:

Example: To add a user to an IAM group


# The following command adds an IAM user named Bob to the IAM group named Admins:

resp = client.add_user_to_group({
  group_name: "Admins", 
  user_name: "Bob", 
})

Request syntax with placeholder values


resp = client.add_user_to_group({
  group_name: "groupNameType", # required
  user_name: "existingUserNameType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :group_name (required, String) —

    The name of the group 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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :user_name (required, String) —

    The name of the user to add.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



702
703
704
705
 
# File 'lib/aws-sdk-iam/client.rb', line 702

def add_user_to_group(params = {}, options = {})
  req = build_request(:add_user_to_group, params)
  req.send_request(options)
end

#associate_delegation_request(params = {}) ⇒ Struct

Associates a delegation request with the current identity.

If the partner that created the delegation request has specified the owner account during creation, only an identity from that owner account can call the ‘AssociateDelegationRequest` API for the specified delegation request. Once the `AssociateDelegationRequest` API call is successful, the ARN of the current calling identity will be stored as the `ownerId` of the request.

If the partner that created the delegation request has not specified the owner account during creation, any caller from any account can call the ‘AssociateDelegationRequest` API for the delegation request. Once this API call is successful, the ARN of the current calling identity will be stored as the `ownerId` and the Amazon Web Services account ID of the current calling identity will be stored as the `ownerAccount` of the request.

For more details, see [ Managing Permissions for Delegation Requests].

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies-temporary-delegation.html#temporary-delegation-managing-permissions

Examples:

Request syntax with placeholder values


resp = client.associate_delegation_request({
  delegation_request_id: "delegationRequestIdType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :delegation_request_id (required, String) —

    The unique identifier of the delegation request to associate.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



746
747
748
749
 
# File 'lib/aws-sdk-iam/client.rb', line 746

def associate_delegation_request(params = {}, options = {})
  req = build_request(:associate_delegation_request, params)
  req.send_request(options)
end

#attach_group_policy(params = {}) ⇒ Struct

Attaches the specified managed policy to the specified IAM group.

You use this operation to attach a managed policy to a group. To embed an inline policy in a group, use [ ‘PutGroupPolicy` ][1].

As a best practice, you can validate your IAM policies. To learn more, see [Validating IAM policies] in the *IAM User Guide*.

For more information about policies, see [Managed policies and inline policies] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_PutGroupPolicy.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html [3]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html

Examples:

Example: To attach a managed policy to an IAM group


# The following command attaches the AWS managed policy named ReadOnlyAccess to the IAM group named Finance.

resp = client.attach_group_policy({
  group_name: "Finance", 
  policy_arn: "arn:aws:iam::aws:policy/ReadOnlyAccess", 
})

Request syntax with placeholder values


resp = client.attach_group_policy({
  group_name: "groupNameType", # required
  policy_arn: "arnType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :group_name (required, String) —

    The name (friendly name, not ARN) of the group to attach the policy to.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :policy_arn (required, String) —

    The Amazon Resource Name (ARN) of the IAM policy you want to attach.

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

    [1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



814
815
816
817
 
# File 'lib/aws-sdk-iam/client.rb', line 814

def attach_group_policy(params = {}, options = {})
  req = build_request(:attach_group_policy, params)
  req.send_request(options)
end

#attach_role_policy(params = {}) ⇒ Struct

Attaches the specified managed policy to the specified IAM role. When you attach a managed policy to a role, the managed policy becomes part of the role’s permission (access) policy.

<note markdown=“1”> You cannot use a managed policy as the role’s trust policy. The role’s trust policy is created at the same time as the role, using [ ‘CreateRole` ][1]. You can update a role’s trust policy using [ ‘UpdateAssumerolePolicy` ][2].

</note>

Use this operation to attach a managed policy to a role. To embed an inline policy in a role, use [ ‘PutRolePolicy` ][3]. For more information about policies, see [Managed policies and inline policies] in the *IAM User Guide*.

As a best practice, you can validate your IAM policies. To learn more, see [Validating IAM policies] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html [2]: docs.aws.amazon.com/IAM/latest/APIReference/API_UpdateAssumeRolePolicy.html [3]: docs.aws.amazon.com/IAM/latest/APIReference/API_PutRolePolicy.html [4]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html [5]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html

Examples:

Example: To attach a managed policy to an IAM role


# The following command attaches the AWS managed policy named ReadOnlyAccess to the IAM role named ReadOnlyRole.

resp = client.attach_role_policy({
  policy_arn: "arn:aws:iam::aws:policy/ReadOnlyAccess", 
  role_name: "ReadOnlyRole", 
})

Request syntax with placeholder values


resp = client.attach_role_policy({
  role_name: "roleNameType", # required
  policy_arn: "arnType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :role_name (required, String) —

    The name (friendly name, not ARN) of the role to attach the policy to.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :policy_arn (required, String) —

    The Amazon Resource Name (ARN) of the IAM policy you want to attach.

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

    [1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



891
892
893
894
 
# File 'lib/aws-sdk-iam/client.rb', line 891

def attach_role_policy(params = {}, options = {})
  req = build_request(:attach_role_policy, params)
  req.send_request(options)
end

#attach_user_policy(params = {}) ⇒ Struct

Attaches the specified managed policy to the specified user.

You use this operation to attach a managed policy to a user. To embed an inline policy in a user, use [ ‘PutUserPolicy` ][1].

As a best practice, you can validate your IAM policies. To learn more, see [Validating IAM policies] in the *IAM User Guide*.

For more information about policies, see [Managed policies and inline policies] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_PutUserPolicy.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html [3]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html

Examples:

Example: To attach a managed policy to an IAM user


# The following command attaches the AWS managed policy named AdministratorAccess to the IAM user named Alice.

resp = client.attach_user_policy({
  policy_arn: "arn:aws:iam::aws:policy/AdministratorAccess", 
  user_name: "Alice", 
})

Request syntax with placeholder values


resp = client.attach_user_policy({
  user_name: "userNameType", # required
  policy_arn: "arnType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (required, String) —

    The name (friendly name, not ARN) of the IAM user to attach the policy to.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :policy_arn (required, String) —

    The Amazon Resource Name (ARN) of the IAM policy you want to attach.

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

    [1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



959
960
961
962
 
# File 'lib/aws-sdk-iam/client.rb', line 959

def attach_user_policy(params = {}, options = {})
  req = build_request(:attach_user_policy, params)
  req.send_request(options)
end

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {}) 


14688
14689
14690
14691
14692
14693
14694
14695
14696
14697
14698
14699
14700
14701
14702
14703
14704
 
# File 'lib/aws-sdk-iam/client.rb', line 14688

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::IAM')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-iam'
  context[:gem_version] = '1.143.0'
  Seahorse::Client::Request.new(handlers, context)
end

#change_password(params = {}) ⇒ Struct

Changes the password of the IAM user who is calling this operation. This operation can be performed using the CLI, the Amazon Web Services API, or the **My Security Credentials** page in the Amazon Web Services Management Console. The Amazon Web Services account root user password is not affected by this operation.

Use [UpdateLoginProfile] to use the CLI, the Amazon Web Services API, or the Users page in the IAM console to change the password for any IAM user. For more information about modifying passwords, see

Managing passwords][2

in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_UpdateLoginProfile.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html

Examples:

Example: To change the password for your IAM user


# The following command changes the password for the current IAM user.

resp = client.change_password({
  new_password: "]35d/{pB9Fo9wJ", 
  old_password: "3s0K_;xh4~8XXI", 
})

Request syntax with placeholder values


resp = client.change_password({
  old_password: "passwordType", # required
  new_password: "passwordType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :old_password (required, String) —

    The IAM user’s current password.

  • :new_password (required, String) —

    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.

    [1]: wikipedia.org/wiki/regex

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1024
1025
1026
1027
 
# File 'lib/aws-sdk-iam/client.rb', line 1024

def change_password(params = {}, options = {})
  req = build_request(:change_password, params)
  req.send_request(options)
end

#create_access_key(params = {}) ⇒ Types::CreateAccessKeyResponse

Creates a new Amazon Web Services secret access key and corresponding Amazon Web Services access key ID for the specified user. The default status for new keys is ‘Active`.

If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials. This is true even if the Amazon Web Services account has no associated users.

For information about quotas on the number of keys you can create, see

IAM and STS quotas][1

in the *IAM User Guide*.

To ensure the security of your Amazon Web Services account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html

Examples:

Example: To create an access key for an IAM user


# The following command creates an access key (access key ID and secret access key) for the IAM user named Bob.

resp = client.create_access_key({
  user_name: "Bob", 
})

resp.to_h outputs the following:
{
  access_key: {
    access_key_id: "AKIAIOSFODNN7EXAMPLE", 
    create_date: Time.parse("2015-03-09T18:39:23.411Z"), 
    secret_access_key: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY", 
    status: "Active", 
    user_name: "Bob", 
  }, 
}

Request syntax with placeholder values


resp = client.create_access_key({
  user_name: "existingUserNameType",
})

Response structure


resp.access_key.user_name #=> String
resp.access_key.access_key_id #=> String
resp.access_key.status #=> String, one of "Active", "Inactive", "Expired"
resp.access_key.secret_access_key #=> String
resp.access_key.create_date #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (String) —

    The name of the IAM user that the new key will belong to.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

Returns:

See Also:



1107
1108
1109
1110
 
# File 'lib/aws-sdk-iam/client.rb', line 1107

def create_access_key(params = {}, options = {})
  req = build_request(:create_access_key, params)
  req.send_request(options)
end

#create_account_alias(params = {}) ⇒ Struct

Creates an alias for your Amazon Web Services account. For information about using an Amazon Web Services account alias, see [Creating, deleting, and listing an Amazon Web Services account alias] in the *Amazon Web Services Sign-In User Guide*.

[1]: docs.aws.amazon.com/signin/latest/userguide/CreateAccountAlias.html

Examples:

Example: To create an account alias


# The following command associates the alias examplecorp to your AWS account.

resp = client.({
  account_alias: "examplecorp", 
})

Request syntax with placeholder values


resp = client.({
  account_alias: "accountAliasType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_alias (required, String) —

    The account alias to create.

    This parameter allows (through its [regex pattern]) a string of characters consisting of lowercase letters, digits, and dashes. You cannot start or finish with a dash, nor can you have two dashes in a row.

    [1]: wikipedia.org/wiki/regex

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1154
1155
1156
1157
 
# File 'lib/aws-sdk-iam/client.rb', line 1154

def (params = {}, options = {})
  req = build_request(:create_account_alias, params)
  req.send_request(options)
end

#create_delegation_request(params = {}) ⇒ Types::CreateDelegationRequestResponse

Creates an IAM delegation request for temporary access delegation.

This API is not available for general use. In order to use this API, a caller first need to go through an onboarding process described in the [partner onboarding documentation].

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies-temporary-delegation-partner-guide.html

Examples:

Request syntax with placeholder values


resp = client.create_delegation_request({
  owner_account_id: "accountIdType",
  description: "delegationRequestDescriptionType", # required
  permissions: { # required
    policy_template_arn: "arnType",
    parameters: [
      {
        name: "policyParameterNameType",
        values: ["policyParameterValueType"],
        type: "string", # accepts string, stringList
      },
    ],
  },
  request_message: "requestMessageType",
  requestor_workflow_id: "requestorWorkflowIdType", # required
  redirect_url: "redirectUrlType",
  notification_channel: "notificationChannelType", # required
  session_duration: 1, # required
  only_send_by_owner: false,
})

Response structure


resp.console_deep_link #=> String
resp.delegation_request_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :owner_account_id (String) —

    The Amazon Web Services account ID this delegation request is targeted to.

    If the account ID is not known, this parameter can be omitted, resulting in a request that can be associated by any account. If the account ID passed, then the created delegation request can only be associated with an identity of that target account.

  • :description (required, String) —

    A description of the delegation request.

  • :permissions (required, Types::DelegationPermission) —

    The permissions to be delegated in this delegation request.

  • :request_message (String) —

    A message explaining the reason for the delegation request.

    Requesters can utilize this field to add a custom note to the delegation request. This field is different from the description such that this is to be utilized for a custom messaging on a case-by-case basis.

    For example, if the current delegation request is in response to a previous request being rejected, this explanation can be added to the request via this field.

  • :requestor_workflow_id (required, String) —

    The workflow ID associated with the requestor.

    This is the unique identifier on the partner side that can be used to track the progress of the request.

    IAM maintains a uniqueness check on this workflow id for each request

    • if a workflow id for an existing request is passed, this API call

    will fail.

  • :redirect_url (String) —

    The URL to redirect to after the delegation request is processed.

    This URL is used by the IAM console to show a link to the customer to re-load the partner workflow.

  • :notification_channel (required, String) —

    The notification channel for updates about the delegation request.

    At this time,only SNS topic ARNs are accepted for notification. This topic ARN must have a resource policy granting ‘SNS:Publish` permission to the IAM service principal (`iam.amazonaws.com`). See

    partner onboarding documentation][1

    for more details.

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies-temporary-delegation-partner-guide.html

  • :session_duration (required, Integer) —

    The duration for which the delegated session should remain active, in seconds.

    The active time window for the session starts when the customer calls the [SendDelegationToken] API.

    [1]: docs.aws.amazon.com/IAM/latest/APIReference/API_SendDelegationToken.html

  • :only_send_by_owner (Boolean) —

    Specifies whether the delegation token should only be sent by the owner.

    This flag prevents any party other than the owner from calling ‘SendDelegationToken` API for this delegation request. This behavior becomes useful when the delegation request owner needs to be present for subsequent partner interactions, but the delegation request was sent to a more privileged user for approval due to the owner lacking sufficient delegation permissions.

Returns:

See Also:



1283
1284
1285
1286
 
# File 'lib/aws-sdk-iam/client.rb', line 1283

def create_delegation_request(params = {}, options = {})
  req = build_request(:create_delegation_request, params)
  req.send_request(options)
end

#create_group(params = {}) ⇒ Types::CreateGroupResponse

Creates a new group.

For information about the number of groups you can create, see [IAM and STS quotas] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html

Examples:

Example: To create an IAM group


# The following command creates an IAM group named Admins.

resp = client.create_group({
  group_name: "Admins", 
})

resp.to_h outputs the following:
{
  group: {
    arn: "arn:aws:iam::123456789012:group/Admins", 
    create_date: Time.parse("2015-03-09T20:30:24.940Z"), 
    group_id: "AIDGPMS9RO4H3FEXAMPLE", 
    group_name: "Admins", 
    path: "/", 
  }, 
}

Request syntax with placeholder values


resp = client.create_group({
  path: "pathType",
  group_name: "groupNameType", # required
})

Response structure


resp.group.path #=> String
resp.group.group_name #=> String
resp.group.group_id #=> String
resp.group.arn #=> String
resp.group.create_date #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :path (String) —

    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.

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html [2]: wikipedia.org/wiki/regex

  • :group_name (required, String) —

    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”.

Returns:

See Also:



1367
1368
1369
1370
 
# File 'lib/aws-sdk-iam/client.rb', line 1367

def create_group(params = {}, options = {})
  req = build_request(:create_group, params)
  req.send_request(options)
end

#create_instance_profile(params = {}) ⇒ Types::CreateInstanceProfileResponse

Creates a new instance profile. For information about instance profiles, see [Using roles for applications on Amazon EC2] in the *IAM User Guide*, and [Instance profiles] in the *Amazon EC2 User Guide*.

For information about the number of instance profiles you can create, see [IAM object quotas] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2.html [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html#ec2-instance-profile [3]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html

Examples:

Example: To create an instance profile


# The following command creates an instance profile named Webserver that is ready to have a role attached and then be
# associated with an EC2 instance.

resp = client.create_instance_profile({
  instance_profile_name: "Webserver", 
})

resp.to_h outputs the following:
{
  instance_profile: {
    arn: "arn:aws:iam::123456789012:instance-profile/Webserver", 
    create_date: Time.parse("2015-03-09T20:33:19.626Z"), 
    instance_profile_id: "AIPAJMBYC7DLSPEXAMPLE", 
    instance_profile_name: "Webserver", 
    path: "/", 
    roles: [
    ], 
  }, 
}

Request syntax with placeholder values


resp = client.create_instance_profile({
  instance_profile_name: "instanceProfileNameType", # required
  path: "pathType",
  tags: [
    {
      key: "tagKeyType", # required
      value: "tagValueType", # required
    },
  ],
})

Response structure


resp.instance_profile.path #=> String
resp.instance_profile.instance_profile_name #=> String
resp.instance_profile.instance_profile_id #=> String
resp.instance_profile.arn #=> String
resp.instance_profile.create_date #=> Time
resp.instance_profile.roles #=> Array
resp.instance_profile.roles[0].path #=> String
resp.instance_profile.roles[0].role_name #=> String
resp.instance_profile.roles[0].role_id #=> String
resp.instance_profile.roles[0].arn #=> String
resp.instance_profile.roles[0].create_date #=> Time
resp.instance_profile.roles[0].assume_role_policy_document #=> String
resp.instance_profile.roles[0].description #=> String
resp.instance_profile.roles[0].max_session_duration #=> Integer
resp.instance_profile.roles[0].permissions_boundary.permissions_boundary_type #=> String, one of "PermissionsBoundaryPolicy"
resp.instance_profile.roles[0].permissions_boundary.permissions_boundary_arn #=> String
resp.instance_profile.roles[0].tags #=> Array
resp.instance_profile.roles[0].tags[0].key #=> String
resp.instance_profile.roles[0].tags[0].value #=> String
resp.instance_profile.roles[0].role_last_used.last_used_date #=> Time
resp.instance_profile.roles[0].role_last_used.region #=> String
resp.instance_profile.tags #=> Array
resp.instance_profile.tags[0].key #=> String
resp.instance_profile.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_profile_name (required, String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :path (String) —

    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.

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html [2]: wikipedia.org/wiki/regex

  • :tags (Array<Types::Tag>) —

    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*.

    <note markdown=“1”> 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.

    </note>

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

Returns:

See Also:



1504
1505
1506
1507
 
# File 'lib/aws-sdk-iam/client.rb', line 1504

def create_instance_profile(params = {}, options = {})
  req = build_request(:create_instance_profile, params)
  req.send_request(options)
end

#create_login_profile(params = {}) ⇒ Types::CreateLoginProfileResponse

Creates a password for the specified IAM user. A password allows an IAM user to access Amazon Web Services services through the Amazon Web Services Management Console.

You can use the CLI, the Amazon Web Services API, or the Users page in the IAM console to create a password for any IAM user. Use

ChangePassword][1

to update your own existing password in the **My

Security Credentials** page in the Amazon Web Services Management Console.

For more information about managing passwords, see [Managing passwords] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_ChangePassword.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html

Examples:

Example: To create an instance profile


# The following command changes IAM user Bob's password and sets the flag that required Bob to change the password the
# next time he signs in.

resp = client.({
  password: "h]6EszR}vJ*m", 
  password_reset_required: true, 
  user_name: "Bob", 
})

resp.to_h outputs the following:
{
  login_profile: {
    create_date: Time.parse("2015-03-10T20:55:40.274Z"), 
    password_reset_required: true, 
    user_name: "Bob", 
  }, 
}

Request syntax with placeholder values


resp = client.({
  user_name: "userNameType",
  password: "passwordType",
  password_reset_required: false,
})

Response structure


resp..user_name #=> String
resp..create_date #=> Time
resp..password_reset_required #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (String) —

    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: _+=,.@-

    [1]: docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoot.html [2]: wikipedia.org/wiki/regex

  • :password (String) —

    The new password for the user.

    This parameter must be omitted when you make the request with an

    AssumeRoot][1

    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.

    [1]: docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoot.html [2]: wikipedia.org/wiki/regex

  • :password_reset_required (Boolean) —

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

Returns:

See Also:



1614
1615
1616
1617
 
# File 'lib/aws-sdk-iam/client.rb', line 1614

def (params = {}, options = {})
  req = build_request(:create_login_profile, params)
  req.send_request(options)
end

#create_open_id_connect_provider(params = {}) ⇒ Types::CreateOpenIDConnectProviderResponse

Creates an IAM entity to describe an identity provider (IdP) that supports [OpenID Connect (OIDC)].

The OIDC provider that you create with this operation can be used as a principal in a role’s trust policy. Such a policy establishes a trust relationship between Amazon Web Services and the OIDC provider.

If you are using an OIDC identity provider from Google, Facebook, or Amazon Cognito, you don’t need to create a separate IAM identity provider. These OIDC identity providers are already built-in to Amazon Web Services and are available for your use. Instead, you can move directly to creating new roles using your identity provider. To learn more, see [Creating a role for web identity or OpenID connect federation] in the *IAM User Guide*.

When you create the IAM OIDC provider, you specify the following:

  • The URL of the OIDC identity provider (IdP) to trust

  • A list of client IDs (also known as audiences) that identify the application or applications allowed to authenticate using the OIDC provider

  • A list of tags that are attached to the specified IAM OIDC provider

  • A list of thumbprints of one or more server certificates that the IdP uses

You get all of this information from the OIDC IdP you want to use to access Amazon Web Services.

<note markdown=“1”> Amazon Web Services secures communication with OIDC identity providers (IdPs) using our library of trusted root certificate authorities (CAs) to verify the JSON Web Key Set (JWKS) endpoint’s TLS certificate. If your OIDC IdP relies on a certificate that is not signed by one of these trusted CAs, only then we secure communication using the thumbprints set in the IdP’s configuration.

</note>

<note markdown=“1”> The trust for the OIDC provider is derived from the IAM provider that this operation creates. Therefore, it is best to limit access to the

CreateOpenIDConnectProvider][3

operation to highly privileged users.

</note>

[1]: openid.net/connect/ [2]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-idp_oidc.html [3]: docs.aws.amazon.com/IAM/latest/APIReference/API_CreateOpenIDConnectProvider.html

Examples:

Example: To create an instance profile


# The following example defines a new OIDC provider in IAM with a client ID of my-application-id and pointing at the
# server with a URL of https://server.example.com.

resp = client.create_open_id_connect_provider({
  client_id_list: [
    "my-application-id", 
  ], 
  thumbprint_list: [
    "3768084dfb3d2b68b7897bf5f565da8efEXAMPLE", 
  ], 
  url: "https://server.example.com", 
})

resp.to_h outputs the following:
{
  open_id_connect_provider_arn: "arn:aws:iam::123456789012:oidc-provider/server.example.com", 
}

Request syntax with placeholder values


resp = client.create_open_id_connect_provider({
  url: "OpenIDConnectProviderUrlType", # required
  client_id_list: ["clientIDType"],
  thumbprint_list: ["thumbprintType"],
  tags: [
    {
      key: "tagKeyType", # required
      value: "tagValueType", # required
    },
  ],
})

Response structure


resp.open_id_connect_provider_arn #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :url (required, String) —

    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 ‘server.example.org` or `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 (Array<String>) —

    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 (Array<String>) —

    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 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 `keys.server.example.com.`

    For more information about obtaining the OIDC provider thumbprint, see

    Obtaining the thumbprint for an OpenID Connect provider][1

    in the

    *IAM user Guide*.

    <note markdown=“1”> If your OIDC provider’s discovery endpoint and JWKS endpoint (‘jwks_uri`) use different certificates or hosts, include the thumbprints for both endpoints in this list.

    </note>

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/identity-providers-oidc-obtain-thumbprint.html

  • :tags (Array<Types::Tag>) —

    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*.

    <note markdown=“1”> 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.

    </note>

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

Returns:

See Also:



1801
1802
1803
1804
 
# File 'lib/aws-sdk-iam/client.rb', line 1801

def create_open_id_connect_provider(params = {}, options = {})
  req = build_request(:create_open_id_connect_provider, params)
  req.send_request(options)
end

#create_policy(params = {}) ⇒ Types::CreatePolicyResponse

Creates a new managed policy for your Amazon Web Services account.

This operation creates a policy version with a version identifier of ‘v1` and sets v1 as the policy’s default version. For more information about policy versions, see [Versioning for managed policies] in the *IAM User Guide*.

As a best practice, you can validate your IAM policies. To learn more, see [Validating IAM policies] in the *IAM User Guide*.

For more information about managed policies in general, see [Managed policies and inline policies] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html [3]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html

Examples:

Request syntax with placeholder values


resp = client.create_policy({
  policy_name: "policyNameType", # required
  path: "policyPathType",
  policy_document: "policyDocumentType", # required
  description: "policyDescriptionType",
  tags: [
    {
      key: "tagKeyType", # required
      value: "tagValueType", # required
    },
  ],
})

Response structure


resp.policy.policy_name #=> String
resp.policy.policy_id #=> String
resp.policy.arn #=> String
resp.policy.path #=> String
resp.policy.default_version_id #=> String
resp.policy.attachment_count #=> Integer
resp.policy.permissions_boundary_usage_count #=> Integer
resp.policy.is_attachable #=> Boolean
resp.policy.description #=> String
resp.policy.create_date #=> Time
resp.policy.update_date #=> Time
resp.policy.tags #=> Array
resp.policy.tags[0].key #=> String
resp.policy.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :policy_name (required, String) —

    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 (String) —

    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.

    <note markdown=“1”> You cannot use an asterisk (*) in the path name.

    </note>

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html [2]: wikipedia.org/wiki/regex

  • :policy_document (required, String) —

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

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_grammar.html [3]: wikipedia.org/wiki/regex

  • :description (String) —

    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 (Array<Types::Tag>) —

    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*.

    <note markdown=“1”> 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.

    </note>

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

Returns:

See Also:



1958
1959
1960
1961
 
# File 'lib/aws-sdk-iam/client.rb', line 1958

def create_policy(params = {}, options = {})
  req = build_request(:create_policy, params)
  req.send_request(options)
end

#create_policy_version(params = {}) ⇒ Types::CreatePolicyVersionResponse

Creates a new version of the specified managed policy. To update a managed policy, you create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must delete an existing version using [DeletePolicyVersion] before you create a new version.

Optionally, you can set the new version as the policy’s default version. The default version is the version that is in effect for the IAM users, groups, and roles to which the policy is attached.

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

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_DeletePolicyVersion.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html

Examples:

Request syntax with placeholder values


resp = client.create_policy_version({
  policy_arn: "arnType", # required
  policy_document: "policyDocumentType", # required
  set_as_default: false,
})

Response structure


resp.policy_version.document #=> String
resp.policy_version.version_id #=> String
resp.policy_version.is_default_version #=> Boolean
resp.policy_version.create_date #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :policy_arn (required, String) —

    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*.

    [1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

  • :policy_document (required, String) —

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

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length [2]: wikipedia.org/wiki/regex

  • :set_as_default (Boolean) —

    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*.

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html

Returns:

See Also:



2061
2062
2063
2064
 
# File 'lib/aws-sdk-iam/client.rb', line 2061

def create_policy_version(params = {}, options = {})
  req = build_request(:create_policy_version, params)
  req.send_request(options)
end

#create_role(params = {}) ⇒ Types::CreateRoleResponse

Creates a new role for your Amazon Web Services account.

For more information about roles, see [IAM roles] in the *IAM User Guide*. For information about quotas for role names and the number of roles you can create, see [IAM and STS quotas] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html

Examples:

Example: To create an IAM role


# The following command creates a role named Test-Role and attaches a trust policy that you must convert from JSON to a
# string. Upon success, the response includes the same policy as a URL-encoded JSON string.

resp = client.create_role({
  assume_role_policy_document: "<Stringified-JSON>", 
  path: "/", 
  role_name: "Test-Role", 
})

resp.to_h outputs the following:
{
  role: {
    arn: "arn:aws:iam::123456789012:role/Test-Role", 
    assume_role_policy_document: "<URL-encoded-JSON>", 
    create_date: Time.parse("2013-06-07T20:43:32.821Z"), 
    path: "/", 
    role_id: "AKIAIOSFODNN7EXAMPLE", 
    role_name: "Test-Role", 
  }, 
}

Request syntax with placeholder values


resp = client.create_role({
  path: "pathType",
  role_name: "roleNameType", # required
  assume_role_policy_document: "policyDocumentType", # required
  description: "roleDescriptionType",
  max_session_duration: 1,
  permissions_boundary: "arnType",
  tags: [
    {
      key: "tagKeyType", # required
      value: "tagValueType", # required
    },
  ],
})

Response structure


resp.role.path #=> String
resp.role.role_name #=> String
resp.role.role_id #=> String
resp.role.arn #=> String
resp.role.create_date #=> Time
resp.role.assume_role_policy_document #=> String
resp.role.description #=> String
resp.role.max_session_duration #=> Integer
resp.role.permissions_boundary.permissions_boundary_type #=> String, one of "PermissionsBoundaryPolicy"
resp.role.permissions_boundary.permissions_boundary_arn #=> String
resp.role.tags #=> Array
resp.role.tags[0].key #=> String
resp.role.tags[0].value #=> String
resp.role.role_last_used.last_used_date #=> Time
resp.role.role_last_used.region #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :path (String) —

    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.

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html [2]: wikipedia.org/wiki/regex

  • :role_name (required, String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :assume_role_policy_document (required, String) —

    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.

    [1]: wikipedia.org/wiki/regex

  • :description (String) —

    A description of the role.

  • :max_session_duration (Integer) —

    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*.

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html

  • :permissions_boundary (String) —

    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 ][2] in the *IAM User Guide*.

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types

  • :tags (Array<Types::Tag>) —

    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*.

    <note markdown=“1”> 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.

    </note>

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

Returns:

See Also:



2266
2267
2268
2269
 
# File 'lib/aws-sdk-iam/client.rb', line 2266

def create_role(params = {}, options = {})
  req = build_request(:create_role, params)
  req.send_request(options)
end

#create_saml_provider(params = {}) ⇒ Types::CreateSAMLProviderResponse

Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0.

The SAML provider resource that you create with this operation can be used as a principal in an IAM role’s trust policy. Such a policy can enable federated users who sign in using the SAML IdP to assume the role. You can create an IAM role that supports Web-based single sign-on (SSO) to the Amazon Web Services Management Console or one that supports API access to Amazon Web Services.

When you create the SAML provider resource, you upload a SAML metadata document that you get from your IdP. That document includes the issuer’s name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that the IdP sends. You must generate the metadata document using the identity management software that is used as your organization’s IdP.

<note markdown=“1”> This operation requires [Signature Version 4].

</note>

For more information, see [Enabling SAML 2.0 federated users to access the Amazon Web Services Management Console] and [About SAML 2.0-based federation] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/general/latest/gr/signature-version-4.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-saml.html [3]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html

Examples:

Request syntax with placeholder values


resp = client.create_saml_provider({
  saml_metadata_document: "SAMLMetadataDocumentType", # required
  name: "SAMLProviderNameType", # required
  tags: [
    {
      key: "tagKeyType", # required
      value: "tagValueType", # required
    },
  ],
  assertion_encryption_mode: "Required", # accepts Required, Allowed
  add_private_key: "privateKeyType",
})

Response structure


resp.saml_provider_arn #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :saml_metadata_document (required, String) —

    An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer’s name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization’s IdP.

    For more information, see [About SAML 2.0-based federation] in the *IAM User Guide*

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html

  • :name (required, String) —

    The name of the provider 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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :tags (Array<Types::Tag>) —

    A list of tags that you want to attach to the new IAM SAML 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*.

    <note markdown=“1”> 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.

    </note>

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

  • :assertion_encryption_mode (String) —

    Specifies the encryption setting for the SAML provider.

  • :add_private_key (String) —

    The private key generated from your external identity provider. The private key must be a .pem file that uses AES-GCM or AES-CBC encryption algorithm to decrypt SAML assertions.

Returns:

See Also:



2384
2385
2386
2387
 
# File 'lib/aws-sdk-iam/client.rb', line 2384

def create_saml_provider(params = {}, options = {})
  req = build_request(:create_saml_provider, params)
  req.send_request(options)
end

#create_service_linked_role(params = {}) ⇒ Types::CreateServiceLinkedRoleResponse

Creates an IAM role that is linked to a specific Amazon Web Services service. The service controls the attached policies and when the role can be deleted. This helps ensure that the service is not broken by an unexpectedly changed or deleted role, which could put your Amazon Web Services resources into an unknown state. Allowing the service to control the role helps improve service stability and proper cleanup when a service and its role are no longer needed. For more information, see [Using service-linked roles] in the *IAM User Guide*.

To attach a policy to this service-linked role, you must make the request using the Amazon Web Services service that depends on this role.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html

Examples:

Request syntax with placeholder values


resp = client.create_service_linked_role({
  aws_service_name: "groupNameType", # required
  description: "roleDescriptionType",
  custom_suffix: "customSuffixType",
})

Response structure


resp.role.path #=> String
resp.role.role_name #=> String
resp.role.role_id #=> String
resp.role.arn #=> String
resp.role.create_date #=> Time
resp.role.assume_role_policy_document #=> String
resp.role.description #=> String
resp.role.max_session_duration #=> Integer
resp.role.permissions_boundary.permissions_boundary_type #=> String, one of "PermissionsBoundaryPolicy"
resp.role.permissions_boundary.permissions_boundary_arn #=> String
resp.role.tags #=> Array
resp.role.tags[0].key #=> String
resp.role.tags[0].value #=> String
resp.role.role_last_used.last_used_date #=> Time
resp.role.role_last_used.region #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :aws_service_name (required, String) —

    The service principal for the Amazon Web Services service to which this role is attached. You use a string similar to a URL but without the http:// in front. For example: ‘elasticbeanstalk.amazonaws.com`.

    Service principals are unique and case-sensitive. To find the exact service principal for your service-linked role, see [Amazon Web Services services that work with IAM] in the *IAM User Guide*. Look for the services that have Yes in the **Service-Linked Role** column. Choose the Yes link to view the service-linked role documentation for that service.

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html

  • :description (String) —

    The description of the role.

  • :custom_suffix (String) —

    A string that you provide, which is combined with the service-provided prefix to form the complete role name. If you make multiple requests for the same service, then you must supply a different ‘CustomSuffix` for each request. Otherwise the request fails with a duplicate role name error. For example, you could add `-1` or `-debug` to the suffix.

    Some services do not support the ‘CustomSuffix` parameter. If you provide an optional suffix and the operation fails, try the operation again without the suffix.

Returns:

See Also:



2471
2472
2473
2474
 
# File 'lib/aws-sdk-iam/client.rb', line 2471

def create_service_linked_role(params = {}, options = {})
  req = build_request(:create_service_linked_role, params)
  req.send_request(options)
end

#create_service_specific_credential(params = {}) ⇒ Types::CreateServiceSpecificCredentialResponse

Generates a set of credentials consisting of a user name and password that can be used to access the service specified in the request. These credentials are generated by IAM, and can be used only for the specified service.

You can have a maximum of two sets of service-specific credentials for each supported service per user.

You can create service-specific credentials for Amazon Bedrock, Amazon CloudWatch Logs, CodeCommit and Amazon Keyspaces (for Apache Cassandra).

You can reset the password to a new service-generated value by calling [ResetServiceSpecificCredential].

For more information about service-specific credentials, see

Service-specific credentials for IAM users][2

in the *IAM User

Guide*.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_ResetServiceSpecificCredential.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_bedrock.html

Examples:

Request syntax with placeholder values


resp = client.create_service_specific_credential({
  user_name: "userNameType", # required
  service_name: "serviceName", # required
  credential_age_days: 1,
})

Response structure


resp.service_specific_credential.create_date #=> Time
resp.service_specific_credential.expiration_date #=> Time
resp.service_specific_credential.service_name #=> String
resp.service_specific_credential.service_user_name #=> String
resp.service_specific_credential.service_password #=> String
resp.service_specific_credential.service_credential_alias #=> String
resp.service_specific_credential.service_credential_secret #=> String
resp.service_specific_credential.service_specific_credential_id #=> String
resp.service_specific_credential.user_name #=> String
resp.service_specific_credential.status #=> String, one of "Active", "Inactive", "Expired"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (required, String) —

    The name of the IAM user that is to be associated with the credentials. The new service-specific credentials have the same permissions as the associated user except that they can be used only to access the specified service.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :service_name (required, String) —

    The name of the Amazon Web Services service that is to be associated with the credentials. The service you specify here is the only service that can be accessed using these credentials.

  • :credential_age_days (Integer) —

    The number of days until the service specific credential expires. This field is only valid for Bedrock and CloudWatch Logs API keys and must be a positive integer. When not specified, the credential will not expire.

Returns:

See Also:



2555
2556
2557
2558
 
# File 'lib/aws-sdk-iam/client.rb', line 2555

def create_service_specific_credential(params = {}, options = {})
  req = build_request(:create_service_specific_credential, params)
  req.send_request(options)
end

#create_user(params = {}) ⇒ Types::CreateUserResponse

Creates a new IAM user for your Amazon Web Services account.

For information about quotas for the number of IAM users you can create, see [IAM and STS quotas] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html

Examples:

Example: To create an IAM user


# The following create-user command creates an IAM user named Bob in the current account.

resp = client.create_user({
  user_name: "Bob", 
})

resp.to_h outputs the following:
{
  user: {
    arn: "arn:aws:iam::123456789012:user/Bob", 
    create_date: Time.parse("2013-06-08T03:20:41.270Z"), 
    path: "/", 
    user_id: "AKIAIOSFODNN7EXAMPLE", 
    user_name: "Bob", 
  }, 
}

Request syntax with placeholder values


resp = client.create_user({
  path: "pathType",
  user_name: "userNameType", # required
  permissions_boundary: "arnType",
  tags: [
    {
      key: "tagKeyType", # required
      value: "tagValueType", # required
    },
  ],
})

Response structure


resp.user.path #=> String
resp.user.user_name #=> String
resp.user.user_id #=> String
resp.user.arn #=> String
resp.user.create_date #=> Time
resp.user.password_last_used #=> Time
resp.user.permissions_boundary.permissions_boundary_type #=> String, one of "PermissionsBoundaryPolicy"
resp.user.permissions_boundary.permissions_boundary_arn #=> String
resp.user.tags #=> Array
resp.user.tags[0].key #=> String
resp.user.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :path (String) —

    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.

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html [2]: wikipedia.org/wiki/regex

  • :user_name (required, String) —

    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 (String) —

    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 ][2] in the *IAM User Guide*.

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types

  • :tags (Array<Types::Tag>) —

    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*.

    <note markdown=“1”> 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.

    </note>

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

Returns:

See Also:



2685
2686
2687
2688
 
# File 'lib/aws-sdk-iam/client.rb', line 2685

def create_user(params = {}, options = {})
  req = build_request(:create_user, params)
  req.send_request(options)
end

#create_virtual_mfa_device(params = {}) ⇒ Types::CreateVirtualMFADeviceResponse

Creates a new virtual MFA device for the Amazon Web Services account. After creating the virtual MFA, use [EnableMFADevice] to attach the MFA device to an IAM user. For more information about creating and working with virtual MFA devices, see [Using a virtual MFA device] in the *IAM User Guide*.

For information about the maximum number of MFA devices you can create, see [IAM and STS quotas] in the *IAM User Guide*.

The seed information contained in the QR code and the Base32 string should be treated like any other secret access information. In other words, protect the seed information as you would your Amazon Web Services access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_EnableMFADevice.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html [3]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html

Examples:

Request syntax with placeholder values


resp = client.create_virtual_mfa_device({
  path: "pathType",
  virtual_mfa_device_name: "virtualMFADeviceName", # required
  tags: [
    {
      key: "tagKeyType", # required
      value: "tagValueType", # required
    },
  ],
})

Response structure


resp.virtual_mfa_device.serial_number #=> String
resp.virtual_mfa_device.base_32_string_seed #=> String
resp.virtual_mfa_device.qr_code_png #=> String
resp.virtual_mfa_device.user.path #=> String
resp.virtual_mfa_device.user.user_name #=> String
resp.virtual_mfa_device.user.user_id #=> String
resp.virtual_mfa_device.user.arn #=> String
resp.virtual_mfa_device.user.create_date #=> Time
resp.virtual_mfa_device.user.password_last_used #=> Time
resp.virtual_mfa_device.user.permissions_boundary.permissions_boundary_type #=> String, one of "PermissionsBoundaryPolicy"
resp.virtual_mfa_device.user.permissions_boundary.permissions_boundary_arn #=> String
resp.virtual_mfa_device.user.tags #=> Array
resp.virtual_mfa_device.user.tags[0].key #=> String
resp.virtual_mfa_device.user.tags[0].value #=> String
resp.virtual_mfa_device.enable_date #=> Time
resp.virtual_mfa_device.tags #=> Array
resp.virtual_mfa_device.tags[0].key #=> String
resp.virtual_mfa_device.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :path (String) —

    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.

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html [2]: wikipedia.org/wiki/regex

  • :virtual_mfa_device_name (required, String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :tags (Array<Types::Tag>) —

    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*.

    <note markdown=“1”> 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.

    </note>

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

Returns:

See Also:



2802
2803
2804
2805
 
# File 'lib/aws-sdk-iam/client.rb', line 2802

def create_virtual_mfa_device(params = {}, options = {})
  req = build_request(:create_virtual_mfa_device, params)
  req.send_request(options)
end

#deactivate_mfa_device(params = {}) ⇒ Struct

Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled.

For more information about creating and working with virtual MFA devices, see [Enabling a virtual multi-factor authentication (MFA) device] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html

Examples:

Request syntax with placeholder values


resp = client.deactivate_mfa_device({
  user_name: "existingUserNameType",
  serial_number: "serialNumberType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (String) —

    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: _+=,.@-

    [1]: docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoot.html [2]: wikipedia.org/wiki/regex

  • :serial_number (required, String) —

    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:

    ,.@:/-

    [1]: wikipedia.org/wiki/regex

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2862
2863
2864
2865
 
# File 'lib/aws-sdk-iam/client.rb', line 2862

def deactivate_mfa_device(params = {}, options = {})
  req = build_request(:deactivate_mfa_device, params)
  req.send_request(options)
end

#delete_access_key(params = {}) ⇒ Struct

Deletes the access key pair associated with the specified IAM user.

If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.

Examples:

Example: To delete an access key for an IAM user


# The following command deletes one access key (access key ID and secret access key) assigned to the IAM user named Bob.

resp = client.delete_access_key({
  access_key_id: "AKIDPMS9RO4H3FEXAMPLE", 
  user_name: "Bob", 
})

Request syntax with placeholder values


resp = client.delete_access_key({
  user_name: "existingUserNameType",
  access_key_id: "accessKeyIdType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (String) —

    The name of the user whose access key pair you want to delete.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :access_key_id (required, String) —

    The access key ID for the access key ID and secret access key you want to delete.

    This parameter allows (through its [regex pattern]) a string of characters that can consist of any upper or lowercased letter or digit.

    [1]: wikipedia.org/wiki/regex

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2923
2924
2925
2926
 
# File 'lib/aws-sdk-iam/client.rb', line 2923

def delete_access_key(params = {}, options = {})
  req = build_request(:delete_access_key, params)
  req.send_request(options)
end

#delete_account_alias(params = {}) ⇒ Struct

Deletes the specified Amazon Web Services account alias. For information about using an Amazon Web Services account alias, see [Creating, deleting, and listing an Amazon Web Services account alias] in the *Amazon Web Services Sign-In User Guide*.

[1]: docs.aws.amazon.com/signin/latest/userguide/CreateAccountAlias.html

Examples:

Example: To delete an account alias


# The following command removes the alias mycompany from the current AWS account:

resp = client.({
  account_alias: "mycompany", 
})

Request syntax with placeholder values


resp = client.({
  account_alias: "accountAliasType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_alias (required, String) —

    The name of the account alias to delete.

    This parameter allows (through its [regex pattern]) a string of characters consisting of lowercase letters, digits, and dashes. You cannot start or finish with a dash, nor can you have two dashes in a row.

    [1]: wikipedia.org/wiki/regex

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2970
2971
2972
2973
 
# File 'lib/aws-sdk-iam/client.rb', line 2970

def (params = {}, options = {})
  req = build_request(:delete_account_alias, params)
  req.send_request(options)
end

#delete_account_password_policy(params = {}) ⇒ Struct

Deletes the password policy for the Amazon Web Services account. There are no parameters.

Examples:

Example: To delete the current account password policy


# The following command removes the password policy from the current AWS account:

resp = client.({
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2992
2993
2994
2995
 
# File 'lib/aws-sdk-iam/client.rb', line 2992

def (params = {}, options = {})
  req = build_request(:delete_account_password_policy, params)
  req.send_request(options)
end

#delete_group(params = {}) ⇒ Struct

Deletes the specified IAM group. The group must not contain any users or have any attached policies.

Examples:

Request syntax with placeholder values


resp = client.delete_group({
  group_name: "groupNameType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :group_name (required, String) —

    The name of the IAM group to delete.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3024
3025
3026
3027
 
# File 'lib/aws-sdk-iam/client.rb', line 3024

def delete_group(params = {}, options = {})
  req = build_request(:delete_group, params)
  req.send_request(options)
end

#delete_group_policy(params = {}) ⇒ Struct

Deletes the specified inline policy that is embedded in the specified IAM group.

A group can also have managed policies attached to it. To detach a managed policy from a group, use [DetachGroupPolicy]. For more information about policies, refer to [Managed policies and inline policies] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_DetachGroupPolicy.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html

Examples:

Example: To delete a policy from an IAM group


# The following command deletes the policy named ExamplePolicy from the group named Admins:

resp = client.delete_group_policy({
  group_name: "Admins", 
  policy_name: "ExamplePolicy", 
})

Request syntax with placeholder values


resp = client.delete_group_policy({
  group_name: "groupNameType", # required
  policy_name: "policyNameType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :group_name (required, String) —

    The name (friendly name, not ARN) identifying the group that the policy is embedded in.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :policy_name (required, String) —

    The name identifying the policy document to delete.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3090
3091
3092
3093
 
# File 'lib/aws-sdk-iam/client.rb', line 3090

def delete_group_policy(params = {}, options = {})
  req = build_request(:delete_group_policy, params)
  req.send_request(options)
end

#delete_instance_profile(params = {}) ⇒ Struct

Deletes the specified instance profile. The instance profile must not have an associated role.

Make sure that you do not have any Amazon EC2 instances running with the instance profile you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.

For more information about instance profiles, see [Using instance profiles] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html

Examples:

Example: To delete an instance profile


# The following command deletes the instance profile named ExampleInstanceProfile

resp = client.delete_instance_profile({
  instance_profile_name: "ExampleInstanceProfile", 
})

Request syntax with placeholder values


resp = client.delete_instance_profile({
  instance_profile_name: "instanceProfileNameType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_profile_name (required, String) —

    The name of the instance profile to delete.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3143
3144
3145
3146
 
# File 'lib/aws-sdk-iam/client.rb', line 3143

def delete_instance_profile(params = {}, options = {})
  req = build_request(:delete_instance_profile, params)
  req.send_request(options)
end

#delete_login_profile(params = {}) ⇒ Struct

Deletes the password for the specified IAM user or root user, For more information, see [Managing passwords for IAM users].

You can use the CLI, the Amazon Web Services API, or the Users page in the IAM console to delete a password for any IAM user. You can use [ChangePassword] to update, but not delete, your own password in the **My Security Credentials** page in the Amazon Web Services Management Console.

Deleting a user’s password does not prevent a user from accessing Amazon Web Services through the command line interface or the API. To prevent all user access, you must also either make any access keys inactive or delete them. For more information about making keys inactive or deleting them, see [UpdateAccessKey] and [DeleteAccessKey].

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_passwords_admin-change-user.html [2]: docs.aws.amazon.com/IAM/latest/APIReference/API_ChangePassword.html [3]: docs.aws.amazon.com/IAM/latest/APIReference/API_UpdateAccessKey.html [4]: docs.aws.amazon.com/IAM/latest/APIReference/API_DeleteAccessKey.html

Examples:

Example: To delete a password for an IAM user


# The following command deletes the password for the IAM user named Bob.

resp = client.({
  user_name: "Bob", 
})

Request syntax with placeholder values


resp = client.({
  user_name: "userNameType",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (String) —

    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: _+=,.@-

    [1]: docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoot.html [2]: wikipedia.org/wiki/regex

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3210
3211
3212
3213
 
# File 'lib/aws-sdk-iam/client.rb', line 3210

def (params = {}, options = {})
  req = build_request(:delete_login_profile, params)
  req.send_request(options)
end

#delete_open_id_connect_provider(params = {}) ⇒ Struct

Deletes an OpenID Connect identity provider (IdP) resource object in IAM.

Deleting an IAM OIDC provider resource does not update any roles that reference the provider as a principal in their trust policies. Any attempt to assume a role that references a deleted provider fails.

This operation is idempotent; it does not fail or return an error if you call the operation for a provider that does not exist.

Examples:

Request syntax with placeholder values


resp = client.delete_open_id_connect_provider({
  open_id_connect_provider_arn: "arnType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3247
3248
3249
3250
 
# File 'lib/aws-sdk-iam/client.rb', line 3247

def delete_open_id_connect_provider(params = {}, options = {})
  req = build_request(:delete_open_id_connect_provider, params)
  req.send_request(options)
end

#delete_policy(params = {}) ⇒ Struct

Deletes the specified managed policy.

Before you can delete a managed policy, you must first detach the policy from all users, groups, and roles that it is attached to. In addition, you must delete all the policy’s versions. The following steps describe the process for deleting a managed policy:

For information about managed policies, see [Managed policies and inline policies] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_DetachUserPolicy.html [2]: docs.aws.amazon.com/IAM/latest/APIReference/API_DetachGroupPolicy.html [3]: docs.aws.amazon.com/IAM/latest/APIReference/API_DetachRolePolicy.html [4]: docs.aws.amazon.com/IAM/latest/APIReference/API_ListEntitiesForPolicy.html [5]: docs.aws.amazon.com/IAM/latest/APIReference/API_DeletePolicyVersion.html [6]: docs.aws.amazon.com/IAM/latest/APIReference/API_ListPolicyVersions.html [7]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html

Examples:

Request syntax with placeholder values


resp = client.delete_policy({
  policy_arn: "arnType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3308
3309
3310
3311
 
# File 'lib/aws-sdk-iam/client.rb', line 3308

def delete_policy(params = {}, options = {})
  req = build_request(:delete_policy, params)
  req.send_request(options)
end

#delete_policy_version(params = {}) ⇒ Struct

Deletes the specified version from the specified managed policy.

You cannot delete the default version from a policy using this operation. To delete the default version from a policy, use [DeletePolicy]. To find out which version of a policy is marked as the default version, use [ListPolicyVersions].

For information about versions for managed policies, see [Versioning for managed policies] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_DeletePolicy.html [2]: docs.aws.amazon.com/IAM/latest/APIReference/API_ListPolicyVersions.html [3]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html

Examples:

Request syntax with placeholder values


resp = client.delete_policy_version({
  policy_arn: "arnType", # required
  version_id: "policyVersionIdType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3369
3370
3371
3372
 
# File 'lib/aws-sdk-iam/client.rb', line 3369

def delete_policy_version(params = {}, options = {})
  req = build_request(:delete_policy_version, params)
  req.send_request(options)
end

#delete_role(params = {}) ⇒ Struct

Deletes the specified role. Unlike the Amazon Web Services Management Console, when you delete a role programmatically, you must delete the items attached to the role manually, or the deletion fails. For more information, see [Deleting an IAM role]. Before attempting to delete a role, remove the following attached items:

Make sure that you do not have any Amazon EC2 instances running with the role you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage_delete.html#roles-managingrole-deleting-cli [2]: docs.aws.amazon.com/IAM/latest/APIReference/API_DeleteRolePolicy.html [3]: docs.aws.amazon.com/IAM/latest/APIReference/API_DetachRolePolicy.html [4]: docs.aws.amazon.com/IAM/latest/APIReference/API_RemoveRoleFromInstanceProfile.html [5]: docs.aws.amazon.com/IAM/latest/APIReference/API_DeleteInstanceProfile.html

Examples:

Example: To delete an IAM role


# The following command removes the role named Test-Role.

resp = client.delete_role({
  role_name: "Test-Role", 
})

Request syntax with placeholder values


resp = client.delete_role({
  role_name: "roleNameType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :role_name (required, String) —

    The name of the role to delete.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3435
3436
3437
3438
 
# File 'lib/aws-sdk-iam/client.rb', line 3435

def delete_role(params = {}, options = {})
  req = build_request(:delete_role, params)
  req.send_request(options)
end

#delete_role_permissions_boundary(params = {}) ⇒ Struct

Deletes the permissions boundary for the specified IAM role.

You cannot set the boundary for a service-linked role.

Deleting the permissions boundary for a role might increase its permissions. For example, it might allow anyone who assumes the role to perform all the actions granted in its permissions policies.

Examples:

Request syntax with placeholder values


resp = client.delete_role_permissions_boundary({
  role_name: "roleNameType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :role_name (required, String) —

    The name (friendly name, not ARN) of the IAM role from which you want to remove the permissions boundary.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3464
3465
3466
3467
 
# File 'lib/aws-sdk-iam/client.rb', line 3464

def delete_role_permissions_boundary(params = {}, options = {})
  req = build_request(:delete_role_permissions_boundary, params)
  req.send_request(options)
end

#delete_role_policy(params = {}) ⇒ Struct

Deletes the specified inline policy that is embedded in the specified IAM role.

A role can also have managed policies attached to it. To detach a managed policy from a role, use [DetachRolePolicy]. For more information about policies, refer to [Managed policies and inline policies] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_DetachRolePolicy.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html

Examples:

Example: To remove a policy from an IAM role


# The following command removes the policy named ExamplePolicy from the role named Test-Role.

resp = client.delete_role_policy({
  policy_name: "ExamplePolicy", 
  role_name: "Test-Role", 
})

Request syntax with placeholder values


resp = client.delete_role_policy({
  role_name: "roleNameType", # required
  policy_name: "policyNameType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :role_name (required, String) —

    The name (friendly name, not ARN) identifying the role that the policy is embedded in.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :policy_name (required, String) —

    The name of the inline policy to delete from the specified IAM role.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3530
3531
3532
3533
 
# File 'lib/aws-sdk-iam/client.rb', line 3530

def delete_role_policy(params = {}, options = {})
  req = build_request(:delete_role_policy, params)
  req.send_request(options)
end

#delete_saml_provider(params = {}) ⇒ Struct

Deletes a SAML provider resource in IAM.

Deleting the provider resource from IAM does not update any roles that reference the SAML provider resource’s ARN as a principal in their trust policies. Any attempt to assume a role that references a non-existent provider resource ARN fails.

<note markdown=“1”> This operation requires [Signature Version 4].

</note>

[1]: docs.aws.amazon.com/general/latest/gr/signature-version-4.html

Examples:

Request syntax with placeholder values


resp = client.delete_saml_provider({
  saml_provider_arn: "arnType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :saml_provider_arn (required, String) —

    The Amazon Resource Name (ARN) of the SAML provider to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3565
3566
3567
3568
 
# File 'lib/aws-sdk-iam/client.rb', line 3565

def delete_saml_provider(params = {}, options = {})
  req = build_request(:delete_saml_provider, params)
  req.send_request(options)
end

#delete_server_certificate(params = {}) ⇒ Struct

Deletes the specified server certificate.

For more information about working with server certificates, see

Working with server certificates][1

in the *IAM User Guide*. This

topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.

If you are using a server certificate with Elastic Load Balancing, deleting the certificate could have implications for your application. If Elastic Load Balancing doesn’t detect the deletion of bound certificates, it may continue to use the certificates. This could cause Elastic Load Balancing to stop accepting traffic. We recommend that you remove the reference to the certificate from Elastic Load Balancing before using this command to delete the certificate. For more information, see [DeleteLoadBalancerListeners] in the *Elastic Load Balancing API Reference*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html [2]: docs.aws.amazon.com/ElasticLoadBalancing/latest/APIReference/API_DeleteLoadBalancerListeners.html

Examples:

Request syntax with placeholder values


resp = client.delete_server_certificate({
  server_certificate_name: "serverCertificateNameType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :server_certificate_name (required, String) —

    The name of the server certificate you want to delete.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3669
3670
3671
3672
 
# File 'lib/aws-sdk-iam/client.rb', line 3669

def delete_server_certificate(params = {}, options = {})
  req = build_request(:delete_server_certificate, params)
  req.send_request(options)
end

#delete_service_linked_role(params = {}) ⇒ Types::DeleteServiceLinkedRoleResponse

Submits a service-linked role deletion request and returns a ‘DeletionTaskId`, which you can use to check the status of the deletion. Before you call this operation, confirm that the role has no active sessions and that any resources used by the role in the linked service are deleted. If you call this operation more than once for the same service-linked role and an earlier deletion task is not complete, then the `DeletionTaskId` of the earlier request is returned.

If you submit a deletion request for a service-linked role whose linked service is still accessing a resource, then the deletion task fails. If it fails, the [GetServiceLinkedRoleDeletionStatus] operation returns the reason for the failure, usually including the resources that must be deleted. To delete the service-linked role, you must first remove those resources from the linked service and then submit the deletion request again. Resources are specific to the service that is linked to the role. For more information about removing resources from a service, see the [Amazon Web Services documentation] for your service.

For more information about service-linked roles, see [Roles terms and concepts: Amazon Web Services service-linked role] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetServiceLinkedRoleDeletionStatus.html [2]: docs.aws.amazon.com/ [3]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role

Examples:

Request syntax with placeholder values


resp = client.delete_service_linked_role({
  role_name: "roleNameType", # required
})

Response structure


resp.deletion_task_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :role_name (required, String) —

    The name of the service-linked role to be deleted.

Returns:

See Also:



3724
3725
3726
3727
 
# File 'lib/aws-sdk-iam/client.rb', line 3724

def delete_service_linked_role(params = {}, options = {})
  req = build_request(:delete_service_linked_role, params)
  req.send_request(options)
end

#delete_service_specific_credential(params = {}) ⇒ Struct

Deletes the specified service-specific credential.

Examples:

Request syntax with placeholder values


resp = client.delete_service_specific_credential({
  user_name: "userNameType",
  service_specific_credential_id: "serviceSpecificCredentialId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (String) —

    The name of the IAM user associated with the service-specific credential. If this value is not specified, then the operation assumes the user whose credentials are used to call the operation.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :service_specific_credential_id (required, String) —

    The unique identifier of the service-specific credential. You can get this value by calling [ListServiceSpecificCredentials].

    This parameter allows (through its [regex pattern]) a string of characters that can consist of any upper or lowercased letter or digit.

    [1]: docs.aws.amazon.com/IAM/latest/APIReference/API_ListServiceSpecificCredentials.html [2]: wikipedia.org/wiki/regex

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3771
3772
3773
3774
 
# File 'lib/aws-sdk-iam/client.rb', line 3771

def delete_service_specific_credential(params = {}, options = {})
  req = build_request(:delete_service_specific_credential, params)
  req.send_request(options)
end

#delete_signing_certificate(params = {}) ⇒ Struct

Deletes a signing certificate associated with the specified IAM user.

If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated IAM users.

Examples:

Example: To delete a signing certificate for an IAM user


# The following command deletes the specified signing certificate for the IAM user named Anika.

resp = client.delete_signing_certificate({
  certificate_id: "TA7SMP42TDN5Z26OBPJE7EXAMPLE", 
  user_name: "Anika", 
})

Request syntax with placeholder values


resp = client.delete_signing_certificate({
  user_name: "existingUserNameType",
  certificate_id: "certificateIdType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (String) —

    The name of the user the signing certificate belongs to.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :certificate_id (required, String) —

    The ID of the signing certificate to delete.

    The format of this parameter, as described by its [regex] pattern, is a string of characters that can be upper- or lower-cased letters or digits.

    [1]: wikipedia.org/wiki/regex

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3831
3832
3833
3834
 
# File 'lib/aws-sdk-iam/client.rb', line 3831

def delete_signing_certificate(params = {}, options = {})
  req = build_request(:delete_signing_certificate, params)
  req.send_request(options)
end

#delete_ssh_public_key(params = {}) ⇒ Struct

Deletes the specified SSH public key.

The SSH public key deleted by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see [Set up CodeCommit for SSH connections] in the *CodeCommit User Guide*.

[1]: docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html

Examples:

Request syntax with placeholder values


resp = client.delete_ssh_public_key({
  user_name: "userNameType", # required
  ssh_public_key_id: "publicKeyIdType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (required, String) —

    The name of the IAM user associated with the SSH public key.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :ssh_public_key_id (required, String) —

    The unique identifier for the SSH public key.

    This parameter allows (through its [regex pattern]) a string of characters that can consist of any upper or lowercased letter or digit.

    [1]: wikipedia.org/wiki/regex

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3618
3619
3620
3621
 
# File 'lib/aws-sdk-iam/client.rb', line 3618

def delete_ssh_public_key(params = {}, options = {})
  req = build_request(:delete_ssh_public_key, params)
  req.send_request(options)
end

#delete_user(params = {}) ⇒ Struct

Deletes the specified IAM user. Unlike the Amazon Web Services Management Console, when you delete a user programmatically, you must delete the items attached to the user manually, or the deletion fails. For more information, see [Deleting an IAM user]. Before attempting to delete a user, remove the following items:

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_users_manage.html#id_users_deleting_cli [2]: docs.aws.amazon.com/IAM/latest/APIReference/API_DeleteLoginProfile.html [3]: docs.aws.amazon.com/IAM/latest/APIReference/API_DeleteAccessKey.html [4]: docs.aws.amazon.com/IAM/latest/APIReference/API_DeleteSigningCertificate.html [5]: docs.aws.amazon.com/IAM/latest/APIReference/API_DeleteSSHPublicKey.html [6]: docs.aws.amazon.com/IAM/latest/APIReference/API_DeleteServiceSpecificCredential.html [7]: docs.aws.amazon.com/IAM/latest/APIReference/API_DeactivateMFADevice.html [8]: docs.aws.amazon.com/IAM/latest/APIReference/API_DeleteVirtualMFADevice.html [9]: docs.aws.amazon.com/IAM/latest/APIReference/API_DeleteUserPolicy.html [10]: docs.aws.amazon.com/IAM/latest/APIReference/API_DetachUserPolicy.html [11]: docs.aws.amazon.com/IAM/latest/APIReference/API_RemoveUserFromGroup.html

Examples:

Example: To delete an IAM user


# The following command removes the IAM user named Bob from the current account.

resp = client.delete_user({
  user_name: "Bob", 
})

Request syntax with placeholder values


resp = client.delete_user({
  user_name: "existingUserNameType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (required, String) —

    The name of the user to delete.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3908
3909
3910
3911
 
# File 'lib/aws-sdk-iam/client.rb', line 3908

def delete_user(params = {}, options = {})
  req = build_request(:delete_user, params)
  req.send_request(options)
end

#delete_user_permissions_boundary(params = {}) ⇒ Struct

Deletes the permissions boundary for the specified IAM user.

Deleting the permissions boundary for a user might increase its permissions by allowing the user to perform all the actions granted in its permissions policies.

Examples:

Request syntax with placeholder values


resp = client.delete_user_permissions_boundary({
  user_name: "userNameType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (required, String) —

    The name (friendly name, not ARN) of the IAM user from which you want to remove the permissions boundary.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3935
3936
3937
3938
 
# File 'lib/aws-sdk-iam/client.rb', line 3935

def delete_user_permissions_boundary(params = {}, options = {})
  req = build_request(:delete_user_permissions_boundary, params)
  req.send_request(options)
end

#delete_user_policy(params = {}) ⇒ Struct

Deletes the specified inline policy that is embedded in the specified IAM user.

A user can also have managed policies attached to it. To detach a managed policy from a user, use [DetachUserPolicy]. For more information about policies, refer to [Managed policies and inline policies] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_DetachUserPolicy.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html

Examples:

Example: To remove a policy from an IAM user


# The following delete-user-policy command removes the specified policy from the IAM user named Juan:

resp = client.delete_user_policy({
  policy_name: "ExamplePolicy", 
  user_name: "Juan", 
})

Request syntax with placeholder values


resp = client.delete_user_policy({
  user_name: "existingUserNameType", # required
  policy_name: "policyNameType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (required, String) —

    The name (friendly name, not ARN) identifying the user that the policy is embedded in.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :policy_name (required, String) —

    The name identifying the policy document to delete.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4001
4002
4003
4004
 
# File 'lib/aws-sdk-iam/client.rb', line 4001

def delete_user_policy(params = {}, options = {})
  req = build_request(:delete_user_policy, params)
  req.send_request(options)
end

#delete_virtual_mfa_device(params = {}) ⇒ Struct

Deletes a virtual MFA device.

<note markdown=“1”> You must deactivate a user’s virtual MFA device before you can delete it. For information about deactivating MFA devices, see [DeactivateMFADevice].

</note>

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_DeactivateMFADevice.html

Examples:

Example: To remove a virtual MFA device


# The following delete-virtual-mfa-device command removes the specified MFA device from the current AWS account.

resp = client.delete_virtual_mfa_device({
  serial_number: "arn:aws:iam::123456789012:mfa/ExampleName", 
})

Request syntax with placeholder values


resp = client.delete_virtual_mfa_device({
  serial_number: "serialNumberType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :serial_number (required, String) —

    The serial number that uniquely identifies the MFA device. 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:

    ,.@:/-

    [1]: wikipedia.org/wiki/regex

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4052
4053
4054
4055
 
# File 'lib/aws-sdk-iam/client.rb', line 4052

def delete_virtual_mfa_device(params = {}, options = {})
  req = build_request(:delete_virtual_mfa_device, params)
  req.send_request(options)
end

#detach_group_policy(params = {}) ⇒ Struct

Removes the specified managed policy from the specified IAM group.

A group can also have inline policies embedded with it. To delete an inline policy, use [DeleteGroupPolicy]. For information about policies, see [Managed policies and inline policies] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_DeleteGroupPolicy.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html

Examples:

Request syntax with placeholder values


resp = client.detach_group_policy({
  group_name: "groupNameType", # required
  policy_arn: "arnType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :group_name (required, String) —

    The name (friendly name, not ARN) of the IAM group to detach the policy from.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :policy_arn (required, String) —

    The Amazon Resource Name (ARN) of the IAM policy you want to detach.

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

    [1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4105
4106
4107
4108
 
# File 'lib/aws-sdk-iam/client.rb', line 4105

def detach_group_policy(params = {}, options = {})
  req = build_request(:detach_group_policy, params)
  req.send_request(options)
end

#detach_role_policy(params = {}) ⇒ Struct

Removes the specified managed policy from the specified role.

A role can also have inline policies embedded with it. To delete an inline policy, use [DeleteRolePolicy]. For information about policies, see [Managed policies and inline policies] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_DeleteRolePolicy.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html

Examples:

Request syntax with placeholder values


resp = client.detach_role_policy({
  role_name: "roleNameType", # required
  policy_arn: "arnType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :role_name (required, String) —

    The name (friendly name, not ARN) of the IAM role to detach the policy from.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :policy_arn (required, String) —

    The Amazon Resource Name (ARN) of the IAM policy you want to detach.

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

    [1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4158
4159
4160
4161
 
# File 'lib/aws-sdk-iam/client.rb', line 4158

def detach_role_policy(params = {}, options = {})
  req = build_request(:detach_role_policy, params)
  req.send_request(options)
end

#detach_user_policy(params = {}) ⇒ Struct

Removes the specified managed policy from the specified user.

A user can also have inline policies embedded with it. To delete an inline policy, use [DeleteUserPolicy]. For information about policies, see [Managed policies and inline policies] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_DeleteUserPolicy.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html

Examples:

Request syntax with placeholder values


resp = client.detach_user_policy({
  user_name: "userNameType", # required
  policy_arn: "arnType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (required, String) —

    The name (friendly name, not ARN) of the IAM user to detach the policy from.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :policy_arn (required, String) —

    The Amazon Resource Name (ARN) of the IAM policy you want to detach.

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

    [1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4211
4212
4213
4214
 
# File 'lib/aws-sdk-iam/client.rb', line 4211

def detach_user_policy(params = {}, options = {})
  req = build_request(:detach_user_policy, params)
  req.send_request(options)
end

#disable_organizations_root_credentials_management(params = {}) ⇒ Types::DisableOrganizationsRootCredentialsManagementResponse

Disables the management of privileged root user credentials across member accounts in your organization. When you disable this feature, the management account and the delegated administrator for IAM can no longer manage root user credentials for member accounts in your organization.

Examples:

Example: To disable the RootCredentialsManagement feature in your organization


# The following command disables the management of privileged root user credentials across member accounts in your
# organization.

resp = client.disable_organizations_root_credentials_management({
})

resp.to_h outputs the following:
{
  enabled_features: [
    "RootSessions", 
  ], 
  organization_id: "o-aa111bb222", 
}

Response structure


resp.organization_id #=> String
resp.enabled_features #=> Array
resp.enabled_features[0] #=> String, one of "RootCredentialsManagement", "RootSessions"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



4254
4255
4256
4257
 
# File 'lib/aws-sdk-iam/client.rb', line 4254

def disable_organizations_root_credentials_management(params = {}, options = {})
  req = build_request(:disable_organizations_root_credentials_management, params)
  req.send_request(options)
end

#disable_organizations_root_sessions(params = {}) ⇒ Types::DisableOrganizationsRootSessionsResponse

Disables root user sessions for privileged tasks across member accounts in your organization. When you disable this feature, the management account and the delegated administrator for IAM can no longer perform privileged tasks on member accounts in your organization.

Examples:

Example: To disable the RootSessions feature in your organization


# The following command disables root user sessions for privileged tasks across member accounts in your organization.

resp = client.disable_organizations_root_sessions({
})

resp.to_h outputs the following:
{
  enabled_features: [
    "RootCredentialsManagement", 
  ], 
  organization_id: "o-aa111bb222", 
}

Response structure


resp.organization_id #=> String
resp.enabled_features #=> Array
resp.enabled_features[0] #=> String, one of "RootCredentialsManagement", "RootSessions"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



4296
4297
4298
4299
 
# File 'lib/aws-sdk-iam/client.rb', line 4296

def disable_organizations_root_sessions(params = {}, options = {})
  req = build_request(:disable_organizations_root_sessions, params)
  req.send_request(options)
end

#disable_outbound_web_identity_federation(params = {}) ⇒ Struct

Disables the outbound identity federation feature for your Amazon Web Services account. When disabled, IAM principals in the account cannot use the ‘GetWebIdentityToken` API to obtain JSON Web Tokens (JWTs) for authentication with external services. This operation does not affect tokens that were issued before the feature was disabled.

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4313
4314
4315
4316
 
# File 'lib/aws-sdk-iam/client.rb', line 4313

def disable_outbound_web_identity_federation(params = {}, options = {})
  req = build_request(:disable_outbound_web_identity_federation, params)
  req.send_request(options)
end

#enable_mfa_device(params = {}) ⇒ Struct

Enables the specified MFA device and associates it with the specified IAM user. When enabled, the MFA device is required for every subsequent login by the IAM user associated with the device.

Examples:

Request syntax with placeholder values


resp = client.enable_mfa_device({
  user_name: "existingUserNameType", # required
  serial_number: "serialNumberType", # required
  authentication_code_1: "authenticationCodeType", # required
  authentication_code_2: "authenticationCodeType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (required, String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :serial_number (required, String) —

    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:

    ,.@:/-

    [1]: wikipedia.org/wiki/regex

  • :authentication_code_1 (required, String) —

    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].

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_sync.html

  • :authentication_code_2 (required, String) —

    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].

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_sync.html

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4394
4395
4396
4397
 
# File 'lib/aws-sdk-iam/client.rb', line 4394

def enable_mfa_device(params = {}, options = {})
  req = build_request(:enable_mfa_device, params)
  req.send_request(options)
end

#enable_organizations_root_credentials_management(params = {}) ⇒ Types::EnableOrganizationsRootCredentialsManagementResponse

Enables the management of privileged root user credentials across member accounts in your organization. When you enable root credentials management for [centralized root access], the management account and the delegated administrator for IAM can manage root user credentials for member accounts in your organization.

Before you enable centralized root access, you must have an account configured with the following settings:

  • You must manage your Amazon Web Services accounts in [Organizations].

  • Enable trusted access for Identity and Access Management in Organizations. For details, see [IAM and Organizations] in the *Organizations User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_root-user.html#id_root-user-access-management [2]: docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html [3]: docs.aws.amazon.com/organizations/latest/userguide/services-that-can-integrate-iam.html

Examples:

Example: To enable the RootCredentialsManagement feature in your organization


# The following command enables the management of privileged root user credentials across member accounts in your
# organization.

resp = client.enable_organizations_root_credentials_management({
})

resp.to_h outputs the following:
{
  enabled_features: [
    "RootCredentialsManagement", 
  ], 
  organization_id: "o-aa111bb222", 
}

Response structure


resp.organization_id #=> String
resp.enabled_features #=> Array
resp.enabled_features[0] #=> String, one of "RootCredentialsManagement", "RootSessions"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



4453
4454
4455
4456
 
# File 'lib/aws-sdk-iam/client.rb', line 4453

def enable_organizations_root_credentials_management(params = {}, options = {})
  req = build_request(:enable_organizations_root_credentials_management, params)
  req.send_request(options)
end

#enable_organizations_root_sessions(params = {}) ⇒ Types::EnableOrganizationsRootSessionsResponse

Allows the management account or delegated administrator to perform privileged tasks on member accounts in your organization. For more information, see [Centrally manage root access for member accounts] in the *Identity and Access Management User Guide*.

Before you enable this feature, you must have an account configured with the following settings:

  • You must manage your Amazon Web Services accounts in [Organizations].

  • Enable trusted access for Identity and Access Management in Organizations. For details, see [IAM and Organizations] in the *Organizations User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_root-user.html#id_root-user-access-management [2]: docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html [3]: docs.aws.amazon.com/organizations/latest/userguide/services-that-can-integrate-ra.html

Examples:

Example: To enable the RootSessions feature in your organization


# The following command allows the management account or delegated administrator to perform privileged tasks on member
# accounts in your organization.

resp = client.enable_organizations_root_sessions({
})

resp.to_h outputs the following:
{
  enabled_features: [
    "RootCredentialsManagement", 
    "RootSessions", 
  ], 
  organization_id: "o-aa111bb222", 
}

Response structure


resp.organization_id #=> String
resp.enabled_features #=> Array
resp.enabled_features[0] #=> String, one of "RootCredentialsManagement", "RootSessions"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



4512
4513
4514
4515
 
# File 'lib/aws-sdk-iam/client.rb', line 4512

def enable_organizations_root_sessions(params = {}, options = {})
  req = build_request(:enable_organizations_root_sessions, params)
  req.send_request(options)
end

#enable_outbound_web_identity_federation(params = {}) ⇒ Types::EnableOutboundWebIdentityFederationResponse

Enables the outbound identity federation feature for your Amazon Web Services account. When enabled, IAM principals in your account can use the ‘GetWebIdentityToken` API to obtain JSON Web Tokens (JWTs) for secure authentication with external services. This operation also generates a unique issuer URL for your Amazon Web Services account.

Examples:

Response structure


resp.issuer_identifier #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



4535
4536
4537
4538
 
# File 'lib/aws-sdk-iam/client.rb', line 4535

def enable_outbound_web_identity_federation(params = {}, options = {})
  req = build_request(:enable_outbound_web_identity_federation, params)
  req.send_request(options)
end

#generate_credential_report(params = {}) ⇒ Types::GenerateCredentialReportResponse

Generates a credential report for the Amazon Web Services account. For more information about the credential report, see [Getting credential reports] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html

Examples:

Response structure


resp.state #=> String, one of "STARTED", "INPROGRESS", "COMPLETE"
resp.description #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



4562
4563
4564
4565
 
# File 'lib/aws-sdk-iam/client.rb', line 4562

def generate_credential_report(params = {}, options = {})
  req = build_request(:generate_credential_report, params)
  req.send_request(options)
end

#generate_organizations_access_report(params = {}) ⇒ Types::GenerateOrganizationsAccessReportResponse

Generates a report for service last accessed data for Organizations. You can generate a report for any entities (organization root, organizational unit, or account) or policies in your organization.

To call this operation, you must be signed in using your Organizations management account credentials. You can use your long-term IAM user or root user credentials, or temporary credentials from assuming an IAM role. SCPs must be enabled for your organization root. You must have the required IAM and Organizations permissions. For more information, see [Refining permissions using service last accessed data] in the *IAM User Guide*.

You can generate a service last accessed data report for entities by specifying only the entity’s path. This data includes a list of services that are allowed by any service control policies (SCPs) that apply to the entity.

You can generate a service last accessed data report for a policy by specifying an entity’s path and an optional Organizations policy ID. This data includes a list of services that are allowed by the specified SCP.

For each service in both report types, the data includes the most recent account activity that the policy allows to account principals in the entity or the entity’s children. For important information about the data, reporting period, permissions required, troubleshooting, and supported Regions see [Reducing permissions using service last accessed data] in the *IAM User Guide*.

The data includes all attempts to access Amazon Web Services, not just the successful ones. This includes all attempts that were made using the Amazon Web Services Management Console, the Amazon Web Services API through any of the SDKs, or any of the command line tools. An unexpected entry in the service last accessed data does not mean that an account has been compromised, because the request might have been denied. Refer to your CloudTrail logs as the authoritative source for information about all API calls and whether they were successful or denied access. For more information, see [Logging IAM events with CloudTrail] in the *IAM User Guide*.

This operation returns a ‘JobId`. Use this parameter in the ` GetOrganizationsAccessReport ` operation to check the status of the report generation. To check the status of this request, use the `JobId` parameter in the ` GetOrganizationsAccessReport ` operation and test the `JobStatus` response parameter. When the job is complete, you can retrieve the report.

To generate a service last accessed data report for entities, specify an entity path without specifying the optional Organizations policy ID. The type of entity that you specify determines the data returned in the report.

  • Root – When you specify the organizations root as the entity, the resulting report lists all of the services allowed by SCPs that are attached to your root. For each service, the report includes data for all accounts in your organization except the management account, because the management account is not limited by SCPs.

  • OU – When you specify an organizational unit (OU) as the entity, the resulting report lists all of the services allowed by SCPs that are attached to the OU and its parents. For each service, the report includes data for all accounts in the OU or its children. This data excludes the management account, because the management account is not limited by SCPs.

  • **management account** – When you specify the management account, the resulting report lists all Amazon Web Services services, because the management account is not limited by SCPs. For each service, the report includes data for only the management account.

  • Account – When you specify another account as the entity, the resulting report lists all of the services allowed by SCPs that are attached to the account and its parents. For each service, the report includes data for only the specified account.

To generate a service last accessed data report for policies, specify an entity path and the optional Organizations policy ID. The type of entity that you specify determines the data returned for each service.

  • Root – When you specify the root entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for all accounts in your organization to which the SCP applies. This data excludes the management account, because the management account is not limited by SCPs. If the SCP is not attached to any entities in the organization, then the report will return a list of services with no data.

  • OU – When you specify an OU entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for all accounts in the OU or its children to which the SCP applies. This means that other accounts outside the OU that are affected by the SCP might not be included in the data. This data excludes the management account, because the management account is not limited by SCPs. If the SCP is not attached to the OU or one of its children, the report will return a list of services with no data.

  • **management account** – When you specify the management account, the resulting report lists all Amazon Web Services services, because the management account is not limited by SCPs. If you specify a policy ID in the CLI or API, the policy is ignored. For each service, the report includes data for only the management account.

  • Account – When you specify another account entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for only the specified account. This means that other accounts in the organization that are affected by the SCP might not be included in the data. If the SCP is not attached to the account, the report will return a list of services with no data.

<note markdown=“1”> Service last accessed data does not use other policy types when determining whether a principal could access a service. These other policy types include identity-based policies, resource-based policies, access control lists, IAM permissions boundaries, and STS assume role policies. It only applies SCP logic. For more about the evaluation of policy types, see [Evaluating policies] in the *IAM User Guide*.

</note>

For more information about service last accessed data, see [Reducing policy scope by viewing user activity] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/cloudtrail-integration.html [3]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-basics

Examples:

Example: To generate a service last accessed data report for an organizational unit


# The following operation generates a report for the organizational unit ou-rge0-awexample

resp = client.generate_organizations_access_report({
  entity_path: "o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-1a2b3c-k9l8m7n6o5example", 
})

resp.to_h outputs the following:
{
  job_id: "examplea-1234-b567-cde8-90fg123abcd4", 
}

Request syntax with placeholder values


resp = client.generate_organizations_access_report({
  entity_path: "organizationsEntityPathType", # required
  organizations_policy_id: "organizationsPolicyIdType",
})

Response structure


resp.job_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :entity_path (required, String) —

    The path of the Organizations entity (root, OU, or account). You can build an entity path using the known structure of your organization. For example, assume that your account ID is ‘123456789012` and its parent OU ID is `ou-rge0-awsabcde`. The organization root ID is `r-f6g7h8i9j0example` and your organization ID is `o-a1b2c3d4e5`. Your entity path is `o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-rge0-awsabcde/123456789012`.

  • :organizations_policy_id (String) —

    The identifier of the Organizations service control policy (SCP). This parameter is optional.

    This ID is used to generate information about when an account principal that is limited by the SCP attempted to access an Amazon Web Services service.

Returns:

See Also:



4747
4748
4749
4750
 
# File 'lib/aws-sdk-iam/client.rb', line 4747

def generate_organizations_access_report(params = {}, options = {})
  req = build_request(:generate_organizations_access_report, params)
  req.send_request(options)
end

#generate_service_last_accessed_details(params = {}) ⇒ Types::GenerateServiceLastAccessedDetailsResponse

Generates a report that includes details about when an IAM resource (user, group, role, or policy) was last used in an attempt to access Amazon Web Services services. Recent activity usually appears within four hours. IAM reports activity for at least the last 400 days, or less if your Region began supporting this feature within the last year. For more information, see [Regions where data is tracked]. For more information about services and actions for which action last accessed information is displayed, see [IAM action last accessed information services and actions].

The service last accessed data includes all attempts to access an Amazon Web Services API, not just the successful ones. This includes all attempts that were made using the Amazon Web Services Management Console, the Amazon Web Services API through any of the SDKs, or any of the command line tools. An unexpected entry in the service last accessed data does not mean that your account has been compromised, because the request might have been denied. Refer to your CloudTrail logs as the authoritative source for information about all API calls and whether they were successful or denied access. For more information, see [Logging IAM events with CloudTrail] in the *IAM User Guide*.

The ‘GenerateServiceLastAccessedDetails` operation returns a `JobId`. Use this parameter in the following operations to retrieve the following details from your report:

  • GetServiceLastAccessedDetails][4

    – Use this operation for users,

    groups, roles, or policies to list every Amazon Web Services service that the resource could access using permissions policies. For each service, the response includes information about the most recent access attempt.

    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`.

  • GetServiceLastAccessedDetailsWithEntities][5

    – Use this operation

    for groups and policies to list information about the associated entities (users or roles) that attempted to access a specific Amazon Web Services service.

To check the status of the ‘GenerateServiceLastAccessedDetails` request, use the `JobId` parameter in the same operations and test the `JobStatus` response parameter.

For additional information about the permissions policies that allow an identity (user, group, or role) to access specific services, use the [ListPoliciesGrantingServiceAccess] operation.

<note markdown=“1”> Service last accessed data does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see [Evaluating policies] in the *IAM User Guide*.

</note>

For more information about service and action last accessed data, see

Reducing permissions using service last accessed data][8

in the *IAM

User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#access-advisor_tracking-period [2]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor-action-last-accessed.html [3]: docs.aws.amazon.com/IAM/latest/UserGuide/cloudtrail-integration.html [4]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetServiceLastAccessedDetails.html [5]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetServiceLastAccessedDetailsWithEntities.html [6]: docs.aws.amazon.com/IAM/latest/APIReference/API_ListPoliciesGrantingServiceAccess.html [7]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-basics [8]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html

Examples:

Example: To generate a service last accessed data report for a policy


# The following operation generates a report for the policy: ExamplePolicy1

resp = client.generate_service_last_accessed_details({
  arn: "arn:aws:iam::123456789012:policy/ExamplePolicy1", 
})

resp.to_h outputs the following:
{
  job_id: "examplef-1305-c245-eba4-71fe298bcda7", 
}

Request syntax with placeholder values


resp = client.generate_service_last_accessed_details({
  arn: "arnType", # required
  granularity: "SERVICE_LEVEL", # accepts SERVICE_LEVEL, ACTION_LEVEL
})

Response structure


resp.job_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

    The ARN of the IAM resource (user, group, role, or managed policy) used to generate information about when the resource was last used in an attempt to access an Amazon Web Services service.

  • :granularity (String) —

    The level of detail that you want to generate. You can specify whether you want to generate information about the last attempt to access services or actions. If you specify service-level granularity, this operation generates only service data. If you specify action-level granularity, it generates service and action data. If you don’t include this optional parameter, the operation generates service data.

Returns:

See Also:



4872
4873
4874
4875
 
# File 'lib/aws-sdk-iam/client.rb', line 4872

def generate_service_last_accessed_details(params = {}, options = {})
  req = build_request(:generate_service_last_accessed_details, params)
  req.send_request(options)
end

#get_access_key_last_used(params = {}) ⇒ Types::GetAccessKeyLastUsedResponse

Retrieves information about when the specified access key was last used. The information includes the date and time of last use, along with the Amazon Web Services service and Region that were specified in the last request made with that key.

Examples:

Request syntax with placeholder values


resp = client.get_access_key_last_used({
  access_key_id: "accessKeyIdType", # required
})

Response structure


resp.user_name #=> String
resp.access_key_last_used.last_used_date #=> Time
resp.access_key_last_used.service_name #=> String
resp.access_key_last_used.region #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :access_key_id (required, String) —

    The identifier of an access key.

    This parameter allows (through its [regex pattern]) a string of characters that can consist of any upper or lowercased letter or digit.

    [1]: wikipedia.org/wiki/regex

Returns:

See Also:



4915
4916
4917
4918
 
# File 'lib/aws-sdk-iam/client.rb', line 4915

def get_access_key_last_used(params = {}, options = {})
  req = build_request(:get_access_key_last_used, params)
  req.send_request(options)
end

#get_account_authorization_details(params = {}) ⇒ Types::GetAccountAuthorizationDetailsResponse

Retrieves information about all IAM users, groups, roles, and policies in your Amazon Web Services account, including their relationships to one another. Use this operation to obtain a snapshot of the configuration of IAM permissions (users, groups, roles, and policies) in your account.

<note markdown=“1”> Policies returned by this operation are URL-encoded compliant with [RFC 3986]. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the ‘decode` method of the `java.net.URLDecoder` utility class in the Java SDK. Other languages and SDKs provide similar functionality, and some SDKs do this decoding automatically.

</note>

You can optionally filter the results using the ‘Filter` parameter. You can paginate the results using the `MaxItems` and `Marker` parameters.

[1]: tools.ietf.org/html/rfc3986

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.({
  filter: ["User"], # accepts User, Role, Group, LocalManagedPolicy, AWSManagedPolicy
  max_items: 1,
  marker: "markerType",
})

Response structure


resp.user_detail_list #=> Array
resp.user_detail_list[0].path #=> String
resp.user_detail_list[0].user_name #=> String
resp.user_detail_list[0].user_id #=> String
resp.user_detail_list[0].arn #=> String
resp.user_detail_list[0].create_date #=> Time
resp.user_detail_list[0].user_policy_list #=> Array
resp.user_detail_list[0].user_policy_list[0].policy_name #=> String
resp.user_detail_list[0].user_policy_list[0].policy_document #=> String
resp.user_detail_list[0].group_list #=> Array
resp.user_detail_list[0].group_list[0] #=> String
resp.user_detail_list[0].attached_managed_policies #=> Array
resp.user_detail_list[0].attached_managed_policies[0].policy_name #=> String
resp.user_detail_list[0].attached_managed_policies[0].policy_arn #=> String
resp.user_detail_list[0].permissions_boundary.permissions_boundary_type #=> String, one of "PermissionsBoundaryPolicy"
resp.user_detail_list[0].permissions_boundary.permissions_boundary_arn #=> String
resp.user_detail_list[0].tags #=> Array
resp.user_detail_list[0].tags[0].key #=> String
resp.user_detail_list[0].tags[0].value #=> String
resp.group_detail_list #=> Array
resp.group_detail_list[0].path #=> String
resp.group_detail_list[0].group_name #=> String
resp.group_detail_list[0].group_id #=> String
resp.group_detail_list[0].arn #=> String
resp.group_detail_list[0].create_date #=> Time
resp.group_detail_list[0].group_policy_list #=> Array
resp.group_detail_list[0].group_policy_list[0].policy_name #=> String
resp.group_detail_list[0].group_policy_list[0].policy_document #=> String
resp.group_detail_list[0].attached_managed_policies #=> Array
resp.group_detail_list[0].attached_managed_policies[0].policy_name #=> String
resp.group_detail_list[0].attached_managed_policies[0].policy_arn #=> String
resp.role_detail_list #=> Array
resp.role_detail_list[0].path #=> String
resp.role_detail_list[0].role_name #=> String
resp.role_detail_list[0].role_id #=> String
resp.role_detail_list[0].arn #=> String
resp.role_detail_list[0].create_date #=> Time
resp.role_detail_list[0].assume_role_policy_document #=> String
resp.role_detail_list[0].instance_profile_list #=> Array
resp.role_detail_list[0].instance_profile_list[0].path #=> String
resp.role_detail_list[0].instance_profile_list[0].instance_profile_name #=> String
resp.role_detail_list[0].instance_profile_list[0].instance_profile_id #=> String
resp.role_detail_list[0].instance_profile_list[0].arn #=> String
resp.role_detail_list[0].instance_profile_list[0].create_date #=> Time
resp.role_detail_list[0].instance_profile_list[0].roles #=> Array
resp.role_detail_list[0].instance_profile_list[0].roles[0].path #=> String
resp.role_detail_list[0].instance_profile_list[0].roles[0].role_name #=> String
resp.role_detail_list[0].instance_profile_list[0].roles[0].role_id #=> String
resp.role_detail_list[0].instance_profile_list[0].roles[0].arn #=> String
resp.role_detail_list[0].instance_profile_list[0].roles[0].create_date #=> Time
resp.role_detail_list[0].instance_profile_list[0].roles[0].assume_role_policy_document #=> String
resp.role_detail_list[0].instance_profile_list[0].roles[0].description #=> String
resp.role_detail_list[0].instance_profile_list[0].roles[0].max_session_duration #=> Integer
resp.role_detail_list[0].instance_profile_list[0].roles[0].permissions_boundary.permissions_boundary_type #=> String, one of "PermissionsBoundaryPolicy"
resp.role_detail_list[0].instance_profile_list[0].roles[0].permissions_boundary.permissions_boundary_arn #=> String
resp.role_detail_list[0].instance_profile_list[0].roles[0].tags #=> Array
resp.role_detail_list[0].instance_profile_list[0].roles[0].tags[0].key #=> String
resp.role_detail_list[0].instance_profile_list[0].roles[0].tags[0].value #=> String
resp.role_detail_list[0].instance_profile_list[0].roles[0].role_last_used.last_used_date #=> Time
resp.role_detail_list[0].instance_profile_list[0].roles[0].role_last_used.region #=> String
resp.role_detail_list[0].instance_profile_list[0].tags #=> Array
resp.role_detail_list[0].instance_profile_list[0].tags[0].key #=> String
resp.role_detail_list[0].instance_profile_list[0].tags[0].value #=> String
resp.role_detail_list[0].role_policy_list #=> Array
resp.role_detail_list[0].role_policy_list[0].policy_name #=> String
resp.role_detail_list[0].role_policy_list[0].policy_document #=> String
resp.role_detail_list[0].attached_managed_policies #=> Array
resp.role_detail_list[0].attached_managed_policies[0].policy_name #=> String
resp.role_detail_list[0].attached_managed_policies[0].policy_arn #=> String
resp.role_detail_list[0].permissions_boundary.permissions_boundary_type #=> String, one of "PermissionsBoundaryPolicy"
resp.role_detail_list[0].permissions_boundary.permissions_boundary_arn #=> String
resp.role_detail_list[0].tags #=> Array
resp.role_detail_list[0].tags[0].key #=> String
resp.role_detail_list[0].tags[0].value #=> String
resp.role_detail_list[0].role_last_used.last_used_date #=> Time
resp.role_detail_list[0].role_last_used.region #=> String
resp.policies #=> Array
resp.policies[0].policy_name #=> String
resp.policies[0].policy_id #=> String
resp.policies[0].arn #=> String
resp.policies[0].path #=> String
resp.policies[0].default_version_id #=> String
resp.policies[0].attachment_count #=> Integer
resp.policies[0].permissions_boundary_usage_count #=> Integer
resp.policies[0].is_attachable #=> Boolean
resp.policies[0].description #=> String
resp.policies[0].create_date #=> Time
resp.policies[0].update_date #=> Time
resp.policies[0].policy_version_list #=> Array
resp.policies[0].policy_version_list[0].document #=> String
resp.policies[0].policy_version_list[0].version_id #=> String
resp.policies[0].policy_version_list[0].is_default_version #=> Boolean
resp.policies[0].policy_version_list[0].create_date #=> Time
resp.is_truncated #=> Boolean
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filter (Array<String>) —

    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 (Integer) —

    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

    1. 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 (String) —

    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.

Returns:

See Also:



5090
5091
5092
5093
 
# File 'lib/aws-sdk-iam/client.rb', line 5090

def (params = {}, options = {})
  req = build_request(:get_account_authorization_details, params)
  req.send_request(options)
end

#get_account_password_policy(params = {}) ⇒ Types::GetAccountPasswordPolicyResponse

Retrieves the password policy for the Amazon Web Services account. This tells you the complexity requirements and mandatory rotation periods for the IAM user passwords in your account. For more information about using a password policy, see [Managing an IAM password policy].

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html

Examples:

Example: To see the current account password policy


# The following command displays details about the password policy for the current AWS account.

resp = client.({
})

resp.to_h outputs the following:
{
  password_policy: {
    allow_users_to_change_password: false, 
    expire_passwords: false, 
    hard_expiry: false, 
    max_password_age: 90, 
    minimum_password_length: 8, 
    password_reuse_prevention: 12, 
    require_lowercase_characters: false, 
    require_numbers: true, 
    require_symbols: true, 
    require_uppercase_characters: false, 
  }, 
}

Response structure


resp.password_policy.minimum_password_length #=> Integer
resp.password_policy.require_symbols #=> Boolean
resp.password_policy.require_numbers #=> Boolean
resp.password_policy.require_uppercase_characters #=> Boolean
resp.password_policy.require_lowercase_characters #=> Boolean
resp.password_policy.allow_users_to_change_password #=> Boolean
resp.password_policy.expire_passwords #=> Boolean
resp.password_policy.max_password_age #=> Integer
resp.password_policy.password_reuse_prevention #=> Integer
resp.password_policy.hard_expiry #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



5150
5151
5152
5153
 
# File 'lib/aws-sdk-iam/client.rb', line 5150

def (params = {}, options = {})
  req = build_request(:get_account_password_policy, params)
  req.send_request(options)
end

#get_account_summary(params = {}) ⇒ Types::GetAccountSummaryResponse

Retrieves information about IAM entity usage and IAM quotas in the Amazon Web Services account.

For information about IAM quotas, see [IAM and STS quotas] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html

Examples:

Example: To get information about IAM entity quotas and usage in the current account


# The following command returns information about the IAM entity quotas and usage in the current AWS account.

resp = client.({
})

resp.to_h outputs the following:
{
  summary_map: {
    "AccessKeysPerUserQuota" => 2, 
    "AccountAccessKeysPresent" => 1, 
    "AccountMFAEnabled" => 0, 
    "AccountSigningCertificatesPresent" => 0, 
    "AttachedPoliciesPerGroupQuota" => 10, 
    "AttachedPoliciesPerRoleQuota" => 10, 
    "AttachedPoliciesPerUserQuota" => 10, 
    "GlobalEndpointTokenVersion" => 2, 
    "GroupPolicySizeQuota" => 5120, 
    "Groups" => 15, 
    "GroupsPerUserQuota" => 10, 
    "GroupsQuota" => 100, 
    "MFADevices" => 6, 
    "MFADevicesInUse" => 3, 
    "Policies" => 8, 
    "PoliciesQuota" => 1000, 
    "PolicySizeQuota" => 5120, 
    "PolicyVersionsInUse" => 22, 
    "PolicyVersionsInUseQuota" => 10000, 
    "ServerCertificates" => 1, 
    "ServerCertificatesQuota" => 20, 
    "SigningCertificatesPerUserQuota" => 2, 
    "UserPolicySizeQuota" => 2048, 
    "Users" => 27, 
    "UsersQuota" => 5000, 
    "VersionsPerPolicyQuota" => 5, 
  }, 
}

Response structure


resp.summary_map #=> Hash
resp.summary_map["summaryKeyType"] #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



5218
5219
5220
5221
 
# File 'lib/aws-sdk-iam/client.rb', line 5218

def (params = {}, options = {})
  req = build_request(:get_account_summary, params)
  req.send_request(options)
end

#get_context_keys_for_custom_policy(params = {}) ⇒ Types::GetContextKeysForPolicyResponse

Gets a list of all of the context keys referenced in the input policies. The policies are supplied as a list of one or more strings. To get the context keys from policies associated with an IAM user, group, or role, use [GetContextKeysForPrincipalPolicy].

Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. Context keys can be evaluated by testing against a value specified in an IAM policy. Use ‘GetContextKeysForCustomPolicy` to understand what key names and values you must supply when you call [SimulateCustomPolicy]. 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.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetContextKeysForPrincipalPolicy.html [2]: docs.aws.amazon.com/IAM/latest/APIReference/API_SimulateCustomPolicy.html

Examples:

Request syntax with placeholder values


resp = client.get_context_keys_for_custom_policy({
  policy_input_list: ["policyDocumentType"], # required
})

Response structure


resp.context_key_names #=> Array
resp.context_key_names[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :policy_input_list (required, Array<String>) —

    A list of policies for which you want the list of context keys referenced in those policies. 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`)

    [1]: wikipedia.org/wiki/regex

Returns:

See Also:



5282
5283
5284
5285
 
# File 'lib/aws-sdk-iam/client.rb', line 5282

def get_context_keys_for_custom_policy(params = {}, options = {})
  req = build_request(:get_context_keys_for_custom_policy, params)
  req.send_request(options)
end

#get_context_keys_for_principal_policy(params = {}) ⇒ Types::GetContextKeysForPolicyResponse

Gets a list of all of the context keys referenced in all the IAM policies that are attached to the specified IAM entity. The entity can be an IAM user, group, or role. If you specify a user, then the request also includes all of the policies attached to groups that the user is a member of.

You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use [GetContextKeysForCustomPolicy] instead.

Note: This operation discloses information about the permissions granted to other users. If you do not want users to see other user’s permissions, then consider allowing them to use

GetContextKeysForCustomPolicy][1

instead.

Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. Context keys can be evaluated by testing against a value in an IAM policy. Use [GetContextKeysForPrincipalPolicy] to understand what key names and values you must supply when you call [SimulatePrincipalPolicy].

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetContextKeysForCustomPolicy.html [2]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetContextKeysForPrincipalPolicy.html [3]: docs.aws.amazon.com/IAM/latest/APIReference/API_SimulatePrincipalPolicy.html

Examples:

Request syntax with placeholder values


resp = client.get_context_keys_for_principal_policy({
  policy_source_arn: "arnType", # required
  policy_input_list: ["policyDocumentType"],
})

Response structure


resp.context_key_names #=> Array
resp.context_key_names[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :policy_source_arn (required, String) —

    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*.

    [1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

  • :policy_input_list (Array<String>) —

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

    [1]: wikipedia.org/wiki/regex

Returns:

See Also:



5372
5373
5374
5375
 
# File 'lib/aws-sdk-iam/client.rb', line 5372

def get_context_keys_for_principal_policy(params = {}, options = {})
  req = build_request(:get_context_keys_for_principal_policy, params)
  req.send_request(options)
end

#get_credential_report(params = {}) ⇒ Types::GetCredentialReportResponse

Retrieves a credential report for the Amazon Web Services account. For more information about the credential report, see [Getting credential reports] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html

Examples:

Response structure


resp.content #=> String
resp.report_format #=> String, one of "text/csv"
resp.generated_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



5401
5402
5403
5404
 
# File 'lib/aws-sdk-iam/client.rb', line 5401

def get_credential_report(params = {}, options = {})
  req = build_request(:get_credential_report, params)
  req.send_request(options)
end

#get_delegation_request(params = {}) ⇒ Types::GetDelegationRequestResponse

Retrieves information about a specific delegation request.

If a delegation request has no owner or owner account, ‘GetDelegationRequest` for that delegation request can be called by any account. If the owner account is assigned but there is no owner id, only identities within that owner account can call `GetDelegationRequest` for the delegation request. Once the delegation request is fully owned, the owner of the request gets a default permission to get that delegation request. For more details, see [ Managing Permissions for Delegation Requests].

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies-temporary-delegation.html#temporary-delegation-managing-permissions

Examples:

Request syntax with placeholder values


resp = client.get_delegation_request({
  delegation_request_id: "delegationRequestIdType", # required
  delegation_permission_check: false,
})

Response structure


resp.delegation_request.delegation_request_id #=> String
resp.delegation_request. #=> String
resp.delegation_request.description #=> String
resp.delegation_request.request_message #=> String
resp.delegation_request.permissions.policy_template_arn #=> String
resp.delegation_request.permissions.parameters #=> Array
resp.delegation_request.permissions.parameters[0].name #=> String
resp.delegation_request.permissions.parameters[0].values #=> Array
resp.delegation_request.permissions.parameters[0].values[0] #=> String
resp.delegation_request.permissions.parameters[0].type #=> String, one of "string", "stringList"
resp.delegation_request.permission_policy #=> String
resp.delegation_request.role_permission_restriction_arns #=> Array
resp.delegation_request.role_permission_restriction_arns[0] #=> String
resp.delegation_request.owner_id #=> String
resp.delegation_request.approver_id #=> String
resp.delegation_request.state #=> String, one of "UNASSIGNED", "ASSIGNED", "PENDING_APPROVAL", "FINALIZED", "ACCEPTED", "REJECTED", "EXPIRED"
resp.delegation_request.expiration_time #=> Time
resp.delegation_request.requestor_id #=> String
resp.delegation_request.requestor_name #=> String
resp.delegation_request.create_date #=> Time
resp.delegation_request.session_duration #=> Integer
resp.delegation_request.redirect_url #=> String
resp.delegation_request.notes #=> String
resp.delegation_request.rejection_reason #=> String
resp.delegation_request.only_send_by_owner #=> Boolean
resp.delegation_request.updated_time #=> Time
resp.permission_check_status #=> String, one of "COMPLETE", "IN_PROGRESS", "FAILED"
resp.permission_check_result #=> String, one of "ALLOWED", "DENIED", "UNSURE"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :delegation_request_id (required, String) —

    The unique identifier of the delegation request to retrieve.

  • :delegation_permission_check (Boolean) —

    Specifies whether to perform a permission check for the delegation request.

    If set to true, the ‘GetDelegationRequest` API call will start a permission check process. This process calculates whether the caller has sufficient permissions to cover the asks from this delegation request.

    Setting this parameter to true does not guarantee an answer in the response. See the ‘PermissionCheckStatus` and the `PermissionCheckResult` response attributes for further details.

Returns:

See Also:



5485
5486
5487
5488
 
# File 'lib/aws-sdk-iam/client.rb', line 5485

def get_delegation_request(params = {}, options = {})
  req = build_request(:get_delegation_request, params)
  req.send_request(options)
end

#get_group(params = {}) ⇒ Types::GetGroupResponse

Returns a list of IAM users that are in the specified IAM group. You can paginate the results using the ‘MaxItems` and `Marker` parameters.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_group({
  group_name: "groupNameType", # required
  marker: "markerType",
  max_items: 1,
})

Response structure


resp.group.path #=> String
resp.group.group_name #=> String
resp.group.group_id #=> String
resp.group.arn #=> String
resp.group.create_date #=> Time
resp.users #=> Array
resp.users[0].path #=> String
resp.users[0].user_name #=> String
resp.users[0].user_id #=> String
resp.users[0].arn #=> String
resp.users[0].create_date #=> Time
resp.users[0].password_last_used #=> Time
resp.users[0].permissions_boundary.permissions_boundary_type #=> String, one of "PermissionsBoundaryPolicy"
resp.users[0].permissions_boundary.permissions_boundary_arn #=> String
resp.users[0].tags #=> Array
resp.users[0].tags[0].key #=> String
resp.users[0].tags[0].value #=> String
resp.is_truncated #=> Boolean
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :group_name (required, String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :marker (String) —

    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 (Integer) —

    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

    1. 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.

Returns:

See Also:



5565
5566
5567
5568
 
# File 'lib/aws-sdk-iam/client.rb', line 5565

def get_group(params = {}, options = {})
  req = build_request(:get_group, params)
  req.send_request(options)
end

#get_group_policy(params = {}) ⇒ Types::GetGroupPolicyResponse

Retrieves the specified inline policy document that is embedded in the specified IAM group.

<note markdown=“1”> Policies returned by this operation are URL-encoded compliant with [RFC 3986]. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the ‘decode` method of the `java.net.URLDecoder` utility class in the Java SDK. Other languages and SDKs provide similar functionality, and some SDKs do this decoding automatically.

</note>

An IAM group can also have managed policies attached to it. To retrieve a managed policy document that is attached to a group, use

GetPolicy][2

to determine the policy’s default version, then use

GetPolicyVersion][3

to retrieve the policy document.

For more information about policies, see [Managed policies and inline policies] in the *IAM User Guide*.

[1]: tools.ietf.org/html/rfc3986 [2]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetPolicy.html [3]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetPolicyVersion.html [4]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html

Examples:

Request syntax with placeholder values


resp = client.get_group_policy({
  group_name: "groupNameType", # required
  policy_name: "policyNameType", # required
})

Response structure


resp.group_name #=> String
resp.policy_name #=> String
resp.policy_document #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :group_name (required, String) —

    The name of the group the policy is associated 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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :policy_name (required, String) —

    The name of the policy document to get.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

Returns:

See Also:



5644
5645
5646
5647
 
# File 'lib/aws-sdk-iam/client.rb', line 5644

def get_group_policy(params = {}, options = {})
  req = build_request(:get_group_policy, params)
  req.send_request(options)
end

#get_human_readable_summary(params = {}) ⇒ Types::GetHumanReadableSummaryResponse

Retrieves a human readable summary for a given entity. At this time, the only supported entity type is ‘delegation-request`

This method uses a Large Language Model (LLM) to generate the summary.

If a delegation request has no owner or owner account, ‘GetHumanReadableSummary` for that delegation request can be called by any account. If the owner account is assigned but there is no owner id, only identities within that owner account can call `GetHumanReadableSummary` for the delegation request to retrieve a summary of that request. Once the delegation request is fully owned, the owner of the request gets a default permission to get that delegation request. For more details, read [default permissions granted to delegation requests](). These rules are identical to

GetDelegationRequest][1

API behavior, such that a party who has

permissions to call [GetDelegationRequest] for a given delegation request will always be able to retrieve the human readable summary for that request.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetDelegationRequest.html

Examples:

Request syntax with placeholder values


resp = client.get_human_readable_summary({
  entity_arn: "arnType", # required
  locale: "localeType",
})

Response structure


resp.summary_content #=> String
resp.locale #=> String
resp.summary_state #=> String, one of "AVAILABLE", "NOT_AVAILABLE", "NOT_SUPPORTED", "FAILED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :entity_arn (required, String) —

    Arn of the entity to be summarized. At this time, the only supported entity type is ‘delegation-request`

  • :locale (String) —

    A string representing the locale to use for the summary generation. The supported locale strings are based on the [ Supported languages of the Amazon Web Services Management Console ](/awsconsolehelpdocs/latest/gsg/change-language.html#supported-languages).

Returns:

See Also:



5705
5706
5707
5708
 
# File 'lib/aws-sdk-iam/client.rb', line 5705

def get_human_readable_summary(params = {}, options = {})
  req = build_request(:get_human_readable_summary, params)
  req.send_request(options)
end

#get_instance_profile(params = {}) ⇒ Types::GetInstanceProfileResponse

Retrieves information about the specified instance profile, including the instance profile’s path, GUID, ARN, and role. For more information about instance profiles, see [Using instance profiles] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html

The following waiters are defined for this operation (see #wait_until for detailed usage):

* instance_profile_exists

Examples:

Example: To get information about an instance profile


# The following command gets information about the instance profile named ExampleInstanceProfile.

resp = client.get_instance_profile({
  instance_profile_name: "ExampleInstanceProfile", 
})

resp.to_h outputs the following:
{
  instance_profile: {
    arn: "arn:aws:iam::336924118301:instance-profile/ExampleInstanceProfile", 
    create_date: Time.parse("2013-06-12T23:52:02Z"), 
    instance_profile_id: "AID2MAB8DPLSRHEXAMPLE", 
    instance_profile_name: "ExampleInstanceProfile", 
    path: "/", 
    roles: [
      {
        arn: "arn:aws:iam::336924118301:role/Test-Role", 
        assume_role_policy_document: "<URL-encoded-JSON>", 
        create_date: Time.parse("2013-01-09T06:33:26Z"), 
        path: "/", 
        role_id: "AIDGPMS9RO4H3FEXAMPLE", 
        role_name: "Test-Role", 
      }, 
    ], 
  }, 
}

Request syntax with placeholder values


resp = client.get_instance_profile({
  instance_profile_name: "instanceProfileNameType", # required
})

Response structure


resp.instance_profile.path #=> String
resp.instance_profile.instance_profile_name #=> String
resp.instance_profile.instance_profile_id #=> String
resp.instance_profile.arn #=> String
resp.instance_profile.create_date #=> Time
resp.instance_profile.roles #=> Array
resp.instance_profile.roles[0].path #=> String
resp.instance_profile.roles[0].role_name #=> String
resp.instance_profile.roles[0].role_id #=> String
resp.instance_profile.roles[0].arn #=> String
resp.instance_profile.roles[0].create_date #=> Time
resp.instance_profile.roles[0].assume_role_policy_document #=> String
resp.instance_profile.roles[0].description #=> String
resp.instance_profile.roles[0].max_session_duration #=> Integer
resp.instance_profile.roles[0].permissions_boundary.permissions_boundary_type #=> String, one of "PermissionsBoundaryPolicy"
resp.instance_profile.roles[0].permissions_boundary.permissions_boundary_arn #=> String
resp.instance_profile.roles[0].tags #=> Array
resp.instance_profile.roles[0].tags[0].key #=> String
resp.instance_profile.roles[0].tags[0].value #=> String
resp.instance_profile.roles[0].role_last_used.last_used_date #=> Time
resp.instance_profile.roles[0].role_last_used.region #=> String
resp.instance_profile.tags #=> Array
resp.instance_profile.tags[0].key #=> String
resp.instance_profile.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_profile_name (required, String) —

    The name of the instance profile to get information about.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

Returns:

See Also:



5807
5808
5809
5810
 
# File 'lib/aws-sdk-iam/client.rb', line 5807

def get_instance_profile(params = {}, options = {})
  req = build_request(:get_instance_profile, params)
  req.send_request(options)
end

#get_login_profile(params = {}) ⇒ Types::GetLoginProfileResponse

Retrieves the user name for the specified IAM user. A login profile is created when you create a password for the user to access the Amazon Web Services Management Console. If the user does not exist or does not have a password, the operation returns a 404 (‘NoSuchEntity`) error.

If you create an IAM user with access to the console, the ‘CreateDate` reflects the date you created the initial password for the user.

If you create an IAM user with programmatic access, and then later add a password for the user to access the Amazon Web Services Management Console, the ‘CreateDate` reflects the initial password creation date. A user with programmatic access does not have a login profile unless you create a password for the user to access the Amazon Web Services Management Console.

Examples:

Example: To get password information for an IAM user


# The following command gets information about the password for the IAM user named Anika.

resp = client.({
  user_name: "Anika", 
})

resp.to_h outputs the following:
{
  login_profile: {
    create_date: Time.parse("2012-09-21T23:03:39Z"), 
    user_name: "Anika", 
  }, 
}

Request syntax with placeholder values


resp = client.({
  user_name: "userNameType",
})

Response structure


resp..user_name #=> String
resp..create_date #=> Time
resp..password_reset_required #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (String) —

    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: _+=,.@-

    [1]: docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoot.html [2]: wikipedia.org/wiki/regex

Returns:

See Also:



5883
5884
5885
5886
 
# File 'lib/aws-sdk-iam/client.rb', line 5883

def (params = {}, options = {})
  req = build_request(:get_login_profile, params)
  req.send_request(options)
end

#get_mfa_device(params = {}) ⇒ Types::GetMFADeviceResponse

Retrieves information about an MFA device for a specified user.

Examples:

Request syntax with placeholder values


resp = client.get_mfa_device({
  serial_number: "serialNumberType", # required
  user_name: "userNameType",
})

Response structure


resp.user_name #=> String
resp.serial_number #=> String
resp.enable_date #=> Time
resp.certifications #=> Hash
resp.certifications["CertificationKeyType"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



5927
5928
5929
5930
 
# File 'lib/aws-sdk-iam/client.rb', line 5927

def get_mfa_device(params = {}, options = {})
  req = build_request(:get_mfa_device, params)
  req.send_request(options)
end

#get_open_id_connect_provider(params = {}) ⇒ Types::GetOpenIDConnectProviderResponse

Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM.

Examples:

Request syntax with placeholder values


resp = client.get_open_id_connect_provider({
  open_id_connect_provider_arn: "arnType", # required
})

Response structure


resp.url #=> String
resp.client_id_list #=> Array
resp.client_id_list[0] #=> String
resp.thumbprint_list #=> Array
resp.thumbprint_list[0] #=> String
resp.create_date #=> Time
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



5978
5979
5980
5981
 
# File 'lib/aws-sdk-iam/client.rb', line 5978

def get_open_id_connect_provider(params = {}, options = {})
  req = build_request(:get_open_id_connect_provider, params)
  req.send_request(options)
end

#get_organizations_access_report(params = {}) ⇒ Types::GetOrganizationsAccessReportResponse

Retrieves the service last accessed data report for Organizations that was previously generated using the ‘ GenerateOrganizationsAccessReport ` operation. This operation retrieves the status of your report job and the report contents.

Depending on the parameters that you passed when you generated the report, the data returned could include different information. For details, see [GenerateOrganizationsAccessReport].

To call this operation, you must be signed in to the management account in your organization. SCPs must be enabled for your organization root. You must have permissions to perform this operation. For more information, see [Refining permissions using service last accessed data] in the *IAM User Guide*.

For each service that principals in an account (root user, IAM users, or IAM roles) could access using SCPs, the operation returns details about the most recent access attempt. If there was no attempt, the service is listed without details about the most recent attempt to access the service. If the operation fails, it returns the reason that it failed.

By default, the list is sorted by service namespace.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_GenerateOrganizationsAccessReport.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html

Examples:

Example: To get details from a previously generated organizational unit report


# The following operation gets details about the report with the job ID: examplea-1234-b567-cde8-90fg123abcd4

resp = client.get_organizations_access_report({
  job_id: "examplea-1234-b567-cde8-90fg123abcd4", 
})

resp.to_h outputs the following:
{
  access_details: [
    {
      entity_path: "o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-1a2b3c-k9l8m7n6o5example/111122223333", 
      last_authenticated_time: Time.parse("2019-05-25T16:29:52Z"), 
      region: "us-east-1", 
      service_name: "Amazon DynamoDB", 
      service_namespace: "dynamodb", 
      total_authenticated_entities: 2, 
    }, 
    {
      entity_path: "o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-1a2b3c-k9l8m7n6o5example/123456789012", 
      last_authenticated_time: Time.parse("2019-06-15T13:12:06Z"), 
      region: "us-east-1", 
      service_name: "AWS Identity and Access Management", 
      service_namespace: "iam", 
      total_authenticated_entities: 4, 
    }, 
    {
      service_name: "Amazon Simple Storage Service", 
      service_namespace: "s3", 
      total_authenticated_entities: 0, 
    }, 
  ], 
  is_truncated: false, 
  job_completion_date: Time.parse("2019-06-18T19:47:35.241Z"), 
  job_creation_date: Time.parse("2019-06-18T19:47:31.466Z"), 
  job_status: "COMPLETED", 
  number_of_services_accessible: 3, 
  number_of_services_not_accessed: 1, 
}

Request syntax with placeholder values


resp = client.get_organizations_access_report({
  job_id: "jobIDType", # required
  max_items: 1,
  marker: "markerType",
  sort_key: "SERVICE_NAMESPACE_ASCENDING", # accepts SERVICE_NAMESPACE_ASCENDING, SERVICE_NAMESPACE_DESCENDING, LAST_AUTHENTICATED_TIME_ASCENDING, LAST_AUTHENTICATED_TIME_DESCENDING
})

Response structure


resp.job_status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED"
resp.job_creation_date #=> Time
resp.job_completion_date #=> Time
resp.number_of_services_accessible #=> Integer
resp.number_of_services_not_accessed #=> Integer
resp.access_details #=> Array
resp.access_details[0].service_name #=> String
resp.access_details[0].service_namespace #=> String
resp.access_details[0].region #=> String
resp.access_details[0].entity_path #=> String
resp.access_details[0].last_authenticated_time #=> Time
resp.access_details[0].total_authenticated_entities #=> Integer
resp.is_truncated #=> Boolean
resp.marker #=> String
resp.error_details.message #=> String
resp.error_details.code #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The identifier of the request generated by the

    GenerateOrganizationsAccessReport][1

    operation.

    [1]: docs.aws.amazon.com/IAM/latest/APIReference/API_GenerateOrganizationsAccessReport.html

  • :max_items (Integer) —

    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

    1. 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 (String) —

    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 (String) —

    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.

Returns:

See Also:



6128
6129
6130
6131
 
# File 'lib/aws-sdk-iam/client.rb', line 6128

def get_organizations_access_report(params = {}, options = {})
  req = build_request(:get_organizations_access_report, params)
  req.send_request(options)
end

#get_outbound_web_identity_federation_info(params = {}) ⇒ Types::GetOutboundWebIdentityFederationInfoResponse

Retrieves the configuration information for the outbound identity federation feature in your Amazon Web Services account. The response includes the unique issuer URL for your Amazon Web Services account and the current enabled/disabled status of the feature. Use this operation to obtain the issuer URL that you need to configure trust relationships with external services.

Examples:

Response structure


resp.issuer_identifier #=> String
resp.jwt_vending_enabled #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



6154
6155
6156
6157
 
# File 'lib/aws-sdk-iam/client.rb', line 6154

def get_outbound_web_identity_federation_info(params = {}, options = {})
  req = build_request(:get_outbound_web_identity_federation_info, params)
  req.send_request(options)
end

#get_policy(params = {}) ⇒ Types::GetPolicyResponse

Retrieves information about the specified managed policy, including the policy’s default version and the total number of IAM users, groups, and roles to which the policy is attached. To retrieve the list of the specific users, groups, and roles that the policy is attached to, use [ListEntitiesForPolicy]. This operation returns metadata about the policy. To retrieve the actual policy document for a specific version of the policy, use [GetPolicyVersion].

This operation retrieves information about managed policies. To retrieve information about an inline policy that is embedded with an IAM user, group, or role, use [GetUserPolicy], [GetGroupPolicy], or [GetRolePolicy].

For more information about policies, see [Managed policies and inline policies] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_ListEntitiesForPolicy.html [2]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetPolicyVersion.html [3]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetUserPolicy.html [4]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetGroupPolicy.html [5]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetRolePolicy.html [6]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html

The following waiters are defined for this operation (see #wait_until for detailed usage):

* policy_exists

Examples:

Request syntax with placeholder values


resp = client.get_policy({
  policy_arn: "arnType", # required
})

Response structure


resp.policy.policy_name #=> String
resp.policy.policy_id #=> String
resp.policy.arn #=> String
resp.policy.path #=> String
resp.policy.default_version_id #=> String
resp.policy.attachment_count #=> Integer
resp.policy.permissions_boundary_usage_count #=> Integer
resp.policy.is_attachable #=> Boolean
resp.policy.description #=> String
resp.policy.create_date #=> Time
resp.policy.update_date #=> Time
resp.policy.tags #=> Array
resp.policy.tags[0].key #=> String
resp.policy.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



6231
6232
6233
6234
 
# File 'lib/aws-sdk-iam/client.rb', line 6231

def get_policy(params = {}, options = {})
  req = build_request(:get_policy, params)
  req.send_request(options)
end

#get_policy_version(params = {}) ⇒ Types::GetPolicyVersionResponse

Retrieves information about the specified version of the specified managed policy, including the policy document.

<note markdown=“1”> Policies returned by this operation are URL-encoded compliant with [RFC 3986]. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the ‘decode` method of the `java.net.URLDecoder` utility class in the Java SDK. Other languages and SDKs provide similar functionality, and some SDKs do this decoding automatically.

</note>

To list the available versions for a policy, use [ListPolicyVersions].

This operation retrieves information about managed policies. To retrieve information about an inline policy that is embedded in a user, group, or role, use [GetUserPolicy], [GetGroupPolicy], or [GetRolePolicy].

For more information about the types of policies, see [Managed policies and inline policies] in the *IAM User Guide*.

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

[1]: tools.ietf.org/html/rfc3986 [2]: docs.aws.amazon.com/IAM/latest/APIReference/API_ListPolicyVersions.html [3]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetUserPolicy.html [4]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetGroupPolicy.html [5]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetRolePolicy.html [6]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html [7]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html

Examples:

Request syntax with placeholder values


resp = client.get_policy_version({
  policy_arn: "arnType", # required
  version_id: "policyVersionIdType", # required
})

Response structure


resp.policy_version.document #=> String
resp.policy_version.version_id #=> String
resp.policy_version.is_default_version #=> Boolean
resp.policy_version.create_date #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :policy_arn (required, String) —

    The Amazon Resource Name (ARN) of the managed policy that you want information about.

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

    [1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

  • :version_id (required, String) —

    Identifies the policy version to retrieve.

    This parameter allows (through its [regex pattern]) a string of characters that consists of the lowercase letter ‘v’ followed by one or two digits, and optionally followed by a period ‘.’ and a string of letters and digits.

    [1]: wikipedia.org/wiki/regex

Returns:

See Also:



6317
6318
6319
6320
 
# File 'lib/aws-sdk-iam/client.rb', line 6317

def get_policy_version(params = {}, options = {})
  req = build_request(:get_policy_version, params)
  req.send_request(options)
end

#get_role(params = {}) ⇒ Types::GetRoleResponse

Retrieves information about the specified role, including the role’s path, GUID, ARN, and the role’s trust policy that grants permission to assume the role. For more information about roles, see [IAM roles] in the *IAM User Guide*.

<note markdown=“1”> Policies returned by this operation are URL-encoded compliant with [RFC 3986]. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the ‘decode` method of the `java.net.URLDecoder` utility class in the Java SDK. Other languages and SDKs provide similar functionality, and some SDKs do this decoding automatically.

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html [2]: tools.ietf.org/html/rfc3986

The following waiters are defined for this operation (see #wait_until for detailed usage):

* role_exists

Examples:

Example: To get information about an IAM role


# The following command gets information about the role named Test-Role.

resp = client.get_role({
  role_name: "Test-Role", 
})

resp.to_h outputs the following:
{
  role: {
    arn: "arn:aws:iam::123456789012:role/Test-Role", 
    assume_role_policy_document: "<URL-encoded-JSON>", 
    create_date: Time.parse("2013-04-18T05:01:58Z"), 
    max_session_duration: 3600, 
    path: "/", 
    role_id: "AROADBQP57FF2AEXAMPLE", 
    role_last_used: {
      last_used_date: Time.parse("2019-11-18T05:01:58Z"), 
      region: "us-east-1", 
    }, 
    role_name: "Test-Role", 
  }, 
}

Request syntax with placeholder values


resp = client.get_role({
  role_name: "roleNameType", # required
})

Response structure


resp.role.path #=> String
resp.role.role_name #=> String
resp.role.role_id #=> String
resp.role.arn #=> String
resp.role.create_date #=> Time
resp.role.assume_role_policy_document #=> String
resp.role.description #=> String
resp.role.max_session_duration #=> Integer
resp.role.permissions_boundary.permissions_boundary_type #=> String, one of "PermissionsBoundaryPolicy"
resp.role.permissions_boundary.permissions_boundary_arn #=> String
resp.role.tags #=> Array
resp.role.tags[0].key #=> String
resp.role.tags[0].value #=> String
resp.role.role_last_used.last_used_date #=> Time
resp.role.role_last_used.region #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :role_name (required, String) —

    The name of the IAM role to get information about.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

Returns:

See Also:



6416
6417
6418
6419
 
# File 'lib/aws-sdk-iam/client.rb', line 6416

def get_role(params = {}, options = {})
  req = build_request(:get_role, params)
  req.send_request(options)
end

#get_role_policy(params = {}) ⇒ Types::GetRolePolicyResponse

Retrieves the specified inline policy document that is embedded with the specified IAM role.

<note markdown=“1”> Policies returned by this operation are URL-encoded compliant with [RFC 3986]. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the ‘decode` method of the `java.net.URLDecoder` utility class in the Java SDK. Other languages and SDKs provide similar functionality, and some SDKs do this decoding automatically.

</note>

An IAM role can also have managed policies attached to it. To retrieve a managed policy document that is attached to a role, use

GetPolicy][2

to determine the policy’s default version, then use

GetPolicyVersion][3

to retrieve the policy document.

For more information about policies, see [Managed policies and inline policies] in the *IAM User Guide*.

For more information about roles, see [IAM roles] in the *IAM User Guide*.

[1]: tools.ietf.org/html/rfc3986 [2]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetPolicy.html [3]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetPolicyVersion.html [4]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html [5]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html

Examples:

Request syntax with placeholder values


resp = client.get_role_policy({
  role_name: "roleNameType", # required
  policy_name: "policyNameType", # required
})

Response structure


resp.role_name #=> String
resp.policy_name #=> String
resp.policy_document #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :role_name (required, String) —

    The name of the role associated with the 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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :policy_name (required, String) —

    The name of the policy document to get.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

Returns:

See Also:



6499
6500
6501
6502
 
# File 'lib/aws-sdk-iam/client.rb', line 6499

def get_role_policy(params = {}, options = {})
  req = build_request(:get_role_policy, params)
  req.send_request(options)
end

#get_saml_provider(params = {}) ⇒ Types::GetSAMLProviderResponse

Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated.

<note markdown=“1”> This operation requires [Signature Version 4].

</note>

[1]: docs.aws.amazon.com/general/latest/gr/signature-version-4.html

Examples:

Request syntax with placeholder values


resp = client.get_saml_provider({
  saml_provider_arn: "arnType", # required
})

Response structure


resp.saml_provider_uuid #=> String
resp.saml_metadata_document #=> String
resp.create_date #=> Time
resp.valid_until #=> Time
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.assertion_encryption_mode #=> String, one of "Required", "Allowed"
resp.private_key_list #=> Array
resp.private_key_list[0].key_id #=> String
resp.private_key_list[0].timestamp #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



6560
6561
6562
6563
 
# File 'lib/aws-sdk-iam/client.rb', line 6560

def get_saml_provider(params = {}, options = {})
  req = build_request(:get_saml_provider, params)
  req.send_request(options)
end

#get_server_certificate(params = {}) ⇒ Types::GetServerCertificateResponse

Retrieves information about the specified server certificate stored in IAM.

For more information about working with server certificates, see

Working with server certificates][1

in the *IAM User Guide*. This

topic includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html

Examples:

Request syntax with placeholder values


resp = client.get_server_certificate({
  server_certificate_name: "serverCertificateNameType", # required
})

Response structure


resp.server_certificate.server_certificate_metadata.path #=> String
resp.server_certificate.server_certificate_metadata.server_certificate_name #=> String
resp.server_certificate.server_certificate_metadata.server_certificate_id #=> String
resp.server_certificate.server_certificate_metadata.arn #=> String
resp.server_certificate.server_certificate_metadata.upload_date #=> Time
resp.server_certificate.server_certificate_metadata.expiration #=> Time
resp.server_certificate.certificate_body #=> String
resp.server_certificate.certificate_chain #=> String
resp.server_certificate.tags #=> Array
resp.server_certificate.tags[0].key #=> String
resp.server_certificate.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :server_certificate_name (required, String) —

    The name of the server certificate you want to retrieve information about.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

Returns:

See Also:



6689
6690
6691
6692
 
# File 'lib/aws-sdk-iam/client.rb', line 6689

def get_server_certificate(params = {}, options = {})
  req = build_request(:get_server_certificate, params)
  req.send_request(options)
end

#get_service_last_accessed_details(params = {}) ⇒ Types::GetServiceLastAccessedDetailsResponse

Retrieves a service last accessed report that was created using the ‘GenerateServiceLastAccessedDetails` operation. You can use the `JobId` parameter in `GetServiceLastAccessedDetails` to retrieve the status of your report job. When the report is complete, you can retrieve the generated report. The report includes a list of Amazon Web Services services that the resource (user, group, role, or managed policy) can access.

<note markdown=“1”> Service last accessed data does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see [Evaluating policies] in the *IAM User Guide*.

</note>

For each service that the resource could access using permissions policies, the operation returns details about the most recent access attempt. If there was no attempt, the service is listed without details about the most recent attempt to access the service. If the operation fails, the ‘GetServiceLastAccessedDetails` operation returns the reason that it failed.

The ‘GetServiceLastAccessedDetails` operation returns a list of services. This list includes the number of entities that have attempted to access the service and the date and time of the last attempt. It also returns the ARN of the following entity, depending on the resource ARN that you used to generate the report:

  • User – Returns the user ARN that you used to generate the report

  • Group – Returns the ARN of the group member (user) that last attempted to access the service

  • Role – Returns the role ARN that you used to generate the report

  • Policy – Returns the ARN of the user or role that last used the policy to attempt to access the service

By default, the list is sorted by service namespace.

If you specified ‘ACTION_LEVEL` granularity when you generated the report, this operation returns service and action last accessed data. This includes the most recent access attempt for each tracked action within a service. Otherwise, this operation returns only service data.

For more information about service and action last accessed data, see

Reducing permissions using service last accessed data][2

in the *IAM

User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-basics [2]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html

Examples:

Example: To get details from a previously-generated report


# The following operation gets details about the report with the job ID: examplef-1305-c245-eba4-71fe298bcda7

resp = client.get_service_last_accessed_details({
  job_id: "examplef-1305-c245-eba4-71fe298bcda7", 
})

resp.to_h outputs the following:
{
  is_truncated: false, 
  job_completion_date: Time.parse("2018-10-24T19:47:35.241Z"), 
  job_creation_date: Time.parse("2018-10-24T19:47:31.466Z"), 
  job_status: "COMPLETED", 
  services_last_accessed: [
    {
      last_authenticated: Time.parse("2018-10-24T19:11:00Z"), 
      last_authenticated_entity: "arn:aws:iam::123456789012:user/AWSExampleUser01", 
      service_name: "AWS Identity and Access Management", 
      service_namespace: "iam", 
      total_authenticated_entities: 2, 
    }, 
    {
      service_name: "Amazon Simple Storage Service", 
      service_namespace: "s3", 
      total_authenticated_entities: 0, 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.get_service_last_accessed_details({
  job_id: "jobIDType", # required
  max_items: 1,
  marker: "markerType",
})

Response structure


resp.job_status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED"
resp.job_type #=> String, one of "SERVICE_LEVEL", "ACTION_LEVEL"
resp.job_creation_date #=> Time
resp.services_last_accessed #=> Array
resp.services_last_accessed[0].service_name #=> String
resp.services_last_accessed[0].last_authenticated #=> Time
resp.services_last_accessed[0].service_namespace #=> String
resp.services_last_accessed[0].last_authenticated_entity #=> String
resp.services_last_accessed[0].last_authenticated_region #=> String
resp.services_last_accessed[0].total_authenticated_entities #=> Integer
resp.services_last_accessed[0].tracked_actions_last_accessed #=> Array
resp.services_last_accessed[0].tracked_actions_last_accessed[0].action_name #=> String
resp.services_last_accessed[0].tracked_actions_last_accessed[0].last_accessed_entity #=> String
resp.services_last_accessed[0].tracked_actions_last_accessed[0].last_accessed_time #=> Time
resp.services_last_accessed[0].tracked_actions_last_accessed[0].last_accessed_region #=> String
resp.job_completion_date #=> Time
resp.is_truncated #=> Boolean
resp.marker #=> String
resp.error.message #=> String
resp.error.code #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The ID of the request generated by the

    GenerateServiceLastAccessedDetails][1

    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`.

    [1]: docs.aws.amazon.com/IAM/latest/APIReference/API_GenerateServiceLastAccessedDetails.html

  • :max_items (Integer) —

    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

    1. 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 (String) —

    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.

Returns:

See Also:



6856
6857
6858
6859
 
# File 'lib/aws-sdk-iam/client.rb', line 6856

def get_service_last_accessed_details(params = {}, options = {})
  req = build_request(:get_service_last_accessed_details, params)
  req.send_request(options)
end

#get_service_last_accessed_details_with_entities(params = {}) ⇒ Types::GetServiceLastAccessedDetailsWithEntitiesResponse

After you generate a group or policy report using the ‘GenerateServiceLastAccessedDetails` operation, you can use the `JobId` parameter in `GetServiceLastAccessedDetailsWithEntities`. This operation retrieves the status of your report job and a list of entities that could have used group or policy permissions to access the specified service.

  • Group – For a group report, this operation returns a list of users in the group that could have used the group’s policies in an attempt to access the service.

  • Policy – For a policy report, this operation returns a list of entities (users or roles) that could have used the policy in an attempt to access the service.

You can also use this operation for user or role reports to retrieve details about those entities.

If the operation fails, the ‘GetServiceLastAccessedDetailsWithEntities` operation returns the reason that it failed.

By default, the list of associated entities is sorted by date, with the most recent access listed first.

Examples:

Example: To get sntity details from a previously-generated report


# The following operation returns details about the entities that attempted to access the IAM service.

resp = client.get_service_last_accessed_details_with_entities({
  job_id: "examplef-1305-c245-eba4-71fe298bcda7", 
  service_namespace: "iam", 
})

resp.to_h outputs the following:
{
  entity_details_list: [
    {
      entity_info: {
        arn: "arn:aws:iam::123456789012:user/AWSExampleUser01", 
        id: "AIDAEX2EXAMPLEB6IGCDC", 
        name: "AWSExampleUser01", 
        path: "/", 
        type: "USER", 
      }, 
      last_authenticated: Time.parse("2018-10-24T19:10:00Z"), 
    }, 
    {
      entity_info: {
        arn: "arn:aws:iam::123456789012:role/AWSExampleRole01", 
        id: "AROAEAEXAMPLEIANXSIU4", 
        name: "AWSExampleRole01", 
        path: "/", 
        type: "ROLE", 
      }, 
    }, 
  ], 
  is_truncated: false, 
  job_completion_date: Time.parse("2018-10-24T19:47:35.241Z"), 
  job_creation_date: Time.parse("2018-10-24T19:47:31.466Z"), 
  job_status: "COMPLETED", 
}

Request syntax with placeholder values


resp = client.get_service_last_accessed_details_with_entities({
  job_id: "jobIDType", # required
  service_namespace: "serviceNamespaceType", # required
  max_items: 1,
  marker: "markerType",
})

Response structure


resp.job_status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED"
resp.job_creation_date #=> Time
resp.job_completion_date #=> Time
resp.entity_details_list #=> Array
resp.entity_details_list[0].entity_info.arn #=> String
resp.entity_details_list[0].entity_info.name #=> String
resp.entity_details_list[0].entity_info.type #=> String, one of "USER", "ROLE", "GROUP"
resp.entity_details_list[0].entity_info.id #=> String
resp.entity_details_list[0].entity_info.path #=> String
resp.entity_details_list[0].last_authenticated #=> Time
resp.is_truncated #=> Boolean
resp.marker #=> String
resp.error.message #=> String
resp.error.code #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The ID of the request generated by the ‘GenerateServiceLastAccessedDetails` operation.

  • :service_namespace (required, String) —

    The service namespace for an Amazon Web Services service. Provide the service namespace to learn when the IAM entity last attempted to access the specified service.

    To learn the service namespace for a service, see [Actions, resources, and condition keys for Amazon Web Services services] in the *IAM User Guide*. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, ‘(service prefix: a4b)`. For more information about service namespaces, see [Amazon Web Services service namespaces] in the *Amazon Web Services General Reference*.

    [1]: docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html [2]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces

  • :max_items (Integer) —

    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

    1. 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 (String) —

    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.

Returns:

See Also:



7004
7005
7006
7007
 
# File 'lib/aws-sdk-iam/client.rb', line 7004

def get_service_last_accessed_details_with_entities(params = {}, options = {})
  req = build_request(:get_service_last_accessed_details_with_entities, params)
  req.send_request(options)
end

#get_service_linked_role_deletion_status(params = {}) ⇒ Types::GetServiceLinkedRoleDeletionStatusResponse

Retrieves the status of your service-linked role deletion. After you use [DeleteServiceLinkedRole] to submit a service-linked role for deletion, you can use the ‘DeletionTaskId` parameter in `GetServiceLinkedRoleDeletionStatus` to check the status of the deletion. If the deletion fails, this operation returns the reason that it failed, if that information is returned by the service.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_DeleteServiceLinkedRole.html

Examples:

Request syntax with placeholder values


resp = client.get_service_linked_role_deletion_status({
  deletion_task_id: "DeletionTaskIdType", # required
})

Response structure


resp.status #=> String, one of "SUCCEEDED", "IN_PROGRESS", "FAILED", "NOT_STARTED"
resp.reason.reason #=> String
resp.reason.role_usage_list #=> Array
resp.reason.role_usage_list[0].region #=> String
resp.reason.role_usage_list[0].resources #=> Array
resp.reason.role_usage_list[0].resources[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



7053
7054
7055
7056
 
# File 'lib/aws-sdk-iam/client.rb', line 7053

def get_service_linked_role_deletion_status(params = {}, options = {})
  req = build_request(:get_service_linked_role_deletion_status, params)
  req.send_request(options)
end

#get_ssh_public_key(params = {}) ⇒ Types::GetSSHPublicKeyResponse

Retrieves the specified SSH public key, including metadata about the key.

The SSH public key retrieved by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see [Set up CodeCommit for SSH connections] in the *CodeCommit User Guide*.

[1]: docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html

Examples:

Request syntax with placeholder values


resp = client.get_ssh_public_key({
  user_name: "userNameType", # required
  ssh_public_key_id: "publicKeyIdType", # required
  encoding: "SSH", # required, accepts SSH, PEM
})

Response structure


resp.ssh_public_key.user_name #=> String
resp.ssh_public_key.ssh_public_key_id #=> String
resp.ssh_public_key.fingerprint #=> String
resp.ssh_public_key.ssh_public_key_body #=> String
resp.ssh_public_key.status #=> String, one of "Active", "Inactive", "Expired"
resp.ssh_public_key.upload_date #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (required, String) —

    The name of the IAM user associated with the SSH public key.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :ssh_public_key_id (required, String) —

    The unique identifier for the SSH public key.

    This parameter allows (through its [regex pattern]) a string of characters that can consist of any upper or lowercased letter or digit.

    [1]: wikipedia.org/wiki/regex

  • :encoding (required, String) —

    Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, use ‘SSH`. To retrieve the public key in PEM format, use `PEM`.

Returns:

See Also:



6631
6632
6633
6634
 
# File 'lib/aws-sdk-iam/client.rb', line 6631

def get_ssh_public_key(params = {}, options = {})
  req = build_request(:get_ssh_public_key, params)
  req.send_request(options)
end

#get_user(params = {}) ⇒ Types::GetUserResponse

Retrieves information about the specified IAM user, including the user’s creation date, path, unique ID, and ARN.

If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID used to sign the request to this operation.

The following waiters are defined for this operation (see #wait_until for detailed usage):

* user_exists

Examples:

Example: To get information about an IAM user


# The following command gets information about the IAM user named Bob.

resp = client.get_user({
  user_name: "Bob", 
})

resp.to_h outputs the following:
{
  user: {
    arn: "arn:aws:iam::123456789012:user/Bob", 
    create_date: Time.parse("2012-09-21T23:03:13Z"), 
    path: "/", 
    user_id: "AKIAIOSFODNN7EXAMPLE", 
    user_name: "Bob", 
  }, 
}

Request syntax with placeholder values


resp = client.get_user({
  user_name: "existingUserNameType",
})

Response structure


resp.user.path #=> String
resp.user.user_name #=> String
resp.user.user_id #=> String
resp.user.arn #=> String
resp.user.create_date #=> Time
resp.user.password_last_used #=> Time
resp.user.permissions_boundary.permissions_boundary_type #=> String, one of "PermissionsBoundaryPolicy"
resp.user.permissions_boundary.permissions_boundary_arn #=> String
resp.user.tags #=> Array
resp.user.tags[0].key #=> String
resp.user.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

Returns:

See Also:



7131
7132
7133
7134
 
# File 'lib/aws-sdk-iam/client.rb', line 7131

def get_user(params = {}, options = {})
  req = build_request(:get_user, params)
  req.send_request(options)
end

#get_user_policy(params = {}) ⇒ Types::GetUserPolicyResponse

Retrieves the specified inline policy document that is embedded in the specified IAM user.

<note markdown=“1”> Policies returned by this operation are URL-encoded compliant with [RFC 3986]. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the ‘decode` method of the `java.net.URLDecoder` utility class in the Java SDK. Other languages and SDKs provide similar functionality, and some SDKs do this decoding automatically.

</note>

An IAM user can also have managed policies attached to it. To retrieve a managed policy document that is attached to a user, use

GetPolicy][2

to determine the policy’s default version. Then use

GetPolicyVersion][3

to retrieve the policy document.

For more information about policies, see [Managed policies and inline policies] in the *IAM User Guide*.

[1]: tools.ietf.org/html/rfc3986 [2]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetPolicy.html [3]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetPolicyVersion.html [4]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html

Examples:

Request syntax with placeholder values


resp = client.get_user_policy({
  user_name: "existingUserNameType", # required
  policy_name: "policyNameType", # required
})

Response structure


resp.user_name #=> String
resp.policy_name #=> String
resp.policy_document #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (required, String) —

    The name of the user who the policy is associated 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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :policy_name (required, String) —

    The name of the policy document to get.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

Returns:

See Also:



7210
7211
7212
7213
 
# File 'lib/aws-sdk-iam/client.rb', line 7210

def get_user_policy(params = {}, options = {})
  req = build_request(:get_user_policy, params)
  req.send_request(options)
end

#list_access_keys(params = {}) ⇒ Types::ListAccessKeysResponse

Returns information about the access key IDs associated with the specified IAM user. If there is none, the operation returns an empty list.

Although each user is limited to a small number of keys, you can still paginate the results using the ‘MaxItems` and `Marker` parameters.

If the ‘UserName` is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. If a temporary access key is used, then `UserName` is required. If a long-term key is assigned to the user, then `UserName` is not required.

This operation works for access keys under the Amazon Web Services account. If the Amazon Web Services account has no associated users, the root user returns it’s own access key IDs by running this command.

<note markdown=“1”> To ensure the security of your Amazon Web Services account, the secret access key is accessible only during key and user creation.

</note>

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To list the access key IDs for an IAM user


# The following command lists the access keys IDs for the IAM user named Alice.

resp = client.list_access_keys({
  user_name: "Alice", 
})

resp.to_h outputs the following:
{
  access_key_metadata: [
    {
      access_key_id: "AKIA111111111EXAMPLE", 
      create_date: Time.parse("2016-12-01T22:19:58Z"), 
      status: "Active", 
      user_name: "Alice", 
    }, 
    {
      access_key_id: "AKIA222222222EXAMPLE", 
      create_date: Time.parse("2016-12-01T22:20:01Z"), 
      status: "Active", 
      user_name: "Alice", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_access_keys({
  user_name: "existingUserNameType",
  marker: "markerType",
  max_items: 1,
})

Response structure


resp.access_key_metadata #=> Array
resp.access_key_metadata[0].user_name #=> String
resp.access_key_metadata[0].access_key_id #=> String
resp.access_key_metadata[0].status #=> String, one of "Active", "Inactive", "Expired"
resp.access_key_metadata[0].create_date #=> Time
resp.is_truncated #=> Boolean
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :marker (String) —

    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 (Integer) —

    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

    1. 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.

Returns:

See Also:



7324
7325
7326
7327
 
# File 'lib/aws-sdk-iam/client.rb', line 7324

def list_access_keys(params = {}, options = {})
  req = build_request(:list_access_keys, params)
  req.send_request(options)
end

#list_account_aliases(params = {}) ⇒ Types::ListAccountAliasesResponse

Lists the account alias associated with the Amazon Web Services account (Note: you can have only one). For information about using an Amazon Web Services account alias, see [Creating, deleting, and listing an Amazon Web Services account alias] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/console_account-alias.html#CreateAccountAlias

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To list account aliases


# The following command lists the aliases for the current account.

resp = client.({
})

resp.to_h outputs the following:
{
  account_aliases: [
    "exmaple-corporation", 
  ], 
}

Request syntax with placeholder values


resp = client.({
  marker: "markerType",
  max_items: 1,
})

Response structure


resp. #=> Array
resp.[0] #=> String
resp.is_truncated #=> Boolean
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :marker (String) —

    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 (Integer) —

    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

    1. 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.

Returns:

See Also:



7397
7398
7399
7400
 
# File 'lib/aws-sdk-iam/client.rb', line 7397

def (params = {}, options = {})
  req = build_request(:list_account_aliases, params)
  req.send_request(options)
end

#list_attached_group_policies(params = {}) ⇒ Types::ListAttachedGroupPoliciesResponse

Lists all managed policies that are attached to the specified IAM group.

An IAM group can also have inline policies embedded with it. To list the inline policies for a group, use [ListGroupPolicies]. For information about policies, see [Managed policies and inline policies] in the *IAM User Guide*.

You can paginate the results using the ‘MaxItems` and `Marker` parameters. You can use the `PathPrefix` parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the operation returns an empty list.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_ListGroupPolicies.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_attached_group_policies({
  group_name: "groupNameType", # required
  path_prefix: "policyPathType",
  marker: "markerType",
  max_items: 1,
})

Response structure


resp.attached_policies #=> Array
resp.attached_policies[0].policy_name #=> String
resp.attached_policies[0].policy_arn #=> String
resp.is_truncated #=> Boolean
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :group_name (required, String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :path_prefix (String) —

    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.

    [1]: wikipedia.org/wiki/regex

  • :marker (String) —

    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 (Integer) —

    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

    1. 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.

Returns:

See Also:



7496
7497
7498
7499
 
# File 'lib/aws-sdk-iam/client.rb', line 7496

def list_attached_group_policies(params = {}, options = {})
  req = build_request(:list_attached_group_policies, params)
  req.send_request(options)
end

#list_attached_role_policies(params = {}) ⇒ Types::ListAttachedRolePoliciesResponse

Lists all managed policies that are attached to the specified IAM role.

An IAM role can also have inline policies embedded with it. To list the inline policies for a role, use [ListRolePolicies]. For information about policies, see [Managed policies and inline policies] in the *IAM User Guide*.

You can paginate the results using the ‘MaxItems` and `Marker` parameters. You can use the `PathPrefix` parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified role (or none that match the specified path prefix), the operation returns an empty list.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_ListRolePolicies.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_attached_role_policies({
  role_name: "roleNameType", # required
  path_prefix: "policyPathType",
  marker: "markerType",
  max_items: 1,
})

Response structure


resp.attached_policies #=> Array
resp.attached_policies[0].policy_name #=> String
resp.attached_policies[0].policy_arn #=> String
resp.is_truncated #=> Boolean
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :role_name (required, String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :path_prefix (String) —

    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.

    [1]: wikipedia.org/wiki/regex

  • :marker (String) —

    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 (Integer) —

    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

    1. 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.

Returns:

See Also:



7595
7596
7597
7598
 
# File 'lib/aws-sdk-iam/client.rb', line 7595

def list_attached_role_policies(params = {}, options = {})
  req = build_request(:list_attached_role_policies, params)
  req.send_request(options)
end

#list_attached_user_policies(params = {}) ⇒ Types::ListAttachedUserPoliciesResponse

Lists all managed policies that are attached to the specified IAM user.

An IAM user can also have inline policies embedded with it. To list the inline policies for a user, use [ListUserPolicies]. For information about policies, see [Managed policies and inline policies] in the *IAM User Guide*.

You can paginate the results using the ‘MaxItems` and `Marker` parameters. You can use the `PathPrefix` parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the operation returns an empty list.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_ListUserPolicies.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_attached_user_policies({
  user_name: "userNameType", # required
  path_prefix: "policyPathType",
  marker: "markerType",
  max_items: 1,
})

Response structure


resp.attached_policies #=> Array
resp.attached_policies[0].policy_name #=> String
resp.attached_policies[0].policy_arn #=> String
resp.is_truncated #=> Boolean
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (required, String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :path_prefix (String) —

    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.

    [1]: wikipedia.org/wiki/regex

  • :marker (String) —

    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 (Integer) —

    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

    1. 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.

Returns:

See Also:



7694
7695
7696
7697
 
# File 'lib/aws-sdk-iam/client.rb', line 7694

def list_attached_user_policies(params = {}, options = {})
  req = build_request(:list_attached_user_policies, params)
  req.send_request(options)
end

#list_delegation_requests(params = {}) ⇒ Types::ListDelegationRequestsResponse

Lists delegation requests based on the specified criteria.

If a delegation request has no owner, even if it is assigned to a specific account, it will not be part of the ‘ListDelegationRequests` output for that account.

For more details, see [ Managing Permissions for Delegation Requests].

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies-temporary-delegation.html#temporary-delegation-managing-permissions

Examples:

Request syntax with placeholder values


resp = client.list_delegation_requests({
  owner_id: "ownerIdType",
  marker: "markerType",
  max_items: 1,
})

Response structure


resp.delegation_requests #=> Array
resp.delegation_requests[0].delegation_request_id #=> String
resp.delegation_requests[0]. #=> String
resp.delegation_requests[0].description #=> String
resp.delegation_requests[0].request_message #=> String
resp.delegation_requests[0].permissions.policy_template_arn #=> String
resp.delegation_requests[0].permissions.parameters #=> Array
resp.delegation_requests[0].permissions.parameters[0].name #=> String
resp.delegation_requests[0].permissions.parameters[0].values #=> Array
resp.delegation_requests[0].permissions.parameters[0].values[0] #=> String
resp.delegation_requests[0].permissions.parameters[0].type #=> String, one of "string", "stringList"
resp.delegation_requests[0].permission_policy #=> String
resp.delegation_requests[0].role_permission_restriction_arns #=> Array
resp.delegation_requests[0].role_permission_restriction_arns[0] #=> String
resp.delegation_requests[0].owner_id #=> String
resp.delegation_requests[0].approver_id #=> String
resp.delegation_requests[0].state #=> String, one of "UNASSIGNED", "ASSIGNED", "PENDING_APPROVAL", "FINALIZED", "ACCEPTED", "REJECTED", "EXPIRED"
resp.delegation_requests[0].expiration_time #=> Time
resp.delegation_requests[0].requestor_id #=> String
resp.delegation_requests[0].requestor_name #=> String
resp.delegation_requests[0].create_date #=> Time
resp.delegation_requests[0].session_duration #=> Integer
resp.delegation_requests[0].redirect_url #=> String
resp.delegation_requests[0].notes #=> String
resp.delegation_requests[0].rejection_reason #=> String
resp.delegation_requests[0].only_send_by_owner #=> Boolean
resp.delegation_requests[0].updated_time #=> Time
resp.marker #=> String
resp.is_truncated #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :owner_id (String) —

    The owner ID to filter delegation requests by.

  • :marker (String) —

    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 (Integer) —

    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

    1. Note that IAM may 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.

Returns:

See Also:



7782
7783
7784
7785
 
# File 'lib/aws-sdk-iam/client.rb', line 7782

def list_delegation_requests(params = {}, options = {})
  req = build_request(:list_delegation_requests, params)
  req.send_request(options)
end

#list_entities_for_policy(params = {}) ⇒ Types::ListEntitiesForPolicyResponse

Lists all IAM users, groups, and roles that the specified managed policy is attached to.

You can use the optional ‘EntityFilter` parameter to limit the results to a particular type of entity (users, groups, or roles). For example, to list only the roles that are attached to the specified policy, set `EntityFilter` to `Role`.

You can paginate the results using the ‘MaxItems` and `Marker` parameters.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_entities_for_policy({
  policy_arn: "arnType", # required
  entity_filter: "User", # accepts User, Role, Group, LocalManagedPolicy, AWSManagedPolicy
  path_prefix: "pathType",
  policy_usage_filter: "PermissionsPolicy", # accepts PermissionsPolicy, PermissionsBoundary
  marker: "markerType",
  max_items: 1,
})

Response structure


resp.policy_groups #=> Array
resp.policy_groups[0].group_name #=> String
resp.policy_groups[0].group_id #=> String
resp.policy_users #=> Array
resp.policy_users[0].user_name #=> String
resp.policy_users[0].user_id #=> String
resp.policy_roles #=> Array
resp.policy_roles[0].role_name #=> String
resp.policy_roles[0].role_id #=> String
resp.is_truncated #=> Boolean
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :policy_arn (required, String) —

    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*.

    [1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

  • :entity_filter (String) —

    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 (String) —

    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.

    [1]: wikipedia.org/wiki/regex

  • :policy_usage_filter (String) —

    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 (String) —

    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 (Integer) —

    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

    1. 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.

Returns:

See Also:



7900
7901
7902
7903
 
# File 'lib/aws-sdk-iam/client.rb', line 7900

def list_entities_for_policy(params = {}, options = {})
  req = build_request(:list_entities_for_policy, params)
  req.send_request(options)
end

#list_group_policies(params = {}) ⇒ Types::ListGroupPoliciesResponse

Lists the names of the inline policies that are embedded in the specified IAM group.

An IAM group can also have managed policies attached to it. To list the managed policies that are attached to a group, use [ListAttachedGroupPolicies]. For more information about policies, see [Managed policies and inline policies] in the *IAM User Guide*.

You can paginate the results using the ‘MaxItems` and `Marker` parameters. If there are no inline policies embedded with the specified group, the operation returns an empty list.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_ListAttachedGroupPolicies.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To list the in-line policies for an IAM group


# The following command lists the names of in-line policies that are embedded in the IAM group named Admins.

resp = client.list_group_policies({
  group_name: "Admins", 
})

resp.to_h outputs the following:
{
  policy_names: [
    "AdminRoot", 
    "KeyPolicy", 
  ], 
}

Request syntax with placeholder values


resp = client.list_group_policies({
  group_name: "groupNameType", # required
  marker: "markerType",
  max_items: 1,
})

Response structure


resp.policy_names #=> Array
resp.policy_names[0] #=> String
resp.is_truncated #=> Boolean
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :group_name (required, String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :marker (String) —

    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 (Integer) —

    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

    1. 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.

Returns:

See Also:



7995
7996
7997
7998
 
# File 'lib/aws-sdk-iam/client.rb', line 7995

def list_group_policies(params = {}, options = {})
  req = build_request(:list_group_policies, params)
  req.send_request(options)
end

#list_groups(params = {}) ⇒ Types::ListGroupsResponse

Lists the IAM groups that have the specified path prefix.

You can paginate the results using the ‘MaxItems` and `Marker` parameters.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To list the IAM groups for the current account


# The following command lists the IAM groups in the current account:

resp = client.list_groups({
})

resp.to_h outputs the following:
{
  groups: [
    {
      arn: "arn:aws:iam::123456789012:group/Admins", 
      create_date: Time.parse("2016-12-15T21:40:08.121Z"), 
      group_id: "AGPA1111111111EXAMPLE", 
      group_name: "Admins", 
      path: "/division_abc/subdivision_xyz/", 
    }, 
    {
      arn: "arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/engineering/Test", 
      create_date: Time.parse("2016-11-30T14:10:01.156Z"), 
      group_id: "AGP22222222222EXAMPLE", 
      group_name: "Test", 
      path: "/division_abc/subdivision_xyz/product_1234/engineering/", 
    }, 
    {
      arn: "arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/Managers", 
      create_date: Time.parse("2016-06-12T20:14:52.032Z"), 
      group_id: "AGPI3333333333EXAMPLE", 
      group_name: "Managers", 
      path: "/division_abc/subdivision_xyz/product_1234/", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_groups({
  path_prefix: "pathPrefixType",
  marker: "markerType",
  max_items: 1,
})

Response structure


resp.groups #=> Array
resp.groups[0].path #=> String
resp.groups[0].group_name #=> String
resp.groups[0].group_id #=> String
resp.groups[0].arn #=> String
resp.groups[0].create_date #=> Time
resp.is_truncated #=> Boolean
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :path_prefix (String) —

    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.

    [1]: wikipedia.org/wiki/regex

  • :marker (String) —

    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 (Integer) —

    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

    1. 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.

Returns:

See Also:



8105
8106
8107
8108
 
# File 'lib/aws-sdk-iam/client.rb', line 8105

def list_groups(params = {}, options = {})
  req = build_request(:list_groups, params)
  req.send_request(options)
end

#list_groups_for_user(params = {}) ⇒ Types::ListGroupsForUserResponse

Lists the IAM groups that the specified IAM user belongs to.

You can paginate the results using the ‘MaxItems` and `Marker` parameters.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To list the groups that an IAM user belongs to


# The following command displays the groups that the IAM user named Bob belongs to.

resp = client.list_groups_for_user({
  user_name: "Bob", 
})

resp.to_h outputs the following:
{
  groups: [
    {
      arn: "arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/engineering/Test", 
      create_date: Time.parse("2016-11-30T14:10:01.156Z"), 
      group_id: "AGP2111111111EXAMPLE", 
      group_name: "Test", 
      path: "/division_abc/subdivision_xyz/product_1234/engineering/", 
    }, 
    {
      arn: "arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/Managers", 
      create_date: Time.parse("2016-06-12T20:14:52.032Z"), 
      group_id: "AGPI222222222SEXAMPLE", 
      group_name: "Managers", 
      path: "/division_abc/subdivision_xyz/product_1234/", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_groups_for_user({
  user_name: "existingUserNameType", # required
  marker: "markerType",
  max_items: 1,
})

Response structure


resp.groups #=> Array
resp.groups[0].path #=> String
resp.groups[0].group_name #=> String
resp.groups[0].group_id #=> String
resp.groups[0].arn #=> String
resp.groups[0].create_date #=> Time
resp.is_truncated #=> Boolean
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (required, String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :marker (String) —

    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 (Integer) —

    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

    1. 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.

Returns:

See Also:



8204
8205
8206
8207
 
# File 'lib/aws-sdk-iam/client.rb', line 8204

def list_groups_for_user(params = {}, options = {})
  req = build_request(:list_groups_for_user, params)
  req.send_request(options)
end

#list_instance_profile_tags(params = {}) ⇒ Types::ListInstanceProfileTagsResponse

Lists the tags that are attached to the specified IAM instance profile. The returned list of tags is sorted by tag key. For more information about tagging, see [Tagging IAM resources] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_instance_profile_tags({
  instance_profile_name: "instanceProfileNameType", # required
  marker: "markerType",
  max_items: 1,
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.is_truncated #=> Boolean
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_profile_name (required, String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :marker (String) —

    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 (Integer) —

    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

    1. 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.

Returns:

See Also:



8275
8276
8277
8278
 
# File 'lib/aws-sdk-iam/client.rb', line 8275

def list_instance_profile_tags(params = {}, options = {})
  req = build_request(:list_instance_profile_tags, params)
  req.send_request(options)
end

#list_instance_profiles(params = {}) ⇒ Types::ListInstanceProfilesResponse

Lists the instance profiles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about instance profiles, see [Using instance profiles] in the *IAM User Guide*.

<note markdown=“1”> IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for an instance profile, see [GetInstanceProfile].

</note>

You can paginate the results using the ‘MaxItems` and `Marker` parameters.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html [2]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetInstanceProfile.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_instance_profiles({
  path_prefix: "pathPrefixType",
  marker: "markerType",
  max_items: 1,
})

Response structure


resp.instance_profiles #=> Array
resp.instance_profiles[0].path #=> String
resp.instance_profiles[0].instance_profile_name #=> String
resp.instance_profiles[0].instance_profile_id #=> String
resp.instance_profiles[0].arn #=> String
resp.instance_profiles[0].create_date #=> Time
resp.instance_profiles[0].roles #=> Array
resp.instance_profiles[0].roles[0].path #=> String
resp.instance_profiles[0].roles[0].role_name #=> String
resp.instance_profiles[0].roles[0].role_id #=> String
resp.instance_profiles[0].roles[0].arn #=> String
resp.instance_profiles[0].roles[0].create_date #=> Time
resp.instance_profiles[0].roles[0].assume_role_policy_document #=> String
resp.instance_profiles[0].roles[0].description #=> String
resp.instance_profiles[0].roles[0].max_session_duration #=> Integer
resp.instance_profiles[0].roles[0].permissions_boundary.permissions_boundary_type #=> String, one of "PermissionsBoundaryPolicy"
resp.instance_profiles[0].roles[0].permissions_boundary.permissions_boundary_arn #=> String
resp.instance_profiles[0].roles[0].tags #=> Array
resp.instance_profiles[0].roles[0].tags[0].key #=> String
resp.instance_profiles[0].roles[0].tags[0].value #=> String
resp.instance_profiles[0].roles[0].role_last_used.last_used_date #=> Time
resp.instance_profiles[0].roles[0].role_last_used.region #=> String
resp.instance_profiles[0].tags #=> Array
resp.instance_profiles[0].tags[0].key #=> String
resp.instance_profiles[0].tags[0].value #=> String
resp.is_truncated #=> Boolean
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :path_prefix (String) —

    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.

    [1]: wikipedia.org/wiki/regex

  • :marker (String) —

    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 (Integer) —

    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

    1. 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.

Returns:

See Also:



8386
8387
8388
8389
 
# File 'lib/aws-sdk-iam/client.rb', line 8386

def list_instance_profiles(params = {}, options = {})
  req = build_request(:list_instance_profiles, params)
  req.send_request(options)
end

#list_instance_profiles_for_role(params = {}) ⇒ Types::ListInstanceProfilesForRoleResponse

Lists the instance profiles that have the specified associated IAM role. If there are none, the operation returns an empty list. For more information about instance profiles, go to [Using instance profiles] in the *IAM User Guide*.

You can paginate the results using the ‘MaxItems` and `Marker` parameters.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_instance_profiles_for_role({
  role_name: "roleNameType", # required
  marker: "markerType",
  max_items: 1,
})

Response structure


resp.instance_profiles #=> Array
resp.instance_profiles[0].path #=> String
resp.instance_profiles[0].instance_profile_name #=> String
resp.instance_profiles[0].instance_profile_id #=> String
resp.instance_profiles[0].arn #=> String
resp.instance_profiles[0].create_date #=> Time
resp.instance_profiles[0].roles #=> Array
resp.instance_profiles[0].roles[0].path #=> String
resp.instance_profiles[0].roles[0].role_name #=> String
resp.instance_profiles[0].roles[0].role_id #=> String
resp.instance_profiles[0].roles[0].arn #=> String
resp.instance_profiles[0].roles[0].create_date #=> Time
resp.instance_profiles[0].roles[0].assume_role_policy_document #=> String
resp.instance_profiles[0].roles[0].description #=> String
resp.instance_profiles[0].roles[0].max_session_duration #=> Integer
resp.instance_profiles[0].roles[0].permissions_boundary.permissions_boundary_type #=> String, one of "PermissionsBoundaryPolicy"
resp.instance_profiles[0].roles[0].permissions_boundary.permissions_boundary_arn #=> String
resp.instance_profiles[0].roles[0].tags #=> Array
resp.instance_profiles[0].roles[0].tags[0].key #=> String
resp.instance_profiles[0].roles[0].tags[0].value #=> String
resp.instance_profiles[0].roles[0].role_last_used.last_used_date #=> Time
resp.instance_profiles[0].roles[0].role_last_used.region #=> String
resp.instance_profiles[0].tags #=> Array
resp.instance_profiles[0].tags[0].key #=> String
resp.instance_profiles[0].tags[0].value #=> String
resp.is_truncated #=> Boolean
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :role_name (required, String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :marker (String) —

    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 (Integer) —

    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

    1. 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.

Returns:

See Also:



8482
8483
8484
8485
 
# File 'lib/aws-sdk-iam/client.rb', line 8482

def list_instance_profiles_for_role(params = {}, options = {})
  req = build_request(:list_instance_profiles_for_role, params)
  req.send_request(options)
end

#list_mfa_device_tags(params = {}) ⇒ Types::ListMFADeviceTagsResponse

Lists the tags that are attached to the specified IAM virtual multi-factor authentication (MFA) device. The returned list of tags is sorted by tag key. For more information about tagging, see [Tagging IAM resources] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_mfa_device_tags({
  serial_number: "serialNumberType", # required
  marker: "markerType",
  max_items: 1,
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.is_truncated #=> Boolean
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :serial_number (required, String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :marker (String) —

    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 (Integer) —

    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

    1. 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.

Returns:

See Also:



8555
8556
8557
8558
 
# File 'lib/aws-sdk-iam/client.rb', line 8555

def list_mfa_device_tags(params = {}, options = {})
  req = build_request(:list_mfa_device_tags, params)
  req.send_request(options)
end

#list_mfa_devices(params = {}) ⇒ Types::ListMFADevicesResponse

Lists the MFA devices for an IAM user. If the request includes a IAM user name, then this operation lists all the MFA devices associated with the specified user. If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request for this operation.

You can paginate the results using the ‘MaxItems` and `Marker` parameters.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_mfa_devices({
  user_name: "existingUserNameType",
  marker: "markerType",
  max_items: 1,
})

Response structure


resp.mfa_devices #=> Array
resp.mfa_devices[0].user_name #=> String
resp.mfa_devices[0].serial_number #=> String
resp.mfa_devices[0].enable_date #=> Time
resp.is_truncated #=> Boolean
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :marker (String) —

    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 (Integer) —

    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

    1. 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.

Returns:

See Also:



8627
8628
8629
8630
 
# File 'lib/aws-sdk-iam/client.rb', line 8627

def list_mfa_devices(params = {}, options = {})
  req = build_request(:list_mfa_devices, params)
  req.send_request(options)
end

#list_open_id_connect_provider_tags(params = {}) ⇒ Types::ListOpenIDConnectProviderTagsResponse

Lists the tags that are attached to the specified OpenID Connect (OIDC)-compatible identity provider. The returned list of tags is sorted by tag key. For more information, see [About web identity federation].

For more information about tagging, see [Tagging IAM resources] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_open_id_connect_provider_tags({
  open_id_connect_provider_arn: "arnType", # required
  marker: "markerType",
  max_items: 1,
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.is_truncated #=> Boolean
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :open_id_connect_provider_arn (required, String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :marker (String) —

    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 (Integer) —

    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

    1. 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.

Returns:

See Also:



8703
8704
8705
8706
 
# File 'lib/aws-sdk-iam/client.rb', line 8703

def list_open_id_connect_provider_tags(params = {}, options = {})
  req = build_request(:list_open_id_connect_provider_tags, params)
  req.send_request(options)
end

#list_open_id_connect_providers(params = {}) ⇒ Types::ListOpenIDConnectProvidersResponse

Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the Amazon Web Services account.

<note markdown=“1”> IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for an OIDC provider, see [GetOpenIDConnectProvider].

</note>

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetOpenIDConnectProvider.html

Examples:

Response structure


resp.open_id_connect_provider_list #=> Array
resp.open_id_connect_provider_list[0].arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



8736
8737
8738
8739
 
# File 'lib/aws-sdk-iam/client.rb', line 8736

def list_open_id_connect_providers(params = {}, options = {})
  req = build_request(:list_open_id_connect_providers, params)
  req.send_request(options)
end

#list_organizations_features(params = {}) ⇒ Types::ListOrganizationsFeaturesResponse

Lists the centralized root access features enabled for your organization. For more information, see [Centrally manage root access for member accounts].

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_root-user.html#id_root-user-access-management

Examples:

Example: To list the centralized root access features enabled for your organization


# he following command lists the centralized root access features enabled for your organization.

resp = client.list_organizations_features({
})

resp.to_h outputs the following:
{
  enabled_features: [
    "RootCredentialsManagement", 
  ], 
  organization_id: "o-aa111bb222", 
}

Response structure


resp.organization_id #=> String
resp.enabled_features #=> Array
resp.enabled_features[0] #=> String, one of "RootCredentialsManagement", "RootSessions"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



8780
8781
8782
8783
 
# File 'lib/aws-sdk-iam/client.rb', line 8780

def list_organizations_features(params = {}, options = {})
  req = build_request(:list_organizations_features, params)
  req.send_request(options)
end

#list_policies(params = {}) ⇒ Types::ListPoliciesResponse

Lists all the managed policies that are available in your Amazon Web Services account, including your own customer-defined managed policies and all Amazon Web Services managed policies.

You can filter the list of policies that is returned using the optional ‘OnlyAttached`, `Scope`, and `PathPrefix` parameters. For example, to list only the customer managed policies in your Amazon Web Services account, set `Scope` to `Local`. To list only Amazon Web Services managed policies, set `Scope` to `AWS`.

You can paginate the results using the ‘MaxItems` and `Marker` parameters.

For more information about managed policies, see [Managed policies and inline policies] in the *IAM User Guide*.

<note markdown=“1”> IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a customer manged policy, see [GetPolicy].

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html [2]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetPolicy.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_policies({
  scope: "All", # accepts All, AWS, Local
  only_attached: false,
  path_prefix: "policyPathType",
  policy_usage_filter: "PermissionsPolicy", # accepts PermissionsPolicy, PermissionsBoundary
  marker: "markerType",
  max_items: 1,
})

Response structure


resp.policies #=> Array
resp.policies[0].policy_name #=> String
resp.policies[0].policy_id #=> String
resp.policies[0].arn #=> String
resp.policies[0].path #=> String
resp.policies[0].default_version_id #=> String
resp.policies[0].attachment_count #=> Integer
resp.policies[0].permissions_boundary_usage_count #=> Integer
resp.policies[0].is_attachable #=> Boolean
resp.policies[0].description #=> String
resp.policies[0].create_date #=> Time
resp.policies[0].update_date #=> Time
resp.policies[0].tags #=> Array
resp.policies[0].tags[0].key #=> String
resp.policies[0].tags[0].value #=> String
resp.is_truncated #=> Boolean
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :scope (String) —

    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 (Boolean) —

    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 (String) —

    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.

    [1]: wikipedia.org/wiki/regex

  • :policy_usage_filter (String) —

    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 (String) —

    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 (Integer) —

    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

    1. 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.

Returns:

See Also:



8916
8917
8918
8919
 
# File 'lib/aws-sdk-iam/client.rb', line 8916

def list_policies(params = {}, options = {})
  req = build_request(:list_policies, params)
  req.send_request(options)
end

#list_policies_granting_service_access(params = {}) ⇒ Types::ListPoliciesGrantingServiceAccessResponse

Retrieves a list of policies that the IAM identity (user, group, or role) can use to access each specified service.

<note markdown=“1”> This operation does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see [Evaluating policies] in the *IAM User Guide*.

</note>

The list of policies returned by the operation depends on the ARN of the identity that you provide.

  • User – The list of policies includes the managed and inline policies that are attached to the user directly. The list also includes any additional managed and inline policies that are attached to the group to which the user belongs.

  • Group – The list of policies includes only the managed and inline policies that are attached to the group directly. Policies that are attached to the group’s user are not included.

  • Role – The list of policies includes only the managed and inline policies that are attached to the role.

For each managed policy, this operation returns the ARN and policy name. For each inline policy, it returns the policy name and the entity to which it is attached. Inline policies do not have an ARN. For more information about these policy types, see [Managed policies and inline policies] in the *IAM User Guide*.

Policies that are attached to users and roles as permissions boundaries are not returned. To view which managed policy is currently used to set the permissions boundary for a user or role, use the

GetUser][3

or [GetRole] operations.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-basics [2]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html [3]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetUser.html [4]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetRole.html

Examples:

Example: To list policies that allow access to a service


# The following operation lists policies that allow ExampleUser01 to access IAM or EC2.

resp = client.list_policies_granting_service_access({
  arn: "arn:aws:iam::123456789012:user/ExampleUser01", 
  service_namespaces: [
    "iam", 
    "ec2", 
  ], 
})

resp.to_h outputs the following:
{
  is_truncated: false, 
  policies_granting_service_access: [
    {
      policies: [
        {
          policy_arn: "arn:aws:iam::123456789012:policy/ExampleIamPolicy", 
          policy_name: "ExampleIamPolicy", 
          policy_type: "MANAGED", 
        }, 
        {
          entity_name: "AWSExampleGroup1", 
          entity_type: "GROUP", 
          policy_name: "ExampleGroup1Policy", 
          policy_type: "INLINE", 
        }, 
      ], 
      service_namespace: "iam", 
    }, 
    {
      policies: [
        {
          policy_arn: "arn:aws:iam::123456789012:policy/ExampleEc2Policy", 
          policy_name: "ExampleEc2Policy", 
          policy_type: "MANAGED", 
        }, 
      ], 
      service_namespace: "ec2", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_policies_granting_service_access({
  marker: "markerType",
  arn: "arnType", # required
  service_namespaces: ["serviceNamespaceType"], # required
})

Response structure


resp.policies_granting_service_access #=> Array
resp.policies_granting_service_access[0].service_namespace #=> String
resp.policies_granting_service_access[0].policies #=> Array
resp.policies_granting_service_access[0].policies[0].policy_name #=> String
resp.policies_granting_service_access[0].policies[0].policy_type #=> String, one of "INLINE", "MANAGED"
resp.policies_granting_service_access[0].policies[0].policy_arn #=> String
resp.policies_granting_service_access[0].policies[0].entity_type #=> String, one of "USER", "ROLE", "GROUP"
resp.policies_granting_service_access[0].policies[0].entity_name #=> String
resp.is_truncated #=> Boolean
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :marker (String) —

    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.

  • :arn (required, String) —

    The ARN of the IAM identity (user, group, or role) whose policies you want to list.

  • :service_namespaces (required, Array<String>) —

    The service namespace for the Amazon Web Services services whose policies you want to list.

    To learn the service namespace for a service, see [Actions, resources, and condition keys for Amazon Web Services services] in the *IAM User Guide*. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, ‘(service prefix: a4b)`. For more information about service namespaces, see [Amazon Web Services service namespaces] in the *Amazon Web Services General Reference*.

    [1]: docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html [2]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces

Returns:

See Also:



9070
9071
9072
9073
 
# File 'lib/aws-sdk-iam/client.rb', line 9070

def list_policies_granting_service_access(params = {}, options = {})
  req = build_request(:list_policies_granting_service_access, params)
  req.send_request(options)
end

#list_policy_tags(params = {}) ⇒ Types::ListPolicyTagsResponse

Lists the tags that are attached to the specified IAM customer managed policy. The returned list of tags is sorted by tag key. For more information about tagging, see [Tagging IAM resources] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_policy_tags({
  policy_arn: "arnType", # required
  marker: "markerType",
  max_items: 1,
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.is_truncated #=> Boolean
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :policy_arn (required, String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :marker (String) —

    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 (Integer) —

    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

    1. 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.

Returns:

See Also:



9141
9142
9143
9144
 
# File 'lib/aws-sdk-iam/client.rb', line 9141

def list_policy_tags(params = {}, options = {})
  req = build_request(:list_policy_tags, params)
  req.send_request(options)
end

#list_policy_versions(params = {}) ⇒ Types::ListPolicyVersionsResponse

Lists information about the versions of the specified managed policy, including the version that is currently set as the policy’s default version.

For more information about managed policies, see [Managed policies and inline policies] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_policy_versions({
  policy_arn: "arnType", # required
  marker: "markerType",
  max_items: 1,
})

Response structure


resp.versions #=> Array
resp.versions[0].document #=> String
resp.versions[0].version_id #=> String
resp.versions[0].is_default_version #=> Boolean
resp.versions[0].create_date #=> Time
resp.is_truncated #=> Boolean
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :policy_arn (required, String) —

    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*.

    [1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

  • :marker (String) —

    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 (Integer) —

    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

    1. 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.

Returns:

See Also:



9215
9216
9217
9218
 
# File 'lib/aws-sdk-iam/client.rb', line 9215

def list_policy_versions(params = {}, options = {})
  req = build_request(:list_policy_versions, params)
  req.send_request(options)
end

#list_role_policies(params = {}) ⇒ Types::ListRolePoliciesResponse

Lists the names of the inline policies that are embedded in the specified IAM role.

An IAM role can also have managed policies attached to it. To list the managed policies that are attached to a role, use [ListAttachedRolePolicies]. For more information about policies, see [Managed policies and inline policies] in the *IAM User Guide*.

You can paginate the results using the ‘MaxItems` and `Marker` parameters. If there are no inline policies embedded with the specified role, the operation returns an empty list.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_ListAttachedRolePolicies.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_role_policies({
  role_name: "roleNameType", # required
  marker: "markerType",
  max_items: 1,
})

Response structure


resp.policy_names #=> Array
resp.policy_names[0] #=> String
resp.is_truncated #=> Boolean
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :role_name (required, String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :marker (String) —

    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 (Integer) —

    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

    1. 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.

Returns:

See Also:



9293
9294
9295
9296
 
# File 'lib/aws-sdk-iam/client.rb', line 9293

def list_role_policies(params = {}, options = {})
  req = build_request(:list_role_policies, params)
  req.send_request(options)
end

#list_role_tags(params = {}) ⇒ Types::ListRoleTagsResponse

Lists the tags that are attached to the specified role. The returned list of tags is sorted by tag key. For more information about tagging, see [Tagging IAM resources] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To list the tags attached to an IAM role


# The following example shows how to list the tags attached to a role.

resp = client.list_role_tags({
  role_name: "taggedrole1", 
})

resp.to_h outputs the following:
{
  is_truncated: false, 
  tags: [
    {
      key: "Dept", 
      value: "12345", 
    }, 
    {
      key: "Team", 
      value: "Accounting", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_role_tags({
  role_name: "roleNameType", # required
  marker: "markerType",
  max_items: 1,
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.is_truncated #=> Boolean
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :role_name (required, String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :marker (String) —

    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 (Integer) —

    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

    1. 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.

Returns:

See Also:



9387
9388
9389
9390
 
# File 'lib/aws-sdk-iam/client.rb', line 9387

def list_role_tags(params = {}, options = {})
  req = build_request(:list_role_tags, params)
  req.send_request(options)
end

#list_roles(params = {}) ⇒ Types::ListRolesResponse

Lists the IAM roles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about roles, see [IAM roles] in the *IAM User Guide*.

<note markdown=“1”> IAM resource-listing operations return a subset of the available attributes for the resource. This operation does not return the following attributes, even though they are an attribute of the returned object:

* PermissionsBoundary

  • RoleLastUsed

  • Tags

To view all of the information for a role, see [GetRole][2].

</note>

You can paginate the results using the ‘MaxItems` and `Marker` parameters.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html [2]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetRole.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_roles({
  path_prefix: "pathPrefixType",
  marker: "markerType",
  max_items: 1,
})

Response structure


resp.roles #=> Array
resp.roles[0].path #=> String
resp.roles[0].role_name #=> String
resp.roles[0].role_id #=> String
resp.roles[0].arn #=> String
resp.roles[0].create_date #=> Time
resp.roles[0].assume_role_policy_document #=> String
resp.roles[0].description #=> String
resp.roles[0].max_session_duration #=> Integer
resp.roles[0].permissions_boundary.permissions_boundary_type #=> String, one of "PermissionsBoundaryPolicy"
resp.roles[0].permissions_boundary.permissions_boundary_arn #=> String
resp.roles[0].tags #=> Array
resp.roles[0].tags[0].key #=> String
resp.roles[0].tags[0].value #=> String
resp.roles[0].role_last_used.last_used_date #=> Time
resp.roles[0].role_last_used.region #=> String
resp.is_truncated #=> Boolean
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :path_prefix (String) —

    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.

    [1]: wikipedia.org/wiki/regex

  • :marker (String) —

    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 (Integer) —

    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

    1. 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.

Returns:

See Also:



9494
9495
9496
9497
 
# File 'lib/aws-sdk-iam/client.rb', line 9494

def list_roles(params = {}, options = {})
  req = build_request(:list_roles, params)
  req.send_request(options)
end

#list_saml_provider_tags(params = {}) ⇒ Types::ListSAMLProviderTagsResponse

Lists the tags that are attached to the specified Security Assertion Markup Language (SAML) identity provider. The returned list of tags is sorted by tag key. For more information, see [About SAML 2.0-based federation].

For more information about tagging, see [Tagging IAM resources] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_saml_provider_tags({
  saml_provider_arn: "arnType", # required
  marker: "markerType",
  max_items: 1,
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.is_truncated #=> Boolean
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :saml_provider_arn (required, String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :marker (String) —

    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 (Integer) —

    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

    1. 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.

Returns:

See Also:



9570
9571
9572
9573
 
# File 'lib/aws-sdk-iam/client.rb', line 9570

def list_saml_provider_tags(params = {}, options = {})
  req = build_request(:list_saml_provider_tags, params)
  req.send_request(options)
end

#list_saml_providers(params = {}) ⇒ Types::ListSAMLProvidersResponse

Lists the SAML provider resource objects defined in IAM in the account. IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a SAML provider, see [GetSAMLProvider].

This operation requires [Signature Version 4].

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetSAMLProvider.html [2]: docs.aws.amazon.com/general/latest/gr/signature-version-4.html

Examples:

Response structure


resp.saml_provider_list #=> Array
resp.saml_provider_list[0].arn #=> String
resp.saml_provider_list[0].valid_until #=> Time
resp.saml_provider_list[0].create_date #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



9604
9605
9606
9607
 
# File 'lib/aws-sdk-iam/client.rb', line 9604

def list_saml_providers(params = {}, options = {})
  req = build_request(:list_saml_providers, params)
  req.send_request(options)
end

#list_server_certificate_tags(params = {}) ⇒ Types::ListServerCertificateTagsResponse

Lists the tags that are attached to the specified IAM server certificate. The returned list of tags is sorted by tag key. For more information about tagging, see [Tagging IAM resources] in the *IAM User Guide*.

<note markdown=“1”> For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don’t use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, [Working with server certificates] in the *IAM User Guide*.

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_server_certificate_tags({
  server_certificate_name: "serverCertificateNameType", # required
  marker: "markerType",
  max_items: 1,
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.is_truncated #=> Boolean
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :server_certificate_name (required, String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :marker (String) —

    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 (Integer) —

    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

    1. 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.

Returns:

See Also:



9767
9768
9769
9770
 
# File 'lib/aws-sdk-iam/client.rb', line 9767

def list_server_certificate_tags(params = {}, options = {})
  req = build_request(:list_server_certificate_tags, params)
  req.send_request(options)
end

#list_server_certificates(params = {}) ⇒ Types::ListServerCertificatesResponse

Lists the server certificates stored in IAM that have the specified path prefix. If none exist, the operation returns an empty list.

You can paginate the results using the ‘MaxItems` and `Marker` parameters.

For more information about working with server certificates, see

Working with server certificates][1

in the *IAM User Guide*. This

topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.

<note markdown=“1”> IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a servercertificate, see [GetServerCertificate].

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html [2]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetServerCertificate.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_server_certificates({
  path_prefix: "pathPrefixType",
  marker: "markerType",
  max_items: 1,
})

Response structure


resp.server_certificate_metadata_list #=> Array
resp.server_certificate_metadata_list[0].path #=> String
resp.server_certificate_metadata_list[0].server_certificate_name #=> String
resp.server_certificate_metadata_list[0].server_certificate_id #=> String
resp.server_certificate_metadata_list[0].arn #=> String
resp.server_certificate_metadata_list[0].upload_date #=> Time
resp.server_certificate_metadata_list[0].expiration #=> Time
resp.is_truncated #=> Boolean
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :path_prefix (String) —

    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.

    [1]: wikipedia.org/wiki/regex

  • :marker (String) —

    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 (Integer) —

    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

    1. 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.

Returns:

See Also:



9863
9864
9865
9866
 
# File 'lib/aws-sdk-iam/client.rb', line 9863

def list_server_certificates(params = {}, options = {})
  req = build_request(:list_server_certificates, params)
  req.send_request(options)
end

#list_service_specific_credentials(params = {}) ⇒ Types::ListServiceSpecificCredentialsResponse

Returns information about the service-specific credentials associated with the specified IAM user. If none exists, the operation returns an empty list. The service-specific credentials returned by this operation are used only for authenticating the IAM user to a specific service. For more information about using service-specific credentials to authenticate to an Amazon Web Services service, see [Set up service-specific credentials] in the CodeCommit User Guide.

[1]: docs.aws.amazon.com/codecommit/latest/userguide/setting-up-gc.html

Examples:

Request syntax with placeholder values


resp = client.list_service_specific_credentials({
  user_name: "userNameType",
  service_name: "serviceName",
  all_users: false,
  marker: "markerType",
  max_items: 1,
})

Response structure


resp.service_specific_credentials #=> Array
resp.service_specific_credentials[0].user_name #=> String
resp.service_specific_credentials[0].status #=> String, one of "Active", "Inactive", "Expired"
resp.service_specific_credentials[0].service_user_name #=> String
resp.service_specific_credentials[0].service_credential_alias #=> String
resp.service_specific_credentials[0].create_date #=> Time
resp.service_specific_credentials[0].expiration_date #=> Time
resp.service_specific_credentials[0].service_specific_credential_id #=> String
resp.service_specific_credentials[0].service_name #=> String
resp.marker #=> String
resp.is_truncated #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (String) —

    The name of the user whose service-specific credentials you want information about. If this value is not specified, then the operation assumes the user whose credentials are used to call the operation.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :service_name (String) —

    Filters the returned results to only those for the specified Amazon Web Services service. If not specified, then Amazon Web Services returns service-specific credentials for all services.

  • :all_users (Boolean) —

    A flag indicating whether to list service specific credentials for all users. This parameter cannot be specified together with UserName. When true, returns all credentials associated with the specified service.

  • :marker (String) —

    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 from the response that you received to indicate where the next call should start.

  • :max_items (Integer) —

    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.

Returns:

See Also:



9949
9950
9951
9952
 
# File 'lib/aws-sdk-iam/client.rb', line 9949

def list_service_specific_credentials(params = {}, options = {})
  req = build_request(:list_service_specific_credentials, params)
  req.send_request(options)
end

#list_signing_certificates(params = {}) ⇒ Types::ListSigningCertificatesResponse

Returns information about the signing certificates associated with the specified IAM user. If none exists, the operation returns an empty list.

Although each user is limited to a small number of signing certificates, you can still paginate the results using the ‘MaxItems` and `Marker` parameters.

If the ‘UserName` field is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request for this operation. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To list the signing certificates for an IAM user


# The following command lists the signing certificates for the IAM user named Bob.

resp = client.list_signing_certificates({
  user_name: "Bob", 
})

resp.to_h outputs the following:
{
  certificates: [
    {
      certificate_body: "-----BEGIN CERTIFICATE-----<certificate-body>-----END CERTIFICATE-----", 
      certificate_id: "TA7SMP42TDN5Z26OBPJE7EXAMPLE", 
      status: "Active", 
      upload_date: Time.parse("2013-06-06T21:40:08Z"), 
      user_name: "Bob", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_signing_certificates({
  user_name: "existingUserNameType",
  marker: "markerType",
  max_items: 1,
})

Response structure


resp.certificates #=> Array
resp.certificates[0].user_name #=> String
resp.certificates[0].certificate_id #=> String
resp.certificates[0].certificate_body #=> String
resp.certificates[0].status #=> String, one of "Active", "Inactive", "Expired"
resp.certificates[0].upload_date #=> Time
resp.is_truncated #=> Boolean
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :marker (String) —

    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 (Integer) —

    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

    1. 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.

Returns:

See Also:



10052
10053
10054
10055
 
# File 'lib/aws-sdk-iam/client.rb', line 10052

def list_signing_certificates(params = {}, options = {})
  req = build_request(:list_signing_certificates, params)
  req.send_request(options)
end

#list_ssh_public_keys(params = {}) ⇒ Types::ListSSHPublicKeysResponse

Returns information about the SSH public keys associated with the specified IAM user. If none exists, the operation returns an empty list.

The SSH public keys returned by this operation are used only for authenticating the IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see [Set up CodeCommit for SSH connections] in the *CodeCommit User Guide*.

Although each user is limited to a small number of keys, you can still paginate the results using the ‘MaxItems` and `Marker` parameters.

[1]: docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_ssh_public_keys({
  user_name: "userNameType",
  marker: "markerType",
  max_items: 1,
})

Response structure


resp.ssh_public_keys #=> Array
resp.ssh_public_keys[0].user_name #=> String
resp.ssh_public_keys[0].ssh_public_key_id #=> String
resp.ssh_public_keys[0].status #=> String, one of "Active", "Inactive", "Expired"
resp.ssh_public_keys[0].upload_date #=> Time
resp.is_truncated #=> Boolean
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :marker (String) —

    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 (Integer) —

    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

    1. 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.

Returns:

See Also:



9687
9688
9689
9690
 
# File 'lib/aws-sdk-iam/client.rb', line 9687

def list_ssh_public_keys(params = {}, options = {})
  req = build_request(:list_ssh_public_keys, params)
  req.send_request(options)
end

#list_user_policies(params = {}) ⇒ Types::ListUserPoliciesResponse

Lists the names of the inline policies embedded in the specified IAM user.

An IAM user can also have managed policies attached to it. To list the managed policies that are attached to a user, use [ListAttachedUserPolicies]. For more information about policies, see [Managed policies and inline policies] in the *IAM User Guide*.

You can paginate the results using the ‘MaxItems` and `Marker` parameters. If there are no inline policies embedded with the specified user, the operation returns an empty list.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_ListAttachedUserPolicies.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_user_policies({
  user_name: "existingUserNameType", # required
  marker: "markerType",
  max_items: 1,
})

Response structure


resp.policy_names #=> Array
resp.policy_names[0] #=> String
resp.is_truncated #=> Boolean
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (required, String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :marker (String) —

    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 (Integer) —

    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

    1. 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.

Returns:

See Also:



10130
10131
10132
10133
 
# File 'lib/aws-sdk-iam/client.rb', line 10130

def list_user_policies(params = {}, options = {})
  req = build_request(:list_user_policies, params)
  req.send_request(options)
end

#list_user_tags(params = {}) ⇒ Types::ListUserTagsResponse

Lists the tags that are attached to the specified IAM user. The returned list of tags is sorted by tag key. For more information about tagging, see [Tagging IAM resources] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To list the tags attached to an IAM user


# The following example shows how to list the tags attached to a user.

resp = client.list_user_tags({
  user_name: "anika", 
})

resp.to_h outputs the following:
{
  is_truncated: false, 
  tags: [
    {
      key: "Dept", 
      value: "12345", 
    }, 
    {
      key: "Team", 
      value: "Accounting", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_user_tags({
  user_name: "existingUserNameType", # required
  marker: "markerType",
  max_items: 1,
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.is_truncated #=> Boolean
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (required, String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :marker (String) —

    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 (Integer) —

    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

    1. 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.

Returns:

See Also:



10224
10225
10226
10227
 
# File 'lib/aws-sdk-iam/client.rb', line 10224

def list_user_tags(params = {}, options = {})
  req = build_request(:list_user_tags, params)
  req.send_request(options)
end

#list_users(params = {}) ⇒ Types::ListUsersResponse

Lists the IAM users that have the specified path prefix. If no path prefix is specified, the operation returns all users in the Amazon Web Services account. If there are none, the operation returns an empty list.

<note markdown=“1”> IAM resource-listing operations return a subset of the available attributes for the resource. This operation does not return the following attributes, even though they are an attribute of the returned object:

* PermissionsBoundary

  • Tags

To view all of the information for a user, see [GetUser][1].

</note>

You can paginate the results using the ‘MaxItems` and `Marker` parameters.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetUser.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To list IAM users


# The following command lists the IAM users in the current account.

resp = client.list_users({
})

resp.to_h outputs the following:
{
  users: [
    {
      arn: "arn:aws:iam::123456789012:user/division_abc/subdivision_xyz/engineering/Juan", 
      create_date: Time.parse("2012-09-05T19:38:48Z"), 
      password_last_used: Time.parse("2016-09-08T21:47:36Z"), 
      path: "/division_abc/subdivision_xyz/engineering/", 
      user_id: "AID2MAB8DPLSRHEXAMPLE", 
      user_name: "Juan", 
    }, 
    {
      arn: "arn:aws:iam::123456789012:user/division_abc/subdivision_xyz/engineering/Anika", 
      create_date: Time.parse("2014-04-09T15:43:45Z"), 
      password_last_used: Time.parse("2016-09-24T16:18:07Z"), 
      path: "/division_abc/subdivision_xyz/engineering/", 
      user_id: "AIDIODR4TAW7CSEXAMPLE", 
      user_name: "Anika", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_users({
  path_prefix: "pathPrefixType",
  marker: "markerType",
  max_items: 1,
})

Response structure


resp.users #=> Array
resp.users[0].path #=> String
resp.users[0].user_name #=> String
resp.users[0].user_id #=> String
resp.users[0].arn #=> String
resp.users[0].create_date #=> Time
resp.users[0].password_last_used #=> Time
resp.users[0].permissions_boundary.permissions_boundary_type #=> String, one of "PermissionsBoundaryPolicy"
resp.users[0].permissions_boundary.permissions_boundary_arn #=> String
resp.users[0].tags #=> Array
resp.users[0].tags[0].key #=> String
resp.users[0].tags[0].value #=> String
resp.is_truncated #=> Boolean
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :path_prefix (String) —

    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.

    [1]: wikipedia.org/wiki/regex

  • :marker (String) —

    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 (Integer) —

    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

    1. 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.

Returns:

See Also:



10355
10356
10357
10358
 
# File 'lib/aws-sdk-iam/client.rb', line 10355

def list_users(params = {}, options = {})
  req = build_request(:list_users, params)
  req.send_request(options)
end

#list_virtual_mfa_devices(params = {}) ⇒ Types::ListVirtualMFADevicesResponse

Lists the virtual MFA devices defined in the Amazon Web Services account by assignment status. If you do not specify an assignment status, the operation returns a list of all virtual MFA devices. Assignment status can be ‘Assigned`, `Unassigned`, or `Any`.

<note markdown=“1”> IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view tag information for a virtual MFA device, see [ListMFADeviceTags].

</note>

You can paginate the results using the ‘MaxItems` and `Marker` parameters.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_ListMFADeviceTags.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To list virtual MFA devices


# The following command lists the virtual MFA devices that have been configured for the current account.

resp = client.list_virtual_mfa_devices({
})

resp.to_h outputs the following:
{
  virtual_mfa_devices: [
    {
      serial_number: "arn:aws:iam::123456789012:mfa/ExampleMFADevice", 
    }, 
    {
      serial_number: "arn:aws:iam::123456789012:mfa/Juan", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_virtual_mfa_devices({
  assignment_status: "Assigned", # accepts Assigned, Unassigned, Any
  marker: "markerType",
  max_items: 1,
})

Response structure


resp.virtual_mfa_devices #=> Array
resp.virtual_mfa_devices[0].serial_number #=> String
resp.virtual_mfa_devices[0].base_32_string_seed #=> String
resp.virtual_mfa_devices[0].qr_code_png #=> String
resp.virtual_mfa_devices[0].user.path #=> String
resp.virtual_mfa_devices[0].user.user_name #=> String
resp.virtual_mfa_devices[0].user.user_id #=> String
resp.virtual_mfa_devices[0].user.arn #=> String
resp.virtual_mfa_devices[0].user.create_date #=> Time
resp.virtual_mfa_devices[0].user.password_last_used #=> Time
resp.virtual_mfa_devices[0].user.permissions_boundary.permissions_boundary_type #=> String, one of "PermissionsBoundaryPolicy"
resp.virtual_mfa_devices[0].user.permissions_boundary.permissions_boundary_arn #=> String
resp.virtual_mfa_devices[0].user.tags #=> Array
resp.virtual_mfa_devices[0].user.tags[0].key #=> String
resp.virtual_mfa_devices[0].user.tags[0].value #=> String
resp.virtual_mfa_devices[0].enable_date #=> Time
resp.virtual_mfa_devices[0].tags #=> Array
resp.virtual_mfa_devices[0].tags[0].key #=> String
resp.virtual_mfa_devices[0].tags[0].value #=> String
resp.is_truncated #=> Boolean
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assignment_status (String) —

    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 (String) —

    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 (Integer) —

    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

    1. 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.

Returns:

See Also:



10466
10467
10468
10469
 
# File 'lib/aws-sdk-iam/client.rb', line 10466

def list_virtual_mfa_devices(params = {}, options = {})
  req = build_request(:list_virtual_mfa_devices, params)
  req.send_request(options)
end

#put_group_policy(params = {}) ⇒ Struct

Adds or updates an inline policy document that is embedded in the specified IAM group.

A user can also have managed policies attached to it. To attach a managed policy to a group, use [ ‘AttachGroupPolicy` ][1]. To create a new managed policy, use [ `CreatePolicy` ][2]. For information about policies, see [Managed policies and inline policies] in the *IAM User Guide*.

For information about the maximum number of inline policies that you can embed in a group, see [IAM and STS quotas] in the *IAM User Guide*.

<note markdown=“1”> Because policy documents can be large, you should use POST rather than GET when calling ‘PutGroupPolicy`. For general information about using the Query API with IAM, see [Making query requests] in the *IAM User Guide*.

</note>

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_AttachGroupPolicy.html [2]: docs.aws.amazon.com/IAM/latest/APIReference/API_CreatePolicy.html [3]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html [4]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html [5]: docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html

Examples:

Example: To add a policy to a group


# The following command adds a policy named IAMReadAccess to the IAM group named PowerUsers.

resp = client.put_group_policy({
  group_name: "PowerUsers", 
  policy_document: "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":[\"iam:Get*\",\"iam:List*\",\"iam:Generate*\"],\"Resource\":\"*\"}}", 
  policy_name: "IAMReadAccess", 
})

Request syntax with placeholder values


resp = client.put_group_policy({
  group_name: "groupNameType", # required
  policy_name: "policyNameType", # required
  policy_document: "policyDocumentType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :group_name (required, String) —

    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: _+=,.@-.

    [1]: wikipedia.org/wiki/regex

  • :policy_name (required, String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :policy_document (required, String) —

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

    [1]: wikipedia.org/wiki/regex

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



10572
10573
10574
10575
 
# File 'lib/aws-sdk-iam/client.rb', line 10572

def put_group_policy(params = {}, options = {})
  req = build_request(:put_group_policy, params)
  req.send_request(options)
end

#put_role_permissions_boundary(params = {}) ⇒ Struct

Adds or updates the policy that is specified as the IAM role’s permissions boundary. You can use an Amazon Web Services managed policy or a customer managed policy to set the boundary for a role. Use the boundary to control the maximum permissions that the role can have. Setting a permissions boundary is an advanced feature that can affect the permissions for the role.

You cannot set the boundary for a service-linked role.

Policies used as permissions boundaries do not provide permissions. You must also attach a permissions policy to the role. To learn how the effective permissions for a role are evaluated, see [IAM JSON policy evaluation logic] in the IAM User Guide.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html

Examples:

Request syntax with placeholder values


resp = client.put_role_permissions_boundary({
  role_name: "roleNameType", # required
  permissions_boundary: "arnType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :role_name (required, String) —

    The name (friendly name, not ARN) of the IAM role for which you want to set the permissions boundary.

  • :permissions_boundary (required, String) —

    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 ][2] in the *IAM User Guide*.

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



10631
10632
10633
10634
 
# File 'lib/aws-sdk-iam/client.rb', line 10631

def put_role_permissions_boundary(params = {}, options = {})
  req = build_request(:put_role_permissions_boundary, params)
  req.send_request(options)
end

#put_role_policy(params = {}) ⇒ Struct

Adds or updates an inline policy document that is embedded in the specified IAM role.

When you embed an inline policy in a role, the inline policy is used as part of the role’s access (permissions) policy. The role’s trust policy is created at the same time as the role, using [ ‘CreateRole` ][1]. You can update a role’s trust policy using [ ‘UpdateAssumeRolePolicy` ][2]. For more information about roles, see

IAM roles][3

in the *IAM User Guide*.

A role can also have a managed policy attached to it. To attach a managed policy to a role, use [ ‘AttachRolePolicy` ][4]. To create a new managed policy, use [ `CreatePolicy` ][5]. For information about policies, see [Managed policies and inline policies] in the *IAM User Guide*.

For information about the maximum number of inline policies that you can embed with a role, see [IAM and STS quotas] in the *IAM User Guide*.

<note markdown=“1”> Because policy documents can be large, you should use POST rather than GET when calling ‘PutRolePolicy`. For general information about using the Query API with IAM, see [Making query requests] in the *IAM User Guide*.

</note>

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html [2]: docs.aws.amazon.com/IAM/latest/APIReference/API_UpdateAssumeRolePolicy.html [3]: docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html [4]: docs.aws.amazon.com/IAM/latest/APIReference/API_AttachRolePolicy.html [5]: docs.aws.amazon.com/IAM/latest/APIReference/API_CreatePolicy.html [6]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html [7]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html [8]: docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html

Examples:

Example: To attach a permissions policy to an IAM role


# The following command adds a permissions policy to the role named Test-Role.

resp = client.put_role_policy({
  policy_document: "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"s3:*\",\"Resource\":\"*\"}}", 
  policy_name: "S3AccessPolicy", 
  role_name: "S3Access", 
})

Request syntax with placeholder values


resp = client.put_role_policy({
  role_name: "roleNameType", # required
  policy_name: "policyNameType", # required
  policy_document: "policyDocumentType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :role_name (required, String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :policy_name (required, String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :policy_document (required, String) —

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

    [1]: wikipedia.org/wiki/regex

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



10747
10748
10749
10750
 
# File 'lib/aws-sdk-iam/client.rb', line 10747

def put_role_policy(params = {}, options = {})
  req = build_request(:put_role_policy, params)
  req.send_request(options)
end

#put_user_permissions_boundary(params = {}) ⇒ Struct

Adds or updates the policy that is specified as the IAM user’s permissions boundary. You can use an Amazon Web Services managed policy or a customer managed policy to set the boundary for a user. Use the boundary to control the maximum permissions that the user can have. Setting a permissions boundary is an advanced feature that can affect the permissions for the user.

Policies that are used as permissions boundaries do not provide permissions. You must also attach a permissions policy to the user. To learn how the effective permissions for a user are evaluated, see [IAM JSON policy evaluation logic] in the IAM User Guide.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html

Examples:

Request syntax with placeholder values


resp = client.put_user_permissions_boundary({
  user_name: "userNameType", # required
  permissions_boundary: "arnType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (required, String) —

    The name (friendly name, not ARN) of the IAM user for which you want to set the permissions boundary.

  • :permissions_boundary (required, String) —

    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 ][2] in the *IAM User Guide*.

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



10804
10805
10806
10807
 
# File 'lib/aws-sdk-iam/client.rb', line 10804

def put_user_permissions_boundary(params = {}, options = {})
  req = build_request(:put_user_permissions_boundary, params)
  req.send_request(options)
end

#put_user_policy(params = {}) ⇒ Struct

Adds or updates an inline policy document that is embedded in the specified IAM user.

An IAM user can also have a managed policy attached to it. To attach a managed policy to a user, use [ ‘AttachUserPolicy` ][1]. To create a new managed policy, use [ `CreatePolicy` ][2]. For information about policies, see [Managed policies and inline policies] in the *IAM User Guide*.

For information about the maximum number of inline policies that you can embed in a user, see [IAM and STS quotas] in the *IAM User Guide*.

<note markdown=“1”> Because policy documents can be large, you should use POST rather than GET when calling ‘PutUserPolicy`. For general information about using the Query API with IAM, see [Making query requests] in the *IAM User Guide*.

</note>

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_AttachUserPolicy.html [2]: docs.aws.amazon.com/IAM/latest/APIReference/API_CreatePolicy.html [3]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html [4]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html [5]: docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html

Examples:

Example: To attach a policy to an IAM user


# The following command attaches a policy to the IAM user named Bob.

resp = client.put_user_policy({
  policy_document: "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"*\",\"Resource\":\"*\"}}", 
  policy_name: "AllAccessPolicy", 
  user_name: "Bob", 
})

Request syntax with placeholder values


resp = client.put_user_policy({
  user_name: "existingUserNameType", # required
  policy_name: "policyNameType", # required
  policy_document: "policyDocumentType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (required, String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :policy_name (required, String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :policy_document (required, String) —

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

    [1]: wikipedia.org/wiki/regex

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



10910
10911
10912
10913
 
# File 'lib/aws-sdk-iam/client.rb', line 10910

def put_user_policy(params = {}, options = {})
  req = build_request(:put_user_policy, params)
  req.send_request(options)
end

#reject_delegation_request(params = {}) ⇒ Struct

Rejects a delegation request, denying the requested temporary access.

Once a request is rejected, it cannot be accepted or updated later. Rejected requests expire after 7 days.

When rejecting a request, an optional explanation can be added using the ‘Notes` request parameter.

For more details, see [ Managing Permissions for Delegation Requests].

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies-temporary-delegation.html#temporary-delegation-managing-permissions

Examples:

Request syntax with placeholder values


resp = client.reject_delegation_request({
  delegation_request_id: "delegationRequestIdType", # required
  notes: "notesType",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :delegation_request_id (required, String) —

    The unique identifier of the delegation request to reject.

  • :notes (String) —

    Optional notes explaining the reason for rejecting the delegation request.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



10950
10951
10952
10953
 
# File 'lib/aws-sdk-iam/client.rb', line 10950

def reject_delegation_request(params = {}, options = {})
  req = build_request(:reject_delegation_request, params)
  req.send_request(options)
end

#remove_client_id_from_open_id_connect_provider(params = {}) ⇒ Struct

Removes the specified client ID (also known as audience) from the list of client IDs registered for the specified IAM OpenID Connect (OIDC) provider resource object.

This operation is idempotent; it does not fail or return an error if you try to remove a client ID that does not exist.

Examples:

Request syntax with placeholder values


resp = client.remove_client_id_from_open_id_connect_provider({
  open_id_connect_provider_arn: "arnType", # required
  client_id: "clientIDType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



10997
10998
10999
11000
 
# File 'lib/aws-sdk-iam/client.rb', line 10997

def remove_client_id_from_open_id_connect_provider(params = {}, options = {})
  req = build_request(:remove_client_id_from_open_id_connect_provider, params)
  req.send_request(options)
end

#remove_role_from_instance_profile(params = {}) ⇒ Struct

Removes the specified IAM role from the specified Amazon EC2 instance profile.

Make sure that you do not have any Amazon EC2 instances running with the role you are about to remove from the instance profile. Removing a role from an instance profile that is associated with a running instance might break any applications running on the instance.

For more information about roles, see [IAM roles] in the *IAM User Guide*. For more information about instance profiles, see [Using instance profiles] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html

Examples:

Example: To remove a role from an instance profile


# The following command removes the role named Test-Role from the instance profile named ExampleInstanceProfile.

resp = client.remove_role_from_instance_profile({
  instance_profile_name: "ExampleInstanceProfile", 
  role_name: "Test-Role", 
})

Request syntax with placeholder values


resp = client.remove_role_from_instance_profile({
  instance_profile_name: "instanceProfileNameType", # required
  role_name: "roleNameType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_profile_name (required, String) —

    The name of the instance profile 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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :role_name (required, String) —

    The name of the role to remove.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



11066
11067
11068
11069
 
# File 'lib/aws-sdk-iam/client.rb', line 11066

def remove_role_from_instance_profile(params = {}, options = {})
  req = build_request(:remove_role_from_instance_profile, params)
  req.send_request(options)
end

#remove_user_from_group(params = {}) ⇒ Struct

Removes the specified user from the specified group.

Examples:

Example: To remove a user from an IAM group


# The following command removes the user named Bob from the IAM group named Admins.

resp = client.remove_user_from_group({
  group_name: "Admins", 
  user_name: "Bob", 
})

Request syntax with placeholder values


resp = client.remove_user_from_group({
  group_name: "groupNameType", # required
  user_name: "existingUserNameType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :group_name (required, String) —

    The name of the group 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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :user_name (required, String) —

    The name of the user to remove.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



11120
11121
11122
11123
 
# File 'lib/aws-sdk-iam/client.rb', line 11120

def remove_user_from_group(params = {}, options = {})
  req = build_request(:remove_user_from_group, params)
  req.send_request(options)
end

#reset_service_specific_credential(params = {}) ⇒ Types::ResetServiceSpecificCredentialResponse

Resets the password for a service-specific credential. The new password is Amazon Web Services generated and cryptographically strong. It cannot be configured by the user. Resetting the password immediately invalidates the previous password associated with this user.

Examples:

Request syntax with placeholder values


resp = client.reset_service_specific_credential({
  user_name: "userNameType",
  service_specific_credential_id: "serviceSpecificCredentialId", # required
})

Response structure


resp.service_specific_credential.create_date #=> Time
resp.service_specific_credential.expiration_date #=> Time
resp.service_specific_credential.service_name #=> String
resp.service_specific_credential.service_user_name #=> String
resp.service_specific_credential.service_password #=> String
resp.service_specific_credential.service_credential_alias #=> String
resp.service_specific_credential.service_credential_secret #=> String
resp.service_specific_credential.service_specific_credential_id #=> String
resp.service_specific_credential.user_name #=> String
resp.service_specific_credential.status #=> String, one of "Active", "Inactive", "Expired"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (String) —

    The name of the IAM user associated with the service-specific credential. If this value is not specified, then the operation assumes the user whose credentials are used to call the operation.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :service_specific_credential_id (required, String) —

    The unique identifier of the service-specific credential.

    This parameter allows (through its [regex pattern]) a string of characters that can consist of any upper or lowercased letter or digit.

    [1]: wikipedia.org/wiki/regex

Returns:

See Also:



11184
11185
11186
11187
 
# File 'lib/aws-sdk-iam/client.rb', line 11184

def reset_service_specific_credential(params = {}, options = {})
  req = build_request(:reset_service_specific_credential, params)
  req.send_request(options)
end

#resync_mfa_device(params = {}) ⇒ Struct

Synchronizes the specified MFA device with its IAM resource object on the Amazon Web Services servers.

For more information about creating and working with virtual MFA devices, see [Using a virtual MFA device] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html

Examples:

Request syntax with placeholder values


resp = client.resync_mfa_device({
  user_name: "existingUserNameType", # required
  serial_number: "serialNumberType", # required
  authentication_code_1: "authenticationCodeType", # required
  authentication_code_2: "authenticationCodeType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (required, String) —

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

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :serial_number (required, String) —

    Serial number that uniquely identifies 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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :authentication_code_1 (required, String) —

    An authentication code emitted by the device.

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

  • :authentication_code_2 (required, String) —

    A subsequent authentication code emitted by the device.

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



11248
11249
11250
11251
 
# File 'lib/aws-sdk-iam/client.rb', line 11248

def resync_mfa_device(params = {}, options = {})
  req = build_request(:resync_mfa_device, params)
  req.send_request(options)
end

#send_delegation_token(params = {}) ⇒ Struct

Sends the exchange token for an accepted delegation request.

The exchange token is sent to the partner via an asynchronous notification channel, established by the partner.

The delegation request must be in the ‘ACCEPTED` state when calling this API. After the `SendDelegationToken` API call is successful, the request transitions to a `FINALIZED` state and cannot be rolled back. However, a user may reject an accepted request before the `SendDelegationToken` API is called.

For more details, see [ Managing Permissions for Delegation Requests].

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies-temporary-delegation.html#temporary-delegation-managing-permissions

Examples:

Request syntax with placeholder values


resp = client.send_delegation_token({
  delegation_request_id: "delegationRequestIdType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :delegation_request_id (required, String) —

    The unique identifier of the delegation request for which to send the token.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



11287
11288
11289
11290
 
# File 'lib/aws-sdk-iam/client.rb', line 11287

def send_delegation_token(params = {}, options = {})
  req = build_request(:send_delegation_token, params)
  req.send_request(options)
end

#set_default_policy_version(params = {}) ⇒ Struct

Sets the specified version of the specified policy as the policy’s default (operative) version.

This operation affects all users, groups, and roles that the policy is attached to. To list the users, groups, and roles that the policy is attached to, use [ListEntitiesForPolicy].

For information about managed policies, see [Managed policies and inline policies] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_ListEntitiesForPolicy.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html

Examples:

Request syntax with placeholder values


resp = client.set_default_policy_version({
  policy_arn: "arnType", # required
  version_id: "policyVersionIdType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



11341
11342
11343
11344
 
# File 'lib/aws-sdk-iam/client.rb', line 11341

def set_default_policy_version(params = {}, options = {})
  req = build_request(:set_default_policy_version, params)
  req.send_request(options)
end

#set_security_token_service_preferences(params = {}) ⇒ Struct

Sets the specified version of the global endpoint token as the token version used for the Amazon Web Services account.

By default, Security Token Service (STS) is available as a global service, and all STS requests go to a single endpoint at ‘sts.amazonaws.com`. Amazon Web Services recommends using Regional STS endpoints to reduce latency, build in redundancy, and increase session token availability. For information about Regional endpoints for STS, see [Security Token Service endpoints and quotas] in the *Amazon Web Services General Reference*.

If you make an STS call to the global endpoint, the resulting session tokens might be valid in some Regions but not others. It depends on the version that is set in this operation. Version 1 tokens are valid only in Amazon Web Services Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens. For information, see [Activating and deactivating STS in an Amazon Web Services Region] in the *IAM User Guide*.

To view the current session token version, see the ‘GlobalEndpointTokenVersion` entry in the response of the

GetAccountSummary][3

operation.

[1]: docs.aws.amazon.com/general/latest/gr/sts.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html [3]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetAccountSummary.html

Examples:

Example: To delete an access key for an IAM user


# The following command sets the STS global endpoint token to version 2. Version 2 tokens are valid in all Regions.

resp = client.set_security_token_service_preferences({
  global_endpoint_token_version: "v2Token", 
})

Request syntax with placeholder values


resp = client.set_security_token_service_preferences({
  global_endpoint_token_version: "v1Token", # required, accepts v1Token, v2Token
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :global_endpoint_token_version (required, String) —

    The version of the global endpoint token. Version 1 tokens are valid only in Amazon Web Services Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens.

    For information, see [Activating and deactivating STS in an Amazon Web Services Region] in the *IAM User Guide*.

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



11414
11415
11416
11417
 
# File 'lib/aws-sdk-iam/client.rb', line 11414

def set_security_token_service_preferences(params = {}, options = {})
  req = build_request(:set_security_token_service_preferences, params)
  req.send_request(options)
end

#simulate_custom_policy(params = {}) ⇒ Types::SimulatePolicyResponse

Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API operations and Amazon Web Services resources to determine the policies’ effective permissions. The policies are provided as strings.

The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations. You can simulate resources that don’t exist in your account.

If you want to simulate existing policies that are attached to an IAM user, group, or role, use [SimulatePrincipalPolicy] instead.

Context keys are variables that are maintained by Amazon Web Services and its services and which provide details about the context of an API query request. You can use the ‘Condition` element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use [GetContextKeysForCustomPolicy].

If the output is long, you can use ‘MaxItems` and `Marker` parameters to paginate the results.

<note markdown=“1”> The IAM policy simulator evaluates statements in the identity-based policy and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see [Testing IAM policies with the IAM policy simulator ][3]in the *IAM User Guide*.

</note>

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_SimulatePrincipalPolicy.html [2]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetContextKeysForCustomPolicy.html [3]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_testing-policies.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.simulate_custom_policy({
  policy_input_list: ["policyDocumentType"], # required
  permissions_boundary_policy_input_list: ["policyDocumentType"],
  action_names: ["ActionNameType"], # required
  resource_arns: ["ResourceNameType"],
  resource_policy: "policyDocumentType",
  resource_owner: "ResourceNameType",
  caller_arn: "ResourceNameType",
  context_entries: [
    {
      context_key_name: "ContextKeyNameType",
      context_key_values: ["ContextKeyValueType"],
      context_key_type: "string", # accepts string, stringList, numeric, numericList, boolean, booleanList, ip, ipList, binary, binaryList, date, dateList
    },
  ],
  resource_handling_option: "ResourceHandlingOptionType",
  max_items: 1,
  marker: "markerType",
})

Response structure


resp.evaluation_results #=> Array
resp.evaluation_results[0].eval_action_name #=> String
resp.evaluation_results[0].eval_resource_name #=> String
resp.evaluation_results[0].eval_decision #=> String, one of "allowed", "explicitDeny", "implicitDeny"
resp.evaluation_results[0].matched_statements #=> Array
resp.evaluation_results[0].matched_statements[0].source_policy_id #=> String
resp.evaluation_results[0].matched_statements[0].source_policy_type #=> String, one of "user", "group", "role", "aws-managed", "user-managed", "resource", "none"
resp.evaluation_results[0].matched_statements[0].start_position.line #=> Integer
resp.evaluation_results[0].matched_statements[0].start_position.column #=> Integer
resp.evaluation_results[0].matched_statements[0].end_position.line #=> Integer
resp.evaluation_results[0].matched_statements[0].end_position.column #=> Integer
resp.evaluation_results[0].missing_context_values #=> Array
resp.evaluation_results[0].missing_context_values[0] #=> String
resp.evaluation_results[0].organizations_decision_detail.allowed_by_organizations #=> Boolean
resp.evaluation_results[0].permissions_boundary_decision_detail.allowed_by_permissions_boundary #=> Boolean
resp.evaluation_results[0].eval_decision_details #=> Hash
resp.evaluation_results[0].eval_decision_details["EvalDecisionSourceType"] #=> String, one of "allowed", "explicitDeny", "implicitDeny"
resp.evaluation_results[0].resource_specific_results #=> Array
resp.evaluation_results[0].resource_specific_results[0].eval_resource_name #=> String
resp.evaluation_results[0].resource_specific_results[0].eval_resource_decision #=> String, one of "allowed", "explicitDeny", "implicitDeny"
resp.evaluation_results[0].resource_specific_results[0].matched_statements #=> Array
resp.evaluation_results[0].resource_specific_results[0].matched_statements[0].source_policy_id #=> String
resp.evaluation_results[0].resource_specific_results[0].matched_statements[0].source_policy_type #=> String, one of "user", "group", "role", "aws-managed", "user-managed", "resource", "none"
resp.evaluation_results[0].resource_specific_results[0].matched_statements[0].start_position.line #=> Integer
resp.evaluation_results[0].resource_specific_results[0].matched_statements[0].start_position.column #=> Integer
resp.evaluation_results[0].resource_specific_results[0].matched_statements[0].end_position.line #=> Integer
resp.evaluation_results[0].resource_specific_results[0].matched_statements[0].end_position.column #=> Integer
resp.evaluation_results[0].resource_specific_results[0].missing_context_values #=> Array
resp.evaluation_results[0].resource_specific_results[0].missing_context_values[0] #=> String
resp.evaluation_results[0].resource_specific_results[0].eval_decision_details #=> Hash
resp.evaluation_results[0].resource_specific_results[0].eval_decision_details["EvalDecisionSourceType"] #=> String, one of "allowed", "explicitDeny", "implicitDeny"
resp.evaluation_results[0].resource_specific_results[0].permissions_boundary_decision_detail.allowed_by_permissions_boundary #=> Boolean
resp.is_truncated #=> Boolean
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :policy_input_list (required, Array<String>) —

    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][1

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

    [1]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetFederationToken.html [2]: docs.aws.amazon.com/IAM/latest/APIReference/API_AssumeRole.html [3]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length [4]: wikipedia.org/wiki/regex

  • :permissions_boundary_policy_input_list (Array<String>) —

    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][1

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

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length [3]: wikipedia.org/wiki/regex

  • :action_names (required, Array<String>) —

    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 (Array<String>) —

    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*.

    <note markdown=“1”> Simulation of resource-based policies isn’t supported for IAM roles.

    </note>

    [1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

  • :resource_policy (String) —

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

    <note markdown=“1”> Simulation of resource-based policies isn’t supported for IAM roles.

    </note>

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length [2]: wikipedia.org/wiki/regex

  • :resource_owner (String) —

    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 (String) —

    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 (Array<Types::ContextEntry>) —

    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 (String) —

    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

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html

  • :max_items (Integer) —

    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

    1. 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 (String) —

    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.

Returns:

See Also:



11751
11752
11753
11754
 
# File 'lib/aws-sdk-iam/client.rb', line 11751

def simulate_custom_policy(params = {}, options = {})
  req = build_request(:simulate_custom_policy, params)
  req.send_request(options)
end

#simulate_principal_policy(params = {}) ⇒ Types::SimulatePolicyResponse

Simulate how a set of IAM policies attached to an IAM entity works with a list of API operations and Amazon Web Services resources to determine the policies’ effective permissions. The entity can be an IAM user, group, or role. If you specify a user, then the simulation also includes all of the policies that are attached to groups that the user belongs to. You can simulate resources that don’t exist in your account.

You can optionally include a list of one or more additional policies specified as strings to include in the simulation. If you want to simulate only policies specified as strings, use

SimulateCustomPolicy][1

instead.

You can also optionally include one resource-based policy to be evaluated with each of the resources included in the simulation for IAM users only.

The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations.

Note: This operation discloses information about the permissions granted to other users. If you do not want users to see other user’s permissions, then consider allowing them to use

SimulateCustomPolicy][1

instead.

Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. You can use the ‘Condition` element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use [GetContextKeysForPrincipalPolicy].

If the output is long, you can use the ‘MaxItems` and `Marker` parameters to paginate the results.

<note markdown=“1”> The IAM policy simulator evaluates statements in the identity-based policy and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see [Testing IAM policies with the IAM policy simulator ][3]in the *IAM User Guide*.

</note>

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_SimulateCustomPolicy.html [2]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetContextKeysForPrincipalPolicy.html [3]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_testing-policies.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.simulate_principal_policy({
  policy_source_arn: "arnType", # required
  policy_input_list: ["policyDocumentType"],
  permissions_boundary_policy_input_list: ["policyDocumentType"],
  action_names: ["ActionNameType"], # required
  resource_arns: ["ResourceNameType"],
  resource_policy: "policyDocumentType",
  resource_owner: "ResourceNameType",
  caller_arn: "ResourceNameType",
  context_entries: [
    {
      context_key_name: "ContextKeyNameType",
      context_key_values: ["ContextKeyValueType"],
      context_key_type: "string", # accepts string, stringList, numeric, numericList, boolean, booleanList, ip, ipList, binary, binaryList, date, dateList
    },
  ],
  resource_handling_option: "ResourceHandlingOptionType",
  max_items: 1,
  marker: "markerType",
})

Response structure


resp.evaluation_results #=> Array
resp.evaluation_results[0].eval_action_name #=> String
resp.evaluation_results[0].eval_resource_name #=> String
resp.evaluation_results[0].eval_decision #=> String, one of "allowed", "explicitDeny", "implicitDeny"
resp.evaluation_results[0].matched_statements #=> Array
resp.evaluation_results[0].matched_statements[0].source_policy_id #=> String
resp.evaluation_results[0].matched_statements[0].source_policy_type #=> String, one of "user", "group", "role", "aws-managed", "user-managed", "resource", "none"
resp.evaluation_results[0].matched_statements[0].start_position.line #=> Integer
resp.evaluation_results[0].matched_statements[0].start_position.column #=> Integer
resp.evaluation_results[0].matched_statements[0].end_position.line #=> Integer
resp.evaluation_results[0].matched_statements[0].end_position.column #=> Integer
resp.evaluation_results[0].missing_context_values #=> Array
resp.evaluation_results[0].missing_context_values[0] #=> String
resp.evaluation_results[0].organizations_decision_detail.allowed_by_organizations #=> Boolean
resp.evaluation_results[0].permissions_boundary_decision_detail.allowed_by_permissions_boundary #=> Boolean
resp.evaluation_results[0].eval_decision_details #=> Hash
resp.evaluation_results[0].eval_decision_details["EvalDecisionSourceType"] #=> String, one of "allowed", "explicitDeny", "implicitDeny"
resp.evaluation_results[0].resource_specific_results #=> Array
resp.evaluation_results[0].resource_specific_results[0].eval_resource_name #=> String
resp.evaluation_results[0].resource_specific_results[0].eval_resource_decision #=> String, one of "allowed", "explicitDeny", "implicitDeny"
resp.evaluation_results[0].resource_specific_results[0].matched_statements #=> Array
resp.evaluation_results[0].resource_specific_results[0].matched_statements[0].source_policy_id #=> String
resp.evaluation_results[0].resource_specific_results[0].matched_statements[0].source_policy_type #=> String, one of "user", "group", "role", "aws-managed", "user-managed", "resource", "none"
resp.evaluation_results[0].resource_specific_results[0].matched_statements[0].start_position.line #=> Integer
resp.evaluation_results[0].resource_specific_results[0].matched_statements[0].start_position.column #=> Integer
resp.evaluation_results[0].resource_specific_results[0].matched_statements[0].end_position.line #=> Integer
resp.evaluation_results[0].resource_specific_results[0].matched_statements[0].end_position.column #=> Integer
resp.evaluation_results[0].resource_specific_results[0].missing_context_values #=> Array
resp.evaluation_results[0].resource_specific_results[0].missing_context_values[0] #=> String
resp.evaluation_results[0].resource_specific_results[0].eval_decision_details #=> Hash
resp.evaluation_results[0].resource_specific_results[0].eval_decision_details["EvalDecisionSourceType"] #=> String, one of "allowed", "explicitDeny", "implicitDeny"
resp.evaluation_results[0].resource_specific_results[0].permissions_boundary_decision_detail.allowed_by_permissions_boundary #=> Boolean
resp.is_truncated #=> Boolean
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :policy_source_arn (required, String) —

    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*.

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length [2]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

  • :policy_input_list (Array<String>) —

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

    [1]: wikipedia.org/wiki/regex

  • :permissions_boundary_policy_input_list (Array<String>) —

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

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length [3]: wikipedia.org/wiki/regex

  • :action_names (required, Array<String>) —

    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 (Array<String>) —

    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*.

    <note markdown=“1”> Simulation of resource-based policies isn’t supported for IAM roles.

    </note>

    [1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

  • :resource_policy (String) —

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

    <note markdown=“1”> Simulation of resource-based policies isn’t supported for IAM roles.

    </note>

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length [2]: wikipedia.org/wiki/regex

  • :resource_owner (String) —

    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 (String) —

    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*.

    [1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

  • :context_entries (Array<Types::ContextEntry>) —

    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 (String) —

    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

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html

  • :max_items (Integer) —

    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

    1. 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 (String) —

    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.

Returns:

See Also:



12119
12120
12121
12122
 
# File 'lib/aws-sdk-iam/client.rb', line 12119

def simulate_principal_policy(params = {}, options = {})
  req = build_request(:simulate_principal_policy, params)
  req.send_request(options)
end

#tag_instance_profile(params = {}) ⇒ Struct

Adds one or more tags to an IAM instance profile. If a tag with the same key name already exists, then that tag is overwritten with the new value.

Each tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

  • **Administrative grouping and discovery** - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name *Cost Center* and the value 41200.

  • **Access control** - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM instance profile that has a specified tag attached. For examples of policies that show how to use tags to control access, see [Control access using IAM tags] in the *IAM User Guide*.

<note markdown=“1”> * 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. For more information about tagging, see
[Tagging IAM resources][2] in the *IAM User Guide*.

  • Amazon Web Services always interprets the tag ‘Value` as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

Examples:

Request syntax with placeholder values


resp = client.tag_instance_profile({
  instance_profile_name: "instanceProfileNameType", # required
  tags: [ # required
    {
      key: "tagKeyType", # required
      value: "tagValueType", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_profile_name (required, String) —

    The name of the IAM instance profile to which you want to add tags.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :tags (required, Array<Types::Tag>) —

    The list of tags that you want to attach to the IAM instance profile. Each tag consists of a key name and an associated value.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



12194
12195
12196
12197
 
# File 'lib/aws-sdk-iam/client.rb', line 12194

def tag_instance_profile(params = {}, options = {})
  req = build_request(:tag_instance_profile, params)
  req.send_request(options)
end

#tag_mfa_device(params = {}) ⇒ Struct

Adds one or more tags to an IAM virtual multi-factor authentication (MFA) device. If a tag with the same key name already exists, then that tag is overwritten with the new value.

A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

  • **Administrative grouping and discovery** - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name *Cost Center* and the value 41200.

  • **Access control** - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM virtual MFA device that has a specified tag attached. For examples of policies that show how to use tags to control access, see [Control access using IAM tags] in the *IAM User Guide*.

<note markdown=“1”> * 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. For more information about tagging, see
[Tagging IAM resources][2] in the *IAM User Guide*.

  • Amazon Web Services always interprets the tag ‘Value` as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

Examples:

Request syntax with placeholder values


resp = client.tag_mfa_device({
  serial_number: "serialNumberType", # required
  tags: [ # required
    {
      key: "tagKeyType", # required
      value: "tagValueType", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :serial_number (required, String) —

    The unique identifier for the IAM virtual MFA device to which you want to add tags. 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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :tags (required, Array<Types::Tag>) —

    The list of tags that you want to attach to the IAM virtual MFA device. Each tag consists of a key name and an associated value.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



12271
12272
12273
12274
 
# File 'lib/aws-sdk-iam/client.rb', line 12271

def tag_mfa_device(params = {}, options = {})
  req = build_request(:tag_mfa_device, params)
  req.send_request(options)
end

#tag_open_id_connect_provider(params = {}) ⇒ Struct

Adds one or more tags to an OpenID Connect (OIDC)-compatible identity provider. For more information about these providers, see [About web identity federation]. If a tag with the same key name already exists, then that tag is overwritten with the new value.

A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

  • **Administrative grouping and discovery** - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name *Cost Center* and the value 41200.

  • **Access control** - Include tags in IAM identity-based and resource-based policies. You can use tags to restrict access to only an OIDC provider that has a specified tag attached. For examples of policies that show how to use tags to control access, see [Control access using IAM tags] in the *IAM User Guide*.

<note markdown=“1”> * 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. For more information about tagging, see
[Tagging IAM resources][3] in the *IAM User Guide*.

  • Amazon Web Services always interprets the tag ‘Value` as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html [3]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

Examples:

Request syntax with placeholder values


resp = client.tag_open_id_connect_provider({
  open_id_connect_provider_arn: "arnType", # required
  tags: [ # required
    {
      key: "tagKeyType", # required
      value: "tagValueType", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :open_id_connect_provider_arn (required, String) —

    The ARN of the OIDC identity provider in IAM to which you want to add tags.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :tags (required, Array<Types::Tag>) —

    The list of tags that you want to attach to the OIDC identity provider in IAM. Each tag consists of a key name and an associated value.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



12349
12350
12351
12352
 
# File 'lib/aws-sdk-iam/client.rb', line 12349

def tag_open_id_connect_provider(params = {}, options = {})
  req = build_request(:tag_open_id_connect_provider, params)
  req.send_request(options)
end

#tag_policy(params = {}) ⇒ Struct

Adds one or more tags to an IAM customer managed policy. If a tag with the same key name already exists, then that tag is overwritten with the new value.

A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

  • **Administrative grouping and discovery** - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name *Cost Center* and the value 41200.

  • **Access control** - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM customer managed policy that has a specified tag attached. For examples of policies that show how to use tags to control access, see [Control access using IAM tags] in the *IAM User Guide*.

<note markdown=“1”> * 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. For more information about tagging, see
[Tagging IAM resources][2] in the *IAM User Guide*.

  • Amazon Web Services always interprets the tag ‘Value` as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

Examples:

Request syntax with placeholder values


resp = client.tag_policy({
  policy_arn: "arnType", # required
  tags: [ # required
    {
      key: "tagKeyType", # required
      value: "tagValueType", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :policy_arn (required, String) —

    The ARN of the IAM customer managed policy to which you want to add tags.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :tags (required, Array<Types::Tag>) —

    The list of tags that you want to attach to the IAM customer managed policy. Each tag consists of a key name and an associated value.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



12426
12427
12428
12429
 
# File 'lib/aws-sdk-iam/client.rb', line 12426

def tag_policy(params = {}, options = {})
  req = build_request(:tag_policy, params)
  req.send_request(options)
end

#tag_role(params = {}) ⇒ Struct

Adds one or more tags to an IAM role. The role can be a regular role or a service-linked role. If a tag with the same key name already exists, then that tag is overwritten with the new value.

A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

  • **Administrative grouping and discovery** - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name *Cost Center* and the value 41200.

  • **Access control** - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM role that has a specified tag attached. You can also restrict access to only those resources that have a certain tag attached. For examples of policies that show how to use tags to control access, see [Control access using IAM tags] in the *IAM User Guide*.

  • **Cost allocation** - Use tags to help track which individuals and teams are using which Amazon Web Services resources.

<note markdown=“1”> * 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. For more information about tagging, see
[Tagging IAM resources][2] in the *IAM User Guide*.

  • Amazon Web Services always interprets the tag ‘Value` as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

</note>

For more information about tagging, see [Tagging IAM identities] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

Examples:

Example: To add a tag key and value to an IAM role


# The following example shows how to add tags to an existing role.

resp = client.tag_role({
  role_name: "taggedrole", 
  tags: [
    {
      key: "Dept", 
      value: "Accounting", 
    }, 
    {
      key: "CostCenter", 
      value: "12345", 
    }, 
  ], 
})

Request syntax with placeholder values


resp = client.tag_role({
  role_name: "roleNameType", # required
  tags: [ # required
    {
      key: "tagKeyType", # required
      value: "tagValueType", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :role_name (required, String) —

    The name of the IAM role to which you want to add 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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :tags (required, Array<Types::Tag>) —

    The list of tags that you want to attach to the IAM role. Each tag consists of a key name and an associated value.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



12527
12528
12529
12530
 
# File 'lib/aws-sdk-iam/client.rb', line 12527

def tag_role(params = {}, options = {})
  req = build_request(:tag_role, params)
  req.send_request(options)
end

#tag_saml_provider(params = {}) ⇒ Struct

Adds one or more tags to a Security Assertion Markup Language (SAML) identity provider. For more information about these providers, see [About SAML 2.0-based federation ][1]. If a tag with the same key name already exists, then that tag is overwritten with the new value.

A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

  • **Administrative grouping and discovery** - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name *Cost Center* and the value 41200.

  • **Access control** - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only a SAML identity provider that has a specified tag attached. For examples of policies that show how to use tags to control access, see [Control access using IAM tags] in the *IAM User Guide*.

<note markdown=“1”> * 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. For more information about tagging, see
[Tagging IAM resources][3] in the *IAM User Guide*.

  • Amazon Web Services always interprets the tag ‘Value` as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html [3]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

Examples:

Request syntax with placeholder values


resp = client.tag_saml_provider({
  saml_provider_arn: "arnType", # required
  tags: [ # required
    {
      key: "tagKeyType", # required
      value: "tagValueType", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :saml_provider_arn (required, String) —

    The ARN of the SAML identity provider in IAM to which you want to add tags.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :tags (required, Array<Types::Tag>) —

    The list of tags that you want to attach to the SAML identity provider in IAM. Each tag consists of a key name and an associated value.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



12605
12606
12607
12608
 
# File 'lib/aws-sdk-iam/client.rb', line 12605

def tag_saml_provider(params = {}, options = {})
  req = build_request(:tag_saml_provider, params)
  req.send_request(options)
end

#tag_server_certificate(params = {}) ⇒ Struct

Adds one or more tags to an IAM server certificate. If a tag with the same key name already exists, then that tag is overwritten with the new value.

<note markdown=“1”> For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don’t use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, [Working with server certificates] in the *IAM User Guide*.

</note>

A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

  • **Administrative grouping and discovery** - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name *Cost Center* and the value 41200.

  • **Access control** - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only a server certificate that has a specified tag attached. For examples of policies that show how to use tags to control access, see

    Control access using IAM tags][2

    in the *IAM User Guide*.

  • **Cost allocation** - Use tags to help track which individuals and teams are using which Amazon Web Services resources.

<note markdown=“1”> * 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. For more information about tagging, see
[Tagging IAM resources][3] in the *IAM User Guide*.

  • Amazon Web Services always interprets the tag ‘Value` as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html [3]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

Examples:

Request syntax with placeholder values


resp = client.tag_server_certificate({
  server_certificate_name: "serverCertificateNameType", # required
  tags: [ # required
    {
      key: "tagKeyType", # required
      value: "tagValueType", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :server_certificate_name (required, String) —

    The name of the IAM server certificate to which you want to add tags.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :tags (required, Array<Types::Tag>) —

    The list of tags that you want to attach to the IAM server certificate. Each tag consists of a key name and an associated value.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



12692
12693
12694
12695
 
# File 'lib/aws-sdk-iam/client.rb', line 12692

def tag_server_certificate(params = {}, options = {})
  req = build_request(:tag_server_certificate, params)
  req.send_request(options)
end

#tag_user(params = {}) ⇒ Struct

Adds one or more tags to an IAM user. If a tag with the same key name already exists, then that tag is overwritten with the new value.

A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

  • **Administrative grouping and discovery** - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name *Cost Center* and the value 41200.

  • **Access control** - Include tags in IAM identity-based and resource-based policies. You can use tags to restrict access to only an IAM requesting user that has a specified tag attached. You can also restrict access to only those resources that have a certain tag attached. For examples of policies that show how to use tags to control access, see [Control access using IAM tags] in the *IAM User Guide*.

  • **Cost allocation** - Use tags to help track which individuals and teams are using which Amazon Web Services resources.

<note markdown=“1”> * 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. For more information about tagging, see
[Tagging IAM resources][2] in the *IAM User Guide*.

  • Amazon Web Services always interprets the tag ‘Value` as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

</note>

For more information about tagging, see [Tagging IAM identities] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

Examples:

Example: To add a tag key and value to an IAM user


# The following example shows how to add tags to an existing user.

resp = client.tag_user({
  tags: [
    {
      key: "Dept", 
      value: "Accounting", 
    }, 
    {
      key: "CostCenter", 
      value: "12345", 
    }, 
  ], 
  user_name: "anika", 
})

Request syntax with placeholder values


resp = client.tag_user({
  user_name: "existingUserNameType", # required
  tags: [ # required
    {
      key: "tagKeyType", # required
      value: "tagValueType", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (required, String) —

    The name of the IAM user to which you want to add tags.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :tags (required, Array<Types::Tag>) —

    The list of tags that you want to attach to the IAM user. Each tag consists of a key name and an associated value.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



12793
12794
12795
12796
 
# File 'lib/aws-sdk-iam/client.rb', line 12793

def tag_user(params = {}, options = {})
  req = build_request(:tag_user, params)
  req.send_request(options)
end

#untag_instance_profile(params = {}) ⇒ Struct

Removes the specified tags from the IAM instance profile. For more information about tagging, see [Tagging IAM resources] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

Examples:

Request syntax with placeholder values


resp = client.untag_instance_profile({
  instance_profile_name: "instanceProfileNameType", # required
  tag_keys: ["tagKeyType"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :instance_profile_name (required, String) —

    The name of the IAM instance profile from which you want to remove tags.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :tag_keys (required, Array<String>) —

    A list of key names as a simple array of strings. The tags with matching keys are removed from the specified instance profile.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



12836
12837
12838
12839
 
# File 'lib/aws-sdk-iam/client.rb', line 12836

def untag_instance_profile(params = {}, options = {})
  req = build_request(:untag_instance_profile, params)
  req.send_request(options)
end

#untag_mfa_device(params = {}) ⇒ Struct

Removes the specified tags from the IAM virtual multi-factor authentication (MFA) device. For more information about tagging, see

Tagging IAM resources][1

in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

Examples:

Request syntax with placeholder values


resp = client.untag_mfa_device({
  serial_number: "serialNumberType", # required
  tag_keys: ["tagKeyType"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :serial_number (required, String) —

    The unique identifier for the IAM virtual MFA device from which you want to remove tags. 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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :tag_keys (required, Array<String>) —

    A list of key names as a simple array of strings. The tags with matching keys are removed from the specified instance profile.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



12880
12881
12882
12883
 
# File 'lib/aws-sdk-iam/client.rb', line 12880

def untag_mfa_device(params = {}, options = {})
  req = build_request(:untag_mfa_device, params)
  req.send_request(options)
end

#untag_open_id_connect_provider(params = {}) ⇒ Struct

Removes the specified tags from the specified OpenID Connect (OIDC)-compatible identity provider in IAM. For more information about OIDC providers, see [About web identity federation]. For more information about tagging, see [Tagging IAM resources] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

Examples:

Request syntax with placeholder values


resp = client.untag_open_id_connect_provider({
  open_id_connect_provider_arn: "arnType", # required
  tag_keys: ["tagKeyType"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :open_id_connect_provider_arn (required, String) —

    The ARN of the OIDC provider in IAM from which you want to remove tags.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :tag_keys (required, Array<String>) —

    A list of key names as a simple array of strings. The tags with matching keys are removed from the specified OIDC provider.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



12926
12927
12928
12929
 
# File 'lib/aws-sdk-iam/client.rb', line 12926

def untag_open_id_connect_provider(params = {}, options = {})
  req = build_request(:untag_open_id_connect_provider, params)
  req.send_request(options)
end

#untag_policy(params = {}) ⇒ Struct

Removes the specified tags from the customer managed policy. For more information about tagging, see [Tagging IAM resources] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

Examples:

Request syntax with placeholder values


resp = client.untag_policy({
  policy_arn: "arnType", # required
  tag_keys: ["tagKeyType"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :policy_arn (required, String) —

    The ARN of the IAM customer managed policy from which you want to remove tags.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :tag_keys (required, Array<String>) —

    A list of key names as a simple array of strings. The tags with matching keys are removed from the specified policy.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



12969
12970
12971
12972
 
# File 'lib/aws-sdk-iam/client.rb', line 12969

def untag_policy(params = {}, options = {})
  req = build_request(:untag_policy, params)
  req.send_request(options)
end

#untag_role(params = {}) ⇒ Struct

Removes the specified tags from the role. For more information about tagging, see [Tagging IAM resources] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

Examples:

Example: To remove a tag from an IAM role


# The following example shows how to remove a tag with the key 'Dept' from a role named 'taggedrole'.

resp = client.untag_role({
  role_name: "taggedrole", 
  tag_keys: [
    "Dept", 
  ], 
})

Request syntax with placeholder values


resp = client.untag_role({
  role_name: "roleNameType", # required
  tag_keys: ["tagKeyType"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :role_name (required, String) —

    The name of the IAM role from which you want to remove 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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :tag_keys (required, Array<String>) —

    A list of key names as a simple array of strings. The tags with matching keys are removed from the specified role.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



13022
13023
13024
13025
 
# File 'lib/aws-sdk-iam/client.rb', line 13022

def untag_role(params = {}, options = {})
  req = build_request(:untag_role, params)
  req.send_request(options)
end

#untag_saml_provider(params = {}) ⇒ Struct

Removes the specified tags from the specified Security Assertion Markup Language (SAML) identity provider in IAM. For more information about these providers, see [About web identity federation]. For more information about tagging, see [Tagging IAM resources] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

Examples:

Request syntax with placeholder values


resp = client.untag_saml_provider({
  saml_provider_arn: "arnType", # required
  tag_keys: ["tagKeyType"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :saml_provider_arn (required, String) —

    The ARN of the SAML identity provider in IAM from which you want to remove tags.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :tag_keys (required, Array<String>) —

    A list of key names as a simple array of strings. The tags with matching keys are removed from the specified SAML identity provider.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



13068
13069
13070
13071
 
# File 'lib/aws-sdk-iam/client.rb', line 13068

def untag_saml_provider(params = {}, options = {})
  req = build_request(:untag_saml_provider, params)
  req.send_request(options)
end

#untag_server_certificate(params = {}) ⇒ Struct

Removes the specified tags from the IAM server certificate. For more information about tagging, see [Tagging IAM resources] in the *IAM User Guide*.

<note markdown=“1”> For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don’t use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, [Working with server certificates] in the *IAM User Guide*.

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html

Examples:

Request syntax with placeholder values


resp = client.untag_server_certificate({
  server_certificate_name: "serverCertificateNameType", # required
  tag_keys: ["tagKeyType"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :server_certificate_name (required, String) —

    The name of the IAM server certificate from which you want to remove tags.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :tag_keys (required, Array<String>) —

    A list of key names as a simple array of strings. The tags with matching keys are removed from the specified IAM server certificate.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



13120
13121
13122
13123
 
# File 'lib/aws-sdk-iam/client.rb', line 13120

def untag_server_certificate(params = {}, options = {})
  req = build_request(:untag_server_certificate, params)
  req.send_request(options)
end

#untag_user(params = {}) ⇒ Struct

Removes the specified tags from the user. For more information about tagging, see [Tagging IAM resources] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

Examples:

Example: To remove a tag from an IAM user


# The following example shows how to remove tags that are attached to a user named 'anika'.

resp = client.untag_user({
  tag_keys: [
    "Dept", 
  ], 
  user_name: "anika", 
})

Request syntax with placeholder values


resp = client.untag_user({
  user_name: "existingUserNameType", # required
  tag_keys: ["tagKeyType"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (required, String) —

    The name of the IAM user from which you want to remove tags.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :tag_keys (required, Array<String>) —

    A list of key names as a simple array of strings. The tags with matching keys are removed from the specified user.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



13173
13174
13175
13176
 
# File 'lib/aws-sdk-iam/client.rb', line 13173

def untag_user(params = {}, options = {})
  req = build_request(:untag_user, params)
  req.send_request(options)
end

#update_access_key(params = {}) ⇒ Struct

Changes the status of the specified access key from Active to Inactive, or vice versa. This operation can be used to disable a user’s key as part of a key rotation workflow.

If the ‘UserName` is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. If a temporary access key is used, then `UserName` is required. If a long-term key is assigned to the user, then `UserName` is not required. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.

For information about rotating keys, see [Managing keys and certificates] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/ManagingCredentials.html

Examples:

Example: To activate or deactivate an access key for an IAM user


# The following command deactivates the specified access key (access key ID and secret access key) for the IAM user named
# Bob.

resp = client.update_access_key({
  access_key_id: "AKIAIOSFODNN7EXAMPLE", 
  status: "Inactive", 
  user_name: "Bob", 
})

Request syntax with placeholder values


resp = client.update_access_key({
  user_name: "existingUserNameType",
  access_key_id: "accessKeyIdType", # required
  status: "Active", # required, accepts Active, Inactive, Expired
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (String) —

    The name of the user whose key 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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :access_key_id (required, String) —

    The access key ID of the secret access key you want to update.

    This parameter allows (through its [regex pattern]) a string of characters that can consist of any upper or lowercased letter or digit.

    [1]: wikipedia.org/wiki/regex

  • :status (required, String) —

    The status you want to assign to the secret access key. ‘Active` means that the key can be used for programmatic calls to Amazon Web Services, while `Inactive` means that the key cannot be used.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



13252
13253
13254
13255
 
# File 'lib/aws-sdk-iam/client.rb', line 13252

def update_access_key(params = {}, options = {})
  req = build_request(:update_access_key, params)
  req.send_request(options)
end

#update_account_password_policy(params = {}) ⇒ Struct

Updates the password policy settings for the Amazon Web Services account.

<note markdown=“1”> This operation does not support partial updates. No parameters are required, but if you do not specify a parameter, that parameter’s value reverts to its default value. See the **Request Parameters** section for each parameter’s default value. Also note that some parameters do not allow the default parameter to be explicitly set. Instead, to invoke the default value, do not include that parameter when you invoke the operation.

</note>

For more information about using a password policy, see [Managing an IAM password policy] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html

Examples:

Example: To set or change the current account password policy


# The following command sets the password policy to require a minimum length of eight characters and to require one or
# more numbers in the password:

resp = client.({
  minimum_password_length: 8, 
  require_numbers: true, 
})

Request syntax with placeholder values


resp = client.({
  minimum_password_length: 1,
  require_symbols: false,
  require_numbers: false,
  require_uppercase_characters: false,
  require_lowercase_characters: false,
  allow_users_to_change_password: false,
  max_password_age: 1,
  password_reuse_prevention: 1,
  hard_expiry: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :minimum_password_length (Integer) —

    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 (Boolean) —

    Specifies whether IAM user passwords must contain at least one of the following non-alphanumeric characters:

    ! @ # $ % ^ &amp; * ( ) _ + - = [ ] { } | ‘

    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 (Boolean) —

    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 (Boolean) —

    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 (Boolean) —

    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 (Boolean) —

    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.

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_passwords_enable-user-change.html

  • :max_password_age (Integer) —

    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 (Integer) —

    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 (Boolean) —

    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.

    <note markdown=“1”> 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.

    </note>

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



13400
13401
13402
13403
 
# File 'lib/aws-sdk-iam/client.rb', line 13400

def (params = {}, options = {})
  req = build_request(:update_account_password_policy, params)
  req.send_request(options)
end

#update_assume_role_policy(params = {}) ⇒ Struct

Updates the policy that grants an IAM entity permission to assume a role. This is typically referred to as the “role trust policy”. For more information about roles, see [Using roles to delegate permissions and federate identities].

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html

Examples:

Example: To update the trust policy for an IAM role


# The following command updates the role trust policy for the role named Test-Role:

resp = client.update_assume_role_policy({
  policy_document: "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"Service\":[\"ec2.amazonaws.com\"]},\"Action\":[\"sts:AssumeRole\"]}]}", 
  role_name: "S3AccessForEC2Instances", 
})

Request syntax with placeholder values


resp = client.update_assume_role_policy({
  role_name: "roleNameType", # required
  policy_document: "policyDocumentType", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :role_name (required, String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :policy_document (required, String) —

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

    [1]: wikipedia.org/wiki/regex

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



13473
13474
13475
13476
 
# File 'lib/aws-sdk-iam/client.rb', line 13473

def update_assume_role_policy(params = {}, options = {})
  req = build_request(:update_assume_role_policy, params)
  req.send_request(options)
end

#update_delegation_request(params = {}) ⇒ Struct

Updates an existing delegation request with additional information. When the delegation request is updated, it reaches the ‘PENDING_APPROVAL` state.

Once a delegation request has an owner, that owner gets a default permission to update the delegation request. For more details, see [ Managing Permissions for Delegation Requests].

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies-temporary-delegation.html#temporary-delegation-managing-permissions

Examples:

Request syntax with placeholder values


resp = client.update_delegation_request({
  delegation_request_id: "delegationRequestIdType", # required
  notes: "notesType",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :delegation_request_id (required, String) —

    The unique identifier of the delegation request to update.

  • :notes (String) —

    Additional notes or comments to add to the delegation request.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



13509
13510
13511
13512
 
# File 'lib/aws-sdk-iam/client.rb', line 13509

def update_delegation_request(params = {}, options = {})
  req = build_request(:update_delegation_request, params)
  req.send_request(options)
end

#update_group(params = {}) ⇒ Struct

Updates the name and/or the path of the specified IAM group.

You should understand the implications of changing a group’s path or name. For more information, see [Renaming users and groups] in the *IAM User Guide*.

<note markdown=“1”> The person making the request (the principal), must have permission to change the role group with the old name and the new name. For example, to change the group named ‘Managers` to `MGRs`, the principal must have a policy that allows them to update both groups. If the principal has permission to update the `Managers` group, but not the `MGRs` group, then the update fails. For more information about permissions, see [Access management].

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_WorkingWithGroupsAndUsers.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/access.html

Examples:

Example: To rename an IAM group


# The following command changes the name of the IAM group Test to Test-1.

resp = client.update_group({
  group_name: "Test", 
  new_group_name: "Test-1", 
})

Request syntax with placeholder values


resp = client.update_group({
  group_name: "groupNameType", # required
  new_path: "pathType",
  new_group_name: "groupNameType",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :group_name (required, String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :new_path (String) —

    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.

    [1]: wikipedia.org/wiki/regex

  • :new_group_name (String) —

    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”.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



13595
13596
13597
13598
 
# File 'lib/aws-sdk-iam/client.rb', line 13595

def update_group(params = {}, options = {})
  req = build_request(:update_group, params)
  req.send_request(options)
end

#update_login_profile(params = {}) ⇒ Struct

Changes the password for the specified IAM user. You can use the CLI, the Amazon Web Services API, or the Users page in the IAM console to change the password for any IAM user. Use [ChangePassword] to change your own password in the **My Security Credentials** page in the Amazon Web Services Management Console.

For more information about modifying passwords, see [Managing passwords] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_ChangePassword.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html

Examples:

Example: To change the password for an IAM user


# The following command creates or changes the password for the IAM user named Bob.

resp = client.({
  password: "SomeKindOfPassword123!@#", 
  user_name: "Bob", 
})

Request syntax with placeholder values


resp = client.({
  user_name: "userNameType", # required
  password: "passwordType",
  password_reset_required: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (required, String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :password (String) —

    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].

    [1]: wikipedia.org/wiki/regex [2]: docs.aws.amazon.com/IAM/latest/APIReference/API_UpdateAccountPasswordPolicy.html

  • :password_reset_required (Boolean) —

    Allows this new password to be used only once by requiring the specified IAM user to set a new password on next sign-in.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



13678
13679
13680
13681
 
# File 'lib/aws-sdk-iam/client.rb', line 13678

def (params = {}, options = {})
  req = build_request(:update_login_profile, params)
  req.send_request(options)
end

#update_open_id_connect_provider_thumbprint(params = {}) ⇒ Struct

Replaces the existing list of server certificate thumbprints associated with an OpenID Connect (OIDC) provider resource object with a new list of thumbprints.

The list that you pass with this operation completely replaces the existing list of thumbprints. (The lists are not merged.)

Typically, you need to update a thumbprint only when the identity provider certificate changes, which occurs rarely. However, if the provider’s certificate does change, any attempt to assume an IAM role that specifies the OIDC provider as a principal fails until the certificate thumbprint is updated.

<note markdown=“1”> Amazon Web Services secures communication with OIDC identity providers (IdPs) using our library of trusted root certificate authorities (CAs) to verify the JSON Web Key Set (JWKS) endpoint’s TLS certificate. If your OIDC IdP relies on a certificate that is not signed by one of these trusted CAs, only then we secure communication using the thumbprints set in the IdP’s configuration.

</note>

<note markdown=“1”> Trust for the OIDC provider is derived from the provider certificate and is validated by the thumbprint. Therefore, it is best to limit access to the ‘UpdateOpenIDConnectProviderThumbprint` operation to highly privileged users.

</note>

Examples:

Request syntax with placeholder values


resp = client.update_open_id_connect_provider_thumbprint({
  open_id_connect_provider_arn: "arnType", # required
  thumbprint_list: ["thumbprintType"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



13748
13749
13750
13751
 
# File 'lib/aws-sdk-iam/client.rb', line 13748

def update_open_id_connect_provider_thumbprint(params = {}, options = {})
  req = build_request(:update_open_id_connect_provider_thumbprint, params)
  req.send_request(options)
end

#update_role(params = {}) ⇒ Struct

Updates the description or maximum session duration setting of a role.

Examples:

Request syntax with placeholder values


resp = client.update_role({
  role_name: "roleNameType", # required
  description: "roleDescriptionType",
  max_session_duration: 1,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :role_name (required, String) —

    The name of the role that you want to modify.

  • :description (String) —

    The new description that you want to apply to the specified role.

  • :max_session_duration (Integer) —

    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*.

    <note markdown=“1”> IAM role credentials provided by Amazon EC2 instances assigned to the role are not subject to the specified maximum session duration.

    </note>

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



13801
13802
13803
13804
 
# File 'lib/aws-sdk-iam/client.rb', line 13801

def update_role(params = {}, options = {})
  req = build_request(:update_role, params)
  req.send_request(options)
end

#update_role_description(params = {}) ⇒ Types::UpdateRoleDescriptionResponse

Use [UpdateRole] instead.

Modifies only the description of a role. This operation performs the same function as the ‘Description` parameter in the `UpdateRole` operation.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_UpdateRole.html

Examples:

Request syntax with placeholder values


resp = client.update_role_description({
  role_name: "roleNameType", # required
  description: "roleDescriptionType", # required
})

Response structure


resp.role.path #=> String
resp.role.role_name #=> String
resp.role.role_id #=> String
resp.role.arn #=> String
resp.role.create_date #=> Time
resp.role.assume_role_policy_document #=> String
resp.role.description #=> String
resp.role.max_session_duration #=> Integer
resp.role.permissions_boundary.permissions_boundary_type #=> String, one of "PermissionsBoundaryPolicy"
resp.role.permissions_boundary.permissions_boundary_arn #=> String
resp.role.tags #=> Array
resp.role.tags[0].key #=> String
resp.role.tags[0].value #=> String
resp.role.role_last_used.last_used_date #=> Time
resp.role.role_last_used.region #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :role_name (required, String) —

    The name of the role that you want to modify.

  • :description (required, String) —

    The new description that you want to apply to the specified role.

Returns:

See Also:



13855
13856
13857
13858
 
# File 'lib/aws-sdk-iam/client.rb', line 13855

def update_role_description(params = {}, options = {})
  req = build_request(:update_role_description, params)
  req.send_request(options)
end

#update_saml_provider(params = {}) ⇒ Types::UpdateSAMLProviderResponse

Updates the metadata document, SAML encryption settings, and private keys for an existing SAML provider. To rotate private keys, add your new private key and then remove the old key in a separate request.

Examples:

Request syntax with placeholder values


resp = client.update_saml_provider({
  saml_metadata_document: "SAMLMetadataDocumentType",
  saml_provider_arn: "arnType", # required
  assertion_encryption_mode: "Required", # accepts Required, Allowed
  add_private_key: "privateKeyType",
  remove_private_key: "privateKeyIdType",
})

Response structure


resp.saml_provider_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :saml_metadata_document (String) —

    An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer’s name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your IdP.

  • :saml_provider_arn (required, String) —

    The Amazon Resource Name (ARN) of the SAML provider to update.

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

    [1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

  • :assertion_encryption_mode (String) —

    Specifies the encryption setting for the SAML provider.

  • :add_private_key (String) —

    Specifies the new private key from your external identity provider. The private key must be a .pem file that uses AES-GCM or AES-CBC encryption algorithm to decrypt SAML assertions.

  • :remove_private_key (String) —

    The Key ID of the private key to remove.

Returns:

See Also:



13915
13916
13917
13918
 
# File 'lib/aws-sdk-iam/client.rb', line 13915

def update_saml_provider(params = {}, options = {})
  req = build_request(:update_saml_provider, params)
  req.send_request(options)
end

#update_server_certificate(params = {}) ⇒ Struct

Updates the name and/or the path of the specified server certificate stored in IAM.

For more information about working with server certificates, see

Working with server certificates][1

in the *IAM User Guide*. This

topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.

You should understand the implications of changing a server certificate’s path or name. For more information, see [Renaming a server certificate] in the *IAM User Guide*.

<note markdown=“1”> The person making the request (the principal), must have permission to change the server certificate with the old name and the new name. For example, to change the certificate named ‘ProductionCert` to `ProdCert`, the principal must have a policy that allows them to update both certificates. If the principal has permission to update the `ProductionCert` group, but not the `ProdCert` certificate, then the update fails. For more information about permissions, see [Access management] in the *IAM User Guide*.

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs_manage.html#RenamingServerCerts [3]: docs.aws.amazon.com/IAM/latest/UserGuide/access.html

Examples:

Request syntax with placeholder values


resp = client.update_server_certificate({
  server_certificate_name: "serverCertificateNameType", # required
  new_path: "pathType",
  new_server_certificate_name: "serverCertificateNameType",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :server_certificate_name (required, String) —

    The name of the server certificate that 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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :new_path (String) —

    The new path for the server certificate. Include this only if you are updating the server certificate’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.

    [1]: wikipedia.org/wiki/regex

  • :new_server_certificate_name (String) —

    The new name for the server certificate. Include this only if you are updating the server certificate’s name. 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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



14066
14067
14068
14069
 
# File 'lib/aws-sdk-iam/client.rb', line 14066

def update_server_certificate(params = {}, options = {})
  req = build_request(:update_server_certificate, params)
  req.send_request(options)
end

#update_service_specific_credential(params = {}) ⇒ Struct

Sets the status of a service-specific credential to ‘Active` or `Inactive`. Service-specific credentials that are inactive cannot be used for authentication to the service. This operation can be used to disable a user’s service-specific credential as part of a credential rotation work flow.

Examples:

Request syntax with placeholder values


resp = client.update_service_specific_credential({
  user_name: "userNameType",
  service_specific_credential_id: "serviceSpecificCredentialId", # required
  status: "Active", # required, accepts Active, Inactive, Expired
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (String) —

    The name of the IAM user associated with the service-specific credential. If you do not specify this value, then the operation assumes the user whose credentials are used to call the operation.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :service_specific_credential_id (required, String) —

    The unique identifier of the service-specific credential.

    This parameter allows (through its [regex pattern]) a string of characters that can consist of any upper or lowercased letter or digit.

    [1]: wikipedia.org/wiki/regex

  • :status (required, String) —

    The status to be assigned to the service-specific credential.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



14119
14120
14121
14122
 
# File 'lib/aws-sdk-iam/client.rb', line 14119

def update_service_specific_credential(params = {}, options = {})
  req = build_request(:update_service_specific_credential, params)
  req.send_request(options)
end

#update_signing_certificate(params = {}) ⇒ Struct

Changes the status of the specified user signing certificate from active to disabled, or vice versa. This operation can be used to disable an IAM user’s signing certificate as part of a certificate rotation work flow.

If the ‘UserName` field is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.

Examples:

Example: To change the active status of a signing certificate for an IAM user


# The following command changes the status of a signing certificate for a user named Bob to Inactive.

resp = client.update_signing_certificate({
  certificate_id: "TA7SMP42TDN5Z26OBPJE7EXAMPLE", 
  status: "Inactive", 
  user_name: "Bob", 
})

Request syntax with placeholder values


resp = client.update_signing_certificate({
  user_name: "existingUserNameType",
  certificate_id: "certificateIdType", # required
  status: "Active", # required, accepts Active, Inactive, Expired
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (String) —

    The name of the IAM user the signing certificate belongs to.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :certificate_id (required, String) —

    The ID of the signing certificate you want to update.

    This parameter allows (through its [regex pattern]) a string of characters that can consist of any upper or lowercased letter or digit.

    [1]: wikipedia.org/wiki/regex

  • :status (required, String) —

    The status you want to assign to the certificate. ‘Active` means that the certificate can be used for programmatic calls to Amazon Web Services `Inactive` means that the certificate cannot be used.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



14189
14190
14191
14192
 
# File 'lib/aws-sdk-iam/client.rb', line 14189

def update_signing_certificate(params = {}, options = {})
  req = build_request(:update_signing_certificate, params)
  req.send_request(options)
end

#update_ssh_public_key(params = {}) ⇒ Struct

Sets the status of an IAM user’s SSH public key to active or inactive. SSH public keys that are inactive cannot be used for authentication. This operation can be used to disable a user’s SSH public key as part of a key rotation work flow.

The SSH public key affected by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see [Set up CodeCommit for SSH connections] in the *CodeCommit User Guide*.

[1]: docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html

Examples:

Request syntax with placeholder values


resp = client.update_ssh_public_key({
  user_name: "userNameType", # required
  ssh_public_key_id: "publicKeyIdType", # required
  status: "Active", # required, accepts Active, Inactive, Expired
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (required, String) —

    The name of the IAM user associated with the SSH public key.

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :ssh_public_key_id (required, String) —

    The unique identifier for the SSH public key.

    This parameter allows (through its [regex pattern]) a string of characters that can consist of any upper or lowercased letter or digit.

    [1]: wikipedia.org/wiki/regex

  • :status (required, String) —

    The status to assign to the SSH public key. ‘Active` means that the key can be used for authentication with an CodeCommit repository. `Inactive` means that the key cannot be used.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



13977
13978
13979
13980
 
# File 'lib/aws-sdk-iam/client.rb', line 13977

def update_ssh_public_key(params = {}, options = {})
  req = build_request(:update_ssh_public_key, params)
  req.send_request(options)
end

#update_user(params = {}) ⇒ Struct

Updates the name and/or the path of the specified IAM user.

You should understand the implications of changing an IAM user’s path or name. For more information, see [Renaming an IAM user] and

Renaming an IAM group][2

in the *IAM User Guide*.

<note markdown=“1”> To change a user name, the requester must have appropriate permissions on both the source object and the target object. For example, to change Bob to Robert, the entity making the request must have permission on Bob and Robert, or must have permission on all (*). For more information about permissions, see [Permissions and policies].

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_users_manage.html#id_users_renaming [2]: docs.aws.amazon.com/IAM/latest/UserGuide/id_groups_manage_rename.html [3]: docs.aws.amazon.com/IAM/latest/UserGuide/PermissionsAndPolicies.html

Examples:

Example: To change an IAM user’s name


# The following command changes the name of the IAM user Bob to Robert. It does not change the user's path.

resp = client.update_user({
  new_user_name: "Robert", 
  user_name: "Bob", 
})

Request syntax with placeholder values


resp = client.update_user({
  user_name: "existingUserNameType", # required
  new_path: "pathType",
  new_user_name: "userNameType",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (required, String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :new_path (String) —

    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.

    [1]: wikipedia.org/wiki/regex

  • :new_user_name (String) —

    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”.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



14274
14275
14276
14277
 
# File 'lib/aws-sdk-iam/client.rb', line 14274

def update_user(params = {}, options = {})
  req = build_request(:update_user, params)
  req.send_request(options)
end

#upload_server_certificate(params = {}) ⇒ Types::UploadServerCertificateResponse

Uploads a server certificate entity for the Amazon Web Services account. The server certificate entity includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded.

We recommend that you use [Certificate Manager] to provision, manage, and deploy your server certificates. With ACM you can request a certificate, deploy it to Amazon Web Services resources, and let ACM handle certificate renewals for you. Certificates provided by ACM are free. For more information about using ACM, see the [Certificate Manager User Guide].

For more information about working with server certificates, see

Working with server certificates][3

in the *IAM User Guide*. This

topic includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.

For information about the number of server certificates you can upload, see [IAM and STS quotas] in the *IAM User Guide*.

<note markdown=“1”> Because the body of the public key certificate, private key, and the certificate chain can be large, you should use POST rather than GET when calling ‘UploadServerCertificate`. For information about setting up signatures and authorization through the API, see [Signing Amazon Web Services API requests] in the *Amazon Web Services General Reference*. For general information about using the Query API with IAM, see [Calling the API by making HTTP query requests] in the *IAM User Guide*.

</note>

[1]: docs.aws.amazon.com/acm/ [2]: docs.aws.amazon.com/acm/latest/userguide/ [3]: docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html [4]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html [5]: docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html [6]: docs.aws.amazon.com/IAM/latest/UserGuide/programming.html

Examples:

Example: To upload a server certificate to your AWS account


# The following upload-server-certificate command uploads a server certificate to your AWS account:

resp = client.upload_server_certificate({
  certificate_body: "-----BEGIN CERTIFICATE-----<a very long certificate text string>-----END CERTIFICATE-----", 
  path: "/company/servercerts/", 
  private_key: "-----BEGIN DSA PRIVATE KEY-----<a very long private key string>-----END DSA PRIVATE KEY-----", 
  server_certificate_name: "ProdServerCert", 
})

resp.to_h outputs the following:
{
  server_certificate_metadata: {
    arn: "arn:aws:iam::123456789012:server-certificate/company/servercerts/ProdServerCert", 
    expiration: Time.parse("2012-05-08T01:02:03.004Z"), 
    path: "/company/servercerts/", 
    server_certificate_id: "ASCA1111111111EXAMPLE", 
    server_certificate_name: "ProdServerCert", 
    upload_date: Time.parse("2010-05-08T01:02:03.004Z"), 
  }, 
}

Request syntax with placeholder values


resp = client.upload_server_certificate({
  path: "pathType",
  server_certificate_name: "serverCertificateNameType", # required
  certificate_body: "certificateBodyType", # required
  private_key: "privateKeyType", # required
  certificate_chain: "certificateChainType",
  tags: [
    {
      key: "tagKeyType", # required
      value: "tagValueType", # required
    },
  ],
})

Response structure


resp.server_certificate_metadata.path #=> String
resp.server_certificate_metadata.server_certificate_name #=> String
resp.server_certificate_metadata.server_certificate_id #=> String
resp.server_certificate_metadata.arn #=> String
resp.server_certificate_metadata.upload_date #=> Time
resp.server_certificate_metadata.expiration #=> Time
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :path (String) —

    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.

    <note markdown=“1”> 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/`).

    </note>

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html [2]: wikipedia.org/wiki/regex

  • :server_certificate_name (required, String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :certificate_body (required, String) —

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

    [1]: wikipedia.org/wiki/regex

  • :private_key (required, String) —

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

    [1]: wikipedia.org/wiki/regex

  • :certificate_chain (String) —

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

    [1]: wikipedia.org/wiki/regex

  • :tags (Array<Types::Tag>) —

    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*.

    <note markdown=“1”> 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.

    </note>

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

Returns:

See Also:



14567
14568
14569
14570
 
# File 'lib/aws-sdk-iam/client.rb', line 14567

def upload_server_certificate(params = {}, options = {})
  req = build_request(:upload_server_certificate, params)
  req.send_request(options)
end

#upload_signing_certificate(params = {}) ⇒ Types::UploadSigningCertificateResponse

Uploads an X.509 signing certificate and associates it with the specified IAM user. Some Amazon Web Services services require you to use certificates to validate requests that are signed with a corresponding private key. When you upload the certificate, its default status is ‘Active`.

For information about when you would use an X.509 signing certificate, see [Managing server certificates in IAM] in the *IAM User Guide*.

If the ‘UserName` is not specified, the IAM user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.

<note markdown=“1”> Because the body of an X.509 certificate can be large, you should use POST rather than GET when calling ‘UploadSigningCertificate`. For information about setting up signatures and authorization through the API, see [Signing Amazon Web Services API requests] in the *Amazon Web Services General Reference*. For general information about using the Query API with IAM, see [Making query requests] in the *IAM User Guide*.

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html [2]: docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html [3]: docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html

Examples:

Example: To upload a signing certificate for an IAM user


# The following command uploads a signing certificate for the IAM user named Bob.

resp = client.upload_signing_certificate({
  certificate_body: "-----BEGIN CERTIFICATE-----<certificate-body>-----END CERTIFICATE-----", 
  user_name: "Bob", 
})

resp.to_h outputs the following:
{
  certificate: {
    certificate_body: "-----BEGIN CERTIFICATE-----<certificate-body>-----END CERTIFICATE-----", 
    certificate_id: "ID123456789012345EXAMPLE", 
    status: "Active", 
    upload_date: Time.parse("2015-06-06T21:40:08.121Z"), 
    user_name: "Bob", 
  }, 
}

Request syntax with placeholder values


resp = client.upload_signing_certificate({
  user_name: "existingUserNameType",
  certificate_body: "certificateBodyType", # required
})

Response structure


resp.certificate.user_name #=> String
resp.certificate.certificate_id #=> String
resp.certificate.certificate_body #=> String
resp.certificate.status #=> String, one of "Active", "Inactive", "Expired"
resp.certificate.upload_date #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (String) —

    The name of the user the signing certificate is 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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :certificate_body (required, String) —

    The contents of the signing certificate.

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

    [1]: wikipedia.org/wiki/regex

Returns:

See Also:



14679
14680
14681
14682
 
# File 'lib/aws-sdk-iam/client.rb', line 14679

def upload_signing_certificate(params = {}, options = {})
  req = build_request(:upload_signing_certificate, params)
  req.send_request(options)
end

#upload_ssh_public_key(params = {}) ⇒ Types::UploadSSHPublicKeyResponse

Uploads an SSH public key and associates it with the specified IAM user.

The SSH public key uploaded by this operation can be used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see [Set up CodeCommit for SSH connections] in the *CodeCommit User Guide*.

[1]: docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html

Examples:

Request syntax with placeholder values


resp = client.upload_ssh_public_key({
  user_name: "userNameType", # required
  ssh_public_key_body: "publicKeyMaterialType", # required
})

Response structure


resp.ssh_public_key.user_name #=> String
resp.ssh_public_key.ssh_public_key_id #=> String
resp.ssh_public_key.fingerprint #=> String
resp.ssh_public_key.ssh_public_key_body #=> String
resp.ssh_public_key.status #=> String, one of "Active", "Inactive", "Expired"
resp.ssh_public_key.upload_date #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (required, String) —

    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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

  • :ssh_public_key_body (required, String) —

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

    [1]: wikipedia.org/wiki/regex

Returns:

See Also:



14350
14351
14352
14353
 
# File 'lib/aws-sdk-iam/client.rb', line 14350

def upload_ssh_public_key(params = {}, options = {})
  req = build_request(:upload_ssh_public_key, params)
  req.send_request(options)
end

#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean

Polls an API operation until a resource enters a desired state.

## Basic Usage

A waiter will call an API operation until:

  • It is successful

  • It enters a terminal state

  • It makes the maximum number of attempts

In between attempts, the waiter will sleep.

# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)

## Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.

# poll for ~25 seconds
client.wait_until(waiter_name, params, {
  max_attempts: 5,
  delay: 5,
})

## Callbacks

You can be notified before each polling attempt and before each delay. If you throw ‘:success` or `:failure` from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(waiter_name, params, {

  # disable max attempts
  max_attempts: nil,

  # poll for 1 hour, instead of a number of attempts
  before_wait: -> (attempts, response) do
    throw :failure if Time.now - started_at > 3600
  end
})

## Handling Errors

When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

## Valid Waiters

The following table lists the valid waiter names, the operations they call, and the default ‘:delay` and `:max_attempts` values.

| waiter_name | params | :delay | :max_attempts | | ———————– | —————————– | ——– | ————- | | instance_profile_exists | #get_instance_profile | 1 | 40 | | policy_exists | #get_policy | 1 | 20 | | role_exists | #get_role | 1 | 20 | | user_exists | #get_user | 1 | 20 |

Parameters:

  • waiter_name (Symbol)
  • params (Hash) (defaults to: {}) —

    ({})

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :max_attempts (Integer)
  • :delay (Integer)
  • :before_attempt (Proc)
  • :before_wait (Proc)

Yields:

  • (w.waiter)

Returns:

  • (Boolean) —

    Returns ‘true` if the waiter was successful.

Raises:

  • (Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError) —

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError) —

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError) —

    Raised when you request to wait for an unknown state.



14797
14798
14799
14800
14801
 
# File 'lib/aws-sdk-iam/client.rb', line 14797

def wait_until(waiter_name, params = {}, options = {})
  w = waiter(waiter_name, options)
  yield(w.waiter) if block_given? # deprecated
  w.wait(params)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


14805
14806
14807
 
# File 'lib/aws-sdk-iam/client.rb', line 14805

def waiter_names
  waiters.keys
end