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
-
#accept_delegation_request(params = {}) ⇒ Struct
Accepts a delegation request, granting the requested temporary access.
-
#acquire_role(params = {}) ⇒ Types::AcquireRoleResponse
Creates an IAM role from the specified role template.
-
#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.
-
#associate_delegation_request(params = {}) ⇒ Struct
Associates a delegation request with the current identity.
-
#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_delegation_request(params = {}) ⇒ Types::CreateDelegationRequestResponse
Creates an IAM delegation request for temporary access delegation.
-
#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 or root 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.
-
#disable_organizations_root_credentials_management(params = {}) ⇒ Types::DisableOrganizationsRootCredentialsManagementResponse
Disables the management of privileged root user credentials across member accounts in your organization.
-
#disable_organizations_root_sessions(params = {}) ⇒ Types::DisableOrganizationsRootSessionsResponse
Disables root user sessions for privileged tasks across member accounts in your organization.
-
#disable_outbound_web_identity_federation(params = {}) ⇒ Struct
Disables the outbound identity federation feature for your Amazon Web Services account.
-
#enable_mfa_device(params = {}) ⇒ Struct
Enables the specified MFA device and associates it with the specified IAM user.
-
#enable_organizations_root_credentials_management(params = {}) ⇒ Types::EnableOrganizationsRootCredentialsManagementResponse
Enables the management of privileged root user credentials across member accounts in your organization.
-
#enable_organizations_root_sessions(params = {}) ⇒ Types::EnableOrganizationsRootSessionsResponse
Allows the management account or delegated administrator to perform privileged tasks on member accounts in your organization.
-
#enable_outbound_web_identity_federation(params = {}) ⇒ Types::EnableOutboundWebIdentityFederationResponse
Enables the outbound identity federation feature for your Amazon Web Services account.
-
#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_properties(params = {}) ⇒ Types::GetAccountPropertiesResponse
Retrieves the account-level properties for the caller's 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_delegation_request(params = {}) ⇒ Types::GetDelegationRequestResponse
Retrieves information about a specific delegation request.
-
#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_human_readable_summary(params = {}) ⇒ Types::GetHumanReadableSummaryResponse
Retrieves a human readable summary for a given entity.
-
#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
GenerateOrganizationsAccessReportoperation. -
#get_outbound_web_identity_federation_info(params = {}) ⇒ Types::GetOutboundWebIdentityFederationInfoResponse
Retrieves the configuration information for the outbound identity federation feature in your Amazon Web Services account.
-
#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_role_template_version(params = {}) ⇒ Types::GetRoleTemplateVersionResponse
Retrieves information about a version of the specified role template.
-
#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
GenerateServiceLastAccessedDetailsoperation. -
#get_service_last_accessed_details_with_entities(params = {}) ⇒ Types::GetServiceLastAccessedDetailsWithEntitiesResponse
After you generate a group or policy report using the
GenerateServiceLastAccessedDetailsoperation, you can use theJobIdparameter 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_delegation_requests(params = {}) ⇒ Types::ListDelegationRequestsResponse
Lists delegation requests based on the specified criteria.
-
#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_organizations_features(params = {}) ⇒ Types::ListOrganizationsFeaturesResponse
Lists the centralized root access features enabled for your organization.
-
#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_account_properties(params = {}) ⇒ Struct
Sets account-level properties for the caller's Amazon Web Services account.
-
#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.
-
#reject_delegation_request(params = {}) ⇒ Struct
Rejects a delegation request, denying the requested temporary access.
-
#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.
-
#send_delegation_token(params = {}) ⇒ Struct
Sends the exchange token for an accepted delegation request.
-
#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_delegation_request(params = {}) ⇒ Struct
Updates an existing delegation request with additional information.
-
#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][1] instead.
-
#update_saml_provider(params = {}) ⇒ Types::UpdateSAMLProviderResponse
Updates the metadata document, SAML encryption settings, and private keys for an existing SAML provider.
-
#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
ActiveorInactive. -
#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.
479 480 481 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 479 def initialize(*args) super end |
Instance Method Details
#accept_delegation_request(params = {}) ⇒ Struct
Accepts a delegation request, granting the requested temporary access.
Once the delegation request is accepted, it is eligible to send the exchange token to the partner. The SendDelegationToken API has to be explicitly called to send the delegation token.
At the time of acceptance, IAM records the details and the state of the identity that called this API. This is the identity that gets mapped to the delegated credential.
An accepted request may be rejected before the exchange token is sent to the partner.
517 518 519 520 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 517 def accept_delegation_request(params = {}, = {}) req = build_request(:accept_delegation_request, params) req.send_request() end |
#acquire_role(params = {}) ⇒ Types::AcquireRoleResponse
Creates an IAM role from the specified role template. The new role takes its configuration—including its name, path, trust policy, inline and managed policies, permissions boundary, tags, and maximum session duration—from the role template version that you specify. For more information about roles, see IAM roles in the IAM User Guide.
If the template version defines parameters, use the
ReplacementValues parameter to supply the values that the service
substitutes into the role during creation.
597 598 599 600 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 597 def acquire_role(params = {}, = {}) req = build_request(:acquire_role, params) req.send_request() end |
#add_client_id_to_open_id_connect_provider(params = {}) ⇒ Struct
Adds a new client ID (also known as audience) to the list of client IDs already registered for the specified IAM OpenID Connect (OIDC) provider resource.
This operation is idempotent; it does not fail or return an error if you add an existing client ID to the provider.
646 647 648 649 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 646 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.
When using the iam:AssociatedResourceArn condition in a policy to
restrict the PassRole IAM action, special considerations apply if
the policy is intended to define access for the
AddRoleToInstanceProfile action. In this case, you cannot specify a
Region or instance ID in the EC2 instance ARN. The ARN value must be
arn:aws:ec2:*:CallerAccountId:instance/*. Using any other ARN value
may lead to unexpected evaluation results.
For more information about roles, see IAM roles in the IAM User Guide. For more information about instance profiles, see Using instance profiles in the IAM User Guide.
734 735 736 737 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 734 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.
788 789 790 791 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 788 def add_user_to_group(params = {}, = {}) req = build_request(:add_user_to_group, params) req.send_request() end |
#associate_delegation_request(params = {}) ⇒ Struct
Associates a delegation request with the current identity.
If the partner that created the delegation request has specified the
owner account during creation, only an identity from that owner
account can call the AssociateDelegationRequest API for the
specified delegation request. Once the AssociateDelegationRequest
API call is successful, the ARN of the current calling identity will
be stored as the ownerId of the request.
If the partner that created the delegation request has not specified
the owner account during creation, any caller from any account can
call the AssociateDelegationRequest API for the delegation request.
Once this API call is successful, the ARN of the current calling
identity will be stored as the ownerId and the Amazon Web Services
account ID of the current calling identity will be stored as the
ownerAccount of the request.
For more details, see Managing Permissions for Delegation Requests.
832 833 834 835 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 832 def associate_delegation_request(params = {}, = {}) req = build_request(:associate_delegation_request, 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.
900 901 902 903 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 900 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.
977 978 979 980 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 977 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.
1045 1046 1047 1048 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 1045 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.
1110 1111 1112 1113 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 1110 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.
1193 1194 1195 1196 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 1193 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.
1240 1241 1242 1243 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 1240 def create_account_alias(params = {}, = {}) req = build_request(:create_account_alias, params) req.send_request() end |
#create_delegation_request(params = {}) ⇒ Types::CreateDelegationRequestResponse
Creates an IAM delegation request for temporary access delegation.
This API is not available for general use. In order to use this API, a caller first need to go through an onboarding process described in the partner onboarding documentation.
1369 1370 1371 1372 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 1369 def create_delegation_request(params = {}, = {}) req = build_request(:create_delegation_request, 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.
1453 1454 1455 1456 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 1453 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.
1592 1593 1594 1595 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 1592 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.
1702 1703 1704 1705 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 1702 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.
1889 1890 1891 1892 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 1889 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.
2046 2047 2048 2049 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 2046 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.
2149 2150 2151 2152 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 2149 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.
2356 2357 2358 2359 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 2356 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.
2474 2475 2476 2477 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 2474 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.
2563 2564 2565 2566 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 2563 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 reset the password to a new service-generated value by calling ResetServiceSpecificCredential.
For more information about using service-specific credentials to authenticate to an Amazon Web Services service, refer to the following docs:
For service-specific credentials with CodeCommit, refer to IAM credentials for CodeCommit: Git credentials, SSH keys, and Amazon Web Services access keys in the IAM User Guide.
For service-specific credentials with Amazon Keyspaces (for Apache Cassandra), refer to Use IAM with Amazon Keyspaces (for Apache Cassandra) in the IAM User Guide.
For services that support long-term API keys, refer to API keys for Amazon Web Services services in the IAM User Guide.
2663 2664 2665 2666 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 2663 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.
2793 2794 2795 2796 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 2793 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.
2910 2911 2912 2913 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 2910 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.
2970 2971 2972 2973 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 2970 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.
3031 3032 3033 3034 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3031 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.
3078 3079 3080 3081 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3078 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.
3100 3101 3102 3103 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3100 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.
3132 3133 3134 3135 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3132 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.
3198 3199 3200 3201 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3198 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.
3251 3252 3253 3254 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3251 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 or root user, For more information, see Managing passwords for IAM users.
You can use the CLI, the Amazon Web Services API, or the Users page in the IAM console to delete a password for any IAM user. You can use ChangePassword to update, but not delete, your own password in the My Security Credentials page in the Amazon Web Services Management Console.
Deleting a user's password does not prevent a user from accessing Amazon Web Services through the command line interface or the API. To prevent all user access, you must also either make any access keys inactive or delete them. For more information about making keys inactive or deleting them, see UpdateAccessKey and DeleteAccessKey.
3318 3319 3320 3321 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3318 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.
3355 3356 3357 3358 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3355 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.
3416 3417 3418 3419 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3416 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.
3477 3478 3479 3480 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3477 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.
3543 3544 3545 3546 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3543 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.
3572 3573 3574 3575 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3572 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.
3638 3639 3640 3641 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3638 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.
3673 3674 3675 3676 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3673 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.
3777 3778 3779 3780 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3777 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.
3832 3833 3834 3835 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3832 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.
3879 3880 3881 3882 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3879 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.
3939 3940 3941 3942 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3939 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.
3726 3727 3728 3729 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 3726 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)
4016 4017 4018 4019 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 4016 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.
4043 4044 4045 4046 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 4043 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.
4109 4110 4111 4112 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 4109 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.
4160 4161 4162 4163 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 4160 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.
4213 4214 4215 4216 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 4213 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.
4266 4267 4268 4269 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 4266 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.
4319 4320 4321 4322 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 4319 def detach_user_policy(params = {}, = {}) req = build_request(:detach_user_policy, params) req.send_request() end |
#disable_organizations_root_credentials_management(params = {}) ⇒ Types::DisableOrganizationsRootCredentialsManagementResponse
Disables the management of privileged root user credentials across member accounts in your organization. When you disable this feature, the management account and the delegated administrator for IAM can no longer manage root user credentials for member accounts in your organization.
4362 4363 4364 4365 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 4362 def disable_organizations_root_credentials_management(params = {}, = {}) req = build_request(:disable_organizations_root_credentials_management, params) req.send_request() end |
#disable_organizations_root_sessions(params = {}) ⇒ Types::DisableOrganizationsRootSessionsResponse
Disables root user sessions for privileged tasks across member accounts in your organization. When you disable this feature, the management account and the delegated administrator for IAM can no longer perform privileged tasks on member accounts in your organization.
4404 4405 4406 4407 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 4404 def disable_organizations_root_sessions(params = {}, = {}) req = build_request(:disable_organizations_root_sessions, params) req.send_request() end |
#disable_outbound_web_identity_federation(params = {}) ⇒ Struct
Disables the outbound identity federation feature for your Amazon Web
Services account. When disabled, IAM principals in the account cannot
use the GetWebIdentityToken API to obtain JSON Web Tokens (JWTs) for
authentication with external services. This operation does not affect
tokens that were issued before the feature was disabled.
4421 4422 4423 4424 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 4421 def disable_outbound_web_identity_federation(params = {}, = {}) req = build_request(:disable_outbound_web_identity_federation, 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.
4502 4503 4504 4505 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 4502 def enable_mfa_device(params = {}, = {}) req = build_request(:enable_mfa_device, params) req.send_request() end |
#enable_organizations_root_credentials_management(params = {}) ⇒ Types::EnableOrganizationsRootCredentialsManagementResponse
Enables the management of privileged root user credentials across member accounts in your organization. When you enable root credentials management for centralized root access, the management account and the delegated administrator for IAM can manage root user credentials for member accounts in your organization.
Before you enable centralized root access, you must have an account configured with the following settings:
You must manage your Amazon Web Services accounts in Organizations.
Enable trusted access for Identity and Access Management in Organizations. For details, see IAM and Organizations in the Organizations User Guide.
4561 4562 4563 4564 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 4561 def enable_organizations_root_credentials_management(params = {}, = {}) req = build_request(:enable_organizations_root_credentials_management, params) req.send_request() end |
#enable_organizations_root_sessions(params = {}) ⇒ Types::EnableOrganizationsRootSessionsResponse
Allows the management account or delegated administrator to perform privileged tasks on member accounts in your organization. For more information, see Centrally manage root access for member accounts in the Identity and Access Management User Guide.
Before you enable this feature, you must have an account configured with the following settings:
You must manage your Amazon Web Services accounts in Organizations.
Enable trusted access for Identity and Access Management in Organizations. For details, see IAM and Organizations in the Organizations User Guide.
4620 4621 4622 4623 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 4620 def enable_organizations_root_sessions(params = {}, = {}) req = build_request(:enable_organizations_root_sessions, params) req.send_request() end |
#enable_outbound_web_identity_federation(params = {}) ⇒ Types::EnableOutboundWebIdentityFederationResponse
Enables the outbound identity federation feature for your Amazon Web
Services account. When enabled, IAM principals in your account can use
the GetWebIdentityToken API to obtain JSON Web Tokens (JWTs) for
secure authentication with external services. This operation also
generates a unique issuer URL for your Amazon Web Services account.
4643 4644 4645 4646 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 4643 def enable_outbound_web_identity_federation(params = {}, = {}) req = build_request(:enable_outbound_web_identity_federation, 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.
4670 4671 4672 4673 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 4670 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.
4855 4856 4857 4858 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 4855 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
JobIdreturned byGenerateServiceLastAccessedDetailmust 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.
4980 4981 4982 4983 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 4980 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.
5023 5024 5025 5026 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 5023 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, and some
SDKs do this decoding automatically.
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.
5200 5201 5202 5203 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 5200 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.
5260 5261 5262 5263 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 5260 def get_account_password_policy(params = {}, = {}) req = build_request(:get_account_password_policy, params) req.send_request() end |
#get_account_properties(params = {}) ⇒ Types::GetAccountPropertiesResponse
Retrieves the account-level properties for the caller's Amazon Web Services account. Account properties are configuration settings that control account-wide IAM features such as Role Manager.
The service returns properties as key-value pairs in
Namespace/PropertyName format. Each namespace groups related
configuration settings. Use PutAccountProperties to modify these
properties.
5291 5292 5293 5294 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 5291 def get_account_properties(params = {}, = {}) req = build_request(:get_account_properties, 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.
5359 5360 5361 5362 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 5359 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.
5423 5424 5425 5426 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 5423 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. This operation doesn't return context keys referenced by service control policies (SCPs). Only context keys referenced by the identity-based policies attached to the specified entity, and any additional policies that you provide, are included.
5516 5517 5518 5519 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 5516 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.
5545 5546 5547 5548 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 5545 def get_credential_report(params = {}, = {}) req = build_request(:get_credential_report, params) req.send_request() end |
#get_delegation_request(params = {}) ⇒ Types::GetDelegationRequestResponse
Retrieves information about a specific delegation request.
If a delegation request has no owner or owner account,
GetDelegationRequest for that delegation request can be called by
any account. If the owner account is assigned but there is no owner
id, only identities within that owner account can call
GetDelegationRequest for the delegation request. Once the delegation
request is fully owned, the owner of the request gets a default
permission to get that delegation request. For more details, see
Managing Permissions for Delegation Requests.
5629 5630 5631 5632 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 5629 def get_delegation_request(params = {}, = {}) req = build_request(:get_delegation_request, 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.
5709 5710 5711 5712 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 5709 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, and some
SDKs do this decoding automatically.
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.
5788 5789 5790 5791 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 5788 def get_group_policy(params = {}, = {}) req = build_request(:get_group_policy, params) req.send_request() end |
#get_human_readable_summary(params = {}) ⇒ Types::GetHumanReadableSummaryResponse
Retrieves a human readable summary for a given entity. At this time,
the only supported entity type is delegation-request
This method uses a Large Language Model (LLM) to generate the summary.
If a delegation request has no owner or owner account,
GetHumanReadableSummary for that delegation request can be called by
any account. If the owner account is assigned but there is no owner
id, only identities within that owner account can call
GetHumanReadableSummary for the delegation request to retrieve a
summary of that request. Once the delegation request is fully owned,
the owner of the request gets a default permission to get that
delegation request. For more details, read default permissions
granted to delegation requests. These rules are identical to
GetDelegationRequest API behavior, such that a party who has
permissions to call GetDelegationRequest for a given delegation
request will always be able to retrieve the human readable summary for
that request.
5849 5850 5851 5852 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 5849 def get_human_readable_summary(params = {}, = {}) req = build_request(:get_human_readable_summary, 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
5953 5954 5955 5956 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 5953 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.
6029 6030 6031 6032 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 6029 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.
6073 6074 6075 6076 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 6073 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.
6124 6125 6126 6127 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 6124 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.
6274 6275 6276 6277 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 6274 def get_organizations_access_report(params = {}, = {}) req = build_request(:get_organizations_access_report, params) req.send_request() end |
#get_outbound_web_identity_federation_info(params = {}) ⇒ Types::GetOutboundWebIdentityFederationInfoResponse
Retrieves the configuration information for the outbound identity federation feature in your Amazon Web Services account. The response includes the unique issuer URL for your Amazon Web Services account and the current enabled/disabled status of the feature. Use this operation to obtain the issuer URL that you need to configure trust relationships with external services.
6300 6301 6302 6303 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 6300 def get_outbound_web_identity_federation_info(params = {}, = {}) req = build_request(:get_outbound_web_identity_federation_info, 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
6377 6378 6379 6380 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 6377 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, and some
SDKs do this decoding automatically.
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.
6463 6464 6465 6466 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 6463 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, and some
SDKs do this decoding automatically.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- role_exists
6564 6565 6566 6567 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 6564 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, and some
SDKs do this decoding automatically.
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.
6647 6648 6649 6650 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 6647 def get_role_policy(params = {}, = {}) req = build_request(:get_role_policy, params) req.send_request() end |
#get_role_template_version(params = {}) ⇒ Types::GetRoleTemplateVersionResponse
Retrieves information about a version of the specified role template. Role templates define a reusable configuration—including role name and path patterns, trust policy, inline and managed policies, permissions boundary, tags, and maximum session duration—that you use to create IAM roles with AcquireRole.
If you do not specify a minor version, the service returns the template's default minor version.
6734 6735 6736 6737 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 6734 def get_role_template_version(params = {}, = {}) req = build_request(:get_role_template_version, 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.
6795 6796 6797 6798 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 6795 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.
6924 6925 6926 6927 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 6924 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.
7091 7092 7093 7094 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 7091 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.
7239 7240 7241 7242 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 7239 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.
7288 7289 7290 7291 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 7288 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.
6866 6867 6868 6869 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 6866 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
7366 7367 7368 7369 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 7366 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, and some
SDKs do this decoding automatically.
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.
7445 7446 7447 7448 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 7445 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.
7559 7560 7561 7562 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 7559 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 IAM User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7632 7633 7634 7635 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 7632 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.
7731 7732 7733 7734 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 7731 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.
7830 7831 7832 7833 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 7830 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.
7929 7930 7931 7932 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 7929 def list_attached_user_policies(params = {}, = {}) req = build_request(:list_attached_user_policies, params) req.send_request() end |
#list_delegation_requests(params = {}) ⇒ Types::ListDelegationRequestsResponse
Lists delegation requests based on the specified criteria.
If a delegation request has no owner, even if it is assigned to a
specific account, it will not be part of the ListDelegationRequests
output for that account.
For more details, see Managing Permissions for Delegation Requests.
8017 8018 8019 8020 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 8017 def list_delegation_requests(params = {}, = {}) req = build_request(:list_delegation_requests, 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.
8135 8136 8137 8138 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 8135 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.
8230 8231 8232 8233 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 8230 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.
8340 8341 8342 8343 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 8340 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.
8439 8440 8441 8442 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 8439 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.
8510 8511 8512 8513 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 8510 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.
8623 8624 8625 8626 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 8623 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.
8721 8722 8723 8724 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 8721 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.
8794 8795 8796 8797 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 8794 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.
8866 8867 8868 8869 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 8866 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.
8942 8943 8944 8945 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 8942 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.
8975 8976 8977 8978 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 8975 def list_open_id_connect_providers(params = {}, = {}) req = build_request(:list_open_id_connect_providers, params) req.send_request() end |
#list_organizations_features(params = {}) ⇒ Types::ListOrganizationsFeaturesResponse
Lists the centralized root access features enabled for your organization. For more information, see Centrally manage root access for member accounts.
9019 9020 9021 9022 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 9019 def list_organizations_features(params = {}, = {}) req = build_request(:list_organizations_features, 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.
9155 9156 9157 9158 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 9155 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.
9309 9310 9311 9312 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 9309 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.
9380 9381 9382 9383 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 9380 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.
9454 9455 9456 9457 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 9454 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.
9532 9533 9534 9535 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 9532 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.
9626 9627 9628 9629 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 9626 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.
9735 9736 9737 9738 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 9735 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.
9811 9812 9813 9814 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 9811 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.
9845 9846 9847 9848 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 9845 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.
10008 10009 10010 10011 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 10008 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.
10104 10105 10106 10107 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 10104 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, refer to the following docs:
For service-specific credentials with CodeCommit, refer to IAM credentials for CodeCommit: Git credentials, SSH keys, and Amazon Web Services access keys in the IAM User Guide.
For service-specific credentials with Amazon Keyspaces (for Apache Cassandra), refer to Use IAM with Amazon Keyspaces (for Apache Cassandra) in the IAM User Guide.
For services that support long-term API keys, refer to API keys for Amazon Web Services services in the IAM User Guide.
10203 10204 10205 10206 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 10203 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.
10306 10307 10308 10309 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 10306 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.
9928 9929 9930 9931 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 9928 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.
10384 10385 10386 10387 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 10384 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.
10478 10479 10480 10481 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 10478 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.
10609 10610 10611 10612 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 10609 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.
10720 10721 10722 10723 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 10720 def list_virtual_mfa_devices(params = {}, = {}) req = build_request(:list_virtual_mfa_devices, params) req.send_request() end |
#put_account_properties(params = {}) ⇒ Struct
Sets account-level properties for the caller's Amazon Web Services account. Account properties are configuration settings that control account-wide IAM features such as Role Manager.
Specify properties as key-value pairs in Namespace/PropertyName
format. All properties in a single request must belong to the same
namespace. Use GetAccountProperties to view the current
properties.
10763 10764 10765 10766 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 10763 def put_account_properties(params = {}, = {}) req = build_request(:put_account_properties, 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.
10869 10870 10871 10872 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 10869 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.
10928 10929 10930 10931 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 10928 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.
11044 11045 11046 11047 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 11044 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.
11101 11102 11103 11104 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 11101 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.
11207 11208 11209 11210 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 11207 def put_user_policy(params = {}, = {}) req = build_request(:put_user_policy, params) req.send_request() end |
#reject_delegation_request(params = {}) ⇒ Struct
Rejects a delegation request, denying the requested temporary access.
Once a request is rejected, it cannot be accepted or updated later. Rejected requests expire after 7 days.
When rejecting a request, an optional explanation can be added using
the Notes request parameter.
For more details, see Managing Permissions for Delegation Requests.
11247 11248 11249 11250 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 11247 def reject_delegation_request(params = {}, = {}) req = build_request(:reject_delegation_request, 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.
11294 11295 11296 11297 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 11294 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.
11363 11364 11365 11366 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 11363 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.
11417 11418 11419 11420 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 11417 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.
11481 11482 11483 11484 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 11481 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.
11545 11546 11547 11548 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 11545 def resync_mfa_device(params = {}, = {}) req = build_request(:resync_mfa_device, params) req.send_request() end |
#send_delegation_token(params = {}) ⇒ Struct
Sends the exchange token for an accepted delegation request.
The exchange token is sent to the partner via an asynchronous notification channel, established by the partner.
The delegation request must be in the ACCEPTED state when calling
this API. After the SendDelegationToken API call is successful, the
request transitions to a FINALIZED state and cannot be rolled back.
However, a user may reject an accepted request before the
SendDelegationToken API is called.
For more details, see Managing Permissions for Delegation Requests.
11584 11585 11586 11587 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 11584 def send_delegation_token(params = {}, = {}) req = build_request(:send_delegation_token, 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.
11638 11639 11640 11641 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 11638 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.
11711 11712 11713 11714 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 11711 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.
12073 12074 12075 12076 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 12073 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.
For cross-account simulations, EvalDecisionDetails returns the
decision for each policy type (identity-based policy, resource-based
policy, and permissions boundary). This helps you identify which
policy type is responsible for an allow or deny decision when policies
span multiple accounts.
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.
12483 12484 12485 12486 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 12483 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
Valueas 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.
12558 12559 12560 12561 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 12558 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
Valueas 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.
12635 12636 12637 12638 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 12635 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
Valueas 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.
12713 12714 12715 12716 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 12713 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
Valueas 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.
12790 12791 12792 12793 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 12790 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
Valueas 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.
12891 12892 12893 12894 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 12891 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
Valueas 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.
12969 12970 12971 12972 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 12969 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
Valueas 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.
13056 13057 13058 13059 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 13056 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
Valueas 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.
13157 13158 13159 13160 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 13157 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.
13200 13201 13202 13203 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 13200 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.
13244 13245 13246 13247 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 13244 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.
13290 13291 13292 13293 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 13290 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.
13333 13334 13335 13336 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 13333 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.
13386 13387 13388 13389 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 13386 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.
13432 13433 13434 13435 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 13432 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.
13484 13485 13486 13487 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 13484 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.
13537 13538 13539 13540 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 13537 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.
13616 13617 13618 13619 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 13616 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.
13764 13765 13766 13767 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 13764 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.
13837 13838 13839 13840 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 13837 def update_assume_role_policy(params = {}, = {}) req = build_request(:update_assume_role_policy, params) req.send_request() end |
#update_delegation_request(params = {}) ⇒ Struct
Updates an existing delegation request with additional information.
When the delegation request is updated, it reaches the
PENDING_APPROVAL state.
Once a delegation request has an owner, that owner gets a default permission to update the delegation request. For more details, see Managing Permissions for Delegation Requests.
13873 13874 13875 13876 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 13873 def update_delegation_request(params = {}, = {}) req = build_request(:update_delegation_request, 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.
13959 13960 13961 13962 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 13959 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.
14042 14043 14044 14045 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 14042 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.
14112 14113 14114 14115 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 14112 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.
14165 14166 14167 14168 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 14165 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.
14221 14222 14223 14224 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 14221 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, SAML encryption settings, and private keys for an existing SAML provider. To rotate private keys, add your new private key and then remove the old key in a separate request.
14281 14282 14283 14284 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 14281 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.
14432 14433 14434 14435 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 14432 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.
14485 14486 14487 14488 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 14485 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.
14555 14556 14557 14558 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 14555 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.
14343 14344 14345 14346 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 14343 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.
14640 14641 14642 14643 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 14640 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.
14933 14934 14935 14936 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 14933 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.
15045 15046 15047 15048 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 15045 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.
14716 14717 14718 14719 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 14716 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 |
15163 15164 15165 15166 15167 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/client.rb', line 15163 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |