@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
andSimulateCustomPolicy
.- 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
andSimulatePrincipalPolicy
.- EvalActionName required ActionNameType
- EvalDecision required PolicyEvaluationDecisionType
- EvalDecisionDetails EvalDecisionDetailsType
- EvalResourceName ResourceNameType
- MatchedStatements StatementListType
- MissingContextValues ContextKeyNamesResultListType
- OrganizationsDecisionDetail OrganizationsDecisionDetail
- ResourceSpecificResults ResourceSpecificResultListType
EvaluationResultsListType
- EvaluationResultsListType
array
- items EvaluationResult
GenerateCredentialReportResponse
- GenerateCredentialReportResponse
object
: Contains the response to a successful GenerateCredentialReport request.- Description ReportStateDescriptionType
- State ReportStateType
GetAccessKeyLastUsedRequest
- GetAccessKeyLastUsedRequest
object
- AccessKeyId required accessKeyIdType
GetAccessKeyLastUsedResponse
- GetAccessKeyLastUsedResponse
object
: Contains the response to a successful GetAccessKeyLastUsed request. It is also returned as a member of the AccessKeyMetaData structure returned by the ListAccessKeys action.- AccessKeyLastUsed AccessKeyLastUsed
- UserName existingUserNameType
GetAccountAuthorizationDetailsRequest
- GetAccountAuthorizationDetailsRequest
object
- Filter entityListType
- Marker markerType
- MaxItems maxItemsType
GetAccountAuthorizationDetailsResponse
- GetAccountAuthorizationDetailsResponse
object
: Contains the response to a successful GetAccountAuthorizationDetails request.- GroupDetailList groupDetailListType
- IsTruncated booleanType
- Marker markerType
- Policies ManagedPolicyDetailListType
- RoleDetailList roleDetailListType
- UserDetailList userDetailListType
GetAccountPasswordPolicyResponse
- GetAccountPasswordPolicyResponse
object
: Contains the response to a successful GetAccountPasswordPolicy request.- PasswordPolicy required PasswordPolicy
GetAccountSummaryResponse
- GetAccountSummaryResponse
object
: Contains the response to a successful GetAccountSummary request.- SummaryMap summaryMapType
GetContextKeysForCustomPolicyRequest
- GetContextKeysForCustomPolicyRequest
object
- PolicyInputList required SimulationPolicyListType
GetContextKeysForPolicyResponse
- GetContextKeysForPolicyResponse
object
: Contains the response to a successful GetContextKeysForPrincipalPolicy or GetContextKeysForCustomPolicy request.- ContextKeyNames ContextKeyNamesResultListType
GetContextKeysForPrincipalPolicyRequest
- GetContextKeysForPrincipalPolicyRequest
object
- PolicyInputList SimulationPolicyListType
- PolicySourceArn required arnType
GetCredentialReportResponse
- GetCredentialReportResponse
object
: Contains the response to a successful GetCredentialReport request.- Content ReportContentType
- GeneratedTime dateType
- ReportFormat ReportFormatType
GetGroupPolicyRequest
- GetGroupPolicyRequest
object
- GroupName required groupNameType
- PolicyName required policyNameType
GetGroupPolicyResponse
- GetGroupPolicyResponse
object
: Contains the response to a successful GetGroupPolicy request.- GroupName required groupNameType
- PolicyDocument required policyDocumentType
- PolicyName required policyNameType
GetGroupRequest
- GetGroupRequest
object
- GroupName required groupNameType
- Marker markerType
- MaxItems maxItemsType
GetGroupResponse
- GetGroupResponse
object
: Contains the response to a successful GetGroup request.- Group required Group
- IsTruncated booleanType
- Marker markerType
- Users required userListType
GetInstanceProfileRequest
- GetInstanceProfileRequest
object
- InstanceProfileName required instanceProfileNameType
GetInstanceProfileResponse
- GetInstanceProfileResponse
object
: Contains the response to a successful GetInstanceProfile request.- InstanceProfile required InstanceProfile
GetLoginProfileRequest
- GetLoginProfileRequest
object
- UserName required userNameType
GetLoginProfileResponse
- GetLoginProfileResponse
object
: Contains the response to a successful GetLoginProfile request.- LoginProfile required LoginProfile
GetOpenIDConnectProviderRequest
- GetOpenIDConnectProviderRequest
object
- OpenIDConnectProviderArn required arnType
GetOpenIDConnectProviderResponse
- GetOpenIDConnectProviderResponse
object
: Contains the response to a successful GetOpenIDConnectProvider request.- ClientIDList clientIDListType
- CreateDate dateType
- ThumbprintList thumbprintListType
- Url OpenIDConnectProviderUrlType
GetPolicyRequest
- GetPolicyRequest
object
- PolicyArn required arnType
GetPolicyResponse
- GetPolicyResponse
object
: Contains the response to a successful GetPolicy request.- Policy Policy
GetPolicyVersionRequest
- GetPolicyVersionRequest
object
- PolicyArn required arnType
- VersionId required policyVersionIdType
GetPolicyVersionResponse
- GetPolicyVersionResponse
object
: Contains the response to a successful GetPolicyVersion request.- PolicyVersion PolicyVersion
GetRolePolicyRequest
- GetRolePolicyRequest
object
- PolicyName required policyNameType
- RoleName required roleNameType
GetRolePolicyResponse
- GetRolePolicyResponse
object
: Contains the response to a successful GetRolePolicy request.- PolicyDocument required policyDocumentType
- PolicyName required policyNameType
- RoleName required roleNameType
GetRoleRequest
- GetRoleRequest
object
- RoleName required roleNameType
GetRoleResponse
- GetRoleResponse
object
: Contains the response to a successful GetRole request.- Role required Role
GetSAMLProviderRequest
- GetSAMLProviderRequest
object
- SAMLProviderArn required arnType
GetSAMLProviderResponse
- GetSAMLProviderResponse
object
: Contains the response to a successful GetSAMLProvider request.- CreateDate dateType
- SAMLMetadataDocument SAMLMetadataDocumentType
- ValidUntil dateType
GetSSHPublicKeyRequest
- GetSSHPublicKeyRequest
object
- Encoding required encodingType
- SSHPublicKeyId required publicKeyIdType
- UserName required userNameType
GetSSHPublicKeyResponse
- GetSSHPublicKeyResponse
object
: Contains the response to a successful GetSSHPublicKey request.- SSHPublicKey SSHPublicKey
GetServerCertificateRequest
- GetServerCertificateRequest
object
- ServerCertificateName required serverCertificateNameType
GetServerCertificateResponse
- GetServerCertificateResponse
object
: Contains the response to a successful GetServerCertificate request.- ServerCertificate required ServerCertificate
GetServiceLinkedRoleDeletionStatusRequest
- GetServiceLinkedRoleDeletionStatusRequest
object
- DeletionTaskId required DeletionTaskIdType
GetServiceLinkedRoleDeletionStatusResponse
- GetServiceLinkedRoleDeletionStatusResponse
object
- Reason DeletionTaskFailureReasonType
- Status required DeletionTaskStatusType
GetUserPolicyRequest
- GetUserPolicyRequest
object
- PolicyName required policyNameType
- UserName required existingUserNameType
GetUserPolicyResponse
- GetUserPolicyResponse
object
: Contains the response to a successful GetUserPolicy request.- PolicyDocument required policyDocumentType
- PolicyName required policyNameType
- UserName required existingUserNameType
GetUserRequest
- GetUserRequest
object
- UserName existingUserNameType
GetUserResponse
- GetUserResponse
object
: Contains the response to a successful GetUser request.- User required User
Group
- Group
object
:Contains information about an IAM group entity.
This data type is used as a response element in the following actions:
-
CreateGroup
-
GetGroup
-
ListGroups
- Arn required arnType
- CreateDate required dateType
- GroupId required idType
- GroupName required groupNameType
- Path required pathType
-
GroupDetail
- GroupDetail
object
:Contains information about an IAM group, including all of the group's policies.
This data type is used as a response element in the GetAccountAuthorizationDetails action.
- Arn arnType
- AttachedManagedPolicies attachedPoliciesListType
- CreateDate dateType
- GroupId idType
- GroupName groupNameType
- GroupPolicyList policyDetailListType
- Path pathType
InstanceProfile
- InstanceProfile
object
:Contains information about an instance profile.
This data type is used as a response element in the following actions:
-
CreateInstanceProfile
-
GetInstanceProfile
-
ListInstanceProfiles
-
ListInstanceProfilesForRole
- Arn required arnType
- CreateDate required dateType
- InstanceProfileId required idType
- InstanceProfileName required instanceProfileNameType
- Path required pathType
- Roles required roleListType
-
InvalidAuthenticationCodeException
- InvalidAuthenticationCodeException
object
: The request was rejected because the authentication code was not recognized. The error message describes the specific error.- message invalidAuthenticationCodeMessage
InvalidCertificateException
- InvalidCertificateException
object
: The request was rejected because the certificate is invalid.- message invalidCertificateMessage
InvalidInputException
- InvalidInputException
object
: The request was rejected because an invalid or out-of-range value was supplied for an input parameter.- message invalidInputMessage
InvalidPublicKeyException
- InvalidPublicKeyException
object
: The request was rejected because the public key is malformed or otherwise invalid.- message invalidPublicKeyMessage
InvalidUserTypeException
- InvalidUserTypeException
object
: The request was rejected because the type of user for the transaction was incorrect.- message invalidUserTypeMessage
KeyPairMismatchException
- KeyPairMismatchException
object
: The request was rejected because the public key certificate and the private key do not match.- message keyPairMismatchMessage
LimitExceededException
- LimitExceededException
object
: The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.- message limitExceededMessage
LineNumber
- LineNumber
integer
ListAccessKeysRequest
- ListAccessKeysRequest
object
- Marker markerType
- MaxItems maxItemsType
- UserName existingUserNameType
ListAccessKeysResponse
- ListAccessKeysResponse
object
: Contains the response to a successful ListAccessKeys request.- AccessKeyMetadata required accessKeyMetadataListType
- IsTruncated booleanType
- Marker markerType
ListAccountAliasesRequest
- ListAccountAliasesRequest
object
- Marker markerType
- MaxItems maxItemsType
ListAccountAliasesResponse
- ListAccountAliasesResponse
object
: Contains the response to a successful ListAccountAliases request.- AccountAliases required accountAliasListType
- IsTruncated booleanType
- Marker markerType
ListAttachedGroupPoliciesRequest
- ListAttachedGroupPoliciesRequest
object
- GroupName required groupNameType
- Marker markerType
- MaxItems maxItemsType
- PathPrefix policyPathType
ListAttachedGroupPoliciesResponse
- ListAttachedGroupPoliciesResponse
object
: Contains the response to a successful ListAttachedGroupPolicies request.- AttachedPolicies attachedPoliciesListType
- IsTruncated booleanType
- Marker markerType
ListAttachedRolePoliciesRequest
- ListAttachedRolePoliciesRequest
object
- Marker markerType
- MaxItems maxItemsType
- PathPrefix policyPathType
- RoleName required roleNameType
ListAttachedRolePoliciesResponse
- ListAttachedRolePoliciesResponse
object
: Contains the response to a successful ListAttachedRolePolicies request.- AttachedPolicies attachedPoliciesListType
- IsTruncated booleanType
- Marker markerType
ListAttachedUserPoliciesRequest
- ListAttachedUserPoliciesRequest
object
- Marker markerType
- MaxItems maxItemsType
- PathPrefix policyPathType
- UserName required userNameType
ListAttachedUserPoliciesResponse
- ListAttachedUserPoliciesResponse
object
: Contains the response to a successful ListAttachedUserPolicies request.- AttachedPolicies attachedPoliciesListType
- IsTruncated booleanType
- Marker markerType
ListEntitiesForPolicyRequest
- ListEntitiesForPolicyRequest
object
- EntityFilter EntityType
- Marker markerType
- MaxItems maxItemsType
- PathPrefix pathType
- PolicyArn required arnType
ListEntitiesForPolicyResponse
- ListEntitiesForPolicyResponse
object
: Contains the response to a successful ListEntitiesForPolicy request.- IsTruncated booleanType
- Marker markerType
- PolicyGroups PolicyGroupListType
- PolicyRoles PolicyRoleListType
- PolicyUsers PolicyUserListType
ListGroupPoliciesRequest
- ListGroupPoliciesRequest
object
- GroupName required groupNameType
- Marker markerType
- MaxItems maxItemsType
ListGroupPoliciesResponse
- ListGroupPoliciesResponse
object
: Contains the response to a successful ListGroupPolicies request.- IsTruncated booleanType
- Marker markerType
- PolicyNames required policyNameListType
ListGroupsForUserRequest
- ListGroupsForUserRequest
object
- Marker markerType
- MaxItems maxItemsType
- UserName required existingUserNameType
ListGroupsForUserResponse
- ListGroupsForUserResponse
object
: Contains the response to a successful ListGroupsForUser request.- Groups required groupListType
- IsTruncated booleanType
- Marker markerType
ListGroupsRequest
- ListGroupsRequest
object
- Marker markerType
- MaxItems maxItemsType
- PathPrefix pathPrefixType
ListGroupsResponse
- ListGroupsResponse
object
: Contains the response to a successful ListGroups request.- Groups required groupListType
- IsTruncated booleanType
- Marker markerType
ListInstanceProfilesForRoleRequest
- ListInstanceProfilesForRoleRequest
object
- Marker markerType
- MaxItems maxItemsType
- RoleName required roleNameType
ListInstanceProfilesForRoleResponse
- ListInstanceProfilesForRoleResponse
object
: Contains the response to a successful ListInstanceProfilesForRole request.- InstanceProfiles required instanceProfileListType
- IsTruncated booleanType
- Marker markerType
ListInstanceProfilesRequest
- ListInstanceProfilesRequest
object
- Marker markerType
- MaxItems maxItemsType
- PathPrefix pathPrefixType
ListInstanceProfilesResponse
- ListInstanceProfilesResponse
object
: Contains the response to a successful ListInstanceProfiles request.- InstanceProfiles required instanceProfileListType
- IsTruncated booleanType
- Marker markerType
ListMFADevicesRequest
- ListMFADevicesRequest
object
- Marker markerType
- MaxItems maxItemsType
- UserName existingUserNameType
ListMFADevicesResponse
- ListMFADevicesResponse
object
: Contains the response to a successful ListMFADevices request.- IsTruncated booleanType
- MFADevices required mfaDeviceListType
- Marker markerType
ListOpenIDConnectProvidersRequest
- ListOpenIDConnectProvidersRequest
object
ListOpenIDConnectProvidersResponse
- ListOpenIDConnectProvidersResponse
object
: Contains the response to a successful ListOpenIDConnectProviders request.- OpenIDConnectProviderList OpenIDConnectProviderListType
ListPoliciesRequest
- ListPoliciesRequest
object
- Marker markerType
- MaxItems maxItemsType
- OnlyAttached booleanType
- PathPrefix policyPathType
- Scope policyScopeType
ListPoliciesResponse
- ListPoliciesResponse
object
: Contains the response to a successful ListPolicies request.- IsTruncated booleanType
- Marker markerType
- Policies policyListType
ListPolicyVersionsRequest
- ListPolicyVersionsRequest
object
- Marker markerType
- MaxItems maxItemsType
- PolicyArn required arnType
ListPolicyVersionsResponse
- ListPolicyVersionsResponse
object
: Contains the response to a successful ListPolicyVersions request.- IsTruncated booleanType
- Marker markerType
- Versions policyDocumentVersionListType
ListRolePoliciesRequest
- ListRolePoliciesRequest
object
- Marker markerType
- MaxItems maxItemsType
- RoleName required roleNameType
ListRolePoliciesResponse
- ListRolePoliciesResponse
object
: Contains the response to a successful ListRolePolicies request.- IsTruncated booleanType
- Marker markerType
- PolicyNames required policyNameListType
ListRolesRequest
- ListRolesRequest
object
- Marker markerType
- MaxItems maxItemsType
- PathPrefix pathPrefixType
ListRolesResponse
- ListRolesResponse
object
: Contains the response to a successful ListRoles request.- IsTruncated booleanType
- Marker markerType
- Roles required roleListType
ListSAMLProvidersRequest
- ListSAMLProvidersRequest
object
ListSAMLProvidersResponse
- ListSAMLProvidersResponse
object
: Contains the response to a successful ListSAMLProviders request.- SAMLProviderList SAMLProviderListType
ListSSHPublicKeysRequest
- ListSSHPublicKeysRequest
object
- Marker markerType
- MaxItems maxItemsType
- UserName userNameType
ListSSHPublicKeysResponse
- ListSSHPublicKeysResponse
object
: Contains the response to a successful ListSSHPublicKeys request.- IsTruncated booleanType
- Marker markerType
- SSHPublicKeys SSHPublicKeyListType
ListServerCertificatesRequest
- ListServerCertificatesRequest
object
- Marker markerType
- MaxItems maxItemsType
- PathPrefix pathPrefixType
ListServerCertificatesResponse
- ListServerCertificatesResponse
object
: Contains the response to a successful ListServerCertificates request.- IsTruncated booleanType
- Marker markerType
- ServerCertificateMetadataList required serverCertificateMetadataListType
ListServiceSpecificCredentialsRequest
- ListServiceSpecificCredentialsRequest
object
- ServiceName serviceName
- UserName userNameType
ListServiceSpecificCredentialsResponse
- ListServiceSpecificCredentialsResponse
object
- ServiceSpecificCredentials ServiceSpecificCredentialsListType
ListSigningCertificatesRequest
- ListSigningCertificatesRequest
object
- Marker markerType
- MaxItems maxItemsType
- UserName existingUserNameType
ListSigningCertificatesResponse
- ListSigningCertificatesResponse
object
: Contains the response to a successful ListSigningCertificates request.- Certificates required certificateListType
- IsTruncated booleanType
- Marker markerType
ListUserPoliciesRequest
- ListUserPoliciesRequest
object
- Marker markerType
- MaxItems maxItemsType
- UserName required existingUserNameType
ListUserPoliciesResponse
- ListUserPoliciesResponse
object
: Contains the response to a successful ListUserPolicies request.- IsTruncated booleanType
- Marker markerType
- PolicyNames required policyNameListType
ListUsersRequest
- ListUsersRequest
object
- Marker markerType
- MaxItems maxItemsType
- PathPrefix pathPrefixType
ListUsersResponse
- ListUsersResponse
object
: Contains the response to a successful ListUsers request.- IsTruncated booleanType
- Marker markerType
- Users required userListType
ListVirtualMFADevicesRequest
- ListVirtualMFADevicesRequest
object
- AssignmentStatus assignmentStatusType
- Marker markerType
- MaxItems maxItemsType
ListVirtualMFADevicesResponse
- ListVirtualMFADevicesResponse
object
: Contains the response to a successful ListVirtualMFADevices request.- IsTruncated booleanType
- Marker markerType
- VirtualMFADevices required virtualMFADeviceListType
LoginProfile
- LoginProfile
object
:Contains the user name and password create date for a user.
This data type is used as a response element in the CreateLoginProfile and GetLoginProfile actions.
- CreateDate required dateType
- PasswordResetRequired booleanType
- UserName required userNameType
MFADevice
- MFADevice
object
:Contains information about an MFA device.
This data type is used as a response element in the ListMFADevices action.
- EnableDate required dateType
- SerialNumber required serialNumberType
- UserName required userNameType
MalformedCertificateException
- MalformedCertificateException
object
: The request was rejected because the certificate was malformed or expired. The error message describes the specific error.- message malformedCertificateMessage
MalformedPolicyDocumentException
- MalformedPolicyDocumentException
object
: The request was rejected because the policy document was malformed. The error message describes the specific error.- message malformedPolicyDocumentMessage
ManagedPolicyDetail
- ManagedPolicyDetail
object
:Contains information about a managed policy, including the policy's ARN, versions, and the number of principal entities (users, groups, and roles) that the policy is attached to.
This data type is used as a response element in the GetAccountAuthorizationDetails action.
For more information about managed policies, see Managed Policies and Inline Policies in the Using IAM guide.
- Arn arnType
- AttachmentCount attachmentCountType
- CreateDate dateType
- DefaultVersionId policyVersionIdType
- Description policyDescriptionType
- IsAttachable booleanType
- Path policyPathType
- PolicyId idType
- PolicyName policyNameType
- PolicyVersionList policyDocumentVersionListType
- UpdateDate dateType
ManagedPolicyDetailListType
- ManagedPolicyDetailListType
array
- items ManagedPolicyDetail
NoSuchEntityException
- NoSuchEntityException
object
: The request was rejected because it referenced an entity that does not exist. The error message describes the entity.- message noSuchEntityMessage
OpenIDConnectProviderListEntry
- OpenIDConnectProviderListEntry
object
: Contains the Amazon Resource Name (ARN) for an IAM OpenID Connect provider.- Arn arnType
OpenIDConnectProviderListType
- OpenIDConnectProviderListType
array
: Contains a list of IAM OpenID Connect providers.
OpenIDConnectProviderUrlType
- OpenIDConnectProviderUrlType
string
: Contains a URL that specifies the endpoint for an OpenID Connect provider.
OrganizationsDecisionDetail
- OrganizationsDecisionDetail
object
: Contains information about AWS Organizations's affect on a policy simulation.- AllowedByOrganizations booleanType
PasswordPolicy
- PasswordPolicy
object
:Contains information about the account password policy.
This data type is used as a response element in the GetAccountPasswordPolicy action.
- AllowUsersToChangePassword booleanType
- ExpirePasswords booleanType
- HardExpiry booleanObjectType
- MaxPasswordAge maxPasswordAgeType
- MinimumPasswordLength minimumPasswordLengthType
- PasswordReusePrevention passwordReusePreventionType
- RequireLowercaseCharacters booleanType
- RequireNumbers booleanType
- RequireSymbols booleanType
- RequireUppercaseCharacters booleanType
PasswordPolicyViolationException
- PasswordPolicyViolationException
object
: The request was rejected because the provided password did not meet the requirements imposed by the account password policy.- message passwordPolicyViolationMessage
Policy
- Policy
object
:Contains information about a managed policy.
This data type is used as a response element in the CreatePolicy, GetPolicy, and ListPolicies actions.
For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.
- Arn arnType
- AttachmentCount attachmentCountType
- CreateDate dateType
- DefaultVersionId policyVersionIdType
- Description policyDescriptionType
- IsAttachable booleanType
- Path policyPathType
- PolicyId idType
- PolicyName policyNameType
- UpdateDate dateType
PolicyDetail
- PolicyDetail
object
:Contains information about an IAM policy, including the policy document.
This data type is used as a response element in the GetAccountAuthorizationDetails action.
- PolicyDocument policyDocumentType
- PolicyName policyNameType
PolicyEvaluationDecisionType
- PolicyEvaluationDecisionType
string
(values: allowed, explicitDeny, implicitDeny)
PolicyEvaluationException
- PolicyEvaluationException
object
: The request failed because a provided policy could not be successfully evaluated. An additional detailed message indicates the source of the failure.- message policyEvaluationErrorMessage
PolicyGroup
- PolicyGroup
object
:Contains information about a group that a managed policy is attached to.
This data type is used as a response element in the ListEntitiesForPolicy action.
For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.
- GroupId idType
- GroupName groupNameType
PolicyGroupListType
- PolicyGroupListType
array
- items PolicyGroup
PolicyIdentifierType
- PolicyIdentifierType
string
PolicyNotAttachableException
- PolicyNotAttachableException
object
: The request failed because AWS service role policies can only be attached to the service-linked role for that service.- message policyNotAttachableMessage
PolicyRole
- PolicyRole
object
:Contains information about a role that a managed policy is attached to.
This data type is used as a response element in the ListEntitiesForPolicy action.
For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.
- RoleId idType
- RoleName roleNameType
PolicyRoleListType
- PolicyRoleListType
array
- items PolicyRole
PolicySourceType
- PolicySourceType
string
(values: user, group, role, aws-managed, user-managed, resource, none)
PolicyUser
- PolicyUser
object
:Contains information about a user that a managed policy is attached to.
This data type is used as a response element in the ListEntitiesForPolicy action.
For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.
- UserId idType
- UserName userNameType
PolicyUserListType
- PolicyUserListType
array
- items PolicyUser
PolicyVersion
- PolicyVersion
object
:Contains information about a version of a managed policy.
This data type is used as a response element in the CreatePolicyVersion, GetPolicyVersion, ListPolicyVersions, and GetAccountAuthorizationDetails actions.
For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.
- CreateDate dateType
- Document policyDocumentType
- IsDefaultVersion booleanType
- VersionId policyVersionIdType
Position
- Position
object
:Contains the row and column of a location of a
Statement
element in a policy document.This data type is used as a member of the
Statement
type.- Column ColumnNumber
- Line LineNumber
PutGroupPolicyRequest
- PutGroupPolicyRequest
object
- GroupName required groupNameType
- PolicyDocument required policyDocumentType
- PolicyName required policyNameType
PutRolePolicyRequest
- PutRolePolicyRequest
object
- PolicyDocument required policyDocumentType
- PolicyName required policyNameType
- RoleName required roleNameType
PutUserPolicyRequest
- PutUserPolicyRequest
object
- PolicyDocument required policyDocumentType
- PolicyName required policyNameType
- UserName required existingUserNameType
ReasonType
- ReasonType
string
RegionNameType
- RegionNameType
string
RemoveClientIDFromOpenIDConnectProviderRequest
- RemoveClientIDFromOpenIDConnectProviderRequest
object
- ClientID required clientIDType
- OpenIDConnectProviderArn required arnType
RemoveRoleFromInstanceProfileRequest
- RemoveRoleFromInstanceProfileRequest
object
- InstanceProfileName required instanceProfileNameType
- RoleName required roleNameType
RemoveUserFromGroupRequest
- RemoveUserFromGroupRequest
object
- GroupName required groupNameType
- UserName required existingUserNameType
ReportContentType
- ReportContentType
string
ReportFormatType
- ReportFormatType
string
(values: text/csv)
ReportStateDescriptionType
- ReportStateDescriptionType
string
ReportStateType
- ReportStateType
string
(values: STARTED, INPROGRESS, COMPLETE)
ResetServiceSpecificCredentialRequest
- ResetServiceSpecificCredentialRequest
object
- ServiceSpecificCredentialId required serviceSpecificCredentialId
- UserName userNameType
ResetServiceSpecificCredentialResponse
- ResetServiceSpecificCredentialResponse
object
- ServiceSpecificCredential ServiceSpecificCredential
ResourceHandlingOptionType
- ResourceHandlingOptionType
string
ResourceNameListType
- ResourceNameListType
array
- items ResourceNameType
ResourceNameType
- ResourceNameType
string
ResourceSpecificResult
- ResourceSpecificResult
object
:Contains the result of the simulation of a single API action call on a single resource.
This data type is used by a member of the EvaluationResult data type.
- EvalDecisionDetails EvalDecisionDetailsType
- EvalResourceDecision required PolicyEvaluationDecisionType
- EvalResourceName required ResourceNameType
- MatchedStatements StatementListType
- MissingContextValues ContextKeyNamesResultListType
ResourceSpecificResultListType
- ResourceSpecificResultListType
array
- items ResourceSpecificResult
ResyncMFADeviceRequest
- ResyncMFADeviceRequest
object
- AuthenticationCode1 required authenticationCodeType
- AuthenticationCode2 required authenticationCodeType
- SerialNumber required serialNumberType
- UserName required existingUserNameType
Role
- Role
object
: Contains information about an IAM role. This structure is returned as a response element in several APIs that interact with roles.- Arn required arnType
- AssumeRolePolicyDocument policyDocumentType
- CreateDate required dateType
- Description roleDescriptionType
- Path required pathType
- RoleId required idType
- RoleName required roleNameType
RoleDetail
- RoleDetail
object
:Contains information about an IAM role, including all of the role's policies.
This data type is used as a response element in the GetAccountAuthorizationDetails action.
- Arn arnType
- AssumeRolePolicyDocument policyDocumentType
- AttachedManagedPolicies attachedPoliciesListType
- CreateDate dateType
- InstanceProfileList instanceProfileListType
- Path pathType
- RoleId idType
- RoleName roleNameType
- RolePolicyList policyDetailListType
RoleUsageListType
- RoleUsageListType
array
- items RoleUsageType
RoleUsageType
- RoleUsageType
object
:An object that contains details about how a service-linked role is used.
This data type is used as a response element in the GetServiceLinkedRoleDeletionStatus operation.
- Region RegionNameType
- Resources ArnListType
SAMLMetadataDocumentType
- SAMLMetadataDocumentType
string
SAMLProviderListEntry
- SAMLProviderListEntry
object
: Contains the list of SAML providers for this account.
SAMLProviderListType
- SAMLProviderListType
array
- items SAMLProviderListEntry
SAMLProviderNameType
- SAMLProviderNameType
string
SSHPublicKey
- SSHPublicKey
object
:Contains information about an SSH public key.
This data type is used as a response element in the GetSSHPublicKey and UploadSSHPublicKey actions.
- Fingerprint required publicKeyFingerprintType
- SSHPublicKeyBody required publicKeyMaterialType
- SSHPublicKeyId required publicKeyIdType
- Status required statusType
- UploadDate dateType
- UserName required userNameType
SSHPublicKeyListType
- SSHPublicKeyListType
array
- items SSHPublicKeyMetadata
SSHPublicKeyMetadata
- SSHPublicKeyMetadata
object
:Contains information about an SSH public key, without the key's body or fingerprint.
This data type is used as a response element in the ListSSHPublicKeys action.
- SSHPublicKeyId required publicKeyIdType
- Status required statusType
- UploadDate required dateType
- UserName required userNameType
ServerCertificate
- ServerCertificate
object
:Contains information about a server certificate.
This data type is used as a response element in the GetServerCertificate action.
- CertificateBody required certificateBodyType
- CertificateChain certificateChainType
- ServerCertificateMetadata required ServerCertificateMetadata
ServerCertificateMetadata
- ServerCertificateMetadata
object
:Contains information about a server certificate without its certificate body, certificate chain, and private key.
This data type is used as a response element in the UploadServerCertificate and ListServerCertificates actions.
ServiceFailureException
- ServiceFailureException
object
: The request processing has failed because of an unknown error, exception or failure.- message serviceFailureExceptionMessage
ServiceNotSupportedException
- ServiceNotSupportedException
object
: The specified service does not support service-specific credentials.- message serviceNotSupportedMessage
ServiceSpecificCredential
- ServiceSpecificCredential
object
: Contains the details of a service specific credential.- CreateDate required dateType
- ServiceName required serviceName
- ServicePassword required servicePassword
- ServiceSpecificCredentialId required serviceSpecificCredentialId
- ServiceUserName required serviceUserName
- Status required statusType
- UserName required userNameType
ServiceSpecificCredentialMetadata
- ServiceSpecificCredentialMetadata
object
: Contains additional details about a service-specific credential.- CreateDate required dateType
- ServiceName required serviceName
- ServiceSpecificCredentialId required serviceSpecificCredentialId
- ServiceUserName required serviceUserName
- Status required statusType
- UserName required userNameType
ServiceSpecificCredentialsListType
- ServiceSpecificCredentialsListType
array
SetDefaultPolicyVersionRequest
- SetDefaultPolicyVersionRequest
object
- PolicyArn required arnType
- VersionId required policyVersionIdType
SigningCertificate
- SigningCertificate
object
:Contains information about an X.509 signing certificate.
This data type is used as a response element in the UploadSigningCertificate and ListSigningCertificates actions.
- CertificateBody required certificateBodyType
- CertificateId required certificateIdType
- Status required statusType
- UploadDate dateType
- UserName required userNameType
SimulateCustomPolicyRequest
- SimulateCustomPolicyRequest
object
- ActionNames required ActionNameListType
- CallerArn ResourceNameType
- ContextEntries ContextEntryListType
- Marker markerType
- MaxItems maxItemsType
- PolicyInputList required SimulationPolicyListType
- ResourceArns ResourceNameListType
- ResourceHandlingOption ResourceHandlingOptionType
- ResourceOwner ResourceNameType
- ResourcePolicy policyDocumentType
SimulatePolicyResponse
- SimulatePolicyResponse
object
: Contains the response to a successful SimulatePrincipalPolicy or SimulateCustomPolicy request.- EvaluationResults EvaluationResultsListType
- IsTruncated booleanType
- Marker markerType
SimulatePrincipalPolicyRequest
- SimulatePrincipalPolicyRequest
object
- ActionNames required ActionNameListType
- CallerArn ResourceNameType
- ContextEntries ContextEntryListType
- Marker markerType
- MaxItems maxItemsType
- PolicyInputList SimulationPolicyListType
- PolicySourceArn required arnType
- ResourceArns ResourceNameListType
- ResourceHandlingOption ResourceHandlingOptionType
- ResourceOwner ResourceNameType
- ResourcePolicy policyDocumentType
SimulationPolicyListType
- SimulationPolicyListType
array
- items policyDocumentType
Statement
- Statement
object
:Contains a reference to a
Statement
element in a policy document that determines the result of the simulation.This data type is used by the
MatchedStatements
member of theEvaluationResult
type.- EndPosition Position
- SourcePolicyId PolicyIdentifierType
- SourcePolicyType PolicySourceType
- StartPosition Position
StatementListType
- StatementListType
array
- items Statement
UnmodifiableEntityException
- UnmodifiableEntityException
object
: The request was rejected because only the service that depends on the service-linked role can modify or delete the role on your behalf. The error message includes the name of the service that depends on this service-linked role. You must request the change through that service.- message unmodifiableEntityMessage
UnrecognizedPublicKeyEncodingException
- UnrecognizedPublicKeyEncodingException
object
: The request was rejected because the public key encoding format is unsupported or unrecognized.
UpdateAccessKeyRequest
- UpdateAccessKeyRequest
object
- AccessKeyId required accessKeyIdType
- Status required statusType
- UserName existingUserNameType
UpdateAccountPasswordPolicyRequest
- UpdateAccountPasswordPolicyRequest
object
- AllowUsersToChangePassword booleanType
- HardExpiry booleanObjectType
- MaxPasswordAge maxPasswordAgeType
- MinimumPasswordLength minimumPasswordLengthType
- PasswordReusePrevention passwordReusePreventionType
- RequireLowercaseCharacters booleanType
- RequireNumbers booleanType
- RequireSymbols booleanType
- RequireUppercaseCharacters booleanType
UpdateAssumeRolePolicyRequest
- UpdateAssumeRolePolicyRequest
object
- PolicyDocument required policyDocumentType
- RoleName required roleNameType
UpdateGroupRequest
- UpdateGroupRequest
object
- GroupName required groupNameType
- NewGroupName groupNameType
- NewPath pathType
UpdateLoginProfileRequest
- UpdateLoginProfileRequest
object
- Password passwordType
- PasswordResetRequired booleanObjectType
- UserName required userNameType
UpdateOpenIDConnectProviderThumbprintRequest
- UpdateOpenIDConnectProviderThumbprintRequest
object
- OpenIDConnectProviderArn required arnType
- ThumbprintList required thumbprintListType
UpdateRoleDescriptionRequest
- UpdateRoleDescriptionRequest
object
- Description required roleDescriptionType
- RoleName required roleNameType
UpdateRoleDescriptionResponse
- UpdateRoleDescriptionResponse
object
- Role Role
UpdateSAMLProviderRequest
- UpdateSAMLProviderRequest
object
- SAMLMetadataDocument required SAMLMetadataDocumentType
- SAMLProviderArn required arnType
UpdateSAMLProviderResponse
- UpdateSAMLProviderResponse
object
: Contains the response to a successful UpdateSAMLProvider request.- SAMLProviderArn arnType
UpdateSSHPublicKeyRequest
- UpdateSSHPublicKeyRequest
object
- SSHPublicKeyId required publicKeyIdType
- Status required statusType
- UserName required userNameType
UpdateServerCertificateRequest
- UpdateServerCertificateRequest
object
- NewPath pathType
- NewServerCertificateName serverCertificateNameType
- ServerCertificateName required serverCertificateNameType
UpdateServiceSpecificCredentialRequest
- UpdateServiceSpecificCredentialRequest
object
- ServiceSpecificCredentialId required serviceSpecificCredentialId
- Status required statusType
- UserName userNameType
UpdateSigningCertificateRequest
- UpdateSigningCertificateRequest
object
- CertificateId required certificateIdType
- Status required statusType
- UserName existingUserNameType
UpdateUserRequest
- UpdateUserRequest
object
- NewPath pathType
- NewUserName userNameType
- UserName required existingUserNameType
UploadSSHPublicKeyRequest
- UploadSSHPublicKeyRequest
object
- SSHPublicKeyBody required publicKeyMaterialType
- UserName required userNameType
UploadSSHPublicKeyResponse
- UploadSSHPublicKeyResponse
object
: Contains the response to a successful UploadSSHPublicKey request.- SSHPublicKey SSHPublicKey
UploadServerCertificateRequest
- UploadServerCertificateRequest
object
- CertificateBody required certificateBodyType
- CertificateChain certificateChainType
- Path pathType
- PrivateKey required privateKeyType
- ServerCertificateName required serverCertificateNameType
UploadServerCertificateResponse
- UploadServerCertificateResponse
object
: Contains the response to a successful UploadServerCertificate request.- ServerCertificateMetadata ServerCertificateMetadata
UploadSigningCertificateRequest
- UploadSigningCertificateRequest
object
- CertificateBody required certificateBodyType
- UserName existingUserNameType
UploadSigningCertificateResponse
- UploadSigningCertificateResponse
object
: Contains the response to a successful UploadSigningCertificate request.- Certificate required SigningCertificate
User
- User
object
:Contains information about an IAM user entity.
This data type is used as a response element in the following actions:
-
CreateUser
-
GetUser
-
ListUsers
-
UserDetail
- UserDetail
object
:Contains information about an IAM user, including all the user's policies and all the IAM groups the user is in.
This data type is used as a response element in the GetAccountAuthorizationDetails action.
- Arn arnType
- AttachedManagedPolicies attachedPoliciesListType
- CreateDate dateType
- GroupList groupNameListType
- Path pathType
- UserId idType
- UserName userNameType
- UserPolicyList policyDetailListType
VirtualMFADevice
- VirtualMFADevice
object
: Contains information about a virtual MFA device.- Base32StringSeed BootstrapDatum
- EnableDate dateType
- QRCodePNG BootstrapDatum
- SerialNumber required serialNumberType
- User User
accessKeyIdType
- accessKeyIdType
string
accessKeyMetadataListType
- accessKeyMetadataListType
array
:Contains a list of access key metadata.
This data type is used as a response element in the ListAccessKeys action.
- items AccessKeyMetadata
accessKeySecretType
- accessKeySecretType
string
accountAliasListType
- accountAliasListType
array
- items accountAliasType
accountAliasType
- accountAliasType
string
arnType
- arnType
string
:The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
assignmentStatusType
- assignmentStatusType
string
(values: Assigned, Unassigned, Any)
attachedPoliciesListType
- attachedPoliciesListType
array
- items AttachedPolicy
attachmentCountType
- attachmentCountType
integer
authenticationCodeType
- authenticationCodeType
string
booleanObjectType
- booleanObjectType
boolean
booleanType
- booleanType
boolean
certificateBodyType
- certificateBodyType
string
certificateChainType
- certificateChainType
string
certificateIdType
- certificateIdType
string
certificateListType
- certificateListType
array
:Contains a list of signing certificates.
This data type is used as a response element in the ListSigningCertificates action.
- items SigningCertificate
clientIDListType
- clientIDListType
array
- items clientIDType
clientIDType
- clientIDType
string
credentialReportExpiredExceptionMessage
- credentialReportExpiredExceptionMessage
string
credentialReportNotPresentExceptionMessage
- credentialReportNotPresentExceptionMessage
string
credentialReportNotReadyExceptionMessage
- credentialReportNotReadyExceptionMessage
string
customSuffixType
- customSuffixType
string
dateType
- dateType
string
deleteConflictMessage
- deleteConflictMessage
string
duplicateCertificateMessage
- duplicateCertificateMessage
string
duplicateSSHPublicKeyMessage
- duplicateSSHPublicKeyMessage
string
encodingType
- encodingType
string
(values: SSH, PEM)
entityAlreadyExistsMessage
- entityAlreadyExistsMessage
string
entityListType
- entityListType
array
- items EntityType
entityTemporarilyUnmodifiableMessage
- entityTemporarilyUnmodifiableMessage
string
existingUserNameType
- existingUserNameType
string
groupDetailListType
- groupDetailListType
array
- items GroupDetail
groupListType
- groupListType
array
:Contains a list of IAM groups.
This data type is used as a response element in the ListGroups action.
- items Group
groupNameListType
- groupNameListType
array
- items groupNameType
groupNameType
- groupNameType
string
idType
- idType
string
instanceProfileListType
- instanceProfileListType
array
: Contains a list of instance profiles.- items InstanceProfile
instanceProfileNameType
- instanceProfileNameType
string
invalidAuthenticationCodeMessage
- invalidAuthenticationCodeMessage
string
invalidCertificateMessage
- invalidCertificateMessage
string
invalidInputMessage
- invalidInputMessage
string
invalidPublicKeyMessage
- invalidPublicKeyMessage
string
invalidUserTypeMessage
- invalidUserTypeMessage
string
keyPairMismatchMessage
- keyPairMismatchMessage
string
limitExceededMessage
- limitExceededMessage
string
malformedCertificateMessage
- malformedCertificateMessage
string
malformedPolicyDocumentMessage
- malformedPolicyDocumentMessage
string
markerType
- markerType
string
maxItemsType
- maxItemsType
integer
maxPasswordAgeType
- maxPasswordAgeType
integer
mfaDeviceListType
- mfaDeviceListType
array
:Contains a list of MFA devices.
This data type is used as a response element in the ListMFADevices and ListVirtualMFADevices actions.
- items MFADevice
minimumPasswordLengthType
- minimumPasswordLengthType
integer
noSuchEntityMessage
- noSuchEntityMessage
string
passwordPolicyViolationMessage
- passwordPolicyViolationMessage
string
passwordReusePreventionType
- passwordReusePreventionType
integer
passwordType
- passwordType
string
pathPrefixType
- pathPrefixType
string
pathType
- pathType
string
policyDescriptionType
- policyDescriptionType
string
policyDetailListType
- policyDetailListType
array
- items PolicyDetail
policyDocumentType
- policyDocumentType
string
policyDocumentVersionListType
- policyDocumentVersionListType
array
- items PolicyVersion
policyEvaluationErrorMessage
- policyEvaluationErrorMessage
string
policyListType
- policyListType
array
- items Policy
policyNameListType
- policyNameListType
array
:Contains a list of policy names.
This data type is used as a response element in the ListPolicies action.
- items policyNameType
policyNameType
- policyNameType
string
policyNotAttachableMessage
- policyNotAttachableMessage
string
policyPathType
- policyPathType
string
policyScopeType
- policyScopeType
string
(values: All, AWS, Local)
policyVersionIdType
- policyVersionIdType
string
privateKeyType
- privateKeyType
string
publicKeyFingerprintType
- publicKeyFingerprintType
string
publicKeyIdType
- publicKeyIdType
string
publicKeyMaterialType
- publicKeyMaterialType
string
roleDescriptionType
- roleDescriptionType
string
roleDetailListType
- roleDetailListType
array
- items RoleDetail
roleListType
- roleListType
array
:Contains a list of IAM roles.
This data type is used as a response element in the ListRoles action.
- items Role
roleNameType
- roleNameType
string
serialNumberType
- serialNumberType
string
serverCertificateMetadataListType
- serverCertificateMetadataListType
array
serverCertificateNameType
- serverCertificateNameType
string
serviceFailureExceptionMessage
- serviceFailureExceptionMessage
string
serviceName
- serviceName
string
serviceNotSupportedMessage
- serviceNotSupportedMessage
string
servicePassword
- servicePassword
string
serviceSpecificCredentialId
- serviceSpecificCredentialId
string
serviceUserName
- serviceUserName
string
statusType
- statusType
string
(values: Active, Inactive)
stringType
- stringType
string
summaryKeyType
- summaryKeyType
string
(values: Users, UsersQuota, Groups, GroupsQuota, ServerCertificates, ServerCertificatesQuota, UserPolicySizeQuota, GroupPolicySizeQuota, GroupsPerUserQuota, SigningCertificatesPerUserQuota, AccessKeysPerUserQuota, MFADevices, MFADevicesInUse, AccountMFAEnabled, AccountAccessKeysPresent, AccountSigningCertificatesPresent, AttachedPoliciesPerGroupQuota, AttachedPoliciesPerRoleQuota, AttachedPoliciesPerUserQuota, Policies, PoliciesQuota, PolicySizeQuota, PolicyVersionsInUse, PolicyVersionsInUseQuota, VersionsPerPolicyQuota)
summaryMapType
- summaryMapType
array
- items
object
- key summaryKeyType
- value summaryValueType
- items
summaryValueType
- summaryValueType
integer
thumbprintListType
- thumbprintListType
array
: Contains a list of thumbprints of identity provider server certificates.- items thumbprintType
thumbprintType
- thumbprintType
string
:Contains a thumbprint for an identity provider's server certificate.
The identity provider's server certificate thumbprint is the hex-encoded SHA-1 hash value of the self-signed X.509 certificate used by the domain where the OpenID Connect provider makes its keys available. It is always a 40-character string.
unmodifiableEntityMessage
- unmodifiableEntityMessage
string
unrecognizedPublicKeyEncodingMessage
- unrecognizedPublicKeyEncodingMessage
string
userDetailListType
- userDetailListType
array
- items UserDetail
userListType
- userListType
array
:Contains a list of users.
This data type is used as a response element in the GetGroup and ListUsers actions.
- items User
userNameType
- userNameType
string
virtualMFADeviceListType
- virtualMFADeviceListType
array
- items VirtualMFADevice
virtualMFADeviceName
- virtualMFADeviceName
string