Class: Aws::IAM::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::IAM::Client
- 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
- .identifier ⇒ Object readonly private
API Operations collapse
-
#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.
-
#add_role_to_instance_profile(params = {}) ⇒ Struct
Adds the specified IAM role to the specified instance profile.
-
#add_user_to_group(params = {}) ⇒ Struct
Adds the specified user to the specified group.
-
#attach_group_policy(params = {}) ⇒ Struct
Attaches the specified managed policy to the specified IAM group.
-
#attach_role_policy(params = {}) ⇒ Struct
Attaches the specified managed policy to the specified IAM role.
-
#attach_user_policy(params = {}) ⇒ Struct
Attaches the specified managed policy to the specified user.
-
#change_password(params = {}) ⇒ Struct
Changes the password of the IAM user who is calling this operation.
-
#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.
-
#create_account_alias(params = {}) ⇒ Struct
Creates an alias for your Amazon Web Services account.
-
#create_group(params = {}) ⇒ Types::CreateGroupResponse
Creates a new group.
-
#create_instance_profile(params = {}) ⇒ Types::CreateInstanceProfileResponse
Creates a new instance profile.
-
#create_login_profile(params = {}) ⇒ Types::CreateLoginProfileResponse
Creates a password for the specified IAM user.
-
#create_open_id_connect_provider(params = {}) ⇒ Types::CreateOpenIDConnectProviderResponse
Creates an IAM entity to describe an identity provider (IdP) that supports [OpenID Connect (OIDC)].
-
#create_policy(params = {}) ⇒ Types::CreatePolicyResponse
Creates a new managed policy for your Amazon Web Services account.
-
#create_policy_version(params = {}) ⇒ Types::CreatePolicyVersionResponse
Creates a new version of the specified managed policy.
-
#create_role(params = {}) ⇒ Types::CreateRoleResponse
Creates a new role for your Amazon Web Services account.
-
#create_saml_provider(params = {}) ⇒ Types::CreateSAMLProviderResponse
Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0.
-
#create_service_linked_role(params = {}) ⇒ Types::CreateServiceLinkedRoleResponse
Creates an IAM role that is linked to a specific Amazon Web Services service.
-
#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.
-
#create_user(params = {}) ⇒ Types::CreateUserResponse
Creates a new IAM user for your Amazon Web Services account.
-
#create_virtual_mfa_device(params = {}) ⇒ Types::CreateVirtualMFADeviceResponse
Creates a new virtual MFA device for the Amazon Web Services account.
-
#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.
-
#delete_access_key(params = {}) ⇒ Struct
Deletes the access key pair associated with the specified IAM user.
-
#delete_account_alias(params = {}) ⇒ Struct
Deletes the specified Amazon Web Services account alias.
-
#delete_account_password_policy(params = {}) ⇒ Struct
Deletes the password policy for the Amazon Web Services account.
-
#delete_group(params = {}) ⇒ Struct
Deletes the specified IAM group.
-
#delete_group_policy(params = {}) ⇒ Struct
Deletes the specified inline policy that is embedded in the specified IAM group.
-
#delete_instance_profile(params = {}) ⇒ Struct
Deletes the specified instance profile.
-
#delete_login_profile(params = {}) ⇒ Struct
Deletes the password for the specified IAM user, For more information, see [Managing passwords for IAM users].
-
#delete_open_id_connect_provider(params = {}) ⇒ Struct
Deletes an OpenID Connect identity provider (IdP) resource object in IAM.
-
#delete_policy(params = {}) ⇒ Struct
Deletes the specified managed policy.
-
#delete_policy_version(params = {}) ⇒ Struct
Deletes the specified version from the specified managed policy.
-
#delete_role(params = {}) ⇒ Struct
Deletes the specified role.
-
#delete_role_permissions_boundary(params = {}) ⇒ Struct
Deletes the permissions boundary for the specified IAM role.
-
#delete_role_policy(params = {}) ⇒ Struct
Deletes the specified inline policy that is embedded in the specified IAM role.
-
#delete_saml_provider(params = {}) ⇒ Struct
Deletes a SAML provider resource in IAM.
-
#delete_server_certificate(params = {}) ⇒ Struct
Deletes the specified server certificate.
-
#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.
-
#delete_service_specific_credential(params = {}) ⇒ Struct
Deletes the specified service-specific credential.
-
#delete_signing_certificate(params = {}) ⇒ Struct
Deletes a signing certificate associated with the specified IAM user.
-
#delete_ssh_public_key(params = {}) ⇒ Struct
Deletes the specified SSH public key.
-
#delete_user(params = {}) ⇒ Struct
Deletes the specified IAM user.
-
#delete_user_permissions_boundary(params = {}) ⇒ Struct
Deletes the permissions boundary for the specified IAM user.
-
#delete_user_policy(params = {}) ⇒ Struct
Deletes the specified inline policy that is embedded in the specified IAM user.
-
#delete_virtual_mfa_device(params = {}) ⇒ Struct
Deletes a virtual MFA device.
-
#detach_group_policy(params = {}) ⇒ Struct
Removes the specified managed policy from the specified IAM group.
-
#detach_role_policy(params = {}) ⇒ Struct
Removes the specified managed policy from the specified role.
-
#detach_user_policy(params = {}) ⇒ Struct
Removes the specified managed policy from the specified user.
-
#enable_mfa_device(params = {}) ⇒ Struct
Enables the specified MFA device and associates it with the specified IAM user.
-
#generate_credential_report(params = {}) ⇒ Types::GenerateCredentialReportResponse
Generates a credential report for the Amazon Web Services account.
-
#generate_organizations_access_report(params = {}) ⇒ Types::GenerateOrganizationsAccessReportResponse
Generates a report for service last accessed data for Organizations.
-
#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.
-
#get_access_key_last_used(params = {}) ⇒ Types::GetAccessKeyLastUsedResponse
Retrieves information about when the specified access key was last used.
-
#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.
-
#get_account_password_policy(params = {}) ⇒ Types::GetAccountPasswordPolicyResponse
Retrieves the password policy for the Amazon Web Services account.
-
#get_account_summary(params = {}) ⇒ Types::GetAccountSummaryResponse
Retrieves information about IAM entity usage and IAM quotas in the Amazon Web Services account.
-
#get_context_keys_for_custom_policy(params = {}) ⇒ Types::GetContextKeysForPolicyResponse
Gets a list of all of the context keys referenced in the input policies.
-
#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.
-
#get_credential_report(params = {}) ⇒ Types::GetCredentialReportResponse
Retrieves a credential report for the Amazon Web Services account.
-
#get_group(params = {}) ⇒ Types::GetGroupResponse
Returns a list of IAM users that are in the specified IAM group.
-
#get_group_policy(params = {}) ⇒ Types::GetGroupPolicyResponse
Retrieves the specified inline policy document that is embedded in the specified IAM group.
-
#get_instance_profile(params = {}) ⇒ Types::GetInstanceProfileResponse
Retrieves information about the specified instance profile, including the instance profile’s path, GUID, ARN, and role.
-
#get_login_profile(params = {}) ⇒ Types::GetLoginProfileResponse
Retrieves the user name for the specified IAM user.
-
#get_mfa_device(params = {}) ⇒ Types::GetMFADeviceResponse
Retrieves information about an MFA device for a specified user.
-
#get_open_id_connect_provider(params = {}) ⇒ Types::GetOpenIDConnectProviderResponse
Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM.
-
#get_organizations_access_report(params = {}) ⇒ Types::GetOrganizationsAccessReportResponse
Retrieves the service last accessed data report for Organizations that was previously generated using the ‘ GenerateOrganizationsAccessReport ` operation.
-
#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.
-
#get_policy_version(params = {}) ⇒ Types::GetPolicyVersionResponse
Retrieves information about the specified version of the specified managed policy, including the policy document.
-
#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.
-
#get_role_policy(params = {}) ⇒ Types::GetRolePolicyResponse
Retrieves the specified inline policy document that is embedded with the specified IAM role.
-
#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.
-
#get_server_certificate(params = {}) ⇒ Types::GetServerCertificateResponse
Retrieves information about the specified server certificate stored in IAM.
-
#get_service_last_accessed_details(params = {}) ⇒ Types::GetServiceLastAccessedDetailsResponse
Retrieves a service last accessed report that was created using the ‘GenerateServiceLastAccessedDetails` operation.
-
#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`.
-
#get_service_linked_role_deletion_status(params = {}) ⇒ Types::GetServiceLinkedRoleDeletionStatusResponse
Retrieves the status of your service-linked role deletion.
-
#get_ssh_public_key(params = {}) ⇒ Types::GetSSHPublicKeyResponse
Retrieves the specified SSH public key, including metadata about the key.
-
#get_user(params = {}) ⇒ Types::GetUserResponse
Retrieves information about the specified IAM user, including the user’s creation date, path, unique ID, and ARN.
-
#get_user_policy(params = {}) ⇒ Types::GetUserPolicyResponse
Retrieves the specified inline policy document that is embedded in the specified IAM user.
-
#list_access_keys(params = {}) ⇒ Types::ListAccessKeysResponse
Returns information about the access key IDs associated with the specified IAM user.
-
#list_account_aliases(params = {}) ⇒ Types::ListAccountAliasesResponse
Lists the account alias associated with the Amazon Web Services account (Note: you can have only one).
-
#list_attached_group_policies(params = {}) ⇒ Types::ListAttachedGroupPoliciesResponse
Lists all managed policies that are attached to the specified IAM group.
-
#list_attached_role_policies(params = {}) ⇒ Types::ListAttachedRolePoliciesResponse
Lists all managed policies that are attached to the specified IAM role.
-
#list_attached_user_policies(params = {}) ⇒ Types::ListAttachedUserPoliciesResponse
Lists all managed policies that are attached to the specified IAM user.
-
#list_entities_for_policy(params = {}) ⇒ Types::ListEntitiesForPolicyResponse
Lists all IAM users, groups, and roles that the specified managed policy is attached to.
-
#list_group_policies(params = {}) ⇒ Types::ListGroupPoliciesResponse
Lists the names of the inline policies that are embedded in the specified IAM group.
-
#list_groups(params = {}) ⇒ Types::ListGroupsResponse
Lists the IAM groups that have the specified path prefix.
-
#list_groups_for_user(params = {}) ⇒ Types::ListGroupsForUserResponse
Lists the IAM groups that the specified IAM user belongs to.
-
#list_instance_profile_tags(params = {}) ⇒ Types::ListInstanceProfileTagsResponse
Lists the tags that are attached to the specified IAM instance profile.
-
#list_instance_profiles(params = {}) ⇒ Types::ListInstanceProfilesResponse
Lists the instance profiles that have the specified path prefix.
-
#list_instance_profiles_for_role(params = {}) ⇒ Types::ListInstanceProfilesForRoleResponse
Lists the instance profiles that have the specified associated IAM role.
-
#list_mfa_device_tags(params = {}) ⇒ Types::ListMFADeviceTagsResponse
Lists the tags that are attached to the specified IAM virtual multi-factor authentication (MFA) device.
-
#list_mfa_devices(params = {}) ⇒ Types::ListMFADevicesResponse
Lists the MFA devices for an IAM user.
-
#list_open_id_connect_provider_tags(params = {}) ⇒ Types::ListOpenIDConnectProviderTagsResponse
Lists the tags that are attached to the specified OpenID Connect (OIDC)-compatible identity provider.
-
#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.
-
#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.
-
#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.
-
#list_policy_tags(params = {}) ⇒ Types::ListPolicyTagsResponse
Lists the tags that are attached to the specified IAM customer managed policy.
-
#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.
-
#list_role_policies(params = {}) ⇒ Types::ListRolePoliciesResponse
Lists the names of the inline policies that are embedded in the specified IAM role.
-
#list_role_tags(params = {}) ⇒ Types::ListRoleTagsResponse
Lists the tags that are attached to the specified role.
-
#list_roles(params = {}) ⇒ Types::ListRolesResponse
Lists the IAM roles that have the specified path prefix.
-
#list_saml_provider_tags(params = {}) ⇒ Types::ListSAMLProviderTagsResponse
Lists the tags that are attached to the specified Security Assertion Markup Language (SAML) identity provider.
-
#list_saml_providers(params = {}) ⇒ Types::ListSAMLProvidersResponse
Lists the SAML provider resource objects defined in IAM in the account.
-
#list_server_certificate_tags(params = {}) ⇒ Types::ListServerCertificateTagsResponse
Lists the tags that are attached to the specified IAM server certificate.
-
#list_server_certificates(params = {}) ⇒ Types::ListServerCertificatesResponse
Lists the server certificates stored in IAM that have the specified path prefix.
-
#list_service_specific_credentials(params = {}) ⇒ Types::ListServiceSpecificCredentialsResponse
Returns information about the service-specific credentials associated with the specified IAM user.
-
#list_signing_certificates(params = {}) ⇒ Types::ListSigningCertificatesResponse
Returns information about the signing certificates associated with the specified IAM user.
-
#list_ssh_public_keys(params = {}) ⇒ Types::ListSSHPublicKeysResponse
Returns information about the SSH public keys associated with the specified IAM user.
-
#list_user_policies(params = {}) ⇒ Types::ListUserPoliciesResponse
Lists the names of the inline policies embedded in the specified IAM user.
-
#list_user_tags(params = {}) ⇒ Types::ListUserTagsResponse
Lists the tags that are attached to the specified IAM user.
-
#list_users(params = {}) ⇒ Types::ListUsersResponse
Lists the IAM users that have the specified path prefix.
-
#list_virtual_mfa_devices(params = {}) ⇒ Types::ListVirtualMFADevicesResponse
Lists the virtual MFA devices defined in the Amazon Web Services account by assignment status.
-
#put_group_policy(params = {}) ⇒ Struct
Adds or updates an inline policy document that is embedded in the specified IAM group.
-
#put_role_permissions_boundary(params = {}) ⇒ Struct
Adds or updates the policy that is specified as the IAM role’s permissions boundary.
-
#put_role_policy(params = {}) ⇒ Struct
Adds or updates an inline policy document that is embedded in the specified IAM role.
-
#put_user_permissions_boundary(params = {}) ⇒ Struct
Adds or updates the policy that is specified as the IAM user’s permissions boundary.
-
#put_user_policy(params = {}) ⇒ Struct
Adds or updates an inline policy document that is embedded in the specified IAM user.
-
#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.
-
#remove_role_from_instance_profile(params = {}) ⇒ Struct
Removes the specified IAM role from the specified EC2 instance profile.
-
#remove_user_from_group(params = {}) ⇒ Struct
Removes the specified user from the specified group.
-
#reset_service_specific_credential(params = {}) ⇒ Types::ResetServiceSpecificCredentialResponse
Resets the password for a service-specific credential.
-
#resync_mfa_device(params = {}) ⇒ Struct
Synchronizes the specified MFA device with its IAM resource object on the Amazon Web Services servers.
-
#set_default_policy_version(params = {}) ⇒ Struct
Sets the specified version of the specified policy as the policy’s default (operative) version.
-
#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.
-
#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.
-
#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.
-
#tag_instance_profile(params = {}) ⇒ Struct
Adds one or more tags to an IAM instance profile.
-
#tag_mfa_device(params = {}) ⇒ Struct
Adds one or more tags to an IAM virtual multi-factor authentication (MFA) device.
-
#tag_open_id_connect_provider(params = {}) ⇒ Struct
Adds one or more tags to an OpenID Connect (OIDC)-compatible identity provider.
-
#tag_policy(params = {}) ⇒ Struct
Adds one or more tags to an IAM customer managed policy.
-
#tag_role(params = {}) ⇒ Struct
Adds one or more tags to an IAM role.
-
#tag_saml_provider(params = {}) ⇒ Struct
Adds one or more tags to a Security Assertion Markup Language (SAML) identity provider.
-
#tag_server_certificate(params = {}) ⇒ Struct
Adds one or more tags to an IAM server certificate.
-
#tag_user(params = {}) ⇒ Struct
Adds one or more tags to an IAM user.
-
#untag_instance_profile(params = {}) ⇒ Struct
Removes the specified tags from the IAM instance profile.
-
#untag_mfa_device(params = {}) ⇒ Struct
Removes the specified tags from the IAM virtual multi-factor authentication (MFA) device.
-
#untag_open_id_connect_provider(params = {}) ⇒ Struct
Removes the specified tags from the specified OpenID Connect (OIDC)-compatible identity provider in IAM.
-
#untag_policy(params = {}) ⇒ Struct
Removes the specified tags from the customer managed policy.
-
#untag_role(params = {}) ⇒ Struct
Removes the specified tags from the role.
-
#untag_saml_provider(params = {}) ⇒ Struct
Removes the specified tags from the specified Security Assertion Markup Language (SAML) identity provider in IAM.
-
#untag_server_certificate(params = {}) ⇒ Struct
Removes the specified tags from the IAM server certificate.
-
#untag_user(params = {}) ⇒ Struct
Removes the specified tags from the user.
-
#update_access_key(params = {}) ⇒ Struct
Changes the status of the specified access key from Active to Inactive, or vice versa.
-
#update_account_password_policy(params = {}) ⇒ Struct
Updates the password policy settings for the Amazon Web Services account.
-
#update_assume_role_policy(params = {}) ⇒ Struct
Updates the policy that grants an IAM entity permission to assume a role.
-
#update_group(params = {}) ⇒ Struct
Updates the name and/or the path of the specified IAM group.
-
#update_login_profile(params = {}) ⇒ Struct
Changes the password for the specified IAM user.
-
#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.
-
#update_role(params = {}) ⇒ Struct
Updates the description or maximum session duration setting of a role.
-
#update_role_description(params = {}) ⇒ Types::UpdateRoleDescriptionResponse
Use UpdateRole instead.
-
#update_saml_provider(params = {}) ⇒ Types::UpdateSAMLProviderResponse
Updates the metadata document for an existing SAML provider resource object.
-
#update_server_certificate(params = {}) ⇒ Struct
Updates the name and/or the path of the specified server certificate stored in IAM.
-
#update_service_specific_credential(params = {}) ⇒ Struct
Sets the status of a service-specific credential to ‘Active` or `Inactive`.
-
#update_signing_certificate(params = {}) ⇒ Struct
Changes the status of the specified user signing certificate from active to disabled, or vice versa.
-
#update_ssh_public_key(params = {}) ⇒ Struct
Sets the status of an IAM user’s SSH public key to active or inactive.
-
#update_user(params = {}) ⇒ Struct
Updates the name and/or the path of the specified IAM user.
-
#upload_server_certificate(params = {}) ⇒ Types::UploadServerCertificateResponse
Uploads a server certificate entity for the Amazon Web Services account.
-
#upload_signing_certificate(params = {}) ⇒ Types::UploadSigningCertificateResponse
Uploads an X.509 signing certificate and associates it with the specified IAM user.
-
#upload_ssh_public_key(params = {}) ⇒ Types::UploadSSHPublicKeyResponse
Uploads an SSH public key and associates it with the specified IAM user.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
385 386 387 |
# File 'lib/aws-sdk-iam/client.rb', line 385 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.
13602 13603 13604 |
# File 'lib/aws-sdk-iam/client.rb', line 13602 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.
13605 13606 13607 |
# File 'lib/aws-sdk-iam/client.rb', line 13605 def errors_module Errors end |
Instance Method Details
#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.
431 432 433 434 |
# File 'lib/aws-sdk-iam/client.rb', line 431 def add_client_id_to_open_id_connect_provider(params = {}, = {}) req = build_request(:add_client_id_to_open_id_connect_provider, params) req.send_request() 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>
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/id_roles.html [5]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html
509 510 511 512 |
# File 'lib/aws-sdk-iam/client.rb', line 509 def add_role_to_instance_profile(params = {}, = {}) req = build_request(:add_role_to_instance_profile, params) req.send_request() end |
#add_user_to_group(params = {}) ⇒ Struct
Adds the specified user to the specified group.
563 564 565 566 |
# File 'lib/aws-sdk-iam/client.rb', line 563 def add_user_to_group(params = {}, = {}) req = build_request(:add_user_to_group, params) req.send_request() 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
631 632 633 634 |
# File 'lib/aws-sdk-iam/client.rb', line 631 def attach_group_policy(params = {}, = {}) req = build_request(:attach_group_policy, params) req.send_request() 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
708 709 710 711 |
# File 'lib/aws-sdk-iam/client.rb', line 708 def attach_role_policy(params = {}, = {}) req = build_request(:attach_role_policy, params) req.send_request() 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
776 777 778 779 |
# File 'lib/aws-sdk-iam/client.rb', line 776 def attach_user_policy(params = {}, = {}) req = build_request(:attach_user_policy, params) req.send_request() 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.
13461 13462 13463 13464 13465 13466 13467 13468 13469 13470 13471 13472 |
# File 'lib/aws-sdk-iam/client.rb', line 13461 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-iam' context[:gem_version] = '1.91.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][1
-
in the *IAM User Guide*.
[1]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html
840 841 842 843 |
# File 'lib/aws-sdk-iam/client.rb', line 840 def change_password(params = {}, = {}) req = build_request(:change_password, params) req.send_request() 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
923 924 925 926 |
# File 'lib/aws-sdk-iam/client.rb', line 923 def create_access_key(params = {}, = {}) req = build_request(:create_access_key, params) req.send_request() 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
970 971 972 973 |
# File 'lib/aws-sdk-iam/client.rb', line 970 def create_account_alias(params = {}, = {}) req = build_request(:create_account_alias, params) req.send_request() 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
1054 1055 1056 1057 |
# File 'lib/aws-sdk-iam/client.rb', line 1054 def create_group(params = {}, = {}) req = build_request(:create_group, params) req.send_request() 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
1191 1192 1193 1194 |
# File 'lib/aws-sdk-iam/client.rb', line 1191 def create_instance_profile(params = {}, = {}) req = build_request(:create_instance_profile, params) req.send_request() 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 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/UserGuide/Using_ManagingLogins.html
1290 1291 1292 1293 |
# File 'lib/aws-sdk-iam/client.rb', line 1290 def create_login_profile(params = {}, = {}) req = build_request(:create_login_profile, params) req.send_request() 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 some OIDC identity providers (IdPs) through our library of trusted root certificate authorities (CAs) instead of using a certificate thumbprint to verify your IdP server certificate. These OIDC IdPs include Auth0, GitHub, Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In these cases, your legacy thumbprint remains in your configuration, but is no longer used for validation.
</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 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
1468 1469 1470 1471 |
# File 'lib/aws-sdk-iam/client.rb', line 1468 def create_open_id_connect_provider(params = {}, = {}) req = build_request(:create_open_id_connect_provider, params) req.send_request() 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
1625 1626 1627 1628 |
# File 'lib/aws-sdk-iam/client.rb', line 1625 def create_policy(params = {}, = {}) req = build_request(:create_policy, params) req.send_request() 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/UserGuide/policies-managed-versions.html
1727 1728 1729 1730 |
# File 'lib/aws-sdk-iam/client.rb', line 1727 def create_policy_version(params = {}, = {}) req = build_request(:create_policy_version, params) req.send_request() 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
1932 1933 1934 1935 |
# File 'lib/aws-sdk-iam/client.rb', line 1932 def create_role(params = {}, = {}) req = build_request(:create_role, params) req.send_request() 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
2040 2041 2042 2043 |
# File 'lib/aws-sdk-iam/client.rb', line 2040 def create_saml_provider(params = {}, = {}) req = build_request(:create_saml_provider, params) req.send_request() 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
2127 2128 2129 2130 |
# File 'lib/aws-sdk-iam/client.rb', line 2127 def create_service_linked_role(params = {}, = {}) req = build_request(:create_service_linked_role, params) req.send_request() 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 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 [Using IAM with CodeCommit: Git credentials, SSH keys, and Amazon Web Services access keys] in the *IAM User Guide*.
[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_ssh-keys.html
2199 2200 2201 2202 |
# File 'lib/aws-sdk-iam/client.rb', line 2199 def create_service_specific_credential(params = {}, = {}) req = build_request(:create_service_specific_credential, params) req.send_request() 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
2329 2330 2331 2332 |
# File 'lib/aws-sdk-iam/client.rb', line 2329 def create_user(params = {}, = {}) req = build_request(:create_user, params) req.send_request() 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/UserGuide/Using_VirtualMFA.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html
2445 2446 2447 2448 |
# File 'lib/aws-sdk-iam/client.rb', line 2445 def create_virtual_mfa_device(params = {}, = {}) req = build_request(:create_virtual_mfa_device, params) req.send_request() 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
2499 2500 2501 2502 |
# File 'lib/aws-sdk-iam/client.rb', line 2499 def deactivate_mfa_device(params = {}, = {}) req = build_request(:deactivate_mfa_device, params) req.send_request() 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.
2560 2561 2562 2563 |
# File 'lib/aws-sdk-iam/client.rb', line 2560 def delete_access_key(params = {}, = {}) req = build_request(:delete_access_key, params) req.send_request() 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
2607 2608 2609 2610 |
# File 'lib/aws-sdk-iam/client.rb', line 2607 def delete_account_alias(params = {}, = {}) req = build_request(:delete_account_alias, params) req.send_request() end |
#delete_account_password_policy(params = {}) ⇒ Struct
Deletes the password policy for the Amazon Web Services account. There are no parameters.
2629 2630 2631 2632 |
# File 'lib/aws-sdk-iam/client.rb', line 2629 def delete_account_password_policy(params = {}, = {}) req = build_request(:delete_account_password_policy, params) req.send_request() end |
#delete_group(params = {}) ⇒ Struct
Deletes the specified IAM group. The group must not contain any users or have any attached policies.
2661 2662 2663 2664 |
# File 'lib/aws-sdk-iam/client.rb', line 2661 def delete_group(params = {}, = {}) req = build_request(:delete_group, params) req.send_request() 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/UserGuide/policies-managed-vs-inline.html
2726 2727 2728 2729 |
# File 'lib/aws-sdk-iam/client.rb', line 2726 def delete_group_policy(params = {}, = {}) req = build_request(:delete_group_policy, params) req.send_request() 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
2779 2780 2781 2782 |
# File 'lib/aws-sdk-iam/client.rb', line 2779 def delete_instance_profile(params = {}, = {}) req = build_request(:delete_instance_profile, params) req.send_request() end |
#delete_login_profile(params = {}) ⇒ Struct
Deletes the password for the specified IAM 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
2836 2837 2838 2839 |
# File 'lib/aws-sdk-iam/client.rb', line 2836 def delete_login_profile(params = {}, = {}) req = build_request(:delete_login_profile, params) req.send_request() 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.
2869 2870 2871 2872 |
# File 'lib/aws-sdk-iam/client.rb', line 2869 def delete_open_id_connect_provider(params = {}, = {}) req = build_request(:delete_open_id_connect_provider, params) req.send_request() 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:
-
Detach the policy from all users, groups, and roles that the policy is attached to, using DetachUserPolicy, DetachGroupPolicy, or DetachRolePolicy. To list all the users, groups, and roles that a policy is attached to, use ListEntitiesForPolicy.
-
Delete all versions of the policy using DeletePolicyVersion. To list the policy’s versions, use ListPolicyVersions. You cannot use DeletePolicyVersion to delete the version that is marked as the default version. You delete the policy’s default version in the next step of the process.
-
Delete the policy (this automatically deletes the policy’s default version) using this operation.
For 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
2924 2925 2926 2927 |
# File 'lib/aws-sdk-iam/client.rb', line 2924 def delete_policy(params = {}, = {}) req = build_request(:delete_policy, params) req.send_request() 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/UserGuide/policies-managed-versions.html
2983 2984 2985 2986 |
# File 'lib/aws-sdk-iam/client.rb', line 2983 def delete_policy_version(params = {}, = {}) req = build_request(:delete_policy_version, params) req.send_request() 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:
-
Inline policies (DeleteRolePolicy)
-
Attached managed policies (DetachRolePolicy)
-
Instance profile (RemoveRoleFromInstanceProfile)
-
Optional – Delete instance profile after detaching from role for resource clean up (DeleteInstanceProfile)
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
3045 3046 3047 3048 |
# File 'lib/aws-sdk-iam/client.rb', line 3045 def delete_role(params = {}, = {}) req = build_request(:delete_role, params) req.send_request() 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.
3074 3075 3076 3077 |
# File 'lib/aws-sdk-iam/client.rb', line 3074 def (params = {}, = {}) req = build_request(:delete_role_permissions_boundary, params) req.send_request() 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/UserGuide/policies-managed-vs-inline.html
3139 3140 3141 3142 |
# File 'lib/aws-sdk-iam/client.rb', line 3139 def delete_role_policy(params = {}, = {}) req = build_request(:delete_role_policy, params) req.send_request() 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
3174 3175 3176 3177 |
# File 'lib/aws-sdk-iam/client.rb', line 3174 def delete_saml_provider(params = {}, = {}) req = build_request(:delete_saml_provider, params) req.send_request() 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
3278 3279 3280 3281 |
# File 'lib/aws-sdk-iam/client.rb', line 3278 def delete_server_certificate(params = {}, = {}) req = build_request(:delete_server_certificate, params) req.send_request() 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/ [2]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role
3332 3333 3334 3335 |
# File 'lib/aws-sdk-iam/client.rb', line 3332 def delete_service_linked_role(params = {}, = {}) req = build_request(:delete_service_linked_role, params) req.send_request() end |
#delete_service_specific_credential(params = {}) ⇒ Struct
Deletes the specified service-specific credential.
3378 3379 3380 3381 |
# File 'lib/aws-sdk-iam/client.rb', line 3378 def delete_service_specific_credential(params = {}, = {}) req = build_request(:delete_service_specific_credential, params) req.send_request() 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.
3438 3439 3440 3441 |
# File 'lib/aws-sdk-iam/client.rb', line 3438 def delete_signing_certificate(params = {}, = {}) req = build_request(:delete_signing_certificate, params) req.send_request() 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
3227 3228 3229 3230 |
# File 'lib/aws-sdk-iam/client.rb', line 3227 def delete_ssh_public_key(params = {}, = {}) req = build_request(:delete_ssh_public_key, params) req.send_request() 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:
-
Password (DeleteLoginProfile)
-
Access keys (DeleteAccessKey)
-
Signing certificate (DeleteSigningCertificate)
-
SSH public key (DeleteSSHPublicKey)
-
Git credentials (DeleteServiceSpecificCredential)
-
Multi-factor authentication (MFA) device (DeactivateMFADevice, DeleteVirtualMFADevice)
-
Inline policies (DeleteUserPolicy)
-
Attached managed policies (DetachUserPolicy)
-
Group memberships (RemoveUserFromGroup)
[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_users_manage.html#id_users_deleting_cli
3505 3506 3507 3508 |
# File 'lib/aws-sdk-iam/client.rb', line 3505 def delete_user(params = {}, = {}) req = build_request(:delete_user, params) req.send_request() 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.
3532 3533 3534 3535 |
# File 'lib/aws-sdk-iam/client.rb', line 3532 def (params = {}, = {}) req = build_request(:delete_user_permissions_boundary, params) req.send_request() 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/UserGuide/policies-managed-vs-inline.html
3597 3598 3599 3600 |
# File 'lib/aws-sdk-iam/client.rb', line 3597 def delete_user_policy(params = {}, = {}) req = build_request(:delete_user_policy, params) req.send_request() 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>
3644 3645 3646 3647 |
# File 'lib/aws-sdk-iam/client.rb', line 3644 def delete_virtual_mfa_device(params = {}, = {}) req = build_request(:delete_virtual_mfa_device, params) req.send_request() 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/UserGuide/policies-managed-vs-inline.html
3695 3696 3697 3698 |
# File 'lib/aws-sdk-iam/client.rb', line 3695 def detach_group_policy(params = {}, = {}) req = build_request(:detach_group_policy, params) req.send_request() 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/UserGuide/policies-managed-vs-inline.html
3746 3747 3748 3749 |
# File 'lib/aws-sdk-iam/client.rb', line 3746 def detach_role_policy(params = {}, = {}) req = build_request(:detach_role_policy, params) req.send_request() 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/UserGuide/policies-managed-vs-inline.html
3797 3798 3799 3800 |
# File 'lib/aws-sdk-iam/client.rb', line 3797 def detach_user_policy(params = {}, = {}) req = build_request(:detach_user_policy, params) req.send_request() 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.
3878 3879 3880 3881 |
# File 'lib/aws-sdk-iam/client.rb', line 3878 def enable_mfa_device(params = {}, = {}) req = build_request(:enable_mfa_device, params) req.send_request() 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
3905 3906 3907 3908 |
# File 'lib/aws-sdk-iam/client.rb', line 3905 def generate_credential_report(params = {}, = {}) req = build_request(:generate_credential_report, params) req.send_request() 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
4090 4091 4092 4093 |
# File 'lib/aws-sdk-iam/client.rb', line 4090 def generate_organizations_access_report(params = {}, = {}) req = build_request(:generate_organizations_access_report, params) req.send_request() 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 – 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 – 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][5
-
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/UserGuide/reference_policies_evaluation-logic.html#policy-eval-basics [5]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html
4212 4213 4214 4215 |
# File 'lib/aws-sdk-iam/client.rb', line 4212 def generate_service_last_accessed_details(params = {}, = {}) req = build_request(:generate_service_last_accessed_details, params) req.send_request() 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.
4255 4256 4257 4258 |
# File 'lib/aws-sdk-iam/client.rb', line 4255 def get_access_key_last_used(params = {}, = {}) req = build_request(:get_access_key_last_used, params) req.send_request() 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.
</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.
4429 4430 4431 4432 |
# File 'lib/aws-sdk-iam/client.rb', line 4429 def (params = {}, = {}) req = build_request(:get_account_authorization_details, params) req.send_request() 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
4489 4490 4491 4492 |
# File 'lib/aws-sdk-iam/client.rb', line 4489 def get_account_password_policy(params = {}, = {}) req = build_request(:get_account_password_policy, params) req.send_request() 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
4557 4558 4559 4560 |
# File 'lib/aws-sdk-iam/client.rb', line 4557 def get_account_summary(params = {}, = {}) req = build_request(:get_account_summary, params) req.send_request() 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.
4616 4617 4618 4619 |
# File 'lib/aws-sdk-iam/client.rb', line 4616 def get_context_keys_for_custom_policy(params = {}, = {}) req = build_request(:get_context_keys_for_custom_policy, params) req.send_request() 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 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.
4700 4701 4702 4703 |
# File 'lib/aws-sdk-iam/client.rb', line 4700 def get_context_keys_for_principal_policy(params = {}, = {}) req = build_request(:get_context_keys_for_principal_policy, params) req.send_request() 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
4729 4730 4731 4732 |
# File 'lib/aws-sdk-iam/client.rb', line 4729 def get_credential_report(params = {}, = {}) req = build_request(:get_credential_report, params) req.send_request() 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.
4809 4810 4811 4812 |
# File 'lib/aws-sdk-iam/client.rb', line 4809 def get_group(params = {}, = {}) req = build_request(:get_group, params) req.send_request() 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.
</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 to determine the policy’s default version, then use GetPolicyVersion 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/UserGuide/policies-managed-vs-inline.html
4885 4886 4887 4888 |
# File 'lib/aws-sdk-iam/client.rb', line 4885 def get_group_policy(params = {}, = {}) req = build_request(:get_group_policy, params) req.send_request() 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
4987 4988 4989 4990 |
# File 'lib/aws-sdk-iam/client.rb', line 4987 def get_instance_profile(params = {}, = {}) req = build_request(:get_instance_profile, params) req.send_request() 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.
5057 5058 5059 5060 |
# File 'lib/aws-sdk-iam/client.rb', line 5057 def get_login_profile(params = {}, = {}) req = build_request(:get_login_profile, params) req.send_request() end |
#get_mfa_device(params = {}) ⇒ Types::GetMFADeviceResponse
Retrieves information about an MFA device for a specified user.
5101 5102 5103 5104 |
# File 'lib/aws-sdk-iam/client.rb', line 5101 def get_mfa_device(params = {}, = {}) req = build_request(:get_mfa_device, params) req.send_request() end |
#get_open_id_connect_provider(params = {}) ⇒ Types::GetOpenIDConnectProviderResponse
Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM.
5151 5152 5153 5154 |
# File 'lib/aws-sdk-iam/client.rb', line 5151 def get_open_id_connect_provider(params = {}, = {}) req = build_request(:get_open_id_connect_provider, params) req.send_request() 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/UserGuide/access_policies_access-advisor.html
5296 5297 5298 5299 |
# File 'lib/aws-sdk-iam/client.rb', line 5296 def get_organizations_access_report(params = {}, = {}) req = build_request(:get_organizations_access_report, params) req.send_request() 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/UserGuide/policies-managed-vs-inline.html
The following waiters are defined for this operation (see #wait_until for detailed usage):
* policy_exists
5368 5369 5370 5371 |
# File 'lib/aws-sdk-iam/client.rb', line 5368 def get_policy(params = {}, = {}) req = build_request(:get_policy, params) req.send_request() 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.
</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/UserGuide/policies-managed-vs-inline.html [3]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html
5448 5449 5450 5451 |
# File 'lib/aws-sdk-iam/client.rb', line 5448 def get_policy_version(params = {}, = {}) req = build_request(:get_policy_version, params) req.send_request() 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.
</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
5546 5547 5548 5549 |
# File 'lib/aws-sdk-iam/client.rb', line 5546 def get_role(params = {}, = {}) req = build_request(:get_role, params) req.send_request() 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.
</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 to determine the policy’s default version, then use GetPolicyVersion 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/UserGuide/policies-managed-vs-inline.html [3]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html
5626 5627 5628 5629 |
# File 'lib/aws-sdk-iam/client.rb', line 5626 def get_role_policy(params = {}, = {}) req = build_request(:get_role_policy, params) req.send_request() 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
5679 5680 5681 5682 |
# File 'lib/aws-sdk-iam/client.rb', line 5679 def get_saml_provider(params = {}, = {}) req = build_request(:get_saml_provider, params) req.send_request() 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
5808 5809 5810 5811 |
# File 'lib/aws-sdk-iam/client.rb', line 5808 def get_server_certificate(params = {}, = {}) req = build_request(:get_server_certificate, params) req.send_request() 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
5971 5972 5973 5974 |
# File 'lib/aws-sdk-iam/client.rb', line 5971 def get_service_last_accessed_details(params = {}, = {}) req = build_request(:get_service_last_accessed_details, params) req.send_request() 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.
6119 6120 6121 6122 |
# File 'lib/aws-sdk-iam/client.rb', line 6119 def get_service_last_accessed_details_with_entities(params = {}, = {}) req = build_request(:get_service_last_accessed_details_with_entities, params) req.send_request() 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.
6160 6161 6162 6163 |
# File 'lib/aws-sdk-iam/client.rb', line 6160 def get_service_linked_role_deletion_status(params = {}, = {}) req = build_request(:get_service_linked_role_deletion_status, params) req.send_request() 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
5750 5751 5752 5753 |
# File 'lib/aws-sdk-iam/client.rb', line 5750 def get_ssh_public_key(params = {}, = {}) req = build_request(:get_ssh_public_key, params) req.send_request() 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
6238 6239 6240 6241 |
# File 'lib/aws-sdk-iam/client.rb', line 6238 def get_user(params = {}, = {}) req = build_request(:get_user, params) req.send_request() 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.
</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 to determine the policy’s default version. Then use GetPolicyVersion 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/UserGuide/policies-managed-vs-inline.html
6314 6315 6316 6317 |
# File 'lib/aws-sdk-iam/client.rb', line 6314 def get_user_policy(params = {}, = {}) req = build_request(:get_user_policy, params) req.send_request() 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.
6428 6429 6430 6431 |
# File 'lib/aws-sdk-iam/client.rb', line 6428 def list_access_keys(params = {}, = {}) req = build_request(:list_access_keys, params) req.send_request() 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 *Amazon Web Services Sign-In User Guide*.
[1]: docs.aws.amazon.com/signin/latest/userguide/CreateAccountAlias.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6501 6502 6503 6504 |
# File 'lib/aws-sdk-iam/client.rb', line 6501 def list_account_aliases(params = {}, = {}) req = build_request(:list_account_aliases, params) req.send_request() 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/UserGuide/policies-managed-vs-inline.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6599 6600 6601 6602 |
# File 'lib/aws-sdk-iam/client.rb', line 6599 def list_attached_group_policies(params = {}, = {}) req = build_request(:list_attached_group_policies, params) req.send_request() 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/UserGuide/policies-managed-vs-inline.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6697 6698 6699 6700 |
# File 'lib/aws-sdk-iam/client.rb', line 6697 def list_attached_role_policies(params = {}, = {}) req = build_request(:list_attached_role_policies, params) req.send_request() 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/UserGuide/policies-managed-vs-inline.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6795 6796 6797 6798 |
# File 'lib/aws-sdk-iam/client.rb', line 6795 def list_attached_user_policies(params = {}, = {}) req = build_request(:list_attached_user_policies, params) req.send_request() 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.
6914 6915 6916 6917 |
# File 'lib/aws-sdk-iam/client.rb', line 6914 def list_entities_for_policy(params = {}, = {}) req = build_request(:list_entities_for_policy, params) req.send_request() 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][1
-
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/UserGuide/policies-managed-vs-inline.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7008 7009 7010 7011 |
# File 'lib/aws-sdk-iam/client.rb', line 7008 def list_group_policies(params = {}, = {}) req = build_request(:list_group_policies, params) req.send_request() 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.
7118 7119 7120 7121 |
# File 'lib/aws-sdk-iam/client.rb', line 7118 def list_groups(params = {}, = {}) req = build_request(:list_groups, params) req.send_request() 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.
7217 7218 7219 7220 |
# File 'lib/aws-sdk-iam/client.rb', line 7217 def list_groups_for_user(params = {}, = {}) req = build_request(:list_groups_for_user, params) req.send_request() 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.
7288 7289 7290 7291 |
# File 'lib/aws-sdk-iam/client.rb', line 7288 def (params = {}, = {}) req = build_request(:list_instance_profile_tags, params) req.send_request() 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
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7398 7399 7400 7401 |
# File 'lib/aws-sdk-iam/client.rb', line 7398 def list_instance_profiles(params = {}, = {}) req = build_request(:list_instance_profiles, params) req.send_request() 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.
7494 7495 7496 7497 |
# File 'lib/aws-sdk-iam/client.rb', line 7494 def list_instance_profiles_for_role(params = {}, = {}) req = build_request(:list_instance_profiles_for_role, params) req.send_request() 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.
7567 7568 7569 7570 |
# File 'lib/aws-sdk-iam/client.rb', line 7567 def (params = {}, = {}) req = build_request(:list_mfa_device_tags, params) req.send_request() 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.
7639 7640 7641 7642 |
# File 'lib/aws-sdk-iam/client.rb', line 7639 def list_mfa_devices(params = {}, = {}) req = build_request(:list_mfa_devices, params) req.send_request() 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.
7715 7716 7717 7718 |
# File 'lib/aws-sdk-iam/client.rb', line 7715 def (params = {}, = {}) req = build_request(:list_open_id_connect_provider_tags, params) req.send_request() 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>
7744 7745 7746 7747 |
# File 'lib/aws-sdk-iam/client.rb', line 7744 def list_open_id_connect_providers(params = {}, = {}) req = build_request(:list_open_id_connect_providers, params) req.send_request() 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
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.