Initializing help system before first use

Main functions of the AEC2 package

AEC2_PENDING = 0
Instance state: starting
AEC2_RUNNING = 16
Instance state: running
AEC2_SHUTTING_DOWN = 32
Instance state: shutting down
AEC2_STOPPED = 80
Instance state: stopped
AEC2_STOPPING = 64
Instance state: stopping
AEC2_TERMINATED = 48
Instance state: terminated
AwsID : record
Credentials for AWS access
Note
It is populated from an aid file that can be generated with savePrivateKey and read with loadPrivateKey.
EC2Conf : record
Conplete configuration for AEC2
endpoint : text
AWS EndPoint where to send queries
aidfile : string
File containing AWS credentials
aid : AwsID
AWS credentials
askfile : string
File containing SSH key information
sshid : SshID
SSH key information
image : string
Id of the image to start
type : string
Type of instance to run ( e.g. "t2.mivro")
secgrp : string
Id of the security group for the instance
connmode : string
Default connection model ( "ssh" or "xprmsrv")
xsrvctx : string
xprmsrv context for connection
xsrvpass : text
Password for xprmsrv connection
xsrvport : integer
Port to use for xprmsrv connection
Note
It is populated from an acf file that can be loaded with loadAEC2Config. Run the program aec2setup to create this file.
EC2image : record
An EC2 image
id : string
Id of the image
name : text
Name of the image
description : text
Description
location : text
Location
snapshot : text
Id of the disk snapshot used for this image
available : boolean
Availability status
ispublic : boolean
Report whether the image is public
architecture : string
Architecture ( e.g. "x86_64")
owner : string
Owner of this image
ownerid : string
Id of the owner
EC2instance : record
An EC2 instance
image : string
Id of the image used to start this instance
state : integer
Current state (see AEC2_* constants)
dns : text
Dns name of the instance
key : text
Id of the SSH key to use for SSH connection
type : string
Type of the instance( e.g. "t2.mivro")
launchtime : datetime
Launch time
ipaddr : text
IP address of the instance
EC2secrule : record
An EC2 security rule
protocol : text
Protocol ( e.g. "tcp")
ports : range
Ports range ( e.g. 2513..2515)
sources : list of text
Address list ( e.g. ["0.0.0.0/0"])
SshID : record
SSH key information to connect to the remote instance
Note
It is populated from an ask file that can be generated with createSSHKeyFile and read with selectSSHKeyFile.
EC2statetext : dynamic array(set of integer) of string
Text representation of instance states
aec2_msg : text
Message associated to the last http query fo AWS
aec2_status : integer
http status of the last AWS query
aec2_verbose : boolean
Enable/disable logging of the package
addSecurityIngress
Add a rule to a security group
createImage
Create a new image from a running instance
createKeyPair
Generate a new SSH secret key-pair
createSSHKeyFile
Generate then store a SSH key information in a key-file
createSecurityGroup
Create a new security group
delSecurityIngress
Delete a rule to a security group
deleteKeyPair
Delete a SSH secret key-pair
deleteSecurityGroup
Delete a security group
deregisterImage
Deregister (or delete) an image
describeKeyPair
Get the fingerprint of an existing SSH key-pair
describeSecurityGroup
Get the description of a security group
getAllInstances
Retrieve a list of Instances from AWS.
getAllSecurityGroups
Get the names of all security groups
getConnString
Generate a connection string.
getConnStringSSH
Generate a connection string for an SSH link.
getConnStringXSRV
Generate a connection string for an xprmsrv server.
getEndPoints
Retrieve all endpoint addresses
getId
Get the Id of an instance
getImages
Retrieve a list of AMI from AWS.
getInstances
Get and/or start from atl to atm instances
getKeyFile
Get the current key-file (for ssh connections)
getLaunchPermission
Retrieve launch permission of an image
importKeyPair
Upload to AWS the public part of a local key-pair
isValidPrivateKey
Test whether the provided AWS credentials are valid
loadAEC2Config
Load a configuration file and initialise the package.
loadPrivateKey
Initialise an AWS credentials from an aid-file
newParameter
Generate a parameter for a query
registerImage
Register a new image from an S3 bucket
runInstance
Start a new instance in EC2.
saveAEC2Config
Save the provided configuration into a file
savePrivateKey
Save the provided AWS credentials into an aid-file
selectSSHKeyFile
Select the key to use from a key-file
sendQuery
Generate then send a query to the specified endpoint
setLaunchPermission
Add/remove launch permission of an image to a user
setPrivateKey
Initialise an AWS credentials
storeSSHKeyFile
Store the SSH key information in a "key file"
terminateInstance
Terminate the specified instance.
updateInstance
Update instance information.
waitInstanceReady
Wait for an instance to be ready.

Covered Topics
Parent Topic Amazon EC2 Module

© 2001-2025 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.