Learn R Programming

paws.security.identity (version 0.7.0)

iam: AWS Identity and Access Management

Description

Identity and Access Management

Identity and Access Management (IAM) is a web service for securely controlling access to Amazon Web Services services. With IAM, you can centrally manage users, security credentials such as access keys, and permissions that control which Amazon Web Services resources users and applications can access. For more information about IAM, see Identity and Access Management (IAM) and the Identity and Access Management User Guide.

Usage

iam(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

  • credentials:

    • creds:

      • access_key_id: AWS access key ID

      • secret_access_key: AWS secret access key

      • session_token: AWS temporary session token

    • profile: The name of a profile to use. If not given, then the default profile is used.

    • anonymous: Set anonymous credentials.

  • endpoint: The complete URL to use for the constructed client.

  • region: The AWS Region used in instantiating the client.

  • close_connection: Immediately close all HTTP connections.

  • timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

  • s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.

  • sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Service syntax

svc <- iam(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

add_client_id_to_open_id_connect_providerAdds 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_profileAdds the specified IAM role to the specified instance profile
add_user_to_groupAdds the specified user to the specified group
attach_group_policyAttaches the specified managed policy to the specified IAM group
attach_role_policyAttaches the specified managed policy to the specified IAM role
attach_user_policyAttaches the specified managed policy to the specified user
change_passwordChanges the password of the IAM user who is calling this operation
create_access_keyCreates a new Amazon Web Services secret access key and corresponding Amazon Web Services access key ID for the specified user
create_account_aliasCreates an alias for your Amazon Web Services account
create_groupCreates a new group
create_instance_profileCreates a new instance profile
create_login_profileCreates a password for the specified IAM user
create_open_id_connect_providerCreates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC)
create_policyCreates a new managed policy for your Amazon Web Services account
create_policy_versionCreates a new version of the specified managed policy
create_roleCreates a new role for your Amazon Web Services account
create_saml_providerCreates an IAM resource that describes an identity provider (IdP) that supports SAML 2
create_service_linked_roleCreates an IAM role that is linked to a specific Amazon Web Services service
create_service_specific_credentialGenerates a set of credentials consisting of a user name and password that can be used to access the service specified in the request
create_userCreates a new IAM user for your Amazon Web Services account
create_virtual_mfa_deviceCreates a new virtual MFA device for the Amazon Web Services account
deactivate_mfa_deviceDeactivates the specified MFA device and removes it from association with the user name for which it was originally enabled
delete_access_keyDeletes the access key pair associated with the specified IAM user
delete_account_aliasDeletes the specified Amazon Web Services account alias
delete_account_password_policyDeletes the password policy for the Amazon Web Services account
delete_groupDeletes the specified IAM group
delete_group_policyDeletes the specified inline policy that is embedded in the specified IAM group
delete_instance_profileDeletes the specified instance profile
delete_login_profileDeletes the password for the specified IAM user, For more information, see Managing passwords for IAM users
delete_open_id_connect_providerDeletes an OpenID Connect identity provider (IdP) resource object in IAM
delete_policyDeletes the specified managed policy
delete_policy_versionDeletes the specified version from the specified managed policy
delete_roleDeletes the specified role
delete_role_permissions_boundaryDeletes the permissions boundary for the specified IAM role
delete_role_policyDeletes the specified inline policy that is embedded in the specified IAM role
delete_saml_providerDeletes a SAML provider resource in IAM
delete_server_certificateDeletes the specified server certificate
delete_service_linked_roleSubmits a service-linked role deletion request and returns a DeletionTaskId, which you can use to check the status of the deletion
delete_service_specific_credentialDeletes the specified service-specific credential
delete_signing_certificateDeletes a signing certificate associated with the specified IAM user
delete_ssh_public_keyDeletes the specified SSH public key
delete_userDeletes the specified IAM user
delete_user_permissions_boundaryDeletes the permissions boundary for the specified IAM user
delete_user_policyDeletes the specified inline policy that is embedded in the specified IAM user
delete_virtual_mfa_deviceDeletes a virtual MFA device
detach_group_policyRemoves the specified managed policy from the specified IAM group
detach_role_policyRemoves the specified managed policy from the specified role
detach_user_policyRemoves the specified managed policy from the specified user
enable_mfa_deviceEnables the specified MFA device and associates it with the specified IAM user
generate_credential_reportGenerates a credential report for the Amazon Web Services account
generate_organizations_access_reportGenerates a report for service last accessed data for Organizations
generate_service_last_accessed_detailsGenerates 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_usedRetrieves information about when the specified access key was last used
get_account_authorization_detailsRetrieves information about all IAM users, groups, roles, and policies in your Amazon Web Services account, including their relationships to one another
get_account_password_policyRetrieves the password policy for the Amazon Web Services account
get_account_summaryRetrieves information about IAM entity usage and IAM quotas in the Amazon Web Services account
get_context_keys_for_custom_policyGets a list of all of the context keys referenced in the input policies
get_context_keys_for_principal_policyGets a list of all of the context keys referenced in all the IAM policies that are attached to the specified IAM entity
get_credential_reportRetrieves a credential report for the Amazon Web Services account
get_groupReturns a list of IAM users that are in the specified IAM group
get_group_policyRetrieves the specified inline policy document that is embedded in the specified IAM group
get_instance_profileRetrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and role
get_login_profileRetrieves the user name for the specified IAM user
get_mfa_deviceRetrieves information about an MFA device for a specified user
get_open_id_connect_providerReturns information about the specified OpenID Connect (OIDC) provider resource object in IAM
get_organizations_access_reportRetrieves the service last accessed data report for Organizations that was previously generated using the GenerateOrganizationsAccessReport operation
get_policyRetrieves 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_versionRetrieves information about the specified version of the specified managed policy, including the policy document
get_roleRetrieves 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_policyRetrieves the specified inline policy document that is embedded with the specified IAM role
get_saml_providerReturns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated
get_server_certificateRetrieves information about the specified server certificate stored in IAM
get_service_last_accessed_detailsRetrieves a service last accessed report that was created using the GenerateServiceLastAccessedDetails operation
get_service_last_accessed_details_with_entitiesAfter you generate a group or policy report using the GenerateServiceLastAccessedDetails operation, you can use the JobId parameter in GetServiceLastAccessedDetailsWithEntities
get_service_linked_role_deletion_statusRetrieves the status of your service-linked role deletion
get_ssh_public_keyRetrieves the specified SSH public key, including metadata about the key
get_userRetrieves information about the specified IAM user, including the user's creation date, path, unique ID, and ARN
get_user_policyRetrieves the specified inline policy document that is embedded in the specified IAM user
list_access_keysReturns information about the access key IDs associated with the specified IAM user
list_account_aliasesLists the account alias associated with the Amazon Web Services account (Note: you can have only one)
list_attached_group_policiesLists all managed policies that are attached to the specified IAM group
list_attached_role_policiesLists all managed policies that are attached to the specified IAM role
list_attached_user_policiesLists all managed policies that are attached to the specified IAM user
list_entities_for_policyLists all IAM users, groups, and roles that the specified managed policy is attached to
list_group_policiesLists the names of the inline policies that are embedded in the specified IAM group
list_groupsLists the IAM groups that have the specified path prefix
list_groups_for_userLists the IAM groups that the specified IAM user belongs to
list_instance_profilesLists the instance profiles that have the specified path prefix
list_instance_profiles_for_roleLists the instance profiles that have the specified associated IAM role
list_instance_profile_tagsLists the tags that are attached to the specified IAM instance profile
list_mfa_devicesLists the MFA devices for an IAM user
list_mfa_device_tagsLists the tags that are attached to the specified IAM virtual multi-factor authentication (MFA) device
list_open_id_connect_providersLists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the Amazon Web Services account
list_open_id_connect_provider_tagsLists the tags that are attached to the specified OpenID Connect (OIDC)-compatible identity provider
list_policiesLists 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_accessRetrieves a list of policies that the IAM identity (user, group, or role) can use to access each specified service
list_policy_tagsLists the tags that are attached to the specified IAM customer managed policy
list_policy_versionsLists information about the versions of the specified managed policy, including the version that is currently set as the policy's default version
list_role_policiesLists the names of the inline policies that are embedded in the specified IAM role
list_rolesLists the IAM roles that have the specified path prefix
list_role_tagsLists the tags that are attached to the specified role
list_saml_providersLists the SAML provider resource objects defined in IAM in the account
list_saml_provider_tagsLists the tags that are attached to the specified Security Assertion Markup Language (SAML) identity provider
list_server_certificatesLists the server certificates stored in IAM that have the specified path prefix
list_server_certificate_tagsLists the tags that are attached to the specified IAM server certificate
list_service_specific_credentialsReturns information about the service-specific credentials associated with the specified IAM user
list_signing_certificatesReturns information about the signing certificates associated with the specified IAM user
list_ssh_public_keysReturns information about the SSH public keys associated with the specified IAM user
list_user_policiesLists the names of the inline policies embedded in the specified IAM user
list_usersLists the IAM users that have the specified path prefix
list_user_tagsLists the tags that are attached to the specified IAM user
list_virtual_mfa_devicesLists the virtual MFA devices defined in the Amazon Web Services account by assignment status
put_group_policyAdds or updates an inline policy document that is embedded in the specified IAM group
put_role_permissions_boundaryAdds or updates the policy that is specified as the IAM role's permissions boundary
put_role_policyAdds or updates an inline policy document that is embedded in the specified IAM role
put_user_permissions_boundaryAdds or updates the policy that is specified as the IAM user's permissions boundary
put_user_policyAdds or updates an inline policy document that is embedded in the specified IAM user
remove_client_id_from_open_id_connect_providerRemoves 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_profileRemoves the specified IAM role from the specified Amazon EC2 instance profile
remove_user_from_groupRemoves the specified user from the specified group
reset_service_specific_credentialResets the password for a service-specific credential
resync_mfa_deviceSynchronizes the specified MFA device with its IAM resource object on the Amazon Web Services servers
set_default_policy_versionSets the specified version of the specified policy as the policy's default (operative) version
set_security_token_service_preferencesSets the specified version of the global endpoint token as the token version used for the Amazon Web Services account
simulate_custom_policySimulate 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_policySimulate 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_profileAdds one or more tags to an IAM instance profile
tag_mfa_deviceAdds one or more tags to an IAM virtual multi-factor authentication (MFA) device
tag_open_id_connect_providerAdds one or more tags to an OpenID Connect (OIDC)-compatible identity provider
tag_policyAdds one or more tags to an IAM customer managed policy
tag_roleAdds one or more tags to an IAM role
tag_saml_providerAdds one or more tags to a Security Assertion Markup Language (SAML) identity provider
tag_server_certificateAdds one or more tags to an IAM server certificate
tag_userAdds one or more tags to an IAM user
untag_instance_profileRemoves the specified tags from the IAM instance profile
untag_mfa_deviceRemoves the specified tags from the IAM virtual multi-factor authentication (MFA) device
untag_open_id_connect_providerRemoves the specified tags from the specified OpenID Connect (OIDC)-compatible identity provider in IAM
untag_policyRemoves the specified tags from the customer managed policy
untag_roleRemoves the specified tags from the role
untag_saml_providerRemoves the specified tags from the specified Security Assertion Markup Language (SAML) identity provider in IAM
untag_server_certificateRemoves the specified tags from the IAM server certificate
untag_userRemoves the specified tags from the user
update_access_keyChanges the status of the specified access key from Active to Inactive, or vice versa
update_account_password_policyUpdates the password policy settings for the Amazon Web Services account
update_assume_role_policyUpdates the policy that grants an IAM entity permission to assume a role
update_groupUpdates the name and/or the path of the specified IAM group
update_login_profileChanges the password for the specified IAM user
update_open_id_connect_provider_thumbprintReplaces the existing list of server certificate thumbprints associated with an OpenID Connect (OIDC) provider resource object with a new list of thumbprints
update_roleUpdates the description or maximum session duration setting of a role
update_role_descriptionUse UpdateRole instead
update_saml_providerUpdates the metadata document for an existing SAML provider resource object
update_server_certificateUpdates the name and/or the path of the specified server certificate stored in IAM
update_service_specific_credentialSets the status of a service-specific credential to Active or Inactive
update_signing_certificateChanges the status of the specified user signing certificate from active to disabled, or vice versa
update_ssh_public_keySets the status of an IAM user's SSH public key to active or inactive
update_userUpdates the name and/or the path of the specified IAM user
upload_server_certificateUploads a server certificate entity for the Amazon Web Services account
upload_signing_certificateUploads an X
upload_ssh_public_keyUploads an SSH public key and associates it with the specified IAM user

Examples

Run this code
if (FALSE) {
svc <- iam()
# The following add-client-id-to-open-id-connect-provider command adds the
# client ID my-application-ID to the OIDC provider named
# server.example.com:
svc$add_client_id_to_open_id_connect_provider(
  ClientID = "my-application-ID",
  OpenIDConnectProviderArn = "arn:aws:iam::123456789012:oidc-provider/server.example.com"
)
}

Run the code above in your browser using DataLab