@datafire/amazonaws_iam

5.0.0 • Public • Published

@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

Output

Output schema unknown

AddRoleToInstanceProfile

amazonaws_iam.AddRoleToInstanceProfile({
  "InstanceProfileName": "",
  "RoleName": ""
}, context)

Input

Output

Output schema unknown

AddUserToGroup

amazonaws_iam.AddUserToGroup({
  "GroupName": "",
  "UserName": ""
}, context)

Input

Output

Output schema unknown

AttachGroupPolicy

amazonaws_iam.AttachGroupPolicy({
  "GroupName": "",
  "PolicyArn": ""
}, context)

Input

Output

Output schema unknown

AttachRolePolicy

amazonaws_iam.AttachRolePolicy({
  "RoleName": "",
  "PolicyArn": ""
}, context)

Input

Output

Output schema unknown

AttachUserPolicy

amazonaws_iam.AttachUserPolicy({
  "UserName": "",
  "PolicyArn": ""
}, context)

Input

Output

Output schema unknown

ChangePassword

amazonaws_iam.ChangePassword({
  "OldPassword": "",
  "NewPassword": ""
}, context)

Input

Output

Output schema unknown

CreateAccessKey

amazonaws_iam.CreateAccessKey({}, context)

Input

Output

CreateAccountAlias

amazonaws_iam.CreateAccountAlias({
  "AccountAlias": ""
}, context)

Input

Output

Output schema unknown

CreateGroup

amazonaws_iam.CreateGroup({
  "GroupName": ""
}, context)

Input

Output

CreateInstanceProfile

amazonaws_iam.CreateInstanceProfile({
  "InstanceProfileName": ""
}, context)

Input

Output

CreateLoginProfile

amazonaws_iam.CreateLoginProfile({
  "UserName": "",
  "Password": ""
}, context)

Input

Output

CreateOpenIDConnectProvider

amazonaws_iam.CreateOpenIDConnectProvider({
  "Url": "",
  "ThumbprintList": []
}, context)

Input

Output

CreatePolicy

amazonaws_iam.CreatePolicy({
  "PolicyName": "",
  "PolicyDocument": ""
}, context)

Input

Output

CreatePolicyVersion

amazonaws_iam.CreatePolicyVersion({
  "PolicyArn": "",
  "PolicyDocument": ""
}, context)

Input

Output

CreateRole

amazonaws_iam.CreateRole({
  "RoleName": "",
  "AssumeRolePolicyDocument": ""
}, context)

Input

Output

CreateSAMLProvider

amazonaws_iam.CreateSAMLProvider({
  "SAMLMetadataDocument": "",
  "Name": ""
}, context)

Input

Output

CreateServiceLinkedRole

amazonaws_iam.CreateServiceLinkedRole({
  "AWSServiceName": ""
}, context)

Input

Output

CreateServiceSpecificCredential

amazonaws_iam.CreateServiceSpecificCredential({
  "UserName": "",
  "ServiceName": ""
}, context)

Input

Output

CreateUser

amazonaws_iam.CreateUser({
  "UserName": ""
}, context)

Input

Output

CreateVirtualMFADevice

amazonaws_iam.CreateVirtualMFADevice({
  "VirtualMFADeviceName": ""
}, context)

Input

Output

DeactivateMFADevice

amazonaws_iam.DeactivateMFADevice({
  "UserName": "",
  "SerialNumber": ""
}, context)

Input

Output

Output schema unknown

DeleteAccessKey

amazonaws_iam.DeleteAccessKey({
  "AccessKeyId": ""
}, context)

Input

Output

Output schema unknown

DeleteAccountAlias

amazonaws_iam.DeleteAccountAlias({
  "AccountAlias": ""
}, context)

Input

Output

Output schema unknown

DeleteAccountPasswordPolicy

amazonaws_iam.DeleteAccountPasswordPolicy({}, context)

Input

  • input object

Output

Output schema unknown

DeleteGroup

amazonaws_iam.DeleteGroup({
  "GroupName": ""
}, context)

Input

Output

Output schema unknown

DeleteGroupPolicy

amazonaws_iam.DeleteGroupPolicy({
  "GroupName": "",
  "PolicyName": ""
}, context)

Input

Output

Output schema unknown

DeleteInstanceProfile

amazonaws_iam.DeleteInstanceProfile({
  "InstanceProfileName": ""
}, context)

Input

Output

Output schema unknown

DeleteLoginProfile

amazonaws_iam.DeleteLoginProfile({
  "UserName": ""
}, context)

Input

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

Output

Output schema unknown

DeletePolicyVersion

amazonaws_iam.DeletePolicyVersion({
  "PolicyArn": "",
  "VersionId": ""
}, context)

Input

Output

Output schema unknown

DeleteRole

amazonaws_iam.DeleteRole({
  "RoleName": ""
}, context)

Input

Output

Output schema unknown

DeleteRolePolicy

amazonaws_iam.DeleteRolePolicy({
  "RoleName": "",
  "PolicyName": ""
}, context)

Input

Output

Output schema unknown

DeleteSAMLProvider

amazonaws_iam.DeleteSAMLProvider({
  "SAMLProviderArn": ""
}, context)

Input

  • input object

Output

Output schema unknown

DeleteSSHPublicKey

amazonaws_iam.DeleteSSHPublicKey({
  "UserName": "",
  "SSHPublicKeyId": ""
}, context)

Input

Output

Output schema unknown

DeleteServerCertificate

amazonaws_iam.DeleteServerCertificate({
  "ServerCertificateName": ""
}, context)

Input

Output

Output schema unknown

DeleteServiceLinkedRole

amazonaws_iam.DeleteServiceLinkedRole({
  "RoleName": ""
}, context)

Input

Output

DeleteServiceSpecificCredential

amazonaws_iam.DeleteServiceSpecificCredential({
  "ServiceSpecificCredentialId": ""
}, context)

Input

Output

Output schema unknown

DeleteSigningCertificate

amazonaws_iam.DeleteSigningCertificate({
  "CertificateId": ""
}, context)

Input

Output

Output schema unknown

DeleteUser

amazonaws_iam.DeleteUser({
  "UserName": ""
}, context)

Input

Output

Output schema unknown

DeleteUserPolicy

amazonaws_iam.DeleteUserPolicy({
  "UserName": "",
  "PolicyName": ""
}, context)

Input

Output

Output schema unknown

DeleteVirtualMFADevice

amazonaws_iam.DeleteVirtualMFADevice({
  "SerialNumber": ""
}, context)

Input

Output

Output schema unknown

DetachGroupPolicy

amazonaws_iam.DetachGroupPolicy({
  "GroupName": "",
  "PolicyArn": ""
}, context)

Input

Output

Output schema unknown

DetachRolePolicy

amazonaws_iam.DetachRolePolicy({
  "RoleName": "",
  "PolicyArn": ""
}, context)

Input

Output

Output schema unknown

DetachUserPolicy

amazonaws_iam.DetachUserPolicy({
  "UserName": "",
  "PolicyArn": ""
}, context)

Input

Output

Output schema unknown

EnableMFADevice

amazonaws_iam.EnableMFADevice({
  "UserName": "",
  "SerialNumber": "",
  "AuthenticationCode1": "",
  "AuthenticationCode2": ""
}, context)

Input

Output

Output schema unknown

GenerateCredentialReport

amazonaws_iam.GenerateCredentialReport({}, context)

Input

  • input object

Output

GetAccessKeyLastUsed

amazonaws_iam.GetAccessKeyLastUsed({
  "AccessKeyId": ""
}, context)

Input

Output

GetAccountAuthorizationDetails

amazonaws_iam.GetAccountAuthorizationDetails({}, context)

Input

Output

GetAccountPasswordPolicy

amazonaws_iam.GetAccountPasswordPolicy({}, context)

Input

  • input object

Output

GetAccountSummary

amazonaws_iam.GetAccountSummary({}, context)

Input

  • input object

Output

GetContextKeysForCustomPolicy

amazonaws_iam.GetContextKeysForCustomPolicy({
  "PolicyInputList": []
}, context)

Input

Output

GetContextKeysForPrincipalPolicy

amazonaws_iam.GetContextKeysForPrincipalPolicy({
  "PolicySourceArn": ""
}, context)

Input

Output

GetCredentialReport

amazonaws_iam.GetCredentialReport({}, context)

Input

  • input object

Output

GetGroup

amazonaws_iam.GetGroup({
  "GroupName": ""
}, context)

Input

Output

GetGroupPolicy

amazonaws_iam.GetGroupPolicy({
  "GroupName": "",
  "PolicyName": ""
}, context)

Input

Output

GetInstanceProfile

amazonaws_iam.GetInstanceProfile({
  "InstanceProfileName": ""
}, context)

Input

Output

GetLoginProfile

amazonaws_iam.GetLoginProfile({
  "UserName": ""
}, context)

Input

Output

GetOpenIDConnectProvider

amazonaws_iam.GetOpenIDConnectProvider({
  "OpenIDConnectProviderArn": ""
}, context)

Input

  • input object
    • OpenIDConnectProviderArn required arnType

Output

GetPolicy

amazonaws_iam.GetPolicy({
  "PolicyArn": ""
}, context)

Input

  • input object

Output

GetPolicyVersion

amazonaws_iam.GetPolicyVersion({
  "PolicyArn": "",
  "VersionId": ""
}, context)

Input

Output

GetRole

amazonaws_iam.GetRole({
  "RoleName": ""
}, context)

Input

Output

GetRolePolicy

amazonaws_iam.GetRolePolicy({
  "RoleName": "",
  "PolicyName": ""
}, context)

Input

Output

GetSAMLProvider

amazonaws_iam.GetSAMLProvider({
  "SAMLProviderArn": ""
}, context)

Input

  • input object

Output

GetSSHPublicKey

amazonaws_iam.GetSSHPublicKey({
  "UserName": "",
  "SSHPublicKeyId": "",
  "Encoding": ""
}, context)

Input

Output

GetServerCertificate

amazonaws_iam.GetServerCertificate({
  "ServerCertificateName": ""
}, context)

Input

Output

GetServiceLinkedRoleDeletionStatus

amazonaws_iam.GetServiceLinkedRoleDeletionStatus({
  "DeletionTaskId": ""
}, context)

Input

Output

GetUser

amazonaws_iam.GetUser({}, context)

Input

Output

GetUserPolicy

amazonaws_iam.GetUserPolicy({
  "UserName": "",
  "PolicyName": ""
}, context)

Input

Output

ListAccessKeys

amazonaws_iam.ListAccessKeys({}, context)

Input

Output

ListAccountAliases

amazonaws_iam.ListAccountAliases({}, context)

Input

Output

ListAttachedGroupPolicies

amazonaws_iam.ListAttachedGroupPolicies({
  "GroupName": ""
}, context)

Input

Output

ListAttachedRolePolicies

amazonaws_iam.ListAttachedRolePolicies({
  "RoleName": ""
}, context)

Input

Output

ListAttachedUserPolicies

amazonaws_iam.ListAttachedUserPolicies({
  "UserName": ""
}, context)

Input

Output

ListEntitiesForPolicy

amazonaws_iam.ListEntitiesForPolicy({
  "PolicyArn": ""
}, context)

Input

Output

ListGroupPolicies

amazonaws_iam.ListGroupPolicies({
  "GroupName": ""
}, context)

Input

Output

ListGroups

amazonaws_iam.ListGroups({}, context)

Input

Output

ListGroupsForUser

amazonaws_iam.ListGroupsForUser({
  "UserName": ""
}, context)

Input

Output

ListInstanceProfiles

amazonaws_iam.ListInstanceProfiles({}, context)

Input

Output

ListInstanceProfilesForRole

amazonaws_iam.ListInstanceProfilesForRole({
  "RoleName": ""
}, context)

Input

Output

ListMFADevices

amazonaws_iam.ListMFADevices({}, context)

Input

Output

ListOpenIDConnectProviders

amazonaws_iam.ListOpenIDConnectProviders({}, context)

Input

  • input object

Output

ListPolicies

amazonaws_iam.ListPolicies({}, context)

Input

Output

ListPolicyVersions

amazonaws_iam.ListPolicyVersions({
  "PolicyArn": ""
}, context)

Input

Output

ListRolePolicies

amazonaws_iam.ListRolePolicies({
  "RoleName": ""
}, context)

Input

Output

ListRoles

amazonaws_iam.ListRoles({}, context)

Input

Output

ListSAMLProviders

amazonaws_iam.ListSAMLProviders({}, context)

Input

  • input object

Output

ListSSHPublicKeys

amazonaws_iam.ListSSHPublicKeys({}, context)

Input

Output

ListServerCertificates

amazonaws_iam.ListServerCertificates({}, context)

Input

Output

ListServiceSpecificCredentials

amazonaws_iam.ListServiceSpecificCredentials({}, context)

Input

Output

ListSigningCertificates

amazonaws_iam.ListSigningCertificates({}, context)

Input

Output

ListUserPolicies

amazonaws_iam.ListUserPolicies({
  "UserName": ""
}, context)

Input

Output

ListUsers

amazonaws_iam.ListUsers({}, context)

Input

Output

ListVirtualMFADevices

amazonaws_iam.ListVirtualMFADevices({}, context)

Input

Output

PutGroupPolicy

amazonaws_iam.PutGroupPolicy({
  "GroupName": "",
  "PolicyName": "",
  "PolicyDocument": ""
}, context)

Input

Output

Output schema unknown

PutRolePolicy

amazonaws_iam.PutRolePolicy({
  "RoleName": "",
  "PolicyName": "",
  "PolicyDocument": ""
}, context)

Input

Output

Output schema unknown

PutUserPolicy

amazonaws_iam.PutUserPolicy({
  "UserName": "",
  "PolicyName": "",
  "PolicyDocument": ""
}, context)

Input

Output

Output schema unknown

RemoveClientIDFromOpenIDConnectProvider

amazonaws_iam.RemoveClientIDFromOpenIDConnectProvider({
  "OpenIDConnectProviderArn": "",
  "ClientID": ""
}, context)

Input

Output

Output schema unknown

RemoveRoleFromInstanceProfile

amazonaws_iam.RemoveRoleFromInstanceProfile({
  "InstanceProfileName": "",
  "RoleName": ""
}, context)

Input

Output

Output schema unknown

RemoveUserFromGroup

amazonaws_iam.RemoveUserFromGroup({
  "GroupName": "",
  "UserName": ""
}, context)

Input

Output

Output schema unknown

ResetServiceSpecificCredential

amazonaws_iam.ResetServiceSpecificCredential({
  "ServiceSpecificCredentialId": ""
}, context)

Input

Output

ResyncMFADevice

amazonaws_iam.ResyncMFADevice({
  "UserName": "",
  "SerialNumber": "",
  "AuthenticationCode1": "",
  "AuthenticationCode2": ""
}, context)

Input

Output

Output schema unknown

SetDefaultPolicyVersion

amazonaws_iam.SetDefaultPolicyVersion({
  "PolicyArn": "",
  "VersionId": ""
}, context)

Input

Output

Output schema unknown

SimulateCustomPolicy

amazonaws_iam.SimulateCustomPolicy({
  "PolicyInputList": [],
  "ActionNames": []
}, context)

Input

Output

SimulatePrincipalPolicy

amazonaws_iam.SimulatePrincipalPolicy({
  "PolicySourceArn": "",
  "ActionNames": []
}, context)

Input

Output

UpdateAccessKey

amazonaws_iam.UpdateAccessKey({
  "AccessKeyId": "",
  "Status": ""
}, context)

Input

Output

Output schema unknown

UpdateAccountPasswordPolicy

amazonaws_iam.UpdateAccountPasswordPolicy({}, context)

Input

Output

Output schema unknown

UpdateAssumeRolePolicy

amazonaws_iam.UpdateAssumeRolePolicy({
  "RoleName": "",
  "PolicyDocument": ""
}, context)

Input

Output

Output schema unknown

UpdateGroup

amazonaws_iam.UpdateGroup({
  "GroupName": ""
}, context)

Input

Output

Output schema unknown

UpdateLoginProfile

amazonaws_iam.UpdateLoginProfile({
  "UserName": ""
}, context)

Input

Output

Output schema unknown

UpdateOpenIDConnectProviderThumbprint

amazonaws_iam.UpdateOpenIDConnectProviderThumbprint({
  "OpenIDConnectProviderArn": "",
  "ThumbprintList": []
}, context)

Input

Output

Output schema unknown

UpdateRoleDescription

amazonaws_iam.UpdateRoleDescription({
  "RoleName": "",
  "Description": ""
}, context)

Input

Output

UpdateSAMLProvider

amazonaws_iam.UpdateSAMLProvider({
  "SAMLMetadataDocument": "",
  "SAMLProviderArn": ""
}, context)

Input

Output

UpdateSSHPublicKey

amazonaws_iam.UpdateSSHPublicKey({
  "UserName": "",
  "SSHPublicKeyId": "",
  "Status": ""
}, context)

Input

Output

Output schema unknown

UpdateServerCertificate

amazonaws_iam.UpdateServerCertificate({
  "ServerCertificateName": ""
}, context)

Input

Output

Output schema unknown

UpdateServiceSpecificCredential

amazonaws_iam.UpdateServiceSpecificCredential({
  "ServiceSpecificCredentialId": "",
  "Status": ""
}, context)

Input

Output

Output schema unknown

UpdateSigningCertificate

amazonaws_iam.UpdateSigningCertificate({
  "CertificateId": "",
  "Status": ""
}, context)

Input

Output

Output schema unknown

UpdateUser

amazonaws_iam.UpdateUser({
  "UserName": ""
}, context)

Input

Output

Output schema unknown

UploadSSHPublicKey

amazonaws_iam.UploadSSHPublicKey({
  "UserName": "",
  "SSHPublicKeyBody": ""
}, context)

Input

Output

UploadServerCertificate

amazonaws_iam.UploadServerCertificate({
  "ServerCertificateName": "",
  "CertificateBody": "",
  "PrivateKey": ""
}, context)

Input

Output

UploadSigningCertificate

amazonaws_iam.UploadSigningCertificate({
  "CertificateBody": ""
}, context)

Input

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.

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.

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.

ActionNameListType

ActionNameType

  • ActionNameType string

AddClientIDToOpenIDConnectProviderRequest

  • AddClientIDToOpenIDConnectProviderRequest object

AddRoleToInstanceProfileRequest

AddUserToGroupRequest

ArnListType

AttachGroupPolicyRequest

AttachRolePolicyRequest

AttachUserPolicyRequest

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.

BootstrapDatum

  • BootstrapDatum string

ChangePasswordRequest

ColumnNumber

  • ColumnNumber integer

ContextEntry

  • ContextEntry object:

    Contains information about a condition context key. It includes the name of the key and specifies the value (or values, if the context key supports multiple values) to use in the simulation. This information is used when evaluating the Condition elements of the input policies.

    This data type is used as an input parameter to SimulateCustomPolicy and SimulateCustomPolicy .

ContextEntryListType

ContextKeyNameType

  • ContextKeyNameType string

ContextKeyNamesResultListType

ContextKeyTypeEnum

  • ContextKeyTypeEnum string (values: string, stringList, numeric, numericList, boolean, booleanList, ip, ipList, binary, binaryList, date, dateList)

ContextKeyValueListType

ContextKeyValueType

  • ContextKeyValueType string

CreateAccessKeyRequest

CreateAccessKeyResponse

  • CreateAccessKeyResponse object: Contains the response to a successful CreateAccessKey request.

CreateAccountAliasRequest

CreateGroupRequest

CreateGroupResponse

  • CreateGroupResponse object: Contains the response to a successful CreateGroup request.

CreateInstanceProfileRequest

CreateInstanceProfileResponse

  • CreateInstanceProfileResponse object: Contains the response to a successful CreateInstanceProfile request.

CreateLoginProfileRequest

CreateLoginProfileResponse

  • CreateLoginProfileResponse object: Contains the response to a successful CreateLoginProfile request.

CreateOpenIDConnectProviderRequest

CreateOpenIDConnectProviderResponse

  • CreateOpenIDConnectProviderResponse object: Contains the response to a successful CreateOpenIDConnectProvider request.

CreatePolicyRequest

CreatePolicyResponse

  • CreatePolicyResponse object: Contains the response to a successful CreatePolicy request.

CreatePolicyVersionRequest

CreatePolicyVersionResponse

  • CreatePolicyVersionResponse object: Contains the response to a successful CreatePolicyVersion request.

CreateRoleRequest

CreateRoleResponse

  • CreateRoleResponse object: Contains the response to a successful CreateRole request.
    • Role required Role

CreateSAMLProviderRequest

CreateSAMLProviderResponse

  • CreateSAMLProviderResponse object: Contains the response to a successful CreateSAMLProvider request.

CreateServiceLinkedRoleRequest

CreateServiceLinkedRoleResponse

  • CreateServiceLinkedRoleResponse object

CreateServiceSpecificCredentialRequest

CreateServiceSpecificCredentialResponse

CreateUserRequest

CreateUserResponse

  • CreateUserResponse object: Contains the response to a successful CreateUser request.

CreateVirtualMFADeviceRequest

CreateVirtualMFADeviceResponse

  • CreateVirtualMFADeviceResponse object: Contains the response to a successful CreateVirtualMFADevice request.

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

DeactivateMFADeviceRequest

DeleteAccessKeyRequest

DeleteAccountAliasRequest

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.

DeleteGroupPolicyRequest

DeleteGroupRequest

DeleteInstanceProfileRequest

DeleteLoginProfileRequest

  • DeleteLoginProfileRequest object

DeleteOpenIDConnectProviderRequest

  • DeleteOpenIDConnectProviderRequest object
    • OpenIDConnectProviderArn required arnType

DeletePolicyRequest

  • DeletePolicyRequest object

DeletePolicyVersionRequest

DeleteRolePolicyRequest

DeleteRoleRequest

DeleteSAMLProviderRequest

  • DeleteSAMLProviderRequest object

DeleteSSHPublicKeyRequest

DeleteServerCertificateRequest

DeleteServiceLinkedRoleRequest

  • DeleteServiceLinkedRoleRequest object

DeleteServiceLinkedRoleResponse

DeleteServiceSpecificCredentialRequest

DeleteSigningCertificateRequest

DeleteUserPolicyRequest

DeleteUserRequest

DeleteVirtualMFADeviceRequest

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.

DeletionTaskIdType

  • DeletionTaskIdType string

DeletionTaskStatusType

  • DeletionTaskStatusType string (values: SUCCEEDED, IN_PROGRESS, FAILED, NOT_STARTED)

DetachGroupPolicyRequest

DetachRolePolicyRequest

DetachUserPolicyRequest

DuplicateCertificateException

  • DuplicateCertificateException object: The request was rejected because the same certificate is associated with an IAM user in the account.

DuplicateSSHPublicKeyException

  • DuplicateSSHPublicKeyException object: The request was rejected because the SSH public key is already associated with the specified IAM user.

EnableMFADeviceRequest

EntityAlreadyExistsException

  • EntityAlreadyExistsException object: The request was rejected because it attempted to create a resource that already exists.

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

EvalDecisionSourceType

  • EvalDecisionSourceType string

EvaluationResult

EvaluationResultsListType

GenerateCredentialReportResponse

GetAccessKeyLastUsedRequest

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.

GetAccountAuthorizationDetailsRequest

GetAccountAuthorizationDetailsResponse

GetAccountPasswordPolicyResponse

  • GetAccountPasswordPolicyResponse object: Contains the response to a successful GetAccountPasswordPolicy request.

GetAccountSummaryResponse

  • GetAccountSummaryResponse object: Contains the response to a successful GetAccountSummary request.

GetContextKeysForCustomPolicyRequest

GetContextKeysForPolicyResponse

  • GetContextKeysForPolicyResponse object: Contains the response to a successful GetContextKeysForPrincipalPolicy or GetContextKeysForCustomPolicy request.

GetContextKeysForPrincipalPolicyRequest

GetCredentialReportResponse

GetGroupPolicyRequest

GetGroupPolicyResponse

GetGroupRequest

GetGroupResponse

GetInstanceProfileRequest

GetInstanceProfileResponse

  • GetInstanceProfileResponse object: Contains the response to a successful GetInstanceProfile request.

GetLoginProfileRequest

  • GetLoginProfileRequest object

GetLoginProfileResponse

  • GetLoginProfileResponse object: Contains the response to a successful GetLoginProfile request.

GetOpenIDConnectProviderRequest

  • GetOpenIDConnectProviderRequest object
    • OpenIDConnectProviderArn required arnType

GetOpenIDConnectProviderResponse

GetPolicyRequest

  • GetPolicyRequest object

GetPolicyResponse

  • GetPolicyResponse object: Contains the response to a successful GetPolicy request.

GetPolicyVersionRequest

GetPolicyVersionResponse

  • GetPolicyVersionResponse object: Contains the response to a successful GetPolicyVersion request.

GetRolePolicyRequest

GetRolePolicyResponse

GetRoleRequest

GetRoleResponse

  • GetRoleResponse object: Contains the response to a successful GetRole request.
    • Role required Role

GetSAMLProviderRequest

  • GetSAMLProviderRequest object

GetSAMLProviderResponse

GetSSHPublicKeyRequest

GetSSHPublicKeyResponse

  • GetSSHPublicKeyResponse object: Contains the response to a successful GetSSHPublicKey request.

GetServerCertificateRequest

GetServerCertificateResponse

  • GetServerCertificateResponse object: Contains the response to a successful GetServerCertificate request.

GetServiceLinkedRoleDeletionStatusRequest

  • GetServiceLinkedRoleDeletionStatusRequest object

GetServiceLinkedRoleDeletionStatusResponse

GetUserPolicyRequest

GetUserPolicyResponse

GetUserRequest

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

GroupDetail

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

InvalidAuthenticationCodeException

  • InvalidAuthenticationCodeException object: The request was rejected because the authentication code was not recognized. The error message describes the specific error.

InvalidCertificateException

  • InvalidCertificateException object: The request was rejected because the certificate is invalid.

InvalidInputException

  • InvalidInputException object: The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

InvalidPublicKeyException

  • InvalidPublicKeyException object: The request was rejected because the public key is malformed or otherwise invalid.

InvalidUserTypeException

  • InvalidUserTypeException object: The request was rejected because the type of user for the transaction was incorrect.

KeyPairMismatchException

  • KeyPairMismatchException object: The request was rejected because the public key certificate and the private key do not match.

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.

LineNumber

  • LineNumber integer

ListAccessKeysRequest

ListAccessKeysResponse

ListAccountAliasesRequest

ListAccountAliasesResponse

ListAttachedGroupPoliciesRequest

ListAttachedGroupPoliciesResponse

ListAttachedRolePoliciesRequest

ListAttachedRolePoliciesResponse

ListAttachedUserPoliciesRequest

ListAttachedUserPoliciesResponse

ListEntitiesForPolicyRequest

ListEntitiesForPolicyResponse

ListGroupPoliciesRequest

ListGroupPoliciesResponse

ListGroupsForUserRequest

ListGroupsForUserResponse

  • ListGroupsForUserResponse object: Contains the response to a successful ListGroupsForUser request.

ListGroupsRequest

ListGroupsResponse

ListInstanceProfilesForRoleRequest

ListInstanceProfilesForRoleResponse

ListInstanceProfilesRequest

ListInstanceProfilesResponse

ListMFADevicesRequest

ListMFADevicesResponse

ListOpenIDConnectProvidersRequest

  • ListOpenIDConnectProvidersRequest object

ListOpenIDConnectProvidersResponse

  • ListOpenIDConnectProvidersResponse object: Contains the response to a successful ListOpenIDConnectProviders request.

ListPoliciesRequest

ListPoliciesResponse

ListPolicyVersionsRequest

ListPolicyVersionsResponse

ListRolePoliciesRequest

ListRolePoliciesResponse

ListRolesRequest

ListRolesResponse

ListSAMLProvidersRequest

  • ListSAMLProvidersRequest object

ListSAMLProvidersResponse

  • ListSAMLProvidersResponse object: Contains the response to a successful ListSAMLProviders request.

ListSSHPublicKeysRequest

ListSSHPublicKeysResponse

ListServerCertificatesRequest

ListServerCertificatesResponse

ListServiceSpecificCredentialsRequest

ListServiceSpecificCredentialsResponse

ListSigningCertificatesRequest

ListSigningCertificatesResponse

ListUserPoliciesRequest

ListUserPoliciesResponse

ListUsersRequest

ListUsersResponse

ListVirtualMFADevicesRequest

ListVirtualMFADevicesResponse

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.

MFADevice

  • MFADevice object:

    Contains information about an MFA device.

    This data type is used as a response element in the ListMFADevices action.

MalformedCertificateException

  • MalformedCertificateException object: The request was rejected because the certificate was malformed or expired. The error message describes the specific error.

MalformedPolicyDocumentException

  • MalformedPolicyDocumentException object: The request was rejected because the policy document was malformed. The error message describes the specific error.

ManagedPolicyDetail

ManagedPolicyDetailListType

NoSuchEntityException

  • NoSuchEntityException object: The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

OpenIDConnectProviderListEntry

  • OpenIDConnectProviderListEntry object: Contains the Amazon Resource Name (ARN) for an IAM OpenID Connect provider.

OpenIDConnectProviderListType

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.

PasswordPolicy

PasswordPolicyViolationException

  • PasswordPolicyViolationException object: The request was rejected because the provided password did not meet the requirements imposed by the account password policy.

Policy

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.

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.

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.

PolicyGroupListType

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.

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.

PolicyRoleListType

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.

PolicyUserListType

PolicyVersion

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.

PutGroupPolicyRequest

PutRolePolicyRequest

PutUserPolicyRequest

ReasonType

  • ReasonType string

RegionNameType

  • RegionNameType string

RemoveClientIDFromOpenIDConnectProviderRequest

  • RemoveClientIDFromOpenIDConnectProviderRequest object

RemoveRoleFromInstanceProfileRequest

RemoveUserFromGroupRequest

ReportContentType

  • ReportContentType string

ReportFormatType

  • ReportFormatType string (values: text/csv)

ReportStateDescriptionType

  • ReportStateDescriptionType string

ReportStateType

  • ReportStateType string (values: STARTED, INPROGRESS, COMPLETE)

ResetServiceSpecificCredentialRequest

ResetServiceSpecificCredentialResponse

ResourceHandlingOptionType

  • ResourceHandlingOptionType string

ResourceNameListType

ResourceNameType

  • ResourceNameType string

ResourceSpecificResult

ResourceSpecificResultListType

ResyncMFADeviceRequest

Role

RoleDetail

RoleUsageListType

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.

SAMLMetadataDocumentType

  • SAMLMetadataDocumentType string

SAMLProviderListEntry

  • SAMLProviderListEntry object: Contains the list of SAML providers for this account.

SAMLProviderListType

SAMLProviderNameType

  • SAMLProviderNameType string

SSHPublicKey

SSHPublicKeyListType

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.

ServerCertificate

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.

ServiceNotSupportedException

  • ServiceNotSupportedException object: The specified service does not support service-specific credentials.

ServiceSpecificCredential

ServiceSpecificCredentialMetadata

ServiceSpecificCredentialsListType

SetDefaultPolicyVersionRequest

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.

SimulateCustomPolicyRequest

SimulatePolicyResponse

SimulatePrincipalPolicyRequest

SimulationPolicyListType

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 the EvaluationResult type.

StatementListType

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.

UnrecognizedPublicKeyEncodingException

  • UnrecognizedPublicKeyEncodingException object: The request was rejected because the public key encoding format is unsupported or unrecognized.

UpdateAccessKeyRequest

UpdateAccountPasswordPolicyRequest

UpdateAssumeRolePolicyRequest

UpdateGroupRequest

UpdateLoginProfileRequest

UpdateOpenIDConnectProviderThumbprintRequest

  • UpdateOpenIDConnectProviderThumbprintRequest object

UpdateRoleDescriptionRequest

UpdateRoleDescriptionResponse

  • UpdateRoleDescriptionResponse object

UpdateSAMLProviderRequest

UpdateSAMLProviderResponse

  • UpdateSAMLProviderResponse object: Contains the response to a successful UpdateSAMLProvider request.

UpdateSSHPublicKeyRequest

UpdateServerCertificateRequest

UpdateServiceSpecificCredentialRequest

UpdateSigningCertificateRequest

UpdateUserRequest

UploadSSHPublicKeyRequest

UploadSSHPublicKeyResponse

  • UploadSSHPublicKeyResponse object: Contains the response to a successful UploadSSHPublicKey request.

UploadServerCertificateRequest

UploadServerCertificateResponse

  • UploadServerCertificateResponse object: Contains the response to a successful UploadServerCertificate request.

UploadSigningCertificateRequest

UploadSigningCertificateResponse

  • UploadSigningCertificateResponse object: Contains the response to a successful UploadSigningCertificate request.

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

VirtualMFADevice

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.

accessKeySecretType

  • accessKeySecretType string

accountAliasListType

accountAliasType

  • accountAliasType string

arnType

assignmentStatusType

  • assignmentStatusType string (values: Assigned, Unassigned, Any)

attachedPoliciesListType

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.

clientIDListType

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

entityTemporarilyUnmodifiableMessage

  • entityTemporarilyUnmodifiableMessage string

existingUserNameType

  • existingUserNameType string

groupDetailListType

groupListType

  • groupListType array:

    Contains a list of IAM groups.

    This data type is used as a response element in the ListGroups action.

groupNameListType

groupNameType

  • groupNameType string

idType

  • idType string

instanceProfileListType

  • instanceProfileListType array: Contains a list of instance profiles.

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.

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

policyDocumentType

  • policyDocumentType string

policyDocumentVersionListType

policyEvaluationErrorMessage

  • policyEvaluationErrorMessage string

policyListType

  • policyListType array

policyNameListType

  • policyNameListType array:

    Contains a list of policy names.

    This data type is used as a response element in the ListPolicies action.

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

roleListType

  • roleListType array:

    Contains a list of IAM roles.

    This data type is used as a response element in the ListRoles action.

roleNameType

  • roleNameType string

serialNumberType

  • serialNumberType string

serverCertificateMetadataListType

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

summaryValueType

  • summaryValueType integer

thumbprintListType

  • thumbprintListType array: Contains a list of thumbprints of identity provider server certificates.

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

userListType

  • userListType array:

    Contains a list of users.

    This data type is used as a response element in the GetGroup and ListUsers actions.

userNameType

  • userNameType string

virtualMFADeviceListType

virtualMFADeviceName

  • virtualMFADeviceName string

Readme

Keywords

none

Package Sidebar

Install

npm i @datafire/amazonaws_iam

Weekly Downloads

1

Version

5.0.0

License

MIT

Unpacked Size

755 kB

Total Files

5

Last publish

Collaborators

  • datafire