baiji v0.6.0 Baiji.IAM
AWS Identity and Access Management
AWS Identity and Access Management (IAM) is a web service that you can use to manage users and user permissions under your AWS account. This guide provides descriptions of IAM actions that you can call programmatically. For general information about IAM, see AWS Identity and Access Management (IAM). For the user guide for IAM, see Using IAM.
calls to IAM. However, you can also use the IAM Query API to make direct calls to the IAM web service. To learn more about the IAM Query API, see Making Query Requests in the Using IAM guide. IAM supports GET and POST requests for all actions. That is, the API does not require you to use GET for some actions and POST for others. However, GET requests are subject to the limitation size of a URL. Therefore, for operations that require larger sizes, use a POST request.
Signing Requests
Requests must be signed using an access key ID and a secret access key. We strongly recommend that you do not use your AWS account access key ID and secret access key for everyday work with IAM. You can use the access key ID and secret access key for an IAM user or you can use the AWS Security Token Service to generate temporary security credentials and use those to sign requests.
To sign requests, we recommend that you use Signature Version 4. If you have an existing application that uses Signature Version 2, you do not have to update it to use Signature Version 4. However, some operations now require Signature Version 4. The documentation for operations that require version 4 indicate this requirement.
Additional Resources
For more information, see the following:
- [AWS Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html). This topic provides general information about the types of credentials used for accessing AWS.
- [IAM Best Practices](http://docs.aws.amazon.com/IAM/latest/UserGuide/IAMBestPractices.html). This topic presents a list of suggestions for using the IAM service to help secure your AWS resources.
- [Signing AWS API Requests](http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html). This set of topics walk you through the process of signing a request using an access key ID and secret access key.
Link to this section Summary
Functions
Returns a map containing the input/output shapes for this endpoint
Outputs values common to all actions
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
Adds the specified IAM role to the specified instance profile. An instance profile can contain only one role, and this limit cannot be increased
Adds the specified user to the specified group
Attaches the specified managed policy to the specified IAM group
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
Attaches the specified managed policy to the specified user
Changes the password of the IAM user who is calling this action. The root account password is not affected by this action
Creates a new AWS secret access key and corresponding AWS access key ID for
the specified user. The default status for new keys is Active
Creates an alias for your AWS account. For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the IAM User Guide
Creates a new group
Creates a new instance profile. For information about instance profiles, go to About Instance Profiles
Creates a password for the specified user, giving the user the ability to access AWS services through the AWS Management Console. For more information about managing passwords, see Managing Passwords in the IAM User Guide
Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC)
Creates a new managed policy for your AWS account
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
Creates a new role for your AWS account. For more information about roles, go to Working with Roles. For information about limitations on role names and the number of roles you can create, go to Limitations on IAM Entities in the IAM User Guide
Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0
Creates an IAM role that is linked to a specific AWS 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 AWS 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
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
Creates a new IAM user for your AWS account
Creates a new virtual MFA device for the AWS 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,
go to Using a Virtual MFA
Device
in the IAM User Guide
Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled
Deletes the access key pair associated with the specified IAM user
Deletes the specified AWS account alias. For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the IAM User Guide
Deletes the password policy for the AWS account. There are no parameters
Deletes the specified IAM group. The group must not contain any users or have any attached policies
Deletes the specified inline policy that is embedded in the specified IAM group
Deletes the specified instance profile. The instance profile must not have an associated role
Deletes the password for the specified IAM user, which terminates the user’s ability to access AWS services through the AWS Management Console
Deletes an OpenID Connect identity provider (IdP) resource object in IAM
Deletes the specified managed policy
Deletes the specified version from the specified managed policy
Deletes the specified role. The role must not have any policies attached. For more information about roles, go to Working with Roles
Deletes the specified inline policy that is embedded in the specified IAM role
Deletes a SAML provider resource in IAM
Deletes the specified SSH public key
Deletes the specified server certificate
Deletes the specified service-specific credential
Deletes a signing certificate associated with the specified IAM user
Deletes the specified IAM user. The user must not belong to any groups or have any access keys, signing certificates, or attached policies
Deletes the specified inline policy that is embedded in the specified IAM user
Deletes a virtual MFA device
Removes the specified managed policy from the specified IAM group
Removes the specified managed policy from the specified role
Removes the specified managed policy from the specified user
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
Generates a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the IAM User Guide
Retrieves information about when the specified access key was last used. The information includes the date and time of last use, along with the AWS service and region that were specified in the last request made with that key
Retrieves information about all IAM users, groups, roles, and policies in your AWS account, including their relationships to one another. Use this API to obtain a snapshot of the configuration of IAM permissions (users, groups, roles, and policies) in your account
Retrieves the password policy for the AWS account. For more information about using a password policy, go to Managing an IAM Password Policy
Retrieves information about IAM entity usage and IAM quotas in the AWS account
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
Gets a list of all of the context keys referenced in all of the IAM policies 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
Retrieves a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the IAM User Guide
Returns a list of IAM users that are in the specified IAM group. You can
paginate the results using the MaxItems
and Marker
parameters
Retrieves the specified inline policy document that is embedded in the specified IAM group
Retrieves information about the specified instance profile, including the instance profile’s path, GUID, ARN, and role. For more information about instance profiles, see About Instance Profiles in the IAM User Guide
Retrieves the user name and password-creation date for the specified IAM
user. If the user has not been assigned a password, the action returns a
404 (NoSuchEntity
) error
Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM
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 the
ListEntitiesForPolicy
API. This API returns metadata about the policy. To
retrieve the actual policy document for a specific version of the policy,
use GetPolicyVersion
Retrieves information about the specified version of the specified managed policy, including the policy document
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 Working with Roles
Retrieves the specified inline policy document that is embedded with the specified IAM role
Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated
Retrieves the specified SSH public key, including metadata about the key
Retrieves information about the specified server certificate stored in IAM
Retrieves information about the specified IAM user, including the user’s creation date, path, unique ID, and ARN
Retrieves the specified inline policy document that is embedded in the specified IAM user
Returns information about the access key IDs associated with the specified IAM user. If there are none, the action returns an empty list
Lists the account alias associated with the AWS account (Note: you can have only one). For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the IAM User Guide
Lists all managed policies that are attached to the specified IAM group
Lists all managed policies that are attached to the specified IAM role
Lists all managed policies that are attached to the specified IAM user
Lists all IAM users, groups, and roles that the specified managed policy is attached to
Lists the names of the inline policies that are embedded in the specified IAM group
Lists the IAM groups that have the specified path prefix
Lists the IAM groups that the specified IAM user belongs to
Lists the instance profiles that have the specified path prefix. If there are none, the action returns an empty list. For more information about instance profiles, go to About Instance Profiles
Lists the instance profiles that have the specified associated IAM role. If there are none, the action returns an empty list. For more information about instance profiles, go to About Instance Profiles
Lists the MFA devices for an IAM user. If the request includes a IAM user name, then this action 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 AWS access key ID signing the request for this API
Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the AWS account
Lists all the managed policies that are available in your AWS account, including your own customer-defined managed policies and all AWS managed policies
Lists information about the versions of the specified managed policy, including the version that is currently set as the policy’s default version
Lists the names of the inline policies that are embedded in the specified IAM role
Lists the IAM roles that have the specified path prefix. If there are none, the action returns an empty list. For more information about roles, go to Working with Roles
Lists the SAML provider resource objects defined in IAM in the account
Returns information about the SSH public keys associated with the specified IAM user. If there are none, the action returns an empty list
Lists the server certificates stored in IAM that have the specified path prefix. If none exist, the action returns an empty list
Returns information about the service-specific credentials associated with the specified IAM user. If there are none, the action returns an empty list. The service-specific credentials returned by this action are used only for authenticating the IAM user to a specific service. For more information about using service-specific credentials to authenticate to an AWS service, see Set Up service-specific credentials in the AWS CodeCommit User Guide
Returns information about the signing certificates associated with the specified IAM user. If there are none, the action returns an empty list
Lists the names of the inline policies embedded in the specified IAM user
Lists the IAM users that have the specified path prefix. If no path prefix is specified, the action returns all users in the AWS account. If there are none, the action returns an empty list
Lists the virtual MFA devices defined in the AWS account by assignment
status. If you do not specify an assignment status, the action returns a
list of all virtual MFA devices. Assignment status can be Assigned
,
Unassigned
, or Any
Adds or updates an inline policy document that is embedded in the specified IAM group
Adds or updates an inline policy document that is embedded in the specified IAM role
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
Removes the specified IAM role from the specified EC2 instance profile
Removes the specified user from the specified group
Resets the password for a service-specific credential. The new password is AWS generated and cryptographically strong. It cannot be configured by the user. Resetting the password immediately invalidates the previous password associated with this user
Synchronizes the specified MFA device with its IAM resource object on the AWS servers
Sets the specified version of the specified policy as the policy’s default (operative) version
Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API actions and AWS resources to determine the policies’ effective permissions. The policies are provided as strings
Simulate how a set of IAM policies attached to an IAM entity works with a list of API actions and AWS 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
Changes the status of the specified access key from Active to Inactive, or vice versa. This action can be used to disable a user’s key as part of a key rotation work flow
Updates the password policy settings for the AWS account
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, go to Using Roles to Delegate Permissions and Federate Identities
Updates the name and/or the path of the specified IAM group
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
Modifies the description of a role
Updates the metadata document for an existing SAML provider resource object
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 action can be used to disable a user’s SSH public key as part of a key rotation work flow
Updates the name and/or the path of the specified server certificate stored in IAM
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 action can be used to disable a user’s
service-specific credential as part of a credential rotation work flow
Changes the status of the specified user signing certificate from active to disabled, or vice versa. This action can be used to disable an IAM user’s signing certificate as part of a certificate rotation work flow
Updates the name and/or the path of the specified IAM user
Uploads an SSH public key and associates it with the specified IAM user
Uploads a server certificate entity for the AWS account. The server certificate entity includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded
Uploads an X.509 signing certificate and associates it with the specified
IAM user. Some AWS services use X.509 signing certificates to validate
requests that are signed with a corresponding private key. When you upload
the certificate, its default status is Active
Link to this section Functions
Returns a map containing the input/output shapes for this endpoint
Outputs values common to all actions
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 action is idempotent; it does not fail or return an error if you add an existing client ID to the provider.
Adds the specified IAM role to the specified instance profile. An instance profile can contain only one role, and this limit cannot be increased.
Roles](http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html). For more information about instance profiles, go to About Instance Profiles.
Adds the specified user to the specified group.
Attaches the specified managed policy to the specified IAM group.
You use this API to attach a managed policy to a group. To embed an inline
policy in a group, use PutGroupPolicy
.
For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
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.
inline policy in a role, use PutRolePolicy
. For more information about
policies, see Managed Policies and Inline
Policies
in the IAM User Guide.
Attaches the specified managed policy to the specified user.
You use this API to attach a managed policy to a user. To embed an inline
policy in a user, use PutUserPolicy
.
For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
Changes the password of the IAM user who is calling this action. The root account password is not affected by this action.
To change the password for a different user, see UpdateLoginProfile
. For
more information about modifying passwords, see Managing
Passwords
in the IAM User Guide.
Creates a new AWS secret access key and corresponding AWS 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 AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.
For information about limits on the number of keys you can create, see Limitations on IAM Entities in the IAM User Guide.
Creates an alias for your AWS account. For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the IAM User Guide.
Creates a new group.
For information about the number of groups you can create, see Limitations on IAM Entities in the IAM User Guide.
Creates a new instance profile. For information about instance profiles, go to About Instance Profiles.
For information about the number of instance profiles you can create, see Limitations on IAM Entities in the IAM User Guide.
Creates a password for the specified user, giving the user the ability to access AWS services through the AWS Management Console. For more information about managing passwords, see Managing Passwords in the IAM User Guide.
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 to establish a trust relationship between AWS and the OIDC provider.
When you create the IAM OIDC provider, you specify 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 that are allowed to authenticate using the OIDC provider, and a list of thumbprints of the server certificate(s) that the IdP uses. You get all of this information from the OIDC IdP that you want to use for access to AWS.
Creates a new managed policy for your AWS 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.
For more information about managed policies in general, see Managed Policies and Inline Policies in the IAM User Guide.
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.
Creates a new role for your AWS account. For more information about roles, go to Working with Roles. For information about limitations on role names and the number of roles you can create, go to Limitations on IAM Entities in the IAM User Guide.
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 to 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 AWS Management Console or one that supports API access to AWS.
When you create the SAML provider resource, you upload an a SAML metadata document that you get from your IdP and that 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.
Access the AWS Management Console](http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-saml.html) and About SAML 2.0-based Federation in the IAM User Guide.
Creates an IAM role that is linked to a specific AWS 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 AWS 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.
The name of the role is autogenerated by combining the string that you
specify for the AWSServiceName
parameter with the string that you specify
for the CustomSuffix
parameter. The resulting name must be unique in your
account or the request fails.
To attach a policy to this service-linked role, you must make the request using the AWS service that depends on this role.
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.
The only supported service at this time is AWS CodeCommit.
You can reset the password to a new service-generated value by calling
ResetServiceSpecificCredential
.
For more information about service-specific credentials, see Using IAM with AWS CodeCommit: Git Credentials, SSH Keys, and AWS Access Keys in the IAM User Guide.
Creates a new IAM user for your AWS account.
For information about limitations on the number of IAM users you can create, see Limitations on IAM Entities in the IAM User Guide.
Creates a new virtual MFA device for the AWS 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,
go to Using a Virtual MFA
Device
in the IAM User Guide.
For information about limits on the number of MFA devices you can create, see Limitations on Entities in the IAM User Guide.
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, go to Using a Virtual MFA Device in the IAM User Guide.
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 AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.
Deletes the specified AWS account alias. For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the IAM User Guide.
Deletes the password policy for the AWS account. There are no parameters.
Deletes the specified IAM group. The group must not contain any users or have any attached policies.
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.
Deletes the specified instance profile. The instance profile must not have an associated role.
Instance Profiles](http://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html).
Deletes the password for the specified IAM user, which terminates the user’s ability to access AWS services through the AWS Management Console.
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 action is idempotent; it does not fail or return an error if you call the action for a provider that does not exist.
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, and you must delete all of 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 the `DetachUserPolicy`, `DetachGroupPolicy`, or `DetachRolePolicy` APIs. 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 API.
Deletes the specified version from the specified managed policy.
You cannot delete the default version from a policy using this API. 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.
Deletes the specified role. The role must not have any policies attached. For more information about roles, go to Working with Roles.
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.
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.
Deletes the specified SSH public key.
The SSH public key deleted by this action is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide.
Deletes the specified server certificate.
For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.
Deletes the specified service-specific credential.
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 AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated IAM users.
Deletes the specified IAM user. The user must not belong to any groups or have any access keys, signing certificates, or attached policies.
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.
Deletes a virtual MFA device.
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 the DeleteGroupPolicy
API. For information about policies,
see Managed Policies and Inline
Policies
in the IAM User Guide.
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 the DeleteRolePolicy
API. For information about policies, see
Managed Policies and Inline
Policies
in the IAM User Guide.
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 the DeleteUserPolicy
API. For information about policies, see
Managed Policies and Inline
Policies
in the IAM User Guide.
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.
Generates a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the IAM User Guide.
Retrieves information about when the specified access key was last used. The information includes the date and time of last use, along with the AWS service and region that were specified in the last request made with that key.
Retrieves information about all IAM users, groups, roles, and policies in your AWS account, including their relationships to one another. Use this API to obtain a snapshot of the configuration of IAM permissions (users, groups, roles, and policies) in your account.
You can optionally filter the results using the Filter
parameter. You can
paginate the results using the MaxItems
and Marker
parameters.
Retrieves the password policy for the AWS account. For more information about using a password policy, go to Managing an IAM Password Policy.
Retrieves information about IAM entity usage and IAM quotas in the AWS account.
For information about limitations on IAM entities, see Limitations on IAM Entities in the IAM User Guide.
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 AWS and its services that provide
details about the context of an API query request, and 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.
Gets a list of all of the context keys referenced in all of the IAM policies 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 API 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 AWS and its services that provide
details about the context of an API query request, and 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
.
Retrieves a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the IAM User Guide.
Returns a list of IAM users that are in the specified IAM group. You can
paginate the results using the MaxItems
and Marker
parameters.
Retrieves the specified inline policy document that is embedded in the specified IAM group.
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.
Retrieves information about the specified instance profile, including the instance profile’s path, GUID, ARN, and role. For more information about instance profiles, see About Instance Profiles in the IAM User Guide.
Retrieves the user name and password-creation date for the specified IAM
user. If the user has not been assigned a password, the action returns a
404 (NoSuchEntity
) error.
Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM.
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 the
ListEntitiesForPolicy
API. This API returns metadata about the policy. To
retrieve the actual policy document for a specific version of the policy,
use GetPolicyVersion
.
This API retrieves information about managed policies. To retrieve
information about an inline policy that is embedded with an IAM user,
group, or role, use the GetUserPolicy
, GetGroupPolicy
, or
GetRolePolicy
API.
For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
Retrieves information about the specified version of the specified managed policy, including the policy document.
ListPolicyVersions
.
This API retrieves information about managed policies. To retrieve
information about an inline policy that is embedded in a user, group, or
role, use the GetUserPolicy
, GetGroupPolicy
, or GetRolePolicy
API.
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.
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 Working with Roles.
Retrieves the specified inline policy document that is embedded with the specified IAM role.
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 Using Roles to Delegate Permissions and Federate Identities.
Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated.
Retrieves the specified SSH public key, including metadata about the key.
The SSH public key retrieved by this action is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide.
Retrieves information about the specified server certificate stored in IAM.
For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.
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 AWS access key ID used to sign the request to this API.
Retrieves the specified inline policy document that is embedded in the specified IAM user.
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.
Returns information about the access key IDs associated with the specified IAM user. If there are none, the action 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
field is not specified, the UserName is determined
implicitly based on the AWS access key ID used to sign the request. Because
this action works for access keys under the AWS account, you can use this
action to manage root credentials even if the AWS account has no associated
users.
Lists the account alias associated with the AWS account (Note: you can have only one). For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the IAM User Guide.
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 the ListGroupPolicies
API. 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 action returns an empty list.
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 the ListRolePolicies
API. 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 action returns an empty list.
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 the ListUserPolicies
API. 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 action returns an empty list.
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.
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
action returns an empty list.
Lists the IAM groups that have the specified path prefix.
You can paginate the results using the MaxItems
and Marker
parameters.
Lists the IAM groups that the specified IAM user belongs to.
You can paginate the results using the MaxItems
and Marker
parameters.
Lists the instance profiles that have the specified path prefix. If there are none, the action returns an empty list. For more information about instance profiles, go to About Instance Profiles.
You can paginate the results using the MaxItems
and Marker
parameters.
Lists the instance profiles that have the specified associated IAM role. If there are none, the action returns an empty list. For more information about instance profiles, go to About Instance Profiles.
You can paginate the results using the MaxItems
and Marker
parameters.
Lists the MFA devices for an IAM user. If the request includes a IAM user name, then this action 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 AWS access key ID signing the request for this API.
You can paginate the results using the MaxItems
and Marker
parameters.
Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the AWS account.
Lists all the managed policies that are available in your AWS account, including your own customer-defined managed policies and all AWS 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 AWS account, set Scope
to
Local
. To list only AWS 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.
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.
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
action returns an empty list.
Lists the IAM roles that have the specified path prefix. If there are none, the action returns an empty list. For more information about roles, go to Working with Roles.
You can paginate the results using the MaxItems
and Marker
parameters.
Lists the SAML provider resource objects defined in IAM in the account.
Returns information about the SSH public keys associated with the specified IAM user. If there are none, the action returns an empty list.
The SSH public keys returned by this action are used only for authenticating the IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS 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.
Lists the server certificates stored in IAM that have the specified path prefix. If none exist, the action returns an empty list.
You can paginate the results using the MaxItems
and Marker
parameters.
For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.
Returns information about the service-specific credentials associated with the specified IAM user. If there are none, the action returns an empty list. The service-specific credentials returned by this action are used only for authenticating the IAM user to a specific service. For more information about using service-specific credentials to authenticate to an AWS service, see Set Up service-specific credentials in the AWS CodeCommit User Guide.
Returns information about the signing certificates associated with the specified IAM user. If there are none, the action 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 AWS access key ID used to sign the request for this
API. Because this action works for access keys under the AWS account, you
can use this action to manage root credentials even if the AWS account has
no associated users.
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
action returns an empty list.
Lists the IAM users that have the specified path prefix. If no path prefix is specified, the action returns all users in the AWS account. If there are none, the action returns an empty list.
You can paginate the results using the MaxItems
and Marker
parameters.
Lists the virtual MFA devices defined in the AWS account by assignment
status. If you do not specify an assignment status, the action 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.
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 limits on the number of inline policies that you can embed in a group, see Limitations on IAM Entities in the IAM User Guide.
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 IAM roles, go to Using Roles to Delegate Permissions and Federate
Identities.
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 limits on the number of inline policies that you can embed with a role, see Limitations on IAM Entities in the IAM User Guide.
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 limits on the number of inline policies that you can embed in a user, see Limitations on IAM Entities in the IAM User Guide.
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 action is idempotent; it does not fail or return an error if you try to remove a client ID that does not exist.
Removes the specified IAM role from the specified EC2 instance profile.
Roles](http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html). For more information about instance profiles, go to About Instance Profiles.
Removes the specified user from the specified group.
Resets the password for a service-specific credential. The new password is AWS generated and cryptographically strong. It cannot be configured by the user. Resetting the password immediately invalidates the previous password associated with this user.
Synchronizes the specified MFA device with its IAM resource object on the AWS servers.
For more information about creating and working with virtual MFA devices, go to Using a Virtual MFA Device in the IAM User Guide.
Sets the specified version of the specified policy as the policy’s default (operative) version.
This action 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 the ListEntitiesForPolicy
API.
For information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide.
Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API actions and AWS resources to determine the policies’ effective permissions. The policies are provided as strings.
The simulation does not perform the API actions; it only checks the authorization to determine if the simulated policies allow or deny the actions.
If you want to simulate existing policies attached to an IAM user, group,
or role, use SimulatePrincipalPolicy
instead.
Context keys are variables maintained by AWS 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
GetContextKeysForCustomPolicy
.
If the output is long, you can use MaxItems
and Marker
parameters to
paginate the results.
Simulate how a set of IAM policies attached to an IAM entity works with a list of API actions and AWS 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 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.
The simulation does not perform the API actions, it only checks the authorization to determine if the simulated policies allow or deny the actions.
Note: This API 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 AWS 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.
Changes the status of the specified access key from Active to Inactive, or vice versa. This action can be used to disable a user’s key as part of a key rotation work flow.
If the UserName
field is not specified, the UserName is determined
implicitly based on the AWS access key ID used to sign the request. Because
this action works for access keys under the AWS account, you can use this
action to manage root credentials even if the AWS account has no associated
users.
For information about rotating keys, see Managing Keys and Certificates in the IAM User Guide.
Updates the password policy settings for the AWS account.
an IAM Password Policy](http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html) in the IAM User Guide.
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, go to Using Roles to Delegate Permissions and Federate Identities.
Updates the name and/or the path of the specified IAM group.
appropriate permissions on both the source object and the target object. For example, to change “Managers” to “MGRs”, the entity making the request must have permission on both “Managers” and “MGRs”, or must have permission on all (*). For more information about permissions, see Permissions and Policies.
Changes the password for the specified IAM user.
IAM users can change their own passwords by calling ChangePassword
. For
more information about modifying passwords, see Managing
Passwords
in the IAM User Guide.
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 action completely replaces the existing list of thumbprints. (The lists are not merged.)
Typically, you need to update a thumbprint only when the identity provider’s 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.
Modifies the description of a role.
Updates the metadata document for an existing SAML provider resource object.
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 action 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 action is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide.
Updates the name and/or the path of the specified server certificate stored in IAM.
For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.
have appropriate permissions on both the source object and the target object. For example, to change the name from “ProductionCert” to “ProdCert”, the entity making the request must have permission on “ProductionCert” and “ProdCert”, or must have permission on all (). For more information about permissions, see Access Management in the IAM User Guide*.
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 action can be used to disable a user’s
service-specific credential as part of a credential rotation work flow.
Changes the status of the specified user signing certificate from active to disabled, or vice versa. This action 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 UserName is determined
implicitly based on the AWS access key ID used to sign the request. Because
this action works for access keys under the AWS account, you can use this
action to manage root credentials even if the AWS account has no associated
users.
Updates the name and/or the path of the specified IAM user.
appropriate permissions on both the source object and the target object. For example, to change Bob to Robert, the entity making the request must have permission on Bob and Robert, or must have permission on all (*). For more information about permissions, see Permissions and Policies.
Uploads an SSH public key and associates it with the specified IAM user.
The SSH public key uploaded by this action can be used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide.
Uploads a server certificate entity for the AWS 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 AWS Certificate Manager to provision, manage, and deploy your server certificates. With ACM you can request a certificate, deploy it to AWS resources, and let ACM handle certificate renewals for you. Certificates provided by ACM are free. For more information about using ACM, see the AWS Certificate Manager User Guide.
For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.
For information about the number of server certificates you can upload, see Limitations on IAM Entities and Objects in the IAM User Guide.
Uploads an X.509 signing certificate and associates it with the specified
IAM user. Some AWS services use X.509 signing certificates to validate
requests that are signed with a corresponding private key. When you upload
the certificate, its default status is Active
.
If the UserName
field is not specified, the IAM user name is determined
implicitly based on the AWS access key ID used to sign the request. Because
this action works for access keys under the AWS account, you can use this
action to manage root credentials even if the AWS account has no associated
users.