@aws-lite/iam
Maintained by: @architect
Install
npm i @aws-lite/iam
Optionally install types:
npm i -D @aws-lite/iam-types
Methods
AddClientIDToOpenIDConnectProvider
Properties
ClientID(string) [required]-
The client ID (aka the audience) to add to the IAM OpenId Connect provider resource
OpenIDConnectProviderArn(string) [required]-
ARN of the OpenID Connect resource
Example
await aws.IAM.AddClientIDToOpenIDConnectProvider({
ClientID: String, // required
OpenIDConnectProviderArn: String, // required
})
AddRoleToInstanceProfile
Properties
InstanceProfileName(string) [required]-
Name of the instance profile
RoleName(string) [required]-
Name of the role
Example
await aws.IAM.AddRoleToInstanceProfile({
InstanceProfileName: String, // required
RoleName: String, // required
})
AddUserToGroup
Properties
GroupName(string) [required]-
Name of the group; names are not distinguished by case
UserName(string) [required]-
User name
Example
await aws.IAM.AddUserToGroup({
GroupName: String, // required
UserName: String, // required
})
AttachGroupPolicy
Properties
GroupName(string) [required]-
Name of the group; names are not distinguished by case
PolicyArn(string) [required]-
Arn of the policy
Example
await aws.IAM.AttachGroupPolicy({
GroupName: String, // required
PolicyArn: String, // required
})
AttachRolePolicy
Properties
PolicyArn(string) [required]-
Arn of the policy
RoleName(string) [required]-
Name of the role
Example
await aws.IAM.AttachRolePolicy({
PolicyArn: String, // required
RoleName: String, // required
})
AttachUserPolicy
Properties
PolicyArn(string) [required]-
Arn of the policy
UserName(string) [required]-
User name
Example
await aws.IAM.AttachUserPolicy({
PolicyArn: String, // required
UserName: String, // required
})
ChangePassword
Properties
NewPassword(string) [required]-
New password; must conform to the accounts password policy
OldPassword(string) [required]-
Current password
Example
await aws.IAM.ChangePassword({
NewPassword: String, // required
OldPassword: String, // required
})
CreateAccessKey
Properties
UserName(string) [required]-
User name
Example
await aws.IAM.CreateAccessKey({
UserName: String, // required
})
CreateAccountAlias
Properties
AccountAlias(string) [required]-
Account alias to create
Example
await aws.IAM.CreateAccountAlias({
AccountAlias: String, // required
})
CreateGroup
Properties
GroupName(string) [required]-
Name of the group; names are not distinguished by case
Path(string)-
Path for the identifier
- Example
await aws.IAM.CreateGroup({ GroupName: String, // required Path: String, })
CreateInstanceProfile
Properties
InstanceProfileName(string) [required]-
Name of the instance profile
Path(string)-
Path for the identifier
- More details (AWS)
Example
await aws.IAM.CreateInstanceProfile({
InstanceProfileName: String, // required
Path: String,
Tags: Array,
})
CreateLoginProfile
Properties
Password(string) [required]-
New password for the user
UserName(string) [required]-
User name
PasswordResetRequired(boolean)-
Set to true to specify the user must make a new password on next sign-in
Example
await aws.IAM.CreateLoginProfile({
Password: String, // required
UserName: String, // required
PasswordResetRequired: Boolean,
})
CreateOpenIDConnectProvider
Properties
Url(string) [required]-
URL of the identity provider; must begin with
https:// ClientIDList(array)-
Array of at most 255 client IDs
- More details (AWS)
ThumbprintList(array)-
Array of server certificate thumbprints for the OIDC identity providers server certificates
- Example
await aws.IAM.CreateOpenIDConnectProvider({ Url: String, // required ClientIDList: Array, Tags: Array, ThumbprintList: Array, })
CreatePolicy
Properties
PolicyDocument(string, object) [required]-
The policy document; can be an object, or JSON or YAML string
PolicyName(string) [required]-
Name of the policy
Description(string)-
Description of the resource
Path(string)-
Path for the identifier
- More details (AWS)
Example
await aws.IAM.CreatePolicy({
PolicyDocument: String || Object, // required
PolicyName: String, // required
Description: String,
Path: String,
Tags: Array,
})
CreatePolicyVersion
Properties
PolicyArn(string) [required]-
Arn of the policy
PolicyDocument(string, object) [required]-
The policy document; can be an object, or JSON or YAML string
SetAsDefault(boolean)-
Set to true to make this the default version used by all IAM resources
Example
await aws.IAM.CreatePolicyVersion({
PolicyArn: String, // required
PolicyDocument: String || Object, // required
SetAsDefault: Boolean,
})
CreateRole
Properties
AssumeRolePolicyDocument(string, object) [required]-
Trust relationship policy document granting an entity permission to assume the role; can be an object, or JSON or YAML string
RoleName(string) [required]-
Name of the role
Description(string)-
Description of the resource
MaxSessionDuration(number)-
Maximum session duration (in seconds) to set for the specified role
Path(string)-
Path for the role identifier
- More details (AWS)
Example
await aws.IAM.CreateRole({
AssumeRolePolicyDocument: String || Object, // required
RoleName: String, // required
Description: String,
MaxSessionDuration: Number,
Path: String,
PermissionsBoundary: String,
Tags: Array,
})
CreateServiceLinkedRole
Properties
AWSServiceName(string) [required]-
The service principal to which this role is attached; use
CustomSuffixto prevent duplication errors during multiple requests for the same service CustomSuffix(string)-
Identifier for the role; not supported by all services
Description(string)-
Description of the resource
Example
await aws.IAM.CreateServiceLinkedRole({
AWSServiceName: String, // required
CustomSuffix: String,
Description: String,
})
CreateServiceSpecificCredential
Properties
ServiceName(string) [required]-
Name of the AWS service
UserName(string) [required]-
User name
Example
await aws.IAM.CreateServiceSpecificCredential({
ServiceName: String, // required
UserName: String, // required
})
CreateUser
Properties
UserName(string) [required]-
User name
Path(string)-
Path for the identifier
- More details (AWS)
Example
await aws.IAM.CreateUser({
UserName: String, // required
Path: String,
PermissionsBoundary: String,
Tags: Array,
})
CreateVirtualMFADevice
Properties
VirtualMFADeviceName(string) [required]-
Name of the virtual MFA device
Path(string)-
Path for the identifier
- More details (AWS)
Example
await aws.IAM.CreateVirtualMFADevice({
VirtualMFADeviceName: String, // required
Path: String,
Tags: Array,
})
DeleteAccessKey
Properties
AccessKeyId(string) [required]-
ID of the access key
UserName(string)-
User name
Example
await aws.IAM.DeleteAccessKey({
AccessKeyId: String, // required
UserName: String,
})
DeleteAccountAlias
Properties
AccountAlias(string) [required]-
The account alias
Example
await aws.IAM.DeleteAccountAlias({
AccountAlias: String, // required
})
DeleteAccountPasswordPolicy
Properties
Example
await aws.IAM.DeleteAccountPasswordPolicy()
DeleteGroup
Properties
GroupName(string) [required]-
Name of the group; names are not distinguished by case
Example
await aws.IAM.DeleteGroup({
GroupName: String, // required
})
DeleteGroupPolicy
Properties
GroupName(string) [required]-
Name of the group; names are not distinguished by case
PolicyName(string) [required]-
Name of the policy
Example
await aws.IAM.DeleteGroupPolicy({
GroupName: String, // required
PolicyName: String, // required
})
DeleteInstanceProfile
Properties
InstanceProfileName(string) [required]-
Name of the instance profile
Example
await aws.IAM.DeleteInstanceProfile({
InstanceProfileName: String, // required
})
DeleteLoginProfile
Properties
UserName(string) [required]-
User name
Example
await aws.IAM.DeleteLoginProfile({
UserName: String, // required
})
DeleteOpenIDConnectProvider
Properties
OpenIDConnectProviderArn(string) [required]-
ARN of the OpenID Connect resource
Example
await aws.IAM.DeleteOpenIDConnectProvider({
OpenIDConnectProviderArn: String, // required
})
DeletePolicy
Properties
PolicyArn(string) [required]-
Arn of the policy
Example
await aws.IAM.DeletePolicy({
PolicyArn: String, // required
})
DeletePolicyVersion
Properties
PolicyArn(string) [required]-
Arn of the policy
VersionId(string) [required]-
ID of the policy version; typically
v<n>
Example
await aws.IAM.DeletePolicyVersion({
PolicyArn: String, // required
VersionId: String, // required
})
DeleteRole
Properties
RoleName(string) [required]-
Name of the role
Example
await aws.IAM.DeleteRole({
RoleName: String, // required
})
DeleteRolePermissionsBoundary
Properties
RoleName(string) [required]-
Name of the role
Example
await aws.IAM.DeleteRolePermissionsBoundary({
RoleName: String, // required
})
DeleteRolePolicy
Properties
PolicyName(string) [required]-
Name of the policy
RoleName(string) [required]-
Name of the role
Example
await aws.IAM.DeleteRolePolicy({
PolicyName: String, // required
RoleName: String, // required
})
DeleteServerCertificate
Properties
ServerCertificateName(string) [required]-
Name of the server certificate; do not include path, cannot contain spaces
Example
await aws.IAM.DeleteServerCertificate({
ServerCertificateName: String, // required
})
DeleteServiceLinkedRole
Properties
RoleName(string) [required]-
Name of the role
Example
await aws.IAM.DeleteServiceLinkedRole({
RoleName: String, // required
})
DeleteServiceSpecificCredential
Properties
ServiceSpecificCredentialId(string) [required]-
ID of the service specific credential
UserName(string) [required]-
User name
Example
await aws.IAM.DeleteServiceSpecificCredential({
ServiceSpecificCredentialId: String, // required
UserName: String, // required
})
DeleteSigningCertificate
Properties
CertificateId(string) [required]-
ID of the signing certificate
UserName(string)-
User name
Example
await aws.IAM.DeleteSigningCertificate({
CertificateId: String, // required
UserName: String,
})
DeleteSSHPublicKey
Properties
SSHPublicKeyId(string) [required]-
ID of the SSH public key
UserName(string) [required]-
User name
Example
await aws.IAM.DeleteSSHPublicKey({
SSHPublicKeyId: String, // required
UserName: String, // required
})
DeleteUser
Properties
UserName(string) [required]-
User name
Example
await aws.IAM.DeleteUser({
UserName: String, // required
})
DeleteUserPermissionsBoundary
Properties
UserName(string) [required]-
User name
Example
await aws.IAM.DeleteUserPermissionsBoundary({
UserName: String, // required
})
DeleteUserPolicy
Properties
PolicyName(string) [required]-
Name of the policy
UserName(string) [required]-
User name
Example
await aws.IAM.DeleteUserPolicy({
PolicyName: String, // required
UserName: String, // required
})
DeleteVirtualMFADevice
Properties
SerialNumber(string) [required]-
Serial number or ARN of the virtual MFA device
Example
await aws.IAM.DeleteVirtualMFADevice({
SerialNumber: String, // required
})
DetachGroupPolicy
Properties
GroupName(string) [required]-
Name of the group; names are not distinguished by case
PolicyArn(string) [required]-
Arn of the policy
Example
await aws.IAM.DetachGroupPolicy({
GroupName: String, // required
PolicyArn: String, // required
})
DetachRolePolicy
Properties
PolicyArn(string) [required]-
Arn of the policy
RoleName(string) [required]-
Name of the role
Example
await aws.IAM.DetachRolePolicy({
PolicyArn: String, // required
RoleName: String, // required
})
DetachUserPolicy
Properties
PolicyArn(string) [required]-
Arn of the policy
UserName(string) [required]-
User name
Example
await aws.IAM.DetachUserPolicy({
PolicyArn: String, // required
UserName: String, // required
})
GenerateCredentialReport
Properties
Example
await aws.IAM.GenerateCredentialReport()
GenerateOrganizationsAccessReport
Properties
EntityPath(string) [required]-
Path of the AWS Organizations entity
- Example
await aws.IAM.GenerateOrganizationsAccessReport({ EntityPath: String, // required OrganizationsPolicyId: String, })
GenerateServiceLastAccessedDetails
Properties
Arn(string) [required]-
ARN of the IAM resource used to generate the report
Granularity(string)-
Specify the type of access information; can be one of:
SERVICE_LEVEL(default),ACTION_LEVEL - Example
await aws.IAM.GenerateServiceLastAccessedDetails({ Arn: String, // required Granularity: String, })
GetAccessKeyLastUsed
Properties
AccessKeyId(string) [required]-
ID of the access key
Example
await aws.IAM.GetAccessKeyLastUsed({
AccessKeyId: String, // required
})
GetAccountAuthorizationDetails
Properties
Filter(array)-
Filter results by entity type
- Example
await aws.IAM.GetAccountAuthorizationDetails({ Filter: Array, Marker: String, MaxItems: Number, })
GetAccountPasswordPolicy
Properties
Example
await aws.IAM.GetAccountPasswordPolicy()
GetAccountSummary
Properties
Example
await aws.IAM.GetAccountSummary()
GetContextKeysForCustomPolicy
Properties
PolicyInputList(array) [required]-
Array of policies to get context keys, each item must be a complete policy object
Example
await aws.IAM.GetContextKeysForCustomPolicy({
PolicyInputList: Array, // required
})
GetContextKeysForPrincipalPolicy
Properties
PolicySourceArn(string) [required]-
ARN of the user, group or role for which the resources context keys will be listed
- Example
await aws.IAM.GetContextKeysForPrincipalPolicy({ PolicySourceArn: String, // required PolicyInputList: Array, })
GetCredentialReport
Properties
Example
await aws.IAM.GetCredentialReport()
GetGroup
Properties
GroupName(string) [required]-
Name of the group; names are not distinguished by case
Marker(string)-
Pagination cursor
MaxItems(number)-
Maximum number of items to be returned in a response; at most 1000
Example
await aws.IAM.GetGroup({
GroupName: String, // required
Marker: String,
MaxItems: Number,
})
GetGroupPolicy
Properties
GroupName(string) [required]-
Name of the group; names are not distinguished by case
PolicyName(string) [required]-
Name of the policy
Example
await aws.IAM.GetGroupPolicy({
GroupName: String, // required
PolicyName: String, // required
})
GetInstanceProfile
Properties
InstanceProfileName(string) [required]-
Name of the instance profile
Example
await aws.IAM.GetInstanceProfile({
InstanceProfileName: String, // required
})
GetLoginProfile
Properties
UserName(string) [required]-
User name
Example
await aws.IAM.GetLoginProfile({
UserName: String, // required
})
GetOpenIDConnectProvider
Properties
OpenIDConnectProviderArn(string) [required]-
ARN of the OpenID Connect resource
Example
await aws.IAM.GetOpenIDConnectProvider({
OpenIDConnectProviderArn: String, // required
})
GetOrganizationsAccessReport
Properties
JobId(string) [required]-
ID of the report provided in the
GenerateOrganizationsAccessReportresponse Marker(string)-
Pagination cursor
MaxItems(number)-
Maximum number of items to be returned in a response; at most 1000
SortKey(string)-
Sort results by key
- Example
await aws.IAM.GetOrganizationsAccessReport({ JobId: String, // required Marker: String, MaxItems: Number, SortKey: String, paginate: Boolean, })
GetPolicy
Properties
PolicyArn(string) [required]-
Arn of the policy
Example
await aws.IAM.GetPolicy({
PolicyArn: String, // required
})
GetPolicyVersion
Properties
PolicyArn(string) [required]-
Arn of the policy
VersionId(string) [required]-
ID of the policy version; typically
v<n>
Example
await aws.IAM.GetPolicyVersion({
PolicyArn: String, // required
VersionId: String, // required
})
GetRole
Properties
RoleName(string) [required]-
Name of the role
Example
await aws.IAM.GetRole({
RoleName: String, // required
})
GetRolePolicy
Properties
PolicyName(string) [required]-
Name of the policy
RoleName(string) [required]-
Name of the role
Example
await aws.IAM.GetRolePolicy({
PolicyName: String, // required
RoleName: String, // required
})
GetServerCertificate
Properties
ServerCertificateName(string) [required]-
Name of the server certificate; do not include path, cannot contain spaces
Example
await aws.IAM.GetServerCertificate({
ServerCertificateName: String, // required
})
GetServiceLastAccessedDetails
Properties
JobId(string) [required]-
ID of the report provided in the
GenerateServiceLastAccessedDetailsresponse Marker(string)-
Pagination cursor
MaxItems(number)-
Maximum number of items to be returned in a response; at most 1000
paginate(boolean)-
Enable automatic result pagination; use this instead of making your own individual pagination requests
Example
await aws.IAM.GetServiceLastAccessedDetails({
JobId: String, // required
Marker: String,
MaxItems: Number,
paginate: Boolean,
})
GetServiceLastAccessedDetailsWithEntities
Properties
JobId(string) [required]-
ID of the report provided in the
GenerateServiceLastAccessedDetailsresponse ServiceNamespace(string) [required]-
The service namespace for an AWS service
- Example
await aws.IAM.GetServiceLastAccessedDetailsWithEntities({ JobId: String, // required ServiceNamespace: String, // required Marker: String, MaxItems: Number, paginate: Boolean, })
GetSSHPublicKey
Properties
Encoding(string) [required]-
Specify the encoding format used in the response; can be one of:
SSH,PEM SSHPublicKeyId(string) [required]-
ID of the SSH public key
UserName(string) [required]-
User name
Example
await aws.IAM.GetSSHPublicKey({
Encoding: String, // required
SSHPublicKeyId: String, // required
UserName: String, // required
})
GetUser
Properties
UserName(string) [required]-
User name
Example
await aws.IAM.GetUser({
UserName: String, // required
})
GetUserPolicy
Properties
PolicyName(string) [required]-
Name of the policy
UserName(string) [required]-
User name
Example
await aws.IAM.GetUserPolicy({
PolicyName: String, // required
UserName: String, // required
})
ListAccessKeys
Properties
Marker(string)-
Pagination cursor
MaxItems(number)-
Maximum number of items to be returned in a response; at most 1000
UserName(string)-
User name
paginate(boolean)-
Enable automatic result pagination; use this instead of making your own individual pagination requests
Example
await aws.IAM.ListAccessKeys({
Marker: String,
MaxItems: Number,
UserName: String,
paginate: Boolean,
})
ListAccountAliases
Properties
Marker(string)-
Pagination cursor
MaxItems(number)-
Maximum number of items to be returned in a response; at most 1000
paginate(boolean)-
Enable automatic result pagination; use this instead of making your own individual pagination requests
Example
await aws.IAM.ListAccountAliases({
Marker: String,
MaxItems: Number,
paginate: Boolean,
})
ListAttachedGroupPolicies
Properties
GroupName(string) [required]-
Name of the group; names are not distinguished by case
Marker(string)-
Pagination cursor
MaxItems(number)-
Maximum number of items to be returned in a response; at most 1000
PathPrefix(string)-
Filter results by path prefix
paginate(boolean)-
Enable automatic result pagination; use this instead of making your own individual pagination requests
Example
await aws.IAM.ListAttachedGroupPolicies({
GroupName: String, // required
Marker: String,
MaxItems: Number,
PathPrefix: String,
paginate: Boolean,
})
ListAttachedRolePolicies
Properties
RoleName(string) [required]-
Name of the role
Marker(string)-
Pagination cursor
MaxItems(number)-
Maximum number of items to be returned in a response; at most 1000
PathPrefix(string)-
Filter results by path prefix
paginate(boolean)-
Enable automatic result pagination; use this instead of making your own individual pagination requests
Example
await aws.IAM.ListAttachedRolePolicies({
RoleName: String, // required
Marker: String,
MaxItems: Number,
PathPrefix: String,
paginate: Boolean,
})
ListAttachedUserPolicies
Properties
UserName(string) [required]-
User name
Marker(string)-
Pagination cursor
MaxItems(number)-
Maximum number of items to be returned in a response; at most 1000
PathPrefix(string)-
Filter results by path prefix
paginate(boolean)-
Enable automatic result pagination; use this instead of making your own individual pagination requests
Example
await aws.IAM.ListAttachedUserPolicies({
UserName: String, // required
Marker: String,
MaxItems: Number,
PathPrefix: String,
paginate: Boolean,
})
ListEntitiesForPolicy
Properties
PolicyArn(string) [required]-
Arn of the policy
EntityFilter(string)-
Filter results by entity type
- More details (AWS)
Example
await aws.IAM.ListEntitiesForPolicy({
PolicyArn: String, // required
EntityFilter: String,
Marker: String,
MaxItems: Number,
PathPrefix: String,
PolicyUsageFilter: String,
})
ListGroupPolicies
Properties
GroupName(string) [required]-
Name of the group; names are not distinguished by case
Marker(string)-
Pagination cursor
MaxItems(number)-
Maximum number of items to be returned in a response; at most 1000
paginate(boolean)-
Enable automatic result pagination; use this instead of making your own individual pagination requests
Example
await aws.IAM.ListGroupPolicies({
GroupName: String, // required
Marker: String,
MaxItems: Number,
paginate: Boolean,
})
ListGroups
Properties
Marker(string)-
Pagination cursor
MaxItems(number)-
Maximum number of items to be returned in a response; at most 1000
PathPrefix(string)-
Filter results by path prefix
paginate(boolean)-
Enable automatic result pagination; use this instead of making your own individual pagination requests
Example
await aws.IAM.ListGroups({
Marker: String,
MaxItems: Number,
PathPrefix: String,
paginate: Boolean,
})
ListGroupsForUser
Properties
UserName(string) [required]-
User name
Marker(string)-
Pagination cursor
MaxItems(number)-
Maximum number of items to be returned in a response; at most 1000
paginate(boolean)-
Enable automatic result pagination; use this instead of making your own individual pagination requests
Example
await aws.IAM.ListGroupsForUser({
UserName: String, // required
Marker: String,
MaxItems: Number,
paginate: Boolean,
})
ListInstanceProfiles
Properties
Marker(string)-
Pagination cursor
MaxItems(number)-
Maximum number of items to be returned in a response; at most 1000
PathPrefix(string)-
Filter results by path prefix
paginate(boolean)-
Enable automatic result pagination; use this instead of making your own individual pagination requests
Example
await aws.IAM.ListInstanceProfiles({
Marker: String,
MaxItems: Number,
PathPrefix: String,
paginate: Boolean,
})
ListInstanceProfilesForRole
Properties
RoleName(string) [required]-
Name of the role
Marker(string)-
Pagination cursor
MaxItems(number)-
Maximum number of items to be returned in a response; at most 1000
paginate(boolean)-
Enable automatic result pagination; use this instead of making your own individual pagination requests
Example
await aws.IAM.ListInstanceProfilesForRole({
RoleName: String, // required
Marker: String,
MaxItems: Number,
paginate: Boolean,
})
ListInstanceProfileTags
Properties
InstanceProfileName(string) [required]-
Name of the instance profile
Marker(string)-
Pagination cursor
MaxItems(number)-
Maximum number of items to be returned in a response; at most 1000
paginate(boolean)-
Enable automatic result pagination; use this instead of making your own individual pagination requests
Example
await aws.IAM.ListInstanceProfileTags({
InstanceProfileName: String, // required
Marker: String,
MaxItems: Number,
paginate: Boolean,
})
ListOpenIDConnectProviders
Properties
Example
await aws.IAM.ListOpenIDConnectProviders()
ListOpenIDConnectProviderTags
Properties
OpenIDConnectProviderArn(string) [required]-
ARN of the OpenID Connect resource
Marker(string)-
Pagination cursor
MaxItems(number)-
Maximum number of items to be returned in a response; at most 1000
paginate(boolean)-
Enable automatic result pagination; use this instead of making your own individual pagination requests
Example
await aws.IAM.ListOpenIDConnectProviderTags({
OpenIDConnectProviderArn: String, // required
Marker: String,
MaxItems: Number,
paginate: Boolean,
})
ListPolicies
Properties
Marker(string)-
Pagination cursor
MaxItems(number)-
Maximum number of items to be returned in a response; at most 1000
OnlyAttached(boolean)-
Set to true to only see attached policies
PathPrefix(string)-
Filter results by path prefix
PolicyUsageFilter(string)-
Filter results by how they are used; can be one of:
PermissionsPolicy,PermissionsBoundary Scope(string)-
Filter results by how they are managed; can be one of:
All,AWS,Local(customer managed) paginate(boolean)-
Enable automatic result pagination; use this instead of making your own individual pagination requests
Example
await aws.IAM.ListPolicies({
Marker: String,
MaxItems: Number,
OnlyAttached: Boolean,
PathPrefix: String,
PolicyUsageFilter: String,
Scope: String,
paginate: Boolean,
})
ListPoliciesGrantingServiceAccess
Properties
Arn(string) [required]-
ARN of the IAM identity whose policies you want to list
ServiceNamespaces(array) [required]-
Array of namespaces for the AWS services to be listed
Marker(string)-
Pagination cursor
paginate(boolean)-
Enable automatic result pagination; use this instead of making your own individual pagination requests
Example
await aws.IAM.ListPoliciesGrantingServiceAccess({
Arn: String, // required
ServiceNamespaces: Array, // required
Marker: String,
paginate: Boolean,
})
ListPolicyTags
Properties
PolicyArn(string) [required]-
Arn of the policy
Marker(string)-
Pagination cursor
MaxItems(number)-
Maximum number of items to be returned in a response; at most 1000
paginate(boolean)-
Enable automatic result pagination; use this instead of making your own individual pagination requests
Example
await aws.IAM.ListPolicyTags({
PolicyArn: String, // required
Marker: String,
MaxItems: Number,
paginate: Boolean,
})
ListPolicyVersions
Properties
PolicyArn(string) [required]-
Arn of the policy
Marker(string)-
Pagination cursor
MaxItems(number)-
Maximum number of items to be returned in a response; at most 1000
paginate(boolean)-
Enable automatic result pagination; use this instead of making your own individual pagination requests
Example
await aws.IAM.ListPolicyVersions({
PolicyArn: String, // required
Marker: String,
MaxItems: Number,
paginate: Boolean,
})
ListRolePolicies
Properties
RoleName(string) [required]-
Name of the role
Marker(string)-
Pagination cursor
MaxItems(number)-
Maximum number of items to be returned in a response; at most 1000
paginate(boolean)-
Enable automatic result pagination; use this instead of making your own individual pagination requests
Example
await aws.IAM.ListRolePolicies({
RoleName: String, // required
Marker: String,
MaxItems: Number,
paginate: Boolean,
})
ListRoles
Properties
Marker(string)-
Pagination cursor
MaxItems(number)-
Maximum number of items to be returned in a response; at most 1000
PathPrefix(string)-
Filter results by path prefix
paginate(boolean)-
Enable automatic result pagination; use this instead of making your own individual pagination requests
Example
await aws.IAM.ListRoles({
Marker: String,
MaxItems: Number,
PathPrefix: String,
paginate: Boolean,
})
ListRoleTags
Properties
RoleName(string) [required]-
Name of the role
Marker(string)-
Pagination cursor
MaxItems(number)-
Maximum number of items to be returned in a response; at most 1000
paginate(boolean)-
Enable automatic result pagination; use this instead of making your own individual pagination requests
Example
await aws.IAM.ListRoleTags({
RoleName: String, // required
Marker: String,
MaxItems: Number,
paginate: Boolean,
})
ListServerCertificates
Properties
Marker(string)-
Pagination cursor
MaxItems(number)-
Maximum number of items to be returned in a response; at most 1000
PathPrefix(string)-
Filter results by path prefix
paginate(boolean)-
Enable automatic result pagination; use this instead of making your own individual pagination requests
Example
await aws.IAM.ListServerCertificates({
Marker: String,
MaxItems: Number,
PathPrefix: String,
paginate: Boolean,
})
ListServerCertificateTags
Properties
ServerCertificateName(string) [required]-
Name of the server certificate; do not include path, cannot contain spaces
Marker(string)-
Pagination cursor
MaxItems(number)-
Maximum number of items to be returned in a response; at most 1000
paginate(boolean)-
Enable automatic result pagination; use this instead of making your own individual pagination requests
Example
await aws.IAM.ListServerCertificateTags({
ServerCertificateName: String, // required
Marker: String,
MaxItems: Number,
paginate: Boolean,
})
ListServiceSpecificCredentials
Properties
ServiceName(string)-
Filter results to a specific service
UserName(string)-
User name
Example
await aws.IAM.ListServiceSpecificCredentials({
ServiceName: String,
UserName: String,
})
ListSigningCertificates
Properties
Marker(string)-
Pagination cursor
MaxItems(number)-
Maximum number of items to be returned in a response; at most 1000
UserName(string)-
User name
Example
await aws.IAM.ListSigningCertificates({
Marker: String,
MaxItems: Number,
UserName: String,
})
ListSSHPublicKeys
Properties
Marker(string)-
Pagination cursor
MaxItems(number)-
Maximum number of items to be returned in a response; at most 1000
UserName(string)-
User name
Example
await aws.IAM.ListSSHPublicKeys({
Marker: String,
MaxItems: Number,
UserName: String,
})
ListUserPolicies
Properties
UserName(string) [required]-
User name
Marker(string)-
Pagination cursor
MaxItems(number)-
Maximum number of items to be returned in a response; at most 1000
paginate(boolean)-
Enable automatic result pagination; use this instead of making your own individual pagination requests
Example
await aws.IAM.ListUserPolicies({
UserName: String, // required
Marker: String,
MaxItems: Number,
paginate: Boolean,
})
ListUsers
Properties
Marker(string)-
Pagination cursor
MaxItems(number)-
Maximum number of items to be returned in a response; at most 1000
PathPrefix(string)-
Filter results by path prefix
paginate(boolean)-
Enable automatic result pagination; use this instead of making your own individual pagination requests
Example
await aws.IAM.ListUsers({
Marker: String,
MaxItems: Number,
PathPrefix: String,
paginate: Boolean,
})
ListUserTags
Properties
UserName(string) [required]-
User name
Marker(string)-
Pagination cursor
MaxItems(number)-
Maximum number of items to be returned in a response; at most 1000
paginate(boolean)-
Enable automatic result pagination; use this instead of making your own individual pagination requests
Example
await aws.IAM.ListUserTags({
UserName: String, // required
Marker: String,
MaxItems: Number,
paginate: Boolean,
})
ListVirtualMFADevices
Properties
AssignmentStatus(string)-
Filter results by assignment status; can be one of:
Assigned,Unassigned,Any Marker(string)-
Pagination cursor
MaxItems(number)-
Maximum number of items to be returned in a response; at most 1000
paginate(boolean)-
Enable automatic result pagination; use this instead of making your own individual pagination requests
Example
await aws.IAM.ListVirtualMFADevices({
AssignmentStatus: String,
Marker: String,
MaxItems: Number,
paginate: Boolean,
})
PutGroupPolicy
Properties
GroupName(string) [required]-
Name of the group; names are not distinguished by case
PolicyDocument(string, object) [required]-
The policy document; can be an object, or JSON or YAML string
PolicyName(string) [required]-
Name of the policy
Example
await aws.IAM.PutGroupPolicy({
GroupName: String, // required
PolicyDocument: String || Object, // required
PolicyName: String, // required
})
PutRolePermissionsBoundary
Properties
PermissionsBoundary(string) [required]-
ARN of a managed policy to be used to set the resource’s permissions boundary
RoleName(string) [required]-
Name of the role
Example
await aws.IAM.PutRolePermissionsBoundary({
PermissionsBoundary: String, // required
RoleName: String, // required
})
PutRolePolicy
Properties
PolicyDocument(string, object) [required]-
The policy document; can be an object, or JSON or YAML string
PolicyName(string) [required]-
Name of the policy
RoleName(string) [required]-
Name of the role
Example
await aws.IAM.PutRolePolicy({
PolicyDocument: String || Object, // required
PolicyName: String, // required
RoleName: String, // required
})
PutUserPermissionsBoundary
Properties
PermissionsBoundary(string) [required]-
ARN of a managed policy to be used to set the resource’s permissions boundary
UserName(string) [required]-
User name
Example
await aws.IAM.PutUserPermissionsBoundary({
PermissionsBoundary: String, // required
UserName: String, // required
})
PutUserPolicy
Properties
PolicyDocument(string, object) [required]-
The policy document; can be an object, or JSON or YAML string
PolicyName(string) [required]-
Name of the policy
UserName(string) [required]-
User name
Example
await aws.IAM.PutUserPolicy({
PolicyDocument: String || Object, // required
PolicyName: String, // required
UserName: String, // required
})
RemoveClientIDFromOpenIDConnectProvider
Properties
ClientID(string) [required]-
The client ID
OpenIDConnectProviderArn(string) [required]-
ARN of the OpenID Connect resource
Example
await aws.IAM.RemoveClientIDFromOpenIDConnectProvider({
ClientID: String, // required
OpenIDConnectProviderArn: String, // required
})
RemoveRoleFromInstanceProfile
Properties
InstanceProfileName(string) [required]-
Name of the instance profile
RoleName(string) [required]-
Name of the role
Example
await aws.IAM.RemoveRoleFromInstanceProfile({
InstanceProfileName: String, // required
RoleName: String, // required
})
RemoveUserFromGroup
Properties
GroupName(string) [required]-
Name of the group; names are not distinguished by case
UserName(string) [required]-
User name
Example
await aws.IAM.RemoveUserFromGroup({
GroupName: String, // required
UserName: String, // required
})
ResetServiceSpecificCredential
Properties
ServiceSpecificCredentialId(string) [required]-
ID of the service specific credential
UserName(string)-
User name
Example
await aws.IAM.ResetServiceSpecificCredential({
ServiceSpecificCredentialId: String, // required
UserName: String,
})
SetDefaultPolicyVersion
Properties
PolicyArn(string) [required]-
Arn of the policy
VersionId(string) [required]-
ID of the policy version; typically
v<n>
Example
await aws.IAM.SetDefaultPolicyVersion({
PolicyArn: String, // required
VersionId: String, // required
})
SetSecurityTokenServicePreferences
Properties
GlobalEndpointTokenVersion(string) [required]-
Version of the global endpoint token; can be one of:
v1Token,v2Token - Example
await aws.IAM.SetSecurityTokenServicePreferences({ GlobalEndpointTokenVersion: String, // required })
SimulateCustomPolicy
Properties
ActionNames(array) [required]-
Array of between 3 to 128 API operation names
PolicyInputList(array) [required]-
Array of policy document objects
CallerArn(string)-
ARN of the IAM user to use as the simulated caller of the API operations
ContextEntries(array)-
Array of context keys and values
Marker(string)-
Pagination cursor
MaxItems(number)-
Maximum number of items to be returned in a response; at most 1000
PermissionsBoundaryPolicyInputList(array)-
IAM permissions boundary policy to simulate
ResourceArns(array)-
Array of AWS resource ARNs; default
* ResourceHandlingOption(string)-
Specify the type of simulation to run
ResourceOwner(string)-
ARN representing the AWS account ID that owns any simulated resources
ResourcePolicy(string, object)-
A resource based policy
paginate(boolean)-
Enable automatic result pagination; use this instead of making your own individual pagination requests
Example
await aws.IAM.SimulateCustomPolicy({
ActionNames: Array, // required
PolicyInputList: Array, // required
CallerArn: String,
ContextEntries: Array,
Marker: String,
MaxItems: Number,
PermissionsBoundaryPolicyInputList: Array,
ResourceArns: Array,
ResourceHandlingOption: String,
ResourceOwner: String,
ResourcePolicy: String || Object,
paginate: Boolean,
})
SimulatePrincipalPolicy
Properties
ActionNames(array) [required]-
Array of between 3 to 128 API operation names
PolicySourceArn(string) [required]-
ARN of the user, group or role whose policies will be included in the simulation
CallerArn(string)-
ARN of the IAM user to use as the simulated caller of the API operations
ContextEntries(array)-
Array of context keys and values
Marker(string)-
Pagination cursor
MaxItems(number)-
Maximum number of items to be returned in a response; at most 1000
PermissionsBoundaryPolicyInputList(array)-
IAM permissions boundary policy to simulate
PolicyInputList(array)-
Array of policy document objects
ResourceArns(array)-
Array of AWS resource ARNs; default
* ResourceHandlingOption(string)-
Specify the type of simulation to run
ResourceOwner(string)-
ARN representing the AWS account ID that owns any simulated resources
ResourcePolicy(string, object)-
A resource based policy
paginate(boolean)-
Enable automatic result pagination; use this instead of making your own individual pagination requests
Example
await aws.IAM.SimulatePrincipalPolicy({
ActionNames: Array, // required
PolicySourceArn: String, // required
CallerArn: String,
ContextEntries: Array,
Marker: String,
MaxItems: Number,
PermissionsBoundaryPolicyInputList: Array,
PolicyInputList: Array,
ResourceArns: Array,
ResourceHandlingOption: String,
ResourceOwner: String,
ResourcePolicy: String || Object,
paginate: Boolean,
})
TagInstanceProfile
Properties
InstanceProfileName(string) [required]-
Name of the instance profile
Tags(array) [required]-
List of tags to attach to the resource
- Example
await aws.IAM.TagInstanceProfile({ InstanceProfileName: String, // required Tags: Array, // required })
TagOpenIDConnectProvider
Properties
OpenIDConnectProviderArn(string) [required]-
ARN of the OpenID Connect resource
Tags(array) [required]-
List of tags to attach to the resource
- Example
await aws.IAM.TagOpenIDConnectProvider({ OpenIDConnectProviderArn: String, // required Tags: Array, // required })
TagPolicy
Properties
PolicyArn(string) [required]-
Arn of the policy
Tags(array) [required]-
List of tags to attach to the resource
- Example
await aws.IAM.TagPolicy({ PolicyArn: String, // required Tags: Array, // required })
TagRole
Properties
RoleName(string) [required]-
Name of the role
Tags(array) [required]-
List of tags to attach to the resource
- Example
await aws.IAM.TagRole({ RoleName: String, // required Tags: Array, // required })
TagServerCertificate
Properties
ServerCertificateName(string) [required]-
Name of the server certificate; do not include path, cannot contain spaces
Tags(array) [required]-
List of tags to attach to the resource
- Example
await aws.IAM.TagServerCertificate({ ServerCertificateName: String, // required Tags: Array, // required })
TagUser
Properties
Tags(array) [required]-
List of tags to attach to the resource
- Example
await aws.IAM.TagUser({ Tags: Array, // required UserName: String, // required })
UntagInstanceProfile
Properties
InstanceProfileName(string) [required]-
Name of the instance profile
TagKeys(array) [required]-
Array of tag keys
Example
await aws.IAM.UntagInstanceProfile({
InstanceProfileName: String, // required
TagKeys: Array, // required
})
UntagOpenIDConnectProvider
Properties
OpenIDConnectProviderArn(string) [required]-
ARN of the OpenID Connect resource
TagKeys(array) [required]-
Array of tag keys
Example
await aws.IAM.UntagOpenIDConnectProvider({
OpenIDConnectProviderArn: String, // required
TagKeys: Array, // required
})
UntagPolicy
Properties
PolicyArn(string) [required]-
Arn of the policy
TagKeys(array) [required]-
Array of tag keys
Example
await aws.IAM.UntagPolicy({
PolicyArn: String, // required
TagKeys: Array, // required
})
UntagRole
Properties
RoleName(string) [required]-
Name of the role
TagKeys(array) [required]-
Array of tag keys
Example
await aws.IAM.UntagRole({
RoleName: String, // required
TagKeys: Array, // required
})
UntagServerCertificate
Properties
ServerCertificateName(string) [required]-
Name of the server certificate; do not include path, cannot contain spaces
TagKeys(array) [required]-
Array of tag keys
Example
await aws.IAM.UntagServerCertificate({
ServerCertificateName: String, // required
TagKeys: Array, // required
})
UntagUser
Properties
TagKeys(array) [required]-
Array of tag keys
UserName(string) [required]-
User name
Example
await aws.IAM.UntagUser({
TagKeys: Array, // required
UserName: String, // required
})
UpdateAccessKey
Properties
AccessKeyId(string) [required]-
ID of the access key
Status(string) [required]-
New status for the access key; can be one of:
Active,Inactive UserName(string)-
User name
Example
await aws.IAM.UpdateAccessKey({
AccessKeyId: String, // required
Status: String, // required
UserName: String,
})
UpdateAccountPasswordPolicy
Properties
AllowUsersToChangePassword(boolean)-
Set to true to allow users to change their own passwords
HardExpiry(boolean)-
Set to true to prevent users their password after it expires
MaxPasswordAge(number)-
Number of days between 1 and 1095 before passwords expire
MinimumPasswordLength(number)-
Minimum number of characters between 6 and 128 allowed in a password
PasswordReusePrevention(number)-
Specify how many new passwords from 1 to 24 before a password may be reused
RequireLowercaseCharacters(boolean)-
Set to true to require at least one lowercase character
RequireNumbers(boolean)-
Set to true to require at least one numeric character
RequireSymbols(boolean)-
Set to true to require at least one non-alphanumeric character
RequireUppercaseCharacters(boolean)-
Set to true to require at least one uppercase character
Example
await aws.IAM.UpdateAccountPasswordPolicy({
AllowUsersToChangePassword: Boolean,
HardExpiry: Boolean,
MaxPasswordAge: Number,
MinimumPasswordLength: Number,
PasswordReusePrevention: Number,
RequireLowercaseCharacters: Boolean,
RequireNumbers: Boolean,
RequireSymbols: Boolean,
RequireUppercaseCharacters: Boolean,
})
UpdateAssumeRolePolicy
Properties
PolicyDocument(string, object) [required]-
The policy document; can be an object, or JSON or YAML string
RoleName(string) [required]-
Name of the role
Example
await aws.IAM.UpdateAssumeRolePolicy({
PolicyDocument: String || Object, // required
RoleName: String, // required
})
UpdateGroup
Properties
GroupName(string) [required]-
Name of the group; names are not distinguished by case
NewGroupName(string)-
New name for the group
NewPath(string)-
New path for the service
Example
await aws.IAM.UpdateGroup({
GroupName: String, // required
NewGroupName: String,
NewPath: String,
})
UpdateLoginProfile
Properties
UserName(string) [required]-
User name
Password(string)-
New password for the user
PasswordResetRequired(boolean)-
Set to true to specify the user must make a new password on next sign-in
Example
await aws.IAM.UpdateLoginProfile({
UserName: String, // required
Password: String,
PasswordResetRequired: Boolean,
})
UpdateOpenIDConnectProviderThumbprint
Properties
OpenIDConnectProviderArn(string) [required]-
ARN of the OpenID Connect resource
ThumbprintList(array) [required]-
List of certificate thumbprints
- Example
await aws.IAM.UpdateOpenIDConnectProviderThumbprint({ OpenIDConnectProviderArn: String, // required ThumbprintList: Array, // required })
UpdateRole
Properties
RoleName(string) [required]-
Name of the role
Description(string)-
Description of the resource
MaxSessionDuration(number)-
Maximum session duration (in seconds) to set for the specified role
Example
await aws.IAM.UpdateRole({
RoleName: String, // required
Description: String,
MaxSessionDuration: Number,
})
UpdateRoleDescription
Properties
RoleName(string) [required]-
Name of the role
Description(string)-
Description of the resource
Example
await aws.IAM.UpdateRoleDescription({
RoleName: String, // required
Description: String,
})
UpdateServerCertificate
Properties
ServerCertificateName(string) [required]-
Name of the server certificate; do not include path, cannot contain spaces
NewPath(string)-
New path for the service
NewServerCertificateName(string)-
New name for the server certificate
Example
await aws.IAM.UpdateServerCertificate({
ServerCertificateName: String, // required
NewPath: String,
NewServerCertificateName: String,
})
UpdateServiceSpecificCredential
Properties
ServiceSpecificCredentialId(string) [required]-
ID of the service specific credential
Status(string) [required]-
Status to be assigned to the credential; can be one of:
Active,Inactive UserName(string)-
User name
Example
await aws.IAM.UpdateServiceSpecificCredential({
ServiceSpecificCredentialId: String, // required
Status: String, // required
UserName: String,
})
UpdateSigningCertificate
Properties
CertificateId(string) [required]-
ID of the signing certificate
Status(string) [required]-
Status to be assigned to the signing certificate; can be one of:
Active,Inactive UserName(string)-
User name
Example
await aws.IAM.UpdateSigningCertificate({
CertificateId: String, // required
Status: String, // required
UserName: String,
})
UpdateSSHPublicKey
Properties
SSHPublicKeyId(string) [required]-
ID of the SSH public key
Status(string) [required]-
New status for the SSH key; can be one of :
Active,Inactive UserName(string) [required]-
User name
Example
await aws.IAM.UpdateSSHPublicKey({
SSHPublicKeyId: String, // required
Status: String, // required
UserName: String, // required
})
UpdateUser
Properties
UserName(string) [required]-
User name
NewPath(string)-
New path for the service
NewUserName(string)-
New user name
Example
await aws.IAM.UpdateUser({
UserName: String, // required
NewPath: String,
NewUserName: String,
})
UploadServerCertificate
Properties
CertificateBody(string) [required]-
PEM encoded public key
- More details (AWS)
Tags(array)-
List of tags to attach to the resource
- Example
await aws.IAM.UploadServerCertificate({ CertificateBody: String, // required PrivateKey: String, // required ServerCertificateName: String, // required CertificateChain: String, Path: String, Tags: Array, })
UploadSigningCertificate
Properties
CertificateBody(string) [required]-
Contents of the signing certificate
- Example
await aws.IAM.UploadSigningCertificate({ CertificateBody: String, // required UserName: String, })
UploadSSHPublicKey
Properties
SSHPublicKeyBody(string) [required]-
SSH public key encoded in SSH-RSA or PEM format; minimum length is 2048 bits
- Example
await aws.IAM.UploadSSHPublicKey({ SSHPublicKeyBody: String, // required UserName: String, // required })
Methods yet to be implemented
Please help out by opening a PR!
CreateSAMLProviderDeactivateMFADeviceDeleteSAMLProviderEnableMFADeviceGetMFADeviceGetSAMLProviderGetServiceLinkedRoleDeletionStatusListMFADevicesListMFADeviceTagsListSAMLProvidersListSAMLProviderTagsResyncMFADeviceTagMFADeviceTagSAMLProviderUntagMFADeviceUntagSAMLProviderUpdateSAMLProvider