Client

iam	R Documentation

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)

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.

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.

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¶

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: Adds the specified IAM role to the specified instance profile
add_user_to_group: Adds the specified user to the specified group
attach_group_policy: Attaches the specified managed policy to the specified IAM group
attach_role_policy: Attaches the specified managed policy to the specified IAM role
attach_user_policy: Attaches the specified managed policy to the specified user
change_password: Changes the password of the IAM user who is calling this operation
create_access_key: Creates a new Amazon Web Services secret access key and corresponding Amazon Web Services access key ID for the specified user
create_account_alias: Creates an alias for your Amazon Web Services account
create_group: Creates a new group
create_instance_profile: Creates a new instance profile
create_login_profile: Creates a password for the specified IAM user
create_open_id_connect_provider: Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC)
create_policy: Creates a new managed policy for your Amazon Web Services account
create_policy_version: Creates a new version of the specified managed policy
create_role: Creates a new role for your Amazon Web Services account
create_saml_provider: Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2
create_service_linked_role: Creates an IAM role that is linked to a specific Amazon Web Services service
create_service_specific_credential: 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: Creates a new IAM user for your Amazon Web Services account
create_virtual_mfa_device: Creates a new virtual MFA device for the Amazon Web Services account
deactivate_mfa_device: Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled
delete_access_key: Deletes the access key pair associated with the specified IAM user
delete_account_alias: Deletes the specified Amazon Web Services account alias
delete_account_password_policy: Deletes the password policy for the Amazon Web Services account
delete_group: Deletes the specified IAM group
delete_group_policy: Deletes the specified inline policy that is embedded in the specified IAM group
delete_instance_profile: Deletes the specified instance profile
delete_login_profile: Deletes the password for the specified IAM user, For more information, see Managing passwords for IAM users
delete_open_id_connect_provider: Deletes an OpenID Connect identity provider (IdP) resource object in IAM
delete_policy: Deletes the specified managed policy
delete_policy_version: Deletes the specified version from the specified managed policy
delete_role: Deletes the specified role
delete_role_permissions_boundary: Deletes the permissions boundary for the specified IAM role
delete_role_policy: Deletes the specified inline policy that is embedded in the specified IAM role
delete_saml_provider: Deletes a SAML provider resource in IAM
delete_server_certificate: Deletes the specified server certificate
delete_service_linked_role: 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: Deletes the specified service-specific credential
delete_signing_certificate: Deletes a signing certificate associated with the specified IAM user
delete_ssh_public_key: Deletes the specified SSH public key
delete_user: Deletes the specified IAM user
delete_user_permissions_boundary: Deletes the permissions boundary for the specified IAM user
delete_user_policy: Deletes the specified inline policy that is embedded in the specified IAM user
delete_virtual_mfa_device: Deletes a virtual MFA device
detach_group_policy: Removes the specified managed policy from the specified IAM group
detach_role_policy: Removes the specified managed policy from the specified role
detach_user_policy: Removes the specified managed policy from the specified user
enable_mfa_device: Enables the specified MFA device and associates it with the specified IAM user
generate_credential_report: Generates a credential report for the Amazon Web Services account
generate_organizations_access_report: Generates a report for service last accessed data for Organizations; 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: Retrieves information about when the specified access key was last used
get_account_authorization_details: 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: Retrieves the password policy for the Amazon Web Services account
get_account_summary: Retrieves information about IAM entity usage and IAM quotas in the Amazon Web Services account
get_context_keys_for_custom_policy: Gets a list of all of the context keys referenced in the input policies
get_context_keys_for_principal_policy: 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: Retrieves a credential report for the Amazon Web Services account
get_group: Returns a list of IAM users that are in the specified IAM group
get_group_policy: Retrieves the specified inline policy document that is embedded in the specified IAM group
get_instance_profile: Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and role
get_login_profile: Retrieves the user name for the specified IAM user
get_mfa_device: Retrieves information about an MFA device for a specified user
get_open_id_connect_provider: Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM
get_organizations_access_report: Retrieves the service last accessed data report for Organizations that was previously generated using the GenerateOrganizationsAccessReport operation
get_policy: 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: Retrieves information about the specified version of the specified managed policy, including the policy document
get_role: 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: Retrieves the specified inline policy document that is embedded with the specified IAM role
get_saml_provider: Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated
get_server_certificate: Retrieves information about the specified server certificate stored in IAM
get_service_last_accessed_details: Retrieves a service last accessed report that was created using the GenerateServiceLastAccessedDetails operation; After you generate a group or policy report using the GenerateServiceLastAccessedDetails operation, you can use the JobId parameter in GetServiceLastAccessedDetailsWithEntities; Retrieves the status of your service-linked role deletion
get_ssh_public_key: Retrieves the specified SSH public key, including metadata about the key
get_user: Retrieves information about the specified IAM user, including the user's creation date, path, unique ID, and ARN
get_user_policy: Retrieves the specified inline policy document that is embedded in the specified IAM user
list_access_keys: Returns information about the access key IDs associated with the specified IAM user
list_account_aliases: Lists the account alias associated with the Amazon Web Services account (Note: you can have only one)
list_attached_group_policies: Lists all managed policies that are attached to the specified IAM group
list_attached_role_policies: Lists all managed policies that are attached to the specified IAM role
list_attached_user_policies: Lists all managed policies that are attached to the specified IAM user
list_entities_for_policy: Lists all IAM users, groups, and roles that the specified managed policy is attached to
list_group_policies: Lists the names of the inline policies that are embedded in the specified IAM group
list_groups: Lists the IAM groups that have the specified path prefix
list_groups_for_user: Lists the IAM groups that the specified IAM user belongs to
list_instance_profiles: Lists the instance profiles that have the specified path prefix
list_instance_profiles_for_role: Lists the instance profiles that have the specified associated IAM role
list_instance_profile_tags: Lists the tags that are attached to the specified IAM instance profile
list_mfa_devices: Lists the MFA devices for an IAM user
list_mfa_device_tags: Lists the tags that are attached to the specified IAM virtual multi-factor authentication (MFA) device
list_open_id_connect_providers: Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the Amazon Web Services account
list_open_id_connect_provider_tags: Lists the tags that are attached to the specified OpenID Connect (OIDC)-compatible identity provider
list_policies: 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: Retrieves a list of policies that the IAM identity (user, group, or role) can use to access each specified service
list_policy_tags: Lists the tags that are attached to the specified IAM customer managed policy
list_policy_versions: 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: Lists the names of the inline policies that are embedded in the specified IAM role
list_roles: Lists the IAM roles that have the specified path prefix
list_role_tags: Lists the tags that are attached to the specified role
list_saml_providers: Lists the SAML provider resource objects defined in IAM in the account
list_saml_provider_tags: Lists the tags that are attached to the specified Security Assertion Markup Language (SAML) identity provider
list_server_certificates: Lists the server certificates stored in IAM that have the specified path prefix
list_server_certificate_tags: Lists the tags that are attached to the specified IAM server certificate
list_service_specific_credentials: Returns information about the service-specific credentials associated with the specified IAM user
list_signing_certificates: Returns information about the signing certificates associated with the specified IAM user
list_ssh_public_keys: Returns information about the SSH public keys associated with the specified IAM user
list_user_policies: Lists the names of the inline policies embedded in the specified IAM user
list_users: Lists the IAM users that have the specified path prefix
list_user_tags: Lists the tags that are attached to the specified IAM user
list_virtual_mfa_devices: Lists the virtual MFA devices defined in the Amazon Web Services account by assignment status
put_group_policy: Adds or updates an inline policy document that is embedded in the specified IAM group
put_role_permissions_boundary: Adds or updates the policy that is specified as the IAM role's permissions boundary
put_role_policy: Adds or updates an inline policy document that is embedded in the specified IAM role
put_user_permissions_boundary: Adds or updates the policy that is specified as the IAM user's permissions boundary
put_user_policy: Adds or updates an inline policy document that is embedded in the specified IAM user; 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: Removes the specified IAM role from the specified Amazon EC2 instance profile
remove_user_from_group: Removes the specified user from the specified group
reset_service_specific_credential: Resets the password for a service-specific credential
resync_mfa_device: Synchronizes the specified MFA device with its IAM resource object on the Amazon Web Services servers
set_default_policy_version: Sets the specified version of the specified policy as the policy's default (operative) version; Sets the specified version of the global endpoint token as the token version used for the Amazon Web Services account
simulate_custom_policy: 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: 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: Adds one or more tags to an IAM instance profile
tag_mfa_device: Adds one or more tags to an IAM virtual multi-factor authentication (MFA) device
tag_open_id_connect_provider: Adds one or more tags to an OpenID Connect (OIDC)-compatible identity provider
tag_policy: Adds one or more tags to an IAM customer managed policy
tag_role: Adds one or more tags to an IAM role
tag_saml_provider: Adds one or more tags to a Security Assertion Markup Language (SAML) identity provider
tag_server_certificate: Adds one or more tags to an IAM server certificate
tag_user: Adds one or more tags to an IAM user
untag_instance_profile: Removes the specified tags from the IAM instance profile
untag_mfa_device: Removes the specified tags from the IAM virtual multi-factor authentication (MFA) device
untag_open_id_connect_provider: Removes the specified tags from the specified OpenID Connect (OIDC)-compatible identity provider in IAM
untag_policy: Removes the specified tags from the customer managed policy
untag_role: Removes the specified tags from the role
untag_saml_provider: Removes the specified tags from the specified Security Assertion Markup Language (SAML) identity provider in IAM
untag_server_certificate: Removes the specified tags from the IAM server certificate
untag_user: Removes the specified tags from the user
update_access_key: Changes the status of the specified access key from Active to Inactive, or vice versa
update_account_password_policy: Updates the password policy settings for the Amazon Web Services account
update_assume_role_policy: Updates the policy that grants an IAM entity permission to assume a role
update_group: Updates the name and/or the path of the specified IAM group
update_login_profile: Changes the password for the specified IAM user; 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: Updates the description or maximum session duration setting of a role
update_role_description: Use UpdateRole instead
update_saml_provider: Updates the metadata document for an existing SAML provider resource object
update_server_certificate: Updates the name and/or the path of the specified server certificate stored in IAM
update_service_specific_credential: Sets the status of a service-specific credential to Active or Inactive
update_signing_certificate: Changes the status of the specified user signing certificate from active to disabled, or vice versa
update_ssh_public_key: Sets the status of an IAM user's SSH public key to active or inactive
update_user: Updates the name and/or the path of the specified IAM user
upload_server_certificate: Uploads a server certificate entity for the Amazon Web Services account
upload_signing_certificate: Uploads an X
upload_ssh_public_key: Uploads an SSH public key and associates it with the specified IAM user

Examples¶

## Not run: 
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"
)

## End(Not run)