Class: Aws::IAM::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::IAM::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-iam/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.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
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)][1].
-
#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][1].
-
#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 theJobId
parameter inGetServiceLastAccessedDetailsWithEntities
. -
#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 Amazon 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
orInactive
. -
#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.
Instance Method Summary collapse
-
#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.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
385 386 387 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 385 def initialize(*args) super 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 'gems/aws-sdk-iam/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.
PassRole
permission
on the IAM role by a permissions policy.
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.
509 510 511 512 |
# File 'gems/aws-sdk-iam/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 'gems/aws-sdk-iam/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
.
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.
631 632 633 634 |
# File 'gems/aws-sdk-iam/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.
CreateRole
. You can update a role's trust policy using
UpdateAssumerolePolicy
.
Use this operation to attach a managed policy to a role. To embed an
inline policy in a role, use PutRolePolicy
. 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.
708 709 710 711 |
# File 'gems/aws-sdk-iam/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
.
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.
776 777 778 779 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 776 def attach_user_policy(params = {}, = {}) req = build_request(:attach_user_policy, params) req.send_request() 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 in the IAM User Guide.
840 841 842 843 |
# File 'gems/aws-sdk-iam/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 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.
923 924 925 926 |
# File 'gems/aws-sdk-iam/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.
970 971 972 973 |
# File 'gems/aws-sdk-iam/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.
1054 1055 1056 1057 |
# File 'gems/aws-sdk-iam/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.
1191 1192 1193 1194 |
# File 'gems/aws-sdk-iam/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.
1290 1291 1292 1293 |
# File 'gems/aws-sdk-iam/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.
1471 1472 1473 1474 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 1471 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.
1628 1629 1630 1631 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 1628 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.
1730 1731 1732 1733 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 1730 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.
1935 1936 1937 1938 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 1935 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.
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.
2043 2044 2045 2046 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 2043 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.
2130 2131 2132 2133 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 2130 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.
2202 2203 2204 2205 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 2202 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.
2332 2333 2334 2335 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 2332 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.
2448 2449 2450 2451 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 2448 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.
2502 2503 2504 2505 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 2502 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.
2563 2564 2565 2566 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 2563 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.
2610 2611 2612 2613 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 2610 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.
2632 2633 2634 2635 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 2632 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.
2664 2665 2666 2667 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 2664 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.
2729 2730 2731 2732 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 2729 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.
2782 2783 2784 2785 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 2782 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.
2839 2840 2841 2842 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 2839 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.
2872 2873 2874 2875 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 2872 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.
2927 2928 2929 2930 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 2927 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.
2986 2987 2988 2989 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 2986 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.
3048 3049 3050 3051 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3048 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.
3077 3078 3079 3080 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3077 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.
3142 3143 3144 3145 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3142 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.
3177 3178 3179 3180 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3177 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 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.
3281 3282 3283 3284 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3281 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.
3335 3336 3337 3338 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3335 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.
3381 3382 3383 3384 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3381 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.
3441 3442 3443 3444 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3441 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.
3230 3231 3232 3233 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3230 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)
3508 3509 3510 3511 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3508 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.
3535 3536 3537 3538 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3535 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.
3600 3601 3602 3603 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3600 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.
3647 3648 3649 3650 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3647 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.
3698 3699 3700 3701 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3698 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.
3749 3750 3751 3752 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3749 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.
3800 3801 3802 3803 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3800 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.
3881 3882 3883 3884 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3881 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.
3908 3909 3910 3911 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3908 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.
For more information about service last accessed data, see Reducing policy scope by viewing user activity in the IAM User Guide.
4093 4094 4095 4096 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 4093 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 byGenerateServiceLastAccessedDetail
must be used by the same role within a session, or by the same user when used to callGetServiceLastAccessedDetail
.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.
For more information about service and action last accessed data, see Reducing permissions using service last accessed data in the IAM User Guide.
4215 4216 4217 4218 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 4215 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.
4258 4259 4260 4261 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 4258 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.
decode
method of the java.net.URLDecoder
utility class in the Java
SDK. Other languages and SDKs provide similar functionality.
You can optionally filter the results using the Filter
parameter.
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.
4432 4433 4434 4435 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 4432 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.
4492 4493 4494 4495 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 4492 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.
4560 4561 4562 4563 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 4560 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.
4619 4620 4621 4622 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 4619 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.
4703 4704 4705 4706 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 4703 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.
4732 4733 4734 4735 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 4732 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.
4812 4813 4814 4815 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 4812 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.
decode
method of the java.net.URLDecoder
utility class in the Java
SDK. Other languages and SDKs provide similar functionality.
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.
4888 4889 4890 4891 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 4888 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.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- instance_profile_exists
4990 4991 4992 4993 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 4990 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.
5060 5061 5062 5063 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 5060 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.
5104 5105 5106 5107 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 5104 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.
5154 5155 5156 5157 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 5154 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.
5299 5300 5301 5302 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 5299 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.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- policy_exists
5371 5372 5373 5374 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 5371 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.
decode
method of the java.net.URLDecoder
utility class in the Java
SDK. Other languages and SDKs provide similar functionality.
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.
5451 5452 5453 5454 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 5451 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.
decode
method of the java.net.URLDecoder
utility class in the Java
SDK. Other languages and SDKs provide similar functionality.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- role_exists
5549 5550 5551 5552 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 5549 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.
decode
method of the java.net.URLDecoder
utility class in the Java
SDK. Other languages and SDKs provide similar functionality.
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.
5629 5630 5631 5632 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 5629 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.
5682 5683 5684 5685 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 5682 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 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.
5811 5812 5813 5814 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 5811 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.
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 in the IAM User Guide.
5974 5975 5976 5977 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 5974 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.
6122 6123 6124 6125 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 6122 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.
6163 6164 6165 6166 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 6163 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.
5753 5754 5755 5756 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 5753 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
6241 6242 6243 6244 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 6241 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.
decode
method of the java.net.URLDecoder
utility class in the Java
SDK. Other languages and SDKs provide similar functionality.
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.
6317 6318 6319 6320 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 6317 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6431 6432 6433 6434 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 6431 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6504 6505 6506 6507 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 6504 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6602 6603 6604 6605 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 6602 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6700 6701 6702 6703 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 6700 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6798 6799 6800 6801 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 6798 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.
6917 6918 6919 6920 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 6917 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 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7011 7012 7013 7014 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 7011 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.
7121 7122 7123 7124 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 7121 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.
7220 7221 7222 7223 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 7220 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7291 7292 7293 7294 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 7291 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.
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.
7401 7402 7403 7404 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 7401 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7497 7498 7499 7500 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 7497 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7570 7571 7572 7573 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 7570 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.
7642 7643 7644 7645 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 7642 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7718 7719 7720 7721 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 7718 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.
7747 7748 7749 7750 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 7747 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7883 7884 7885 7886 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 7883 def list_policies(params = {}, = {}) req = build_request(:list_policies, params) req.send_request() end |
#list_policies_granting_service_access(params = {}) ⇒ Types::ListPoliciesGrantingServiceAccessResponse
Retrieves a list of policies that the IAM identity (user, group, or role) can use to access each specified service.
The list of policies returned by the operation depends on the ARN of the identity that you provide.
User – The list of policies includes the managed and inline policies that are attached to the user directly. The list also includes any additional managed and inline policies that are attached to the group to which the user belongs.
Group – The list of policies includes only the managed and inline policies that are attached to the group directly. Policies that are attached to the group’s user are not included.
Role – The list of policies includes only the managed and inline policies that are attached to the role.
For each managed policy, this operation returns the ARN and policy name. For each inline policy, it returns the policy name and the entity to which it is attached. Inline policies do not have an ARN. For more information about these policy types, see Managed policies and inline policies in the IAM User Guide.
Policies that are attached to users and roles as permissions boundaries are not returned. To view which managed policy is currently used to set the permissions boundary for a user or role, use the GetUser or GetRole operations.
8035 8036 8037 8038 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 8035 def list_policies_granting_service_access(params = {}, = {}) req = build_request(:list_policies_granting_service_access, params) req.send_request() end |
#list_policy_tags(params = {}) ⇒ Types::ListPolicyTagsResponse
Lists the tags that are attached to the specified IAM customer managed policy. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8106 8107 8108 8109 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 8106 def (params = {}, = {}) req = build_request(:list_policy_tags, params) req.send_request() end |
#list_policy_versions(params = {}) ⇒ Types::ListPolicyVersionsResponse
Lists information about the versions of the specified managed policy, including the version that is currently set as the policy's default version.
For more information about managed policies, see Managed policies and inline policies in the IAM User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8180 8181 8182 8183 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 8180 def list_policy_versions(params = {}, = {}) req = build_request(:list_policy_versions, params) req.send_request() end |
#list_role_policies(params = {}) ⇒ Types::ListRolePoliciesResponse
Lists the names of the inline policies that are embedded in the specified IAM role.
An IAM role can also have managed policies attached to it. To list the managed policies that are attached to a role, use ListAttachedRolePolicies. For more information about policies, see Managed policies and inline policies in the IAM User Guide.
You can paginate the results using the MaxItems
and Marker
parameters. If there are no inline policies embedded with the
specified role, the operation returns an empty list.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8257 8258 8259 8260 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 8257 def list_role_policies(params = {}, = {}) req = build_request(:list_role_policies, params) req.send_request() end |
#list_role_tags(params = {}) ⇒ Types::ListRoleTagsResponse
Lists the tags that are attached to the specified role. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8351 8352 8353 8354 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 8351 def (params = {}, = {}) req = build_request(:list_role_tags, params) req.send_request() end |
#list_roles(params = {}) ⇒ Types::ListRolesResponse
Lists the IAM roles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about roles, see IAM roles in the IAM User Guide.
PermissionsBoundary
RoleLastUsed
Tags
To view all of the information for a role, see GetRole.
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.
8457 8458 8459 8460 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 8457 def list_roles(params = {}, = {}) req = build_request(:list_roles, params) req.send_request() end |
#list_saml_provider_tags(params = {}) ⇒ Types::ListSAMLProviderTagsResponse
Lists the tags that are attached to the specified Security Assertion Markup Language (SAML) identity provider. The returned list of tags is sorted by tag key. For more information, see About SAML 2.0-based federation.
For more information about tagging, see Tagging IAM resources in the IAM User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8533 8534 8535 8536 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 8533 def (params = {}, = {}) req = build_request(:list_saml_provider_tags, params) req.send_request() end |
#list_saml_providers(params = {}) ⇒ Types::ListSAMLProvidersResponse
Lists the SAML provider resource objects defined in IAM in the account. IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a SAML provider, see GetSAMLProvider.
This operation requires Signature Version 4.
8566 8567 8568 8569 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 8566 def list_saml_providers(params = {}, = {}) req = build_request(:list_saml_providers, params) req.send_request() end |
#list_server_certificate_tags(params = {}) ⇒ Types::ListServerCertificateTagsResponse
Lists the tags that are attached to the specified IAM server certificate. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8729 8730 8731 8732 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 8729 def (params = {}, = {}) req = build_request(:list_server_certificate_tags, params) req.send_request() end |
#list_server_certificates(params = {}) ⇒ Types::ListServerCertificatesResponse
Lists the server certificates stored in IAM that have the specified path prefix. If none exist, the operation returns an empty list.
You can paginate the results using the MaxItems
and Marker
parameters.
For more information about working with server certificates, see Working with server certificates 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8824 8825 8826 8827 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 8824 def list_server_certificates(params = {}, = {}) req = build_request(:list_server_certificates, params) req.send_request() end |
#list_service_specific_credentials(params = {}) ⇒ Types::ListServiceSpecificCredentialsResponse
Returns information about the service-specific credentials associated with the specified IAM user. If none exists, the operation returns an empty list. The service-specific credentials returned by this operation are used only for authenticating the IAM user to a specific service. For more information about using service-specific credentials to authenticate to an Amazon Web Services service, see Set up service-specific credentials in the CodeCommit User Guide.
8885 8886 8887 8888 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 8885 def list_service_specific_credentials(params = {}, = {}) req = build_request(:list_service_specific_credentials, params) req.send_request() end |
#list_signing_certificates(params = {}) ⇒ Types::ListSigningCertificatesResponse
Returns information about the signing certificates associated with the specified IAM user. If none exists, the operation returns an empty list.
Although each user is limited to a small number of signing
certificates, you can still paginate the results using the MaxItems
and Marker
parameters.
If the UserName
field is not specified, the user name is determined
implicitly based on the Amazon Web Services access key ID used to sign
the request for this operation. This operation works for access keys
under the Amazon Web Services account. Consequently, you can use this
operation to manage Amazon Web Services account root user credentials
even if the Amazon Web Services account has no associated users.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8988 8989 8990 8991 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 8988 def list_signing_certificates(params = {}, = {}) req = build_request(:list_signing_certificates, params) req.send_request() end |
#list_ssh_public_keys(params = {}) ⇒ Types::ListSSHPublicKeysResponse
Returns information about the SSH public keys associated with the specified IAM user. If none exists, the operation returns an empty list.
The SSH public keys returned by this operation are used only for authenticating the IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.
Although each user is limited to a small number of keys, you can still
paginate the results using the MaxItems
and Marker
parameters.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8649 8650 8651 8652 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 8649 def list_ssh_public_keys(params = {}, = {}) req = build_request(:list_ssh_public_keys, params) req.send_request() end |
#list_user_policies(params = {}) ⇒ Types::ListUserPoliciesResponse
Lists the names of the inline policies embedded in the specified IAM user.
An IAM user can also have managed policies attached to it. To list the managed policies that are attached to a user, use ListAttachedUserPolicies. For more information about policies, see Managed policies and inline policies in the IAM User Guide.
You can paginate the results using the MaxItems
and Marker
parameters. If there are no inline policies embedded with the
specified user, the operation returns an empty list.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9065 9066 9067 9068 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 9065 def list_user_policies(params = {}, = {}) req = build_request(:list_user_policies, params) req.send_request() end |
#list_user_tags(params = {}) ⇒ Types::ListUserTagsResponse
Lists the tags that are attached to the specified IAM user. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9159 9160 9161 9162 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 9159 def (params = {}, = {}) req = build_request(:list_user_tags, params) req.send_request() end |
#list_users(params = {}) ⇒ Types::ListUsersResponse
Lists the IAM users that have the specified path prefix. If no path prefix is specified, the operation returns all users in the Amazon Web Services account. If there are none, the operation returns an empty list.
PermissionsBoundary
Tags
To view all of the information for a user, see GetUser.
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.
9286 9287 9288 9289 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 9286 def list_users(params = {}, = {}) req = build_request(:list_users, params) req.send_request() end |
#list_virtual_mfa_devices(params = {}) ⇒ Types::ListVirtualMFADevicesResponse
Lists the virtual MFA devices defined in the Amazon Web Services
account by assignment status. If you do not specify an assignment
status, the operation returns a list of all virtual MFA devices.
Assignment status can be Assigned
, Unassigned
, or Any
.
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.
9393 9394 9395 9396 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 9393 def list_virtual_mfa_devices(params = {}, = {}) req = build_request(:list_virtual_mfa_devices, params) req.send_request() end |
#put_group_policy(params = {}) ⇒ Struct
Adds or updates an inline policy document that is embedded in the specified IAM group.
A user can also have managed policies attached to it. To attach a
managed policy to a group, use AttachGroupPolicy
. To create a
new managed policy, use CreatePolicy
. For information about
policies, see Managed policies and inline policies in the IAM
User Guide.
For information about the maximum number of inline policies that you can embed in a group, see IAM and STS quotas in the IAM User Guide.
PutGroupPolicy
. For general information about using
the Query API with IAM, see Making query requests in the IAM
User Guide.
9499 9500 9501 9502 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 9499 def put_group_policy(params = {}, = {}) req = build_request(:put_group_policy, params) req.send_request() end |
#put_role_permissions_boundary(params = {}) ⇒ Struct
Adds or updates the policy that is specified as the IAM role's permissions boundary. You can use an Amazon Web Services managed policy or a customer managed policy to set the boundary for a role. Use the boundary to control the maximum permissions that the role can have. Setting a permissions boundary is an advanced feature that can affect the permissions for the role.
You cannot set the boundary for a service-linked role.
Policies used as permissions boundaries do not provide permissions. You must also attach a permissions policy to the role. To learn how the effective permissions for a role are evaluated, see IAM JSON policy evaluation logic in the IAM User Guide.
9558 9559 9560 9561 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 9558 def (params = {}, = {}) req = build_request(:put_role_permissions_boundary, params) req.send_request() end |
#put_role_policy(params = {}) ⇒ Struct
Adds or updates an inline policy document that is embedded in the specified IAM role.
When you embed an inline policy in a role, the inline policy is used
as part of the role's access (permissions) policy. The role's trust
policy is created at the same time as the role, using CreateRole
. You can update a role's trust policy using
UpdateAssumeRolePolicy
. For more information about roles, see
IAM roles in the IAM User Guide.
A role can also have a managed policy attached to it. To attach a
managed policy to a role, use AttachRolePolicy
. To create a
new managed policy, use CreatePolicy
. For information about
policies, see Managed policies and inline policies in the IAM
User Guide.
For information about the maximum number of inline policies that you can embed with a role, see IAM and STS quotas in the IAM User Guide.
PutRolePolicy
. For general information about using
the Query API with IAM, see Making query requests in the IAM
User Guide.
9674 9675 9676 9677 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 9674 def put_role_policy(params = {}, = {}) req = build_request(:put_role_policy, params) req.send_request() end |
#put_user_permissions_boundary(params = {}) ⇒ Struct
Adds or updates the policy that is specified as the IAM user's permissions boundary. You can use an Amazon Web Services managed policy or a customer managed policy to set the boundary for a user. Use the boundary to control the maximum permissions that the user can have. Setting a permissions boundary is an advanced feature that can affect the permissions for the user.
Policies that are used as permissions boundaries do not provide permissions. You must also attach a permissions policy to the user. To learn how the effective permissions for a user are evaluated, see IAM JSON policy evaluation logic in the IAM User Guide.
9731 9732 9733 9734 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 9731 def (params = {}, = {}) req = build_request(:put_user_permissions_boundary, params) req.send_request() end |
#put_user_policy(params = {}) ⇒ Struct
Adds or updates an inline policy document that is embedded in the specified IAM user.
An IAM user can also have a managed policy attached to it. To attach a
managed policy to a user, use AttachUserPolicy
. To create a
new managed policy, use CreatePolicy
. For information about
policies, see Managed policies and inline policies in the IAM
User Guide.
For information about the maximum number of inline policies that you can embed in a user, see IAM and STS quotas in the IAM User Guide.
PutUserPolicy
. For general information about using
the Query API with IAM, see Making query requests in the IAM
User Guide.
9837 9838 9839 9840 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 9837 def put_user_policy(params = {}, = {}) req = build_request(:put_user_policy, params) req.send_request() end |
#remove_client_id_from_open_id_connect_provider(params = {}) ⇒ Struct
Removes the specified client ID (also known as audience) from the list of client IDs registered for the specified IAM OpenID Connect (OIDC) provider resource object.
This operation is idempotent; it does not fail or return an error if you try to remove a client ID that does not exist.
9879 9880 9881 9882 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 9879 def remove_client_id_from_open_id_connect_provider(params = {}, = {}) req = build_request(:remove_client_id_from_open_id_connect_provider, params) req.send_request() end |
#remove_role_from_instance_profile(params = {}) ⇒ Struct
Removes the specified IAM role from the specified Amazon EC2 instance profile.
Make sure that you do not have any Amazon EC2 instances running with the role you are about to remove from the instance profile. Removing a role from an instance profile that is associated with a running instance might break any applications running on the instance.
For more information about roles, see IAM roles in the IAM User Guide. For more information about instance profiles, see Using instance profiles in the IAM User Guide.
9948 9949 9950 9951 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 9948 def remove_role_from_instance_profile(params = {}, = {}) req = build_request(:remove_role_from_instance_profile, params) req.send_request() end |
#remove_user_from_group(params = {}) ⇒ Struct
Removes the specified user from the specified group.
10002 10003 10004 10005 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 10002 def remove_user_from_group(params = {}, = {}) req = build_request(:remove_user_from_group, params) req.send_request() end |
#reset_service_specific_credential(params = {}) ⇒ Types::ResetServiceSpecificCredentialResponse
Resets the password for a service-specific credential. The new password is Amazon Web Services generated and cryptographically strong. It cannot be configured by the user. Resetting the password immediately invalidates the previous password associated with this user.
10063 10064 10065 10066 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 10063 def reset_service_specific_credential(params = {}, = {}) req = build_request(:reset_service_specific_credential, params) req.send_request() end |
#resync_mfa_device(params = {}) ⇒ Struct
Synchronizes the specified MFA device with its IAM resource object on the Amazon Web Services servers.
For more information about creating and working with virtual MFA devices, see Using a virtual MFA device in the IAM User Guide.
10127 10128 10129 10130 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 10127 def resync_mfa_device(params = {}, = {}) req = build_request(:resync_mfa_device, params) req.send_request() end |
#set_default_policy_version(params = {}) ⇒ Struct
Sets the specified version of the specified policy as the policy's default (operative) version.
This operation affects all users, groups, and roles that the policy is attached to. To list the users, groups, and roles that the policy is attached to, use ListEntitiesForPolicy.
For information about managed policies, see Managed policies and inline policies in the IAM User Guide.
10180 10181 10182 10183 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 10180 def set_default_policy_version(params = {}, = {}) req = build_request(:set_default_policy_version, params) req.send_request() end |
#set_security_token_service_preferences(params = {}) ⇒ Struct
Sets the specified version of the global endpoint token as the token version used for the Amazon Web Services account.
By default, Security Token Service (STS) is available as a global
service, and all STS requests go to a single endpoint at
https://sts.amazonaws.com
. Amazon Web Services recommends using
Regional STS endpoints to reduce latency, build in redundancy, and
increase session token availability. For information about Regional
endpoints for STS, see Security Token Service endpoints and
quotas in the Amazon Web Services General Reference.
If you make an STS call to the global endpoint, the resulting session tokens might be valid in some Regions but not others. It depends on the version that is set in this operation. Version 1 tokens are valid only in Amazon Web Services Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens. For information, see Activating and deactivating STS in an Amazon Web Services Region in the IAM User Guide.
To view the current session token version, see the
GlobalEndpointTokenVersion
entry in the response of the
GetAccountSummary operation.
10252 10253 10254 10255 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 10252 def set_security_token_service_preferences(params = {}, = {}) req = build_request(:set_security_token_service_preferences, params) req.send_request() end |
#simulate_custom_policy(params = {}) ⇒ Types::SimulatePolicyResponse
Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API operations and Amazon Web Services resources to determine the policies' effective permissions. The policies are provided as strings.
The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations. You can simulate resources that don't exist in your account.
If you want to simulate existing policies that are attached to an IAM user, group, or role, use SimulatePrincipalPolicy instead.
Context keys are variables that are maintained by Amazon Web Services
and its services and which provide details about the context of an API
query request. You can use the Condition
element of an IAM policy to
evaluate context keys. To get the list of context keys that the
policies require for correct simulation, use
GetContextKeysForCustomPolicy.
If the output is long, you can use MaxItems
and Marker
parameters
to paginate the results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10587 10588 10589 10590 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 10587 def simulate_custom_policy(params = {}, = {}) req = build_request(:simulate_custom_policy, params) req.send_request() end |
#simulate_principal_policy(params = {}) ⇒ Types::SimulatePolicyResponse
Simulate how a set of IAM policies attached to an IAM entity works with a list of API operations and Amazon Web Services resources to determine the policies' effective permissions. The entity can be an IAM user, group, or role. If you specify a user, then the simulation also includes all of the policies that are attached to groups that the user belongs to. You can simulate resources that don't exist in your account.
You can optionally include a list of one or more additional policies specified as strings to include in the simulation. If you want to simulate only policies specified as strings, use SimulateCustomPolicy instead.
You can also optionally include one resource-based policy to be evaluated with each of the resources included in the simulation for IAM users only.
The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations.
Note: This operation discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use SimulateCustomPolicy instead.
Context keys are variables maintained by Amazon Web Services and its
services that provide details about the context of an API query
request. You can use the Condition
element of an IAM policy to
evaluate context keys. To get the list of context keys that the
policies require for correct simulation, use
GetContextKeysForPrincipalPolicy.
If the output is long, you can use the MaxItems
and Marker
parameters to paginate the results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10953 10954 10955 10956 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 10953 def simulate_principal_policy(params = {}, = {}) req = build_request(:simulate_principal_policy, params) req.send_request() end |
#tag_instance_profile(params = {}) ⇒ Struct
Adds one or more tags to an IAM instance profile. If a tag with the same key name already exists, then that tag is overwritten with the new value.
Each tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM instance profile that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
- Amazon Web Services always interprets the tag
Value
as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
11028 11029 11030 11031 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 11028 def tag_instance_profile(params = {}, = {}) req = build_request(:tag_instance_profile, params) req.send_request() end |
#tag_mfa_device(params = {}) ⇒ Struct
Adds one or more tags to an IAM virtual multi-factor authentication (MFA) device. If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM virtual MFA device that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
- Amazon Web Services always interprets the tag
Value
as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
11105 11106 11107 11108 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 11105 def tag_mfa_device(params = {}, = {}) req = build_request(:tag_mfa_device, params) req.send_request() end |
#tag_open_id_connect_provider(params = {}) ⇒ Struct
Adds one or more tags to an OpenID Connect (OIDC)-compatible identity provider. For more information about these providers, see About web identity federation. If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM identity-based and resource-based policies. You can use tags to restrict access to only an OIDC provider that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
- Amazon Web Services always interprets the tag
Value
as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
11183 11184 11185 11186 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 11183 def tag_open_id_connect_provider(params = {}, = {}) req = build_request(:tag_open_id_connect_provider, params) req.send_request() end |
#tag_policy(params = {}) ⇒ Struct
Adds one or more tags to an IAM customer managed policy. If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM customer managed policy that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
- Amazon Web Services always interprets the tag
Value
as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
11260 11261 11262 11263 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 11260 def tag_policy(params = {}, = {}) req = build_request(:tag_policy, params) req.send_request() end |
#tag_role(params = {}) ⇒ Struct
Adds one or more tags to an IAM role. The role can be a regular role or a service-linked role. If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM role that has a specified tag attached. You can also restrict access to only those resources that have a certain tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
Cost allocation - Use tags to help track which individuals and teams are using which Amazon Web Services resources.
- Amazon Web Services always interprets the tag
Value
as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
For more information about tagging, see Tagging IAM identities in the IAM User Guide.
11361 11362 11363 11364 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 11361 def tag_role(params = {}, = {}) req = build_request(:tag_role, params) req.send_request() end |
#tag_saml_provider(params = {}) ⇒ Struct
Adds one or more tags to a Security Assertion Markup Language (SAML) identity provider. For more information about these providers, see About SAML 2.0-based federation . If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only a SAML identity provider that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
- Amazon Web Services always interprets the tag
Value
as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
11439 11440 11441 11442 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 11439 def tag_saml_provider(params = {}, = {}) req = build_request(:tag_saml_provider, params) req.send_request() end |
#tag_server_certificate(params = {}) ⇒ Struct
Adds one or more tags to an IAM server certificate. If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only a server certificate that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
Cost allocation - Use tags to help track which individuals and teams are using which Amazon Web Services resources.
- Amazon Web Services always interprets the tag
Value
as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
11526 11527 11528 11529 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 11526 def tag_server_certificate(params = {}, = {}) req = build_request(:tag_server_certificate, params) req.send_request() end |
#tag_user(params = {}) ⇒ Struct
Adds one or more tags to an IAM user. If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM identity-based and resource-based policies. You can use tags to restrict access to only an IAM requesting user that has a specified tag attached. You can also restrict access to only those resources that have a certain tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
Cost allocation - Use tags to help track which individuals and teams are using which Amazon Web Services resources.
- Amazon Web Services always interprets the tag
Value
as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
For more information about tagging, see Tagging IAM identities in the IAM User Guide.
11627 11628 11629 11630 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 11627 def tag_user(params = {}, = {}) req = build_request(:tag_user, params) req.send_request() end |
#untag_instance_profile(params = {}) ⇒ Struct
Removes the specified tags from the IAM instance profile. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
11670 11671 11672 11673 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 11670 def untag_instance_profile(params = {}, = {}) req = build_request(:untag_instance_profile, params) req.send_request() end |
#untag_mfa_device(params = {}) ⇒ Struct
Removes the specified tags from the IAM virtual multi-factor authentication (MFA) device. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
11714 11715 11716 11717 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 11714 def untag_mfa_device(params = {}, = {}) req = build_request(:untag_mfa_device, params) req.send_request() end |
#untag_open_id_connect_provider(params = {}) ⇒ Struct
Removes the specified tags from the specified OpenID Connect (OIDC)-compatible identity provider in IAM. For more information about OIDC providers, see About web identity federation. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
11760 11761 11762 11763 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 11760 def untag_open_id_connect_provider(params = {}, = {}) req = build_request(:untag_open_id_connect_provider, params) req.send_request() end |
#untag_policy(params = {}) ⇒ Struct
Removes the specified tags from the customer managed policy. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
11803 11804 11805 11806 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 11803 def untag_policy(params = {}, = {}) req = build_request(:untag_policy, params) req.send_request() end |
#untag_role(params = {}) ⇒ Struct
Removes the specified tags from the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
11856 11857 11858 11859 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 11856 def untag_role(params = {}, = {}) req = build_request(:untag_role, params) req.send_request() end |
#untag_saml_provider(params = {}) ⇒ Struct
Removes the specified tags from the specified Security Assertion Markup Language (SAML) identity provider in IAM. For more information about these providers, see About web identity federation. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
11902 11903 11904 11905 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 11902 def untag_saml_provider(params = {}, = {}) req = build_request(:untag_saml_provider, params) req.send_request() end |
#untag_server_certificate(params = {}) ⇒ Struct
Removes the specified tags from the IAM server certificate. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
11954 11955 11956 11957 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 11954 def untag_server_certificate(params = {}, = {}) req = build_request(:untag_server_certificate, params) req.send_request() end |
#untag_user(params = {}) ⇒ Struct
Removes the specified tags from the user. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
12007 12008 12009 12010 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 12007 def untag_user(params = {}, = {}) req = build_request(:untag_user, params) req.send_request() end |
#update_access_key(params = {}) ⇒ Struct
Changes the status of the specified access key from Active to Inactive, or vice versa. This operation can be used to disable a user's key as part of a key rotation workflow.
If the UserName
is not specified, the user name is determined
implicitly based on the Amazon Web Services access key ID used to sign
the request. If a temporary access key is used, then UserName
is
required. If a long-term key is assigned to the user, then UserName
is not required. This operation works for access keys under the Amazon
Web Services account. Consequently, you can use this operation to
manage Amazon Web Services account root user credentials even if the
Amazon Web Services account has no associated users.
For information about rotating keys, see Managing keys and certificates in the IAM User Guide.
12086 12087 12088 12089 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 12086 def update_access_key(params = {}, = {}) req = build_request(:update_access_key, params) req.send_request() end |
#update_account_password_policy(params = {}) ⇒ Struct
Updates the password policy settings for the Amazon Web Services account.
For more information about using a password policy, see Managing an IAM password policy in the IAM User Guide.
12234 12235 12236 12237 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 12234 def update_account_password_policy(params = {}, = {}) req = build_request(:update_account_password_policy, params) req.send_request() end |
#update_assume_role_policy(params = {}) ⇒ Struct
Updates the policy that grants an IAM entity permission to assume a role. This is typically referred to as the "role trust policy". For more information about roles, see Using roles to delegate permissions and federate identities.
12307 12308 12309 12310 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 12307 def update_assume_role_policy(params = {}, = {}) req = build_request(:update_assume_role_policy, params) req.send_request() end |
#update_group(params = {}) ⇒ Struct
Updates the name and/or the path of the specified IAM group.
You should understand the implications of changing a group's path or name. For more information, see Renaming users and groups in the IAM User Guide.
Managers
to MGRs
, the principal must
have a policy that allows them to update both groups. If the principal
has permission to update the Managers
group, but not the MGRs
group, then the update fails. For more information about permissions,
see Access management.
12393 12394 12395 12396 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 12393 def update_group(params = {}, = {}) req = build_request(:update_group, params) req.send_request() end |
#update_login_profile(params = {}) ⇒ Struct
Changes the password for the specified IAM user. You can use the CLI, the Amazon Web Services API, or the Users page in the IAM console to change the password for any IAM user. Use ChangePassword to change your own password in the My Security Credentials page in the Amazon Web Services Management Console.
For more information about modifying passwords, see Managing passwords in the IAM User Guide.
12474 12475 12476 12477 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 12474 def update_login_profile(params = {}, = {}) req = build_request(:update_login_profile, params) req.send_request() end |
#update_open_id_connect_provider_thumbprint(params = {}) ⇒ Struct
Replaces the existing list of server certificate thumbprints associated with an OpenID Connect (OIDC) provider resource object with a new list of thumbprints.
The list that you pass with this operation completely replaces the existing list of thumbprints. (The lists are not merged.)
Typically, you need to update a thumbprint only when the identity provider certificate changes, which occurs rarely. However, if the provider's certificate does change, any attempt to assume an IAM role that specifies the OIDC provider as a principal fails until the certificate thumbprint is updated.
UpdateOpenIDConnectProviderThumbprint
operation to
highly privileged users.
12540 12541 12542 12543 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 12540 def update_open_id_connect_provider_thumbprint(params = {}, = {}) req = build_request(:update_open_id_connect_provider_thumbprint, params) req.send_request() end |
#update_role(params = {}) ⇒ Struct
Updates the description or maximum session duration setting of a role.
12593 12594 12595 12596 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 12593 def update_role(params = {}, = {}) req = build_request(:update_role, params) req.send_request() end |
#update_role_description(params = {}) ⇒ Types::UpdateRoleDescriptionResponse
Use UpdateRole instead.
Modifies only the description of a role. This operation performs the
same function as the Description
parameter in the UpdateRole
operation.
12643 12644 12645 12646 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 12643 def update_role_description(params = {}, = {}) req = build_request(:update_role_description, params) req.send_request() end |
#update_saml_provider(params = {}) ⇒ Types::UpdateSAMLProviderResponse
Updates the metadata document for an existing SAML provider resource object.
12696 12697 12698 12699 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 12696 def update_saml_provider(params = {}, = {}) req = build_request(:update_saml_provider, params) req.send_request() end |
#update_server_certificate(params = {}) ⇒ Struct
Updates the name and/or the path of the specified server certificate stored in IAM.
For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.
You should understand the implications of changing a server certificate's path or name. For more information, see Renaming a server certificate in the IAM User Guide.
ProductionCert
to
ProdCert
, the principal must have a policy that allows them to
update both certificates. If the principal has permission to update
the ProductionCert
group, but not the ProdCert
certificate, then
the update fails. For more information about permissions, see Access
management in the IAM User Guide.
12847 12848 12849 12850 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 12847 def update_server_certificate(params = {}, = {}) req = build_request(:update_server_certificate, params) req.send_request() end |
#update_service_specific_credential(params = {}) ⇒ Struct
Sets the status of a service-specific credential to Active
or
Inactive
. Service-specific credentials that are inactive cannot be
used for authentication to the service. This operation can be used to
disable a user's service-specific credential as part of a credential
rotation work flow.
12900 12901 12902 12903 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 12900 def update_service_specific_credential(params = {}, = {}) req = build_request(:update_service_specific_credential, params) req.send_request() end |
#update_signing_certificate(params = {}) ⇒ Struct
Changes the status of the specified user signing certificate from active to disabled, or vice versa. This operation can be used to disable an IAM user's signing certificate as part of a certificate rotation work flow.
If the UserName
field is not specified, the user name is determined
implicitly based on the Amazon Web Services access key ID used to sign
the request. This operation works for access keys under the Amazon Web
Services account. Consequently, you can use this operation to manage
Amazon Web Services account root user credentials even if the Amazon
Web Services account has no associated users.
12970 12971 12972 12973 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 12970 def update_signing_certificate(params = {}, = {}) req = build_request(:update_signing_certificate, params) req.send_request() end |
#update_ssh_public_key(params = {}) ⇒ Struct
Sets the status of an IAM user's SSH public key to active or inactive. SSH public keys that are inactive cannot be used for authentication. This operation can be used to disable a user's SSH public key as part of a key rotation work flow.
The SSH public key affected by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.
12758 12759 12760 12761 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 12758 def update_ssh_public_key(params = {}, = {}) req = build_request(:update_ssh_public_key, params) req.send_request() end |
#update_user(params = {}) ⇒ Struct
Updates the name and/or the path of the specified IAM user.
You should understand the implications of changing an IAM user's path or name. For more information, see Renaming an IAM user and Renaming an IAM group in the IAM User Guide.
13055 13056 13057 13058 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 13055 def update_user(params = {}, = {}) req = build_request(:update_user, params) req.send_request() end |
#upload_server_certificate(params = {}) ⇒ Types::UploadServerCertificateResponse
Uploads a server certificate entity for the Amazon Web Services account. The server certificate entity includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded.
We recommend that you use Certificate Manager to provision, manage, and deploy your server certificates. With ACM you can request a certificate, deploy it to Amazon Web Services resources, and let ACM handle certificate renewals for you. Certificates provided by ACM are free. For more information about using ACM, see the Certificate Manager User Guide.
For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.
For information about the number of server certificates you can upload, see IAM and STS quotas in the IAM User Guide.
UploadServerCertificate
. For information about setting
up signatures and authorization through the API, see Signing Amazon
Web Services API requests in the Amazon Web Services General
Reference. For general information about using the Query API with
IAM, see Calling the API by making HTTP query requests in the
IAM User Guide.
13348 13349 13350 13351 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 13348 def upload_server_certificate(params = {}, = {}) req = build_request(:upload_server_certificate, params) req.send_request() end |
#upload_signing_certificate(params = {}) ⇒ Types::UploadSigningCertificateResponse
Uploads an X.509 signing certificate and associates it with the
specified IAM user. Some Amazon Web Services services require you to
use certificates to validate requests that are signed with a
corresponding private key. When you upload the certificate, its
default status is Active
.
For information about when you would use an X.509 signing certificate, see Managing server certificates in IAM in the IAM User Guide.
If the UserName
is not specified, the IAM user name is determined
implicitly based on the Amazon Web Services access key ID used to sign
the request. This operation works for access keys under the Amazon Web
Services account. Consequently, you can use this operation to manage
Amazon Web Services account root user credentials even if the Amazon
Web Services account has no associated users.
UploadSigningCertificate
. For
information about setting up signatures and authorization through the
API, see Signing Amazon Web Services API requests in the Amazon
Web Services General Reference. For general information about using
the Query API with IAM, see Making query requests in the IAM
User Guide.
13460 13461 13462 13463 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 13460 def upload_signing_certificate(params = {}, = {}) req = build_request(:upload_signing_certificate, params) req.send_request() end |
#upload_ssh_public_key(params = {}) ⇒ Types::UploadSSHPublicKeyResponse
Uploads an SSH public key and associates it with the specified IAM user.
The SSH public key uploaded by this operation can be used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.
13131 13132 13133 13134 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 13131 def upload_ssh_public_key(params = {}, = {}) req = build_request(:upload_ssh_public_key, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Basic Usage
A waiter will call an API operation until:
- It is successful
- It enters a terminal state
- It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success
or :failure
from these callbacks,
it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
Valid Waiters
The following table lists the valid waiter names, the operations they call,
and the default :delay
and :max_attempts
values.
waiter_name | params | :delay | :max_attempts |
---|---|---|---|
instance_profile_exists | #get_instance_profile | 1 | 40 |
policy_exists | #get_policy | 1 | 20 |
role_exists | #get_role | 1 | 20 |
user_exists | #get_user | 1 | 20 |
13573 13574 13575 13576 13577 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 13573 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |