Module Data Types

Instances

A very common input parameter actions require is the instance. That instance, refers to the object used in the automation.

For example, all Excel actions are performed on an excel file which is bound to an instance.

The initial action launching the excel file has the instance as it’s output parameter. This is then used by the consequent actions.

Module Data Type
Active Directory Active Directory Entry
AWS EC2 Client
Azure Azure Client
Capturefast Capturefast Connection
CMD CMD Session
Database SQL Connection
Email Email Instance
Excel Excel Instance
Exchange Exchange Connection
FTP FTP Connection
OCR OCR Engine
Outlook Outlook Instance
Terminal Emulation Terminal Session
UI Automation Window Instance
Web Automation Web Browser Instance

Enums

Enums are DataTypes that have a specific range of possible values. For example the “Email.Retrieve” action, requires the user to set if the retrieved emails should be from the Read, Unread or All e-mails.

For these cases that the options are limited, enums are used.

The syntax of an Enum, is similar to the other input parameters.

The Input Parameter, followed by a colon (:) the name of the Enum a dot (.) and then the value.

In the “Retrieve Email” example mentioned above the enum would look like this.

MailsToRetrieve:RetrieveMessagesMode.All

AWS

EC2

EC2 Instance (Virtual Machine) Info

Gives basic information on an EC2 Instance

EC2 Instance Info Properties
Name Type Description
AvailabilityZone Text The Availability Zone of the instance
InstanceID Text The ID of the instance.
InstanceState Enum The current state of the instance
InstanceType Text The instance type
Ipv6s List of Text Values The Ipv6Addresses of the instance
KeyName Text The name of the key pair, if this instance was launched with an associated key pair
Name Text The name of the Instance as defined in the Tags
PublicDns Text The public DNS name assigned to the instance. This name is not available until the instance enters the running state. For EC2-VPC
PublicIpv4 Text The public IPv4 address assigned to the instance, if applicable
PrivateIpv4 Text The private IPv4 address assigned to the instance
StatusChecks Text Checks of the health of the instance that detect problems that require involvement to repair

EC2 Instance (Virtual Machine)

Describes an Amazon EC2 Instance

EC2 Instance Properties
Name Type Description
AmiLaunchIndex Numeric The AMI launch index, which can be used to find this instance in the launch group.
Architecture ArchitectureValues The architecture of the image.
BlockDeviceMappings List of InstanceBlockDeviceMappings Any block device mapping entries for the instance.
CapacityReservationId Text The ID of the Capacity Reservation.
CapacityReservationSpecification CapacityReservationSpecificationResponse Information about the Capacity Reservation targeting option.
ClientToken Text The idempotency token you provided when you launched the instance, if applicable.
CpuOptions CpuOptions The CPU options for the instance.
EbsOptimized Boolean Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn’t available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
ElasticGpuAssociations List of ElasticGpuAssociations The Elastic GPU associated with the instance.
ElasticInferenceAcceleratorAssociations List of ElasticInferenceAcceleratorAssociations The elastic inference accelerator associated with the instance.
EnaSupport Boolean Specifies whether enhanced networking with ENA is enabled.
HibernationOptions HibernationOptions Indicates whether the instance is enabled for hibernation.
Hypervisor HypervisorType The hypervisor type of the instance.
IamInstanceProfile IamInstanceProfile The IAM instance profile associated with the instance, if applicable.
ImageId Text The ID of the AMI used to launch the instance.
InstanceId Text The ID of the instance.
InstanceLifecycle InstanceLifecycleType Indicates whether this is a Spot Instance or a Scheduled Instance.
InstanceType InstanceType The instance type.
KernelId Text The kernel associated with this instance, if applicable.
KeyName Text The name of the key pair, if this instance was launched with an associated key pair.
LaunchTime DateTime The time the instance was launched.
Licenses List of LicenseConfigurations The license configurations.
MetadataOptions InstanceMetadataOptionsResponse The metadata options for the instance.
Monitoring Monitoring The monitoring for the instance.
NetworkInterfaces List of InstanceNetworkInterfaces [EC2-VPC] The network interfaces for the instance.
OutpostArn Text The Amazon Resource Name (ARN) of the Outpost.
Placement Placement The location where the instance launched, if applicable.
Platform PlatformValues The value is Windows for Windows instances; otherwise blank.
PrivateDnsName Text (IPv4 only) The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state.
PrivateIpAddress Text The private IPv4 address assigned to the instance.
ProductCodes List of ProductCodes The product codes attached to this instance, if applicable.
PublicDnsName Text (IPv4 only) The public DNS name assigned to the instance. This name is not available until the instance enters the running state. For EC2-VPC, this name is only available if you’ve enabled DNS hostnames for your VPC.
PublicIpAddress Text The public IPv4 address assigned to the instance, if applicable.
RamdiskId Text The RAM disk associated with this instance, if applicable.
RootDeviceName Text The device name of the root device volume (for example, /dev/sda1).
RootDeviceType DeviceType The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.
SecurityGroups List of GroupIdentifiers The security groups for the instance.
SourceDestCheck Boolean Specifies whether to enable an instance launched in a VPC to perform NAT. This controls whether source/destination checking is enabled on the instance. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.
SpotInstanceRequestId Text If the request is a Spot Instance request, the ID of the request.
SriovNetSupport Text Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
State InstanceState The current state of the instance.
StateReason StateReason The reason for the most recent state transition.
StateTransitionReason Text The reason for the most recent state transition. This might be an empty string.
SubnetId Text [EC2-VPC] The ID of the subnet in which the instance is running.
Tags List of Tags Any tags assigned to the instance.
VirtualizationType VirtualizationType The virtualization type of the instance.
VpcId Text [EC2-VPC] The ID of the VPC in which the instance is running.

EC2 Instance (Virtual Machine) State Change

Describes an instance state change

EC2 Instance State Change Properties
Name Type Description
CurrentState InstanceState The current state of the instance.
InstanceId Text The ID of the instance.
PreviousState InstanceState The previous state of the instance.

EBS Volume

Describes an EBS Volume

EBS Volume Properties
Name Type Description
Iops Numeric The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS SSD volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose SSD volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
KmsKeyId Text The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.
OutpostArn Text The Amazon Resource Name (ARN) of the Outpost.
Size Numeric The size of the volume, in GiBs.
SnapshotId Text The snapshot from which the volume was created, if applicable.
State VolumeState The volume state.
Tags List of Tags Any tags assigned to the volume.
VolumeId Text The ID of the volume.
VolumeType VolumeType The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

EBS Snapshot

Describes an EBS snapshot

EBS Snapshot Properties
Name Type Description
DataEncryptionKeyId Text The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots.
Description Text The description for the snapshot.
Encrypted Boolean Indicates whether the snapshot is encrypted.
KmsKeyId Text The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.
OwnerAlias Text Value from an Amazon-maintained list (amazon
OwnerId Text The AWS account ID of the EBS snapshot owner.
Progress Text The progress of the snapshot, as a percentage.
SnapshotId Text The ID of the snapshot. Each snapshot receives a unique identifier when it is created.
StartTime DateTime The time stamp when the snapshot was initiated.
State SnapshotState The snapshot state.
StateMessage Text Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by DescribeSnapshots.
Tags List of Tags Any tags assigned to the snapshot.
VolumeId Text The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.
VolumeSize Numeric The size of the volume, in GiB.

Active Directory

Group Info

Contains the data of the retrieved Active Directory Group Entry.

Group Info Properties
Name Type Description
Description Text The description of the group
DisplayName Text The display name of the group
Members GroupMember The members of the group
Name Text The name of the group

Group Member

Contains the data of the retrieved Active Directory Group Member.

Group Member Properties
Name Type Description
Guid Text The Guid of the group member
Name Text The name of the group member
ObjectClass Text The object class of the group member
DistinguishedName Text The distinguished name of the group member
Path Text The path of the group member
Schema Text The schema of the group member

User Info

Contains the data of the retrieved Active Directory User Entry.

User Info Properties
Name Type Description
City Text The city of the user
Company Text The company of the user
Country Text The country of the user
DistinguishedName Text The distinguished name of the user
Email Text The email of the user
Extention Text The extention of the user
FirstName Text The first name of the user
Initials Text The initials of the user
LastName Text The last name of the user
PostalCode Text The postal code of the user
State Text The state of the user
TelephoneNumber Text The telephone number of the user
Title Text The title of the user

Azure

Azure Subscription

Describes an Azure Subscription

Azure Subscription Properties
Name Type Description
Id Text The UUID of the Subscription
Name Text The name of the Subscription
Status Text The status of the Subscription

Azure Resource Group

A container that holds related resources for an Azure solution so that the user can manage them as a group

Azure Resource Group Properties
Name Type Description
Id Text The id of the Resource Group
Name Text The name of the Resource Group
Location Text The region of the Resource Group
ProvisioningState Text The provisioning state of the Resource Group
Tags List of Text Values The tags of the Resource Group

Azure VirtualMachine Info

Gives most important information on an Azure Virtual Machine

Azure VirtualMachine Info Properties
Name Type Description
Id Text The id of the Virtual Machine
Name Text The name of the Resource
Location Text The region of the Virtual Machine
SubscriptionId Text The subscription Id
Tags List of Text Values The tags of the Virtual Machine
ResourceGroup Text The Resource Group of the Virtual Machine
ComputerName Text The name of the Virtual Machine
OperatingSystem Text The operating system of the Virtual Machine
PrivateIPAddress Text The private IP Address associated with the Virtual Machine
PublicIPAddress Text The public IP Address associated with the Virtual Machine
Size Text The size of the Virtual Machine
Status Text The status of the Virtual Machine

Azure Virtual Machine

Describes an Azure Virtual Machine

Azure Virtual Machine Properties
Name Type Description
Id Text The id of the Virtual Machine
Name Text The name of the Resource
Location Text The region of the Virtual Machine
SubscriptionId Text The subscription Id
Tags List of Text Values The tags of the Virtual Machine
ResourceGroup Text The Resource Group of the Virtual Machine
ComputerName Text The name of the Virtual Machine
OperatingSystem Text The operating system of the Virtual Machine
PrivateIPAddress Text The private IP Address associated with the Virtual Machine
PublicIPAddress Text The public IP Address associated with the Virtual Machine
Size Text The size of the Virtual Machine
Status Text The status of the Virtual Machine
ProvisioningState Text The provisioning state of the Virtual Machine
BootDiagnosticsStorageUri Text The storage blob endpoint uri if boot diagnostics is enabled for the Virtual Machine
IsBootDiagnosticsEnabled Boolean Specifies whether boot diagnostics is enabled for the Virtual Machine
IsManagedDiskEnabled Boolean Specifies whether managed disks are used for the Virtual Machine’s disks (OS, data)
AvailabilityZones Text The availability zones assigned to the Virtual Machine comma separated
LicenseType Text The licence type
Plan Text The plan of the Virtual Machine
VMGeneration Text The HyperVGenerationType associated with the Virtual Machine
IsUltraSSDEnabled Boolean The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the Virtual Machine
AvailabilitySetId Text The resource ID of the availability set associated with this Virtual Machine
IsManagedServiceIdentityEnabled Boolean Specifies whether Managed Service Identity is enabled for the Virtual Machine
SystemAssignedManagedServiceIdentityPrincipalId Text Gets the System Assigned (Local) Managed Service Identity specific Active Directory service principal ID assigned to the Virtual Machine
SystemAssignedManagedServiceIdentityTenantId Text Gets the System Assigned (Local) Managed Service Identity specific Active Directory tenant ID assigned to the Virtual Machine
ManagedServiceIdentityType Text The type of Managed Service Identity used for the Virtual Machine
OSManagedDisk AzureManagedVmDisk The managed disk backing the operating system disk
OSUnManagedDisk AzureUnManagedVmDisk The VHD file backing the Virtual Machine’s operating system disk
ManagedDataDisks List of AzureManagedVmDisks The managed data disks associated with the Virtual Machine, indexed by LUN number
UnManagedDataDisks List of AzureUnManagedVmDisks The unmanaged data disks associated with the Virtual Machine, indexed by LUN number

Azure Managed Disk

Describes an Azure Managed Disk

Azure Managed Disk Properties
Name Type Description
Id Text The id of the Managed Disk
Name Text The name of the Managed Disk
Location Text The region of the Managed Disk
SubscriptionId Text The subscription Id
Tags List of Text Values The tags of the Managed Disk
ResourceGroup Text The Resource Group of the Managed Disk
AvailabilityZones Text The availability zones assigned to the Managed Disk comma separated
Encrypted Boolean Specifies whether encryption is enabled
IopsSLimit Numeric The number of IOPS allowed for this disk, only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes
IsAttachedToVirtualMachine Boolean Specifies whether the Managed Disk is attached to a virtual machine
SizeInGB Numeric The disk size in GB
OperationSystem Text The type of the operating system on the Managed Disk
VirtualMachine Text The name of the Virtual Machine the Managed Disk is attached to
TimeCreated Text The time when the Managed Disk was created
State Text The state of the Managed Disk
ThroughputLimit Numeric The bandwidth allowed for this Managed Disk, only settable for UltraSSD disks
Type Text The disk SKU

Azure Managed Disk attached to VM

Describes an Azure Managed Disk attached to a Virtual Machine

Azure Managed Disk attached to VM Properties
Name Type Description
Id Text The id of the Managed Disk
Name Text The name of the Managed Disk
Location Text The region of the Managed Disk
SubscriptionId Text The subscription Id
Tags List of Text Values The tags of the Managed Disk
ResourceGroup Text The Resource Group of the Managed Disk
AvailabilityZones Text The availability zones assigned to the Managed Disk comma separated
Encrypted Boolean Specifies whether encryption is enabled
IopsSLimit Numeric The number of IOPS allowed for this disk, only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes
IsAttachedToVirtualMachine Boolean Specifies whether the Managed Disk is attached to a virtual machine
SizeInGB Numeric The disk size in GB
OperationSystem Text The type of the operating system on the Managed Disk
VirtualMachine Text The name of the Virtual Machine the Managed Disk is attached to
TimeCreated Text The time when the Managed Disk was created
State Text The state of the Managed Disk
ThroughputLimit Numeric The bandwidth allowed for this Managed Disk, only settable for UltraSSD disks
Type Text The Managed Disk’s SKU
Caching Text The Managed Disk caching type
Lun Numeric The logical unit number (LUN) of the Managed Disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to a Virtual Machine

Azure UnManaged Disk attached to VM

Describes an Azure UnManaged Disk attached to a Virtual Machine

Azure UnManaged Disk attached to VM Properties
Name Type Description
Name Text The name of the UnManaged Disk
SizeInGB Numeric The disk size in GB
VhdUri Text The URI to the virtual hard disk backing this data disk
Caching Text The UnManaged Disk caching type
Lun Numeric The logical unit number (LUN) assigned to the UnManaged Disk

Azure Snapshot

Describes an Azure Snapshot

Azure Snapshot Properties
Name Type Description
Id Text The id of the Snapshot
Name Text The name of the Snapshot
Location Text The region of the Snapshot
SubscriptionId Text The subscription Id
Tags List of Text Values The tags of the Snapshot
ResourceGroup Text The Resource Group of the Snapshot
CreationSourceId Text The id of the source from which Snapshot is created
CreationSourceType Text The type of the source from which Snapshot is created
OperationSystem Text The operating system in the Snapshot
SizeInGB Numeric The disk size in GB
StorageAccountType Text The SKU type of the Snapshot (PremiumLRS or StandardLRS)
TimeCreated Text The time the Snapshot was created

Email

Email Message

Describes an Email Message

Email Message Properties
Name Type Description
Uid Text The Unique ID of the Email Message
MailFolder Text The MailFolder in which the Email Message is contained
From Text The sender of the Email Message
To List of Text Values A list of the Email Message recipients
CC List of Text Values A list of users who are Carbon Copied to the Email Message
Date DateTime Value The Date and Time the Email Message was sent
Subject Text The subject of the Email Message
Body Text The HTML body of the Email Message
BodyText Text The body text of the Email Message
Attachments List of Files A list of the paths where the attachments are saved

Exchange

Exchange Email Message

Describes an Exchange Email Message

Exchange Email Message Properties
Name Type Description
ItemID Text The Item ID of the Exchange Email Message
MailFolder Text The MailFolder in which the Exchange Email Message is contained
From Text The sender of the Exchange Email Message
To List of Text Values A list of the Exchange Email Message recipients
CC List of Text Values A list of users who are Carbon Copied to the Exchange Email Message
Date DateTime Value The Date and Time the Exchange Email Message was sent
Subject Text The subject of the Exchange Email Message
Body Text The HTML body of the Exchange Email Message
BodyText Text The body text of the Exchange Email Message
Attachments List of Files A list of the paths where the attachments are saved

FTP

FTP File

Describes an FTP File

FTP File Properties
Name Type Description
FullName Text The FullName of the FTP File
Name Text The Name of the FTP File
NameWithoutExtension Text The Name of the FTP File without the extension
Extension Text The Extension of the FTP File
Directory Text The Directory that the FTP File belongs
Size Numeric Value The Size of the FTP File
LastModified DateTime Value The date when the FTP File was last modified

FTP Folder

Describes an FTP Folder

FTP Folder Properties
Name Type Description
FullName Text The FullName of the FTP Folder
Name Text The Name of the FTP Folder
Parent Text The Parent folder of the selected FTP Folder
LastModified DateTime Value The date when the FTP File was last modified

File

File Object

A file object is an object related to a file and its value is the path to the file. A file can be found using the GetFiles action which is included in the “Folders Module”.

Folder.GetFiles Folder:  FileFilter:'*'  Files=> Files
set foldervar to Files[0]

Any path stored in a text variable can be used in actions which require a filepath. There is no need to convert the filepath to a File Object prior to using the action.

File Object data type properties
Name Type Description
CreationTime DateTime The date when the file was created.
Directory Folder The directory where the file is stored.
Exists Boolean This property is true if the file exists or false if the file does not exist.
Extension Text The extension of the file.
FullName Text The full path to the file.
IsArchive Boolean This property is true if the file is an archive or false if it is not.
IsEmpty Boolean This property is true if the file is empty or false if it is not.
IsHidden Boolean This property is true if the file is hidden or false if the file is visible.
IsReadOnly Boolean This property is true if the file is read only or false if it is not.
IsSystem Boolean This property is true if the file is a system file or false if it is not.
LastAccessed DateTime The date when the file was last accessed.
LastModified DateTime The date when the file was last modified.
Name Text The name of the file, including the extension e.g. MyFile.txt.
NameWithoutExtension Text The name of the file, without its extension.
RootPath Folder The root path of the file (e.g. C:).
Size Numeric The size of the file (in bytes).

Folder

Folder Object

A folder object is an object related to a folder and it’s value is the path to the folder. A folder can be found using the GetSubFolders action which is included in the “Folders Module”.

Folder.GetSubfolders Folder: 'C:\Users'  FolderFilter:'*' IncludeSubfolders:False  Subfolders=> Subfolders
set foldervar to Subfolders[0]
Folder Object data type properties
Name Type Description
CreationTime DateTime The date when the folder was created.
Exists Boolean This property is true if the folder exists or false if the folder does not exist.
FilesCount Numeric The number of files included in this folder.
FoldersCount Numeric The number of folders included in this folder.
FullName Text The full path to the folder.
IsEmpty Boolean This property is true if the folder is empty or false if it is not.
IsHidden Boolean This property is true if the folder is hidden or false if the file is visible.
LastModified DateTime The date when the folder was last modified.
Name Text The name of the folder.
Parent Folder The parent directory of the folder.
RootPath Folder The root path of the folder (e.g. C:).

Outlook

Outlook Email Message

Describes an Outlook Email Message

Outlook Email Message Properties
Name Type Description
BCC List of Text Values A list of users who are Blindly Carbon Copied to the Outlook Email Message
EntryID Text The Entry ID of the Outlook Email Message
MailFolder Text The MailFolder in which the Outlook Email Message is contained
From Text The sender of the Outlook Email Message
To List of Text Values A list of the Outlook Email Message recipients
CC List of Text Values A list of users who are Carbon Copied to the Outlook Email Message
Date DateTime Value The Date and Time the Outlook Email Message was sent
Subject Text The subject of the Outlook Email Message
Body Text The HTML body of the Outlook Email Message
BodyText Text The body text of the Outlook Email Message
Attachments List of Files A list of the paths where the attachments are saved

XML

XML Node

A node of an XML document

XML Node Properties
Name Type Description
Name Text The Name of the XML Node
Value Text The Value of the XML Node
InnerText Text The InnerText of the XML Node
InnerXML Text The InnerXML of the XML Node
OuterXML Text The OuterXML of the XML Node
Parent XML Node The Parent XML Node
Children List of XML Nodes The Children of the current XML Node