@datafire/amazonaws_iam
v5.0.0
Published
DataFire integration for AWS Identity and Access Management
Downloads
24
Readme
@datafire/amazonaws_iam
Client library for AWS Identity and Access Management
Installation and Usage
npm install --save @datafire/amazonaws_iam
let amazonaws_iam = require('@datafire/amazonaws_iam').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
amazonaws_iam.AddClientIDToOpenIDConnectProvider({
"OpenIDConnectProviderArn": "",
"ClientID": ""
}).then(data => {
console.log(data);
});
Description
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. AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to IAM and AWS. For example, the SDKs take care of tasks such as cryptographically signing requests (see below), managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the Tools for Amazon Web Services page. We recommend that you use the AWS SDKs to make programmatic API 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. This topic provides general information about the types of credentials used for accessing AWS. IAM Best Practices. This topic presents a list of suggestions for using the IAM service to help secure your AWS resources. Signing AWS API Requests. This set of topics walk you through the process of signing a request using an access key ID and secret access key.
Actions
AddClientIDToOpenIDConnectProvider
amazonaws_iam.AddClientIDToOpenIDConnectProvider({
"OpenIDConnectProviderArn": "",
"ClientID": ""
}, context)
Input
- input
object
- ClientID required clientIDType
- OpenIDConnectProviderArn required arnType
Output
Output schema unknown
AddRoleToInstanceProfile
amazonaws_iam.AddRoleToInstanceProfile({
"InstanceProfileName": "",
"RoleName": ""
}, context)
Input
- input
object
- InstanceProfileName required instanceProfileNameType
- RoleName required roleNameType
Output
Output schema unknown
AddUserToGroup
amazonaws_iam.AddUserToGroup({
"GroupName": "",
"UserName": ""
}, context)
Input
- input
object
- GroupName required groupNameType
- UserName required existingUserNameType
Output
Output schema unknown
AttachGroupPolicy
amazonaws_iam.AttachGroupPolicy({
"GroupName": "",
"PolicyArn": ""
}, context)
Input
- input
object
- GroupName required groupNameType
- PolicyArn required arnType
Output
Output schema unknown
AttachRolePolicy
amazonaws_iam.AttachRolePolicy({
"RoleName": "",
"PolicyArn": ""
}, context)
Input
- input
object
- PolicyArn required arnType
- RoleName required roleNameType
Output
Output schema unknown
AttachUserPolicy
amazonaws_iam.AttachUserPolicy({
"UserName": "",
"PolicyArn": ""
}, context)
Input
- input
object
- PolicyArn required arnType
- UserName required userNameType
Output
Output schema unknown
ChangePassword
amazonaws_iam.ChangePassword({
"OldPassword": "",
"NewPassword": ""
}, context)
Input
- input
object
- NewPassword required passwordType
- OldPassword required passwordType
Output
Output schema unknown
CreateAccessKey
amazonaws_iam.CreateAccessKey({}, context)
Input
- input
object
- UserName existingUserNameType
Output
- output CreateAccessKeyResponse
CreateAccountAlias
amazonaws_iam.CreateAccountAlias({
"AccountAlias": ""
}, context)
Input
- input
object
- AccountAlias required accountAliasType
Output
Output schema unknown
CreateGroup
amazonaws_iam.CreateGroup({
"GroupName": ""
}, context)
Input
- input
object
- GroupName required groupNameType
- Path pathType
Output
- output CreateGroupResponse
CreateInstanceProfile
amazonaws_iam.CreateInstanceProfile({
"InstanceProfileName": ""
}, context)
Input
- input
object
- InstanceProfileName required instanceProfileNameType
- Path pathType
Output
CreateLoginProfile
amazonaws_iam.CreateLoginProfile({
"UserName": "",
"Password": ""
}, context)
Input
- input
object
- Password required passwordType
- PasswordResetRequired booleanType
- UserName required userNameType
Output
- output CreateLoginProfileResponse
CreateOpenIDConnectProvider
amazonaws_iam.CreateOpenIDConnectProvider({
"Url": "",
"ThumbprintList": []
}, context)
Input
- input
object
- ClientIDList clientIDListType
- ThumbprintList required thumbprintListType
- Url required OpenIDConnectProviderUrlType
Output
CreatePolicy
amazonaws_iam.CreatePolicy({
"PolicyName": "",
"PolicyDocument": ""
}, context)
Input
- input
object
- Description policyDescriptionType
- Path policyPathType
- PolicyDocument required policyDocumentType
- PolicyName required policyNameType
Output
- output CreatePolicyResponse
CreatePolicyVersion
amazonaws_iam.CreatePolicyVersion({
"PolicyArn": "",
"PolicyDocument": ""
}, context)
Input
- input
object
- PolicyArn required arnType
- PolicyDocument required policyDocumentType
- SetAsDefault booleanType
Output
- output CreatePolicyVersionResponse
CreateRole
amazonaws_iam.CreateRole({
"RoleName": "",
"AssumeRolePolicyDocument": ""
}, context)
Input
- input
object
- AssumeRolePolicyDocument required policyDocumentType
- Description roleDescriptionType
- Path pathType
- RoleName required roleNameType
Output
- output CreateRoleResponse
CreateSAMLProvider
amazonaws_iam.CreateSAMLProvider({
"SAMLMetadataDocument": "",
"Name": ""
}, context)
Input
- input
object
- Name required SAMLProviderNameType
- SAMLMetadataDocument required SAMLMetadataDocumentType
Output
- output CreateSAMLProviderResponse
CreateServiceLinkedRole
amazonaws_iam.CreateServiceLinkedRole({
"AWSServiceName": ""
}, context)
Input
- input
object
- AWSServiceName required groupNameType
- CustomSuffix customSuffixType
- Description roleDescriptionType
Output
CreateServiceSpecificCredential
amazonaws_iam.CreateServiceSpecificCredential({
"UserName": "",
"ServiceName": ""
}, context)
Input
- input
object
- ServiceName required serviceName
- UserName required userNameType
Output
CreateUser
amazonaws_iam.CreateUser({
"UserName": ""
}, context)
Input
- input
object
- Path pathType
- UserName required userNameType
Output
- output CreateUserResponse
CreateVirtualMFADevice
amazonaws_iam.CreateVirtualMFADevice({
"VirtualMFADeviceName": ""
}, context)
Input
- input
object
- Path pathType
- VirtualMFADeviceName required virtualMFADeviceName
Output
DeactivateMFADevice
amazonaws_iam.DeactivateMFADevice({
"UserName": "",
"SerialNumber": ""
}, context)
Input
- input
object
- SerialNumber required serialNumberType
- UserName required existingUserNameType
Output
Output schema unknown
DeleteAccessKey
amazonaws_iam.DeleteAccessKey({
"AccessKeyId": ""
}, context)
Input
- input
object
- AccessKeyId required accessKeyIdType
- UserName existingUserNameType
Output
Output schema unknown
DeleteAccountAlias
amazonaws_iam.DeleteAccountAlias({
"AccountAlias": ""
}, context)
Input
- input
object
- AccountAlias required accountAliasType
Output
Output schema unknown
DeleteAccountPasswordPolicy
amazonaws_iam.DeleteAccountPasswordPolicy({}, context)
Input
- input
object
Output
Output schema unknown
DeleteGroup
amazonaws_iam.DeleteGroup({
"GroupName": ""
}, context)
Input
- input
object
- GroupName required groupNameType
Output
Output schema unknown
DeleteGroupPolicy
amazonaws_iam.DeleteGroupPolicy({
"GroupName": "",
"PolicyName": ""
}, context)
Input
- input
object
- GroupName required groupNameType
- PolicyName required policyNameType
Output
Output schema unknown
DeleteInstanceProfile
amazonaws_iam.DeleteInstanceProfile({
"InstanceProfileName": ""
}, context)
Input
- input
object
- InstanceProfileName required instanceProfileNameType
Output
Output schema unknown
DeleteLoginProfile
amazonaws_iam.DeleteLoginProfile({
"UserName": ""
}, context)
Input
- input
object
- UserName required userNameType
Output
Output schema unknown
DeleteOpenIDConnectProvider
amazonaws_iam.DeleteOpenIDConnectProvider({
"OpenIDConnectProviderArn": ""
}, context)
Input
- input
object
- OpenIDConnectProviderArn required arnType
Output
Output schema unknown
DeletePolicy
amazonaws_iam.DeletePolicy({
"PolicyArn": ""
}, context)
Input
- input
object
- PolicyArn required arnType
Output
Output schema unknown
DeletePolicyVersion
amazonaws_iam.DeletePolicyVersion({
"PolicyArn": "",
"VersionId": ""
}, context)
Input
- input
object
- PolicyArn required arnType
- VersionId required policyVersionIdType
Output
Output schema unknown
DeleteRole
amazonaws_iam.DeleteRole({
"RoleName": ""
}, context)
Input
- input
object
- RoleName required roleNameType
Output
Output schema unknown
DeleteRolePolicy
amazonaws_iam.DeleteRolePolicy({
"RoleName": "",
"PolicyName": ""
}, context)
Input
- input
object
- PolicyName required policyNameType
- RoleName required roleNameType
Output
Output schema unknown
DeleteSAMLProvider
amazonaws_iam.DeleteSAMLProvider({
"SAMLProviderArn": ""
}, context)
Input
- input
object
- SAMLProviderArn required arnType
Output
Output schema unknown
DeleteSSHPublicKey
amazonaws_iam.DeleteSSHPublicKey({
"UserName": "",
"SSHPublicKeyId": ""
}, context)
Input
- input
object
- SSHPublicKeyId required publicKeyIdType
- UserName required userNameType
Output
Output schema unknown
DeleteServerCertificate
amazonaws_iam.DeleteServerCertificate({
"ServerCertificateName": ""
}, context)
Input
- input
object
- ServerCertificateName required serverCertificateNameType
Output
Output schema unknown
DeleteServiceLinkedRole
amazonaws_iam.DeleteServiceLinkedRole({
"RoleName": ""
}, context)
Input
- input
object
- RoleName required roleNameType
Output
DeleteServiceSpecificCredential
amazonaws_iam.DeleteServiceSpecificCredential({
"ServiceSpecificCredentialId": ""
}, context)
Input
- input
object
- ServiceSpecificCredentialId required serviceSpecificCredentialId
- UserName userNameType
Output
Output schema unknown
DeleteSigningCertificate
amazonaws_iam.DeleteSigningCertificate({
"CertificateId": ""
}, context)
Input
- input
object
- CertificateId required certificateIdType
- UserName existingUserNameType
Output
Output schema unknown
DeleteUser
amazonaws_iam.DeleteUser({
"UserName": ""
}, context)
Input
- input
object
- UserName required existingUserNameType
Output
Output schema unknown
DeleteUserPolicy
amazonaws_iam.DeleteUserPolicy({
"UserName": "",
"PolicyName": ""
}, context)
Input
- input
object
- PolicyName required policyNameType
- UserName required existingUserNameType
Output
Output schema unknown
DeleteVirtualMFADevice
amazonaws_iam.DeleteVirtualMFADevice({
"SerialNumber": ""
}, context)
Input
- input
object
- SerialNumber required serialNumberType
Output
Output schema unknown
DetachGroupPolicy
amazonaws_iam.DetachGroupPolicy({
"GroupName": "",
"PolicyArn": ""
}, context)
Input
- input
object
- GroupName required groupNameType
- PolicyArn required arnType
Output
Output schema unknown
DetachRolePolicy
amazonaws_iam.DetachRolePolicy({
"RoleName": "",
"PolicyArn": ""
}, context)
Input
- input
object
- PolicyArn required arnType
- RoleName required roleNameType
Output
Output schema unknown
DetachUserPolicy
amazonaws_iam.DetachUserPolicy({
"UserName": "",
"PolicyArn": ""
}, context)
Input
- input
object
- PolicyArn required arnType
- UserName required userNameType
Output
Output schema unknown
EnableMFADevice
amazonaws_iam.EnableMFADevice({
"UserName": "",
"SerialNumber": "",
"AuthenticationCode1": "",
"AuthenticationCode2": ""
}, context)
Input
- input
object
- AuthenticationCode1 required authenticationCodeType
- AuthenticationCode2 required authenticationCodeType
- SerialNumber required serialNumberType
- UserName required existingUserNameType
Output
Output schema unknown
GenerateCredentialReport
amazonaws_iam.GenerateCredentialReport({}, context)
Input
- input
object
Output
GetAccessKeyLastUsed
amazonaws_iam.GetAccessKeyLastUsed({
"AccessKeyId": ""
}, context)
Input
- input
object
- AccessKeyId required accessKeyIdType
Output
- output GetAccessKeyLastUsedResponse
GetAccountAuthorizationDetails
amazonaws_iam.GetAccountAuthorizationDetails({}, context)
Input
- input
object
- MaxItems
string
- Marker
string
- Filter entityListType
- Marker markerType
- MaxItems maxItemsType
- MaxItems
Output
GetAccountPasswordPolicy
amazonaws_iam.GetAccountPasswordPolicy({}, context)
Input
- input
object
Output
GetAccountSummary
amazonaws_iam.GetAccountSummary({}, context)
Input
- input
object
Output
- output GetAccountSummaryResponse
GetContextKeysForCustomPolicy
amazonaws_iam.GetContextKeysForCustomPolicy({
"PolicyInputList": []
}, context)
Input
- input
object
- PolicyInputList required SimulationPolicyListType
Output
GetContextKeysForPrincipalPolicy
amazonaws_iam.GetContextKeysForPrincipalPolicy({
"PolicySourceArn": ""
}, context)
Input
- input
object
- PolicyInputList SimulationPolicyListType
- PolicySourceArn required arnType
Output
GetCredentialReport
amazonaws_iam.GetCredentialReport({}, context)
Input
- input
object
Output
- output GetCredentialReportResponse
GetGroup
amazonaws_iam.GetGroup({
"GroupName": ""
}, context)
Input
- input
object
- MaxItems
string
- Marker
string
- GroupName required groupNameType
- Marker markerType
- MaxItems maxItemsType
- MaxItems
Output
- output GetGroupResponse
GetGroupPolicy
amazonaws_iam.GetGroupPolicy({
"GroupName": "",
"PolicyName": ""
}, context)
Input
- input
object
- GroupName required groupNameType
- PolicyName required policyNameType
Output
- output GetGroupPolicyResponse
GetInstanceProfile
amazonaws_iam.GetInstanceProfile({
"InstanceProfileName": ""
}, context)
Input
- input
object
- InstanceProfileName required instanceProfileNameType
Output
- output GetInstanceProfileResponse
GetLoginProfile
amazonaws_iam.GetLoginProfile({
"UserName": ""
}, context)
Input
- input
object
- UserName required userNameType
Output
- output GetLoginProfileResponse
GetOpenIDConnectProvider
amazonaws_iam.GetOpenIDConnectProvider({
"OpenIDConnectProviderArn": ""
}, context)
Input
- input
object
- OpenIDConnectProviderArn required arnType
Output
GetPolicy
amazonaws_iam.GetPolicy({
"PolicyArn": ""
}, context)
Input
- input
object
- PolicyArn required arnType
Output
- output GetPolicyResponse
GetPolicyVersion
amazonaws_iam.GetPolicyVersion({
"PolicyArn": "",
"VersionId": ""
}, context)
Input
- input
object
- PolicyArn required arnType
- VersionId required policyVersionIdType
Output
- output GetPolicyVersionResponse
GetRole
amazonaws_iam.GetRole({
"RoleName": ""
}, context)
Input
- input
object
- RoleName required roleNameType
Output
- output GetRoleResponse
GetRolePolicy
amazonaws_iam.GetRolePolicy({
"RoleName": "",
"PolicyName": ""
}, context)
Input
- input
object
- PolicyName required policyNameType
- RoleName required roleNameType
Output
- output GetRolePolicyResponse
GetSAMLProvider
amazonaws_iam.GetSAMLProvider({
"SAMLProviderArn": ""
}, context)
Input
- input
object
- SAMLProviderArn required arnType
Output
- output GetSAMLProviderResponse
GetSSHPublicKey
amazonaws_iam.GetSSHPublicKey({
"UserName": "",
"SSHPublicKeyId": "",
"Encoding": ""
}, context)
Input
- input
object
- Encoding required encodingType
- SSHPublicKeyId required publicKeyIdType
- UserName required userNameType
Output
- output GetSSHPublicKeyResponse
GetServerCertificate
amazonaws_iam.GetServerCertificate({
"ServerCertificateName": ""
}, context)
Input
- input
object
- ServerCertificateName required serverCertificateNameType
Output
- output GetServerCertificateResponse
GetServiceLinkedRoleDeletionStatus
amazonaws_iam.GetServiceLinkedRoleDeletionStatus({
"DeletionTaskId": ""
}, context)
Input
- input
object
- DeletionTaskId required DeletionTaskIdType
Output
GetUser
amazonaws_iam.GetUser({}, context)
Input
- input
object
- UserName existingUserNameType
Output
- output GetUserResponse
GetUserPolicy
amazonaws_iam.GetUserPolicy({
"UserName": "",
"PolicyName": ""
}, context)
Input
- input
object
- PolicyName required policyNameType
- UserName required existingUserNameType
Output
- output GetUserPolicyResponse
ListAccessKeys
amazonaws_iam.ListAccessKeys({}, context)
Input
- input
object
- MaxItems
string
- Marker
string
- Marker markerType
- MaxItems maxItemsType
- UserName existingUserNameType
- MaxItems
Output
- output ListAccessKeysResponse
ListAccountAliases
amazonaws_iam.ListAccountAliases({}, context)
Input
- input
object
- MaxItems
string
- Marker
string
- Marker markerType
- MaxItems maxItemsType
- MaxItems
Output
- output ListAccountAliasesResponse
ListAttachedGroupPolicies
amazonaws_iam.ListAttachedGroupPolicies({
"GroupName": ""
}, context)
Input
- input
object
- MaxItems
string
- Marker
string
- GroupName required groupNameType
- Marker markerType
- MaxItems maxItemsType
- PathPrefix policyPathType
- MaxItems
Output
ListAttachedRolePolicies
amazonaws_iam.ListAttachedRolePolicies({
"RoleName": ""
}, context)
Input
- input
object
- MaxItems
string
- Marker
string
- Marker markerType
- MaxItems maxItemsType
- PathPrefix policyPathType
- RoleName required roleNameType
- MaxItems
Output
ListAttachedUserPolicies
amazonaws_iam.ListAttachedUserPolicies({
"UserName": ""
}, context)
Input
- input
object
- MaxItems
string
- Marker
string
- Marker markerType
- MaxItems maxItemsType
- PathPrefix policyPathType
- UserName required userNameType
- MaxItems
Output
ListEntitiesForPolicy
amazonaws_iam.ListEntitiesForPolicy({
"PolicyArn": ""
}, context)
Input
- input
object
- MaxItems
string
- Marker
string
- EntityFilter EntityType
- Marker markerType
- MaxItems maxItemsType
- PathPrefix pathType
- PolicyArn required arnType
- MaxItems
Output
ListGroupPolicies
amazonaws_iam.ListGroupPolicies({
"GroupName": ""
}, context)
Input
- input
object
- MaxItems
string
- Marker
string
- GroupName required groupNameType
- Marker markerType
- MaxItems maxItemsType
- MaxItems
Output
- output ListGroupPoliciesResponse
ListGroups
amazonaws_iam.ListGroups({}, context)
Input
- input
object
- MaxItems
string
- Marker
string
- Marker markerType
- MaxItems maxItemsType
- PathPrefix pathPrefixType
- MaxItems
Output
- output ListGroupsResponse
ListGroupsForUser
amazonaws_iam.ListGroupsForUser({
"UserName": ""
}, context)
Input
- input
object
- MaxItems
string
- Marker
string
- Marker markerType
- MaxItems maxItemsType
- UserName required existingUserNameType
- MaxItems
Output
- output ListGroupsForUserResponse
ListInstanceProfiles
amazonaws_iam.ListInstanceProfiles({}, context)
Input
- input
object
- MaxItems
string
- Marker
string
- Marker markerType
- MaxItems maxItemsType
- PathPrefix pathPrefixType
- MaxItems
Output
- output ListInstanceProfilesResponse
ListInstanceProfilesForRole
amazonaws_iam.ListInstanceProfilesForRole({
"RoleName": ""
}, context)
Input
- input
object
- MaxItems
string
- Marker
string
- Marker markerType
- MaxItems maxItemsType
- RoleName required roleNameType
- MaxItems
Output
ListMFADevices
amazonaws_iam.ListMFADevices({}, context)
Input
- input
object
- MaxItems
string
- Marker
string
- Marker markerType
- MaxItems maxItemsType
- UserName existingUserNameType
- MaxItems
Output
- output ListMFADevicesResponse
ListOpenIDConnectProviders
amazonaws_iam.ListOpenIDConnectProviders({}, context)
Input
- input
object
Output
ListPolicies
amazonaws_iam.ListPolicies({}, context)
Input
- input
object
- MaxItems
string
- Marker
string
- Marker markerType
- MaxItems maxItemsType
- OnlyAttached booleanType
- PathPrefix policyPathType
- Scope policyScopeType
- MaxItems
Output
- output ListPoliciesResponse
ListPolicyVersions
amazonaws_iam.ListPolicyVersions({
"PolicyArn": ""
}, context)
Input
- input
object
- MaxItems
string
- Marker
string
- Marker markerType
- MaxItems maxItemsType
- PolicyArn required arnType
- MaxItems
Output
- output ListPolicyVersionsResponse
ListRolePolicies
amazonaws_iam.ListRolePolicies({
"RoleName": ""
}, context)
Input
- input
object
- MaxItems
string
- Marker
string
- Marker markerType
- MaxItems maxItemsType
- RoleName required roleNameType
- MaxItems
Output
- output ListRolePoliciesResponse
ListRoles
amazonaws_iam.ListRoles({}, context)
Input
- input
object
- MaxItems
string
- Marker
string
- Marker markerType
- MaxItems maxItemsType
- PathPrefix pathPrefixType
- MaxItems
Output
- output ListRolesResponse
ListSAMLProviders
amazonaws_iam.ListSAMLProviders({}, context)
Input
- input
object
Output
- output ListSAMLProvidersResponse
ListSSHPublicKeys
amazonaws_iam.ListSSHPublicKeys({}, context)
Input
- input
object
- MaxItems
string
- Marker
string
- Marker markerType
- MaxItems maxItemsType
- UserName userNameType
- MaxItems
Output
- output ListSSHPublicKeysResponse
ListServerCertificates
amazonaws_iam.ListServerCertificates({}, context)
Input
- input
object
- MaxItems
string
- Marker
string
- Marker markerType
- MaxItems maxItemsType
- PathPrefix pathPrefixType
- MaxItems
Output
ListServiceSpecificCredentials
amazonaws_iam.ListServiceSpecificCredentials({}, context)
Input
- input
object
- ServiceName serviceName
- UserName userNameType
Output
ListSigningCertificates
amazonaws_iam.ListSigningCertificates({}, context)
Input
- input
object
- MaxItems
string
- Marker
string
- Marker markerType
- MaxItems maxItemsType
- UserName existingUserNameType
- MaxItems
Output
ListUserPolicies
amazonaws_iam.ListUserPolicies({
"UserName": ""
}, context)
Input
- input
object
- MaxItems
string
- Marker
string
- Marker markerType
- MaxItems maxItemsType
- UserName required existingUserNameType
- MaxItems
Output
- output ListUserPoliciesResponse
ListUsers
amazonaws_iam.ListUsers({}, context)
Input
- input
object
- MaxItems
string
- Marker
string
- Marker markerType
- MaxItems maxItemsType
- PathPrefix pathPrefixType
- MaxItems
Output
- output ListUsersResponse
ListVirtualMFADevices
amazonaws_iam.ListVirtualMFADevices({}, context)
Input
- input
object
- MaxItems
string
- Marker
string
- AssignmentStatus assignmentStatusType
- Marker markerType
- MaxItems maxItemsType
- MaxItems
Output
PutGroupPolicy
amazonaws_iam.PutGroupPolicy({
"GroupName": "",
"PolicyName": "",
"PolicyDocument": ""
}, context)
Input
- input
object
- GroupName required groupNameType
- PolicyDocument required policyDocumentType
- PolicyName required policyNameType
Output
Output schema unknown
PutRolePolicy
amazonaws_iam.PutRolePolicy({
"RoleName": "",
"PolicyName": "",
"PolicyDocument": ""
}, context)
Input
- input
object
- PolicyDocument required policyDocumentType
- PolicyName required policyNameType
- RoleName required roleNameType
Output
Output schema unknown
PutUserPolicy
amazonaws_iam.PutUserPolicy({
"UserName": "",
"PolicyName": "",
"PolicyDocument": ""
}, context)
Input
- input
object
- PolicyDocument required policyDocumentType
- PolicyName required policyNameType
- UserName required existingUserNameType
Output
Output schema unknown
RemoveClientIDFromOpenIDConnectProvider
amazonaws_iam.RemoveClientIDFromOpenIDConnectProvider({
"OpenIDConnectProviderArn": "",
"ClientID": ""
}, context)
Input
- input
object
- ClientID required clientIDType
- OpenIDConnectProviderArn required arnType
Output
Output schema unknown
RemoveRoleFromInstanceProfile
amazonaws_iam.RemoveRoleFromInstanceProfile({
"InstanceProfileName": "",
"RoleName": ""
}, context)
Input
- input
object
- InstanceProfileName required instanceProfileNameType
- RoleName required roleNameType
Output
Output schema unknown
RemoveUserFromGroup
amazonaws_iam.RemoveUserFromGroup({
"GroupName": "",
"UserName": ""
}, context)
Input
- input
object
- GroupName required groupNameType
- UserName required existingUserNameType
Output
Output schema unknown
ResetServiceSpecificCredential
amazonaws_iam.ResetServiceSpecificCredential({
"ServiceSpecificCredentialId": ""
}, context)
Input
- input
object
- ServiceSpecificCredentialId required serviceSpecificCredentialId
- UserName userNameType
Output
ResyncMFADevice
amazonaws_iam.ResyncMFADevice({
"UserName": "",
"SerialNumber": "",
"AuthenticationCode1": "",
"AuthenticationCode2": ""
}, context)
Input
- input
object
- AuthenticationCode1 required authenticationCodeType
- AuthenticationCode2 required authenticationCodeType
- SerialNumber required serialNumberType
- UserName required existingUserNameType
Output
Output schema unknown
SetDefaultPolicyVersion
amazonaws_iam.SetDefaultPolicyVersion({
"PolicyArn": "",
"VersionId": ""
}, context)
Input
- input
object
- PolicyArn required arnType
- VersionId required policyVersionIdType
Output
Output schema unknown
SimulateCustomPolicy
amazonaws_iam.SimulateCustomPolicy({
"PolicyInputList": [],
"ActionNames": []
}, context)
Input
- input
object
- MaxItems
string
- Marker
string
- ActionNames required ActionNameListType
- CallerArn ResourceNameType
- ContextEntries ContextEntryListType
- Marker markerType
- MaxItems maxItemsType
- PolicyInputList required SimulationPolicyListType
- ResourceArns ResourceNameListType
- ResourceHandlingOption ResourceHandlingOptionType
- ResourceOwner ResourceNameType
- ResourcePolicy policyDocumentType
- MaxItems
Output
- output SimulatePolicyResponse
SimulatePrincipalPolicy
amazonaws_iam.SimulatePrincipalPolicy({
"PolicySourceArn": "",
"ActionNames": []
}, context)
Input
- input
object
- MaxItems
string
- Marker
string
- ActionNames required ActionNameListType
- CallerArn ResourceNameType
- ContextEntries ContextEntryListType
- Marker markerType
- MaxItems maxItemsType
- PolicyInputList SimulationPolicyListType
- PolicySourceArn required arnType
- ResourceArns ResourceNameListType
- ResourceHandlingOption ResourceHandlingOptionType
- ResourceOwner ResourceNameType
- ResourcePolicy policyDocumentType
- MaxItems
Output
- output SimulatePolicyResponse
UpdateAccessKey
amazonaws_iam.UpdateAccessKey({
"AccessKeyId": "",
"Status": ""
}, context)
Input
- input
object
- AccessKeyId required accessKeyIdType
- Status required statusType
- UserName existingUserNameType
Output
Output schema unknown
UpdateAccountPasswordPolicy
amazonaws_iam.UpdateAccountPasswordPolicy({}, context)
Input
- input
object
- AllowUsersToChangePassword booleanType
- HardExpiry booleanObjectType
- MaxPasswordAge maxPasswordAgeType
- MinimumPasswordLength minimumPasswordLengthType
- PasswordReusePrevention passwordReusePreventionType
- RequireLowercaseCharacters booleanType
- RequireNumbers booleanType
- RequireSymbols booleanType
- RequireUppercaseCharacters booleanType
Output
Output schema unknown
UpdateAssumeRolePolicy
amazonaws_iam.UpdateAssumeRolePolicy({
"RoleName": "",
"PolicyDocument": ""
}, context)
Input
- input
object
- PolicyDocument required policyDocumentType
- RoleName required roleNameType
Output
Output schema unknown
UpdateGroup
amazonaws_iam.UpdateGroup({
"GroupName": ""
}, context)
Input
- input
object
- GroupName required groupNameType
- NewGroupName groupNameType
- NewPath pathType
Output
Output schema unknown
UpdateLoginProfile
amazonaws_iam.UpdateLoginProfile({
"UserName": ""
}, context)
Input
- input
object
- Password passwordType
- PasswordResetRequired booleanObjectType
- UserName required userNameType
Output
Output schema unknown
UpdateOpenIDConnectProviderThumbprint
amazonaws_iam.UpdateOpenIDConnectProviderThumbprint({
"OpenIDConnectProviderArn": "",
"ThumbprintList": []
}, context)
Input
- input
object
- OpenIDConnectProviderArn required arnType
- ThumbprintList required thumbprintListType
Output
Output schema unknown
UpdateRoleDescription
amazonaws_iam.UpdateRoleDescription({
"RoleName": "",
"Description": ""
}, context)
Input
- input
object
- Description required roleDescriptionType
- RoleName required roleNameType
Output
UpdateSAMLProvider
amazonaws_iam.UpdateSAMLProvider({
"SAMLMetadataDocument": "",
"SAMLProviderArn": ""
}, context)
Input
- input
object
- SAMLMetadataDocument required SAMLMetadataDocumentType
- SAMLProviderArn required arnType
Output
- output UpdateSAMLProviderResponse
UpdateSSHPublicKey
amazonaws_iam.UpdateSSHPublicKey({
"UserName": "",
"SSHPublicKeyId": "",
"Status": ""
}, context)
Input
- input
object
- SSHPublicKeyId required publicKeyIdType
- Status required statusType
- UserName required userNameType
Output
Output schema unknown
UpdateServerCertificate
amazonaws_iam.UpdateServerCertificate({
"ServerCertificateName": ""
}, context)
Input
- input
object
- NewPath pathType
- NewServerCertificateName serverCertificateNameType
- ServerCertificateName required serverCertificateNameType
Output
Output schema unknown
UpdateServiceSpecificCredential
amazonaws_iam.UpdateServiceSpecificCredential({
"ServiceSpecificCredentialId": "",
"Status": ""
}, context)
Input
- input
object
- ServiceSpecificCredentialId required serviceSpecificCredentialId
- Status required statusType
- UserName userNameType
Output
Output schema unknown
UpdateSigningCertificate
amazonaws_iam.UpdateSigningCertificate({
"CertificateId": "",
"Status": ""
}, context)
Input
- input
object
- CertificateId required certificateIdType
- Status required statusType
- UserName existingUserNameType
Output
Output schema unknown
UpdateUser
amazonaws_iam.UpdateUser({
"UserName": ""
}, context)
Input
- input
object
- NewPath pathType
- NewUserName userNameType
- UserName required existingUserNameType
Output
Output schema unknown
UploadSSHPublicKey
amazonaws_iam.UploadSSHPublicKey({
"UserName": "",
"SSHPublicKeyBody": ""
}, context)
Input
- input
object
- SSHPublicKeyBody required publicKeyMaterialType
- UserName required userNameType
Output
- output UploadSSHPublicKeyResponse
UploadServerCertificate
amazonaws_iam.UploadServerCertificate({
"ServerCertificateName": "",
"CertificateBody": "",
"PrivateKey": ""
}, context)
Input
- input
object
- CertificateBody required certificateBodyType
- CertificateChain certificateChainType
- Path pathType
- PrivateKey required privateKeyType
- ServerCertificateName required serverCertificateNameType
Output
UploadSigningCertificate
amazonaws_iam.UploadSigningCertificate({
"CertificateBody": ""
}, context)
Input
- input
object
- CertificateBody required certificateBodyType
- UserName existingUserNameType
Output
Definitions
AccessKey
- AccessKey
object
: Contains information about an AWS access key. This data type is used as a response element in the CreateAccessKey and ListAccessKeys actions. The SecretAccessKey value is returned only in response to CreateAccessKey. You can get a secret access key only when you first create an access key; you cannot recover the secret access key later. If you lose a secret access key, you must create a new access key.- AccessKeyId required accessKeyIdType
- CreateDate dateType
- SecretAccessKey required accessKeySecretType
- Status required statusType
- UserName required userNameType
AccessKeyLastUsed
- AccessKeyLastUsed
object
: Contains information about the last time an AWS access key was used. This data type is used as a response element in the GetAccessKeyLastUsed action.- LastUsedDate required dateType
- Region required stringType
- ServiceName required stringType
AccessKeyMetadata
- AccessKeyMetadata
object
: Contains information about an AWS access key, without its secret key. This data type is used as a response element in the ListAccessKeys action.- AccessKeyId accessKeyIdType
- CreateDate dateType
- Status statusType
- UserName userNameType
ActionNameListType
- ActionNameListType
array
- items ActionNameType
ActionNameType
- ActionNameType
string
AddClientIDToOpenIDConnectProviderRequest
- AddClientIDToOpenIDConnectProviderRequest
object
- ClientID required clientIDType
- OpenIDConnectProviderArn required arnType
AddRoleToInstanceProfileRequest
- AddRoleToInstanceProfileRequest
object
- InstanceProfileName required instanceProfileNameType
- RoleName required roleNameType
AddUserToGroupRequest
- AddUserToGroupRequest
object
- GroupName required groupNameType
- UserName required existingUserNameType
ArnListType
- ArnListType
array
- items arnType
AttachGroupPolicyRequest
- AttachGroupPolicyRequest
object
- GroupName required groupNameType
- PolicyArn required arnType
AttachRolePolicyRequest
- AttachRolePolicyRequest
object
- PolicyArn required arnType
- RoleName required roleNameType
AttachUserPolicyRequest
- AttachUserPolicyRequest
object
- PolicyArn required arnType
- UserName required userNameType
AttachedPolicy
- AttachedPolicy
object
: Contains information about an attached policy. An attached policy is a managed policy that has been attached to a user, group, or role. This data type is used as a response element in the ListAttachedGroupPolicies, ListAttachedRolePolicies, ListAttachedUserPolicies, and GetAccountAuthorizationDetails actions. For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.- PolicyArn arnType
- PolicyName policyNameType
BootstrapDatum
- BootstrapDatum
string
ChangePasswordRequest
- ChangePasswordRequest
object
- NewPassword required passwordType
- OldPassword required passwordType
ColumnNumber
- ColumnNumber
integer
ContextEntry
- ContextEntry
object
: Contains information about a condition context key. It includes the name of the key and specifies the value (or values, if the context key supports multiple values) to use in the simulation. This information is used when evaluating the Condition elements of the input policies. This data type is used as an input parameter to SimulateCustomPolicy and SimulateCustomPolicy .- ContextKeyName ContextKeyNameType
- ContextKeyType ContextKeyTypeEnum
- ContextKeyValues ContextKeyValueListType
ContextEntryListType
- ContextEntryListType
array
- items ContextEntry
ContextKeyNameType
- ContextKeyNameType
string
ContextKeyNamesResultListType
- ContextKeyNamesResultListType
array
- items ContextKeyNameType
ContextKeyTypeEnum
- ContextKeyTypeEnum
string
(values: string, stringList, numeric, numericList, boolean, booleanList, ip, ipList, binary, binaryList, date, dateList)
ContextKeyValueListType
- ContextKeyValueListType
array
- items ContextKeyValueType
ContextKeyValueType
- ContextKeyValueType
string
CreateAccessKeyRequest
- CreateAccessKeyRequest
object
- UserName existingUserNameType
CreateAccessKeyResponse
- CreateAccessKeyResponse
object
: Contains the response to a successful CreateAccessKey request.- AccessKey required AccessKey
CreateAccountAliasRequest
- CreateAccountAliasRequest
object
- AccountAlias required accountAliasType
CreateGroupRequest
- CreateGroupRequest
object
- GroupName required groupNameType
- Path pathType
CreateGroupResponse
- CreateGroupResponse
object
: Contains the response to a successful CreateGroup request.- Group required Group
CreateInstanceProfileRequest
- CreateInstanceProfileRequest
object
- InstanceProfileName required instanceProfileNameType
- Path pathType
CreateInstanceProfileResponse
- CreateInstanceProfileResponse
object
: Contains the response to a successful CreateInstanceProfile request.- InstanceProfile required InstanceProfile
CreateLoginProfileRequest
- CreateLoginProfileRequest
object
- Password required passwordType
- PasswordResetRequired booleanType
- UserName required userNameType
CreateLoginProfileResponse
- CreateLoginProfileResponse
object
: Contains the response to a successful CreateLoginProfile request.- LoginProfile required LoginProfile
CreateOpenIDConnectProviderRequest
- CreateOpenIDConnectProviderRequest
object
- ClientIDList clientIDListType
- ThumbprintList required thumbprintListType
- Url required OpenIDConnectProviderUrlType
CreateOpenIDConnectProviderResponse
- CreateOpenIDConnectProviderResponse
object
: Contains the response to a successful CreateOpenIDConnectProvider request.- OpenIDConnectProviderArn arnType
CreatePolicyRequest
- CreatePolicyRequest
object
- Description policyDescriptionType
- Path policyPathType
- PolicyDocument required policyDocumentType
- PolicyName required policyNameType
CreatePolicyResponse
- CreatePolicyResponse
object
: Contains the response to a successful CreatePolicy request.- Policy Policy
CreatePolicyVersionRequest
- CreatePolicyVersionRequest
object
- PolicyArn required arnType
- PolicyDocument required policyDocumentType
- SetAsDefault booleanType
CreatePolicyVersionResponse
- CreatePolicyVersionResponse
object
: Contains the response to a successful CreatePolicyVersion request.- PolicyVersion PolicyVersion
CreateRoleRequest
- CreateRoleRequest
object
- AssumeRolePolicyDocument required policyDocumentType
- Description roleDescriptionType
- Path pathType
- RoleName required roleNameType
CreateRoleResponse
- CreateRoleResponse
object
: Contains the response to a successful CreateRole request.- Role required Role
CreateSAMLProviderRequest
- CreateSAMLProviderRequest
object
- Name required SAMLProviderNameType
- SAMLMetadataDocument required SAMLMetadataDocumentType
CreateSAMLProviderResponse
- CreateSAMLProviderResponse
object
: Contains the response to a successful CreateSAMLProvider request.- SAMLProviderArn arnType
CreateServiceLinkedRoleRequest
- CreateServiceLinkedRoleRequest
object
- AWSServiceName required groupNameType
- CustomSuffix customSuffixType
- Description roleDescriptionType
CreateServiceLinkedRoleResponse
- CreateServiceLinkedRoleResponse
object
- Role Role
CreateServiceSpecificCredentialRequest
- CreateServiceSpecificCredentialRequest
object
- ServiceName required serviceName
- UserName required userNameType
CreateServiceSpecificCredentialResponse
- CreateServiceSpecificCredentialResponse
object
- ServiceSpecificCredential ServiceSpecificCredential
CreateUserRequest
- CreateUserRequest
object
- Path pathType
- UserName required userNameType
CreateUserResponse
- CreateUserResponse
object
: Contains the response to a successful CreateUser request.- User User
CreateVirtualMFADeviceRequest
- CreateVirtualMFADeviceRequest
object
- Path pathType
- VirtualMFADeviceName required virtualMFADeviceName
CreateVirtualMFADeviceResponse
- CreateVirtualMFADeviceResponse
object
: Contains the response to a successful CreateVirtualMFADevice request.- VirtualMFADevice required VirtualMFADevice
CredentialReportExpiredException
- CredentialReportExpiredException
object
: The request was rejected because the most recent credential report has expired. To generate a new credential report, use GenerateCredentialReport. For more information about credential report expiration, see Getting Credential Reports in the IAM User Guide.
CredentialReportNotPresentException
- CredentialReportNotPresentException
object
: The request was rejected because the credential report does not exist. To generate a credential report, use GenerateCredentialReport.
CredentialReportNotReadyException
- CredentialReportNotReadyException
object
: The request was rejected because the credential report is still being generated.
DeactivateMFADeviceRequest
- DeactivateMFADeviceRequest
object
- SerialNumber required serialNumberType
- UserName required existingUserNameType
DeleteAccessKeyRequest
- DeleteAccessKeyRequest
object
- AccessKeyId required accessKeyIdType
- UserName existingUserNameType
DeleteAccountAliasRequest
- DeleteAccountAliasRequest
object
- AccountAlias required accountAliasType
DeleteConflictException
- DeleteConflictException
object
: The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.- message deleteConflictMessage
DeleteGroupPolicyRequest
- DeleteGroupPolicyRequest
object
- GroupName required groupNameType
- PolicyName required policyNameType
DeleteGroupRequest
- DeleteGroupRequest
object
- GroupName required groupNameType
DeleteInstanceProfileRequest
- DeleteInstanceProfileRequest
object
- InstanceProfileName required instanceProfileNameType
DeleteLoginProfileRequest
- DeleteLoginProfileRequest
object
- UserName required userNameType
DeleteOpenIDConnectProviderRequest
- DeleteOpenIDConnectProviderRequest
object
- OpenIDConnectProviderArn required arnType
DeletePolicyRequest
- DeletePolicyRequest
object
- PolicyArn required arnType
DeletePolicyVersionRequest
- DeletePolicyVersionRequest
object
- PolicyArn required arnType
- VersionId required policyVersionIdType
DeleteRolePolicyRequest
- DeleteRolePolicyRequest
object
- PolicyName required policyNameType
- RoleName required roleNameType
DeleteRoleRequest
- DeleteRoleRequest
object
- RoleName required roleNameType
DeleteSAMLProviderRequest
- DeleteSAMLProviderRequest
object
- SAMLProviderArn required arnType
DeleteSSHPublicKeyRequest
- DeleteSSHPublicKeyRequest
object
- SSHPublicKeyId required publicKeyIdType
- UserName required userNameType
DeleteServerCertificateRequest
- DeleteServerCertificateRequest
object
- ServerCertificateName required serverCertificateNameType
DeleteServiceLinkedRoleRequest
- DeleteServiceLinkedRoleRequest
object
- RoleName required roleNameType
DeleteServiceLinkedRoleResponse
- DeleteServiceLinkedRoleResponse
object
- DeletionTaskId required DeletionTaskIdType
DeleteServiceSpecificCredentialRequest
- DeleteServiceSpecificCredentialRequest
object
- ServiceSpecificCredentialId required serviceSpecificCredentialId
- UserName userNameType
DeleteSigningCertificateRequest
- DeleteSigningCertificateRequest
object
- CertificateId required certificateIdType
- UserName existingUserNameType
DeleteUserPolicyRequest
- DeleteUserPolicyRequest
object
- PolicyName required policyNameType
- UserName required existingUserNameType
DeleteUserRequest
- DeleteUserRequest
object
- UserName required existingUserNameType
DeleteVirtualMFADeviceRequest
- DeleteVirtualMFADeviceRequest
object
- SerialNumber required serialNumberType
DeletionTaskFailureReasonType
- DeletionTaskFailureReasonType
object
: The reason that the service-linked role deletion failed. This data type is used as a response element in the GetServiceLinkedRoleDeletionStatus operation.- Reason ReasonType
- RoleUsageList RoleUsageListType
DeletionTaskIdType
- DeletionTaskIdType
string
DeletionTaskStatusType
- DeletionTaskStatusType
string
(values: SUCCEEDED, IN_PROGRESS, FAILED, NOT_STARTED)
DetachGroupPolicyRequest
- DetachGroupPolicyRequest
object
- GroupName required groupNameType
- PolicyArn required arnType
DetachRolePolicyRequest
- DetachRolePolicyRequest
object
- PolicyArn required arnType
- RoleName required roleNameType
DetachUserPolicyRequest
- DetachUserPolicyRequest
object
- PolicyArn required arnType
- UserName required userNameType
DuplicateCertificateException
- DuplicateCertificateException
object
: The request was rejected because the same certificate is associated with an IAM user in the account.- message duplicateCertificateMessage
DuplicateSSHPublicKeyException
- DuplicateSSHPublicKeyException
object
: The request was rejected because the SSH public key is already associated with the specified IAM user.- message duplicateSSHPublicKeyMessage
EnableMFADeviceRequest
- EnableMFADeviceRequest
object
- AuthenticationCode1 required authenticationCodeType
- AuthenticationCode2 required authenticationCodeType
- SerialNumber required serialNumberType
- UserName required existingUserNameType
EntityAlreadyExistsException
- EntityAlreadyExistsException
object
: The request was rejected because it attempted to create a resource that already exists.- message entityAlreadyExistsMessage
EntityTemporarilyUnmodifiableException
- EntityTemporarilyUnmodifiableException
object
: The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity.
EntityType
- EntityType
string
(values: User, Role, Group, LocalManagedPolicy, AWSManagedPolicy)
EvalDecisionDetailsType
- EvalDecisionDetailsType
array
- items
object
- items
EvalDecisionSourceType
- EvalDecisionSourceType
string
EvaluationResult
- EvaluationResult
object
: Contains the results of a simulation. This data type is used by the return parameter of SimulateCustomPolicy and SimulatePrincipalPolicy .- EvalActionName required ActionNameType
- EvalDecision required PolicyEvaluationDecisionType
- EvalDecisionDetails EvalDecisionDetailsType
- EvalResourceName ResourceNameType
- MatchedStatements StatementListType
- MissingContextValues [ContextKeyNamesResultListType](#contextkeynamesresultli