API Conventions
Overview
This topic discusses the conventions used in the Amazon EC2 SOAP API reference. This includes
terminology, notation and any abbreviations used to illuminate the API.
The API reference is broken down into a collection of Operations and Data Types.
Operations
Operations encapsulate the possible interactions with Amazon EC2. These can be viewed as remote
procedure calls and consist of a request and response message pair. Requests must be signed, allowing
Amazon EC2 to authenticate the caller. For clarity, the sample requests and responses illustrating each
of the operations described in this reference are not signed.
Data Types and the Amazon EC2 WSDL
The current version of the Amazon EC2 WSDL is available at the following location:
http://ec2.amazonaws.com/doc/2006-06-26/AmazonEC2.wsdl. Some libraries can generate code directly
from the WSDL. Other libraries require a little more work on your part.
Values provided as parameters to the various operations must be of the indicated type. Standard XSD
types (like string, boolean, int) are prefixed with xsd:. Complex types defined by the
Amazon EC2 WSDL are prefixed with ec2:.
Parameters that consist of lists of information are defined within our WSDL to require <info> tags
around each member. Throughout the API, type references for parameters that accept such a list of
values are specified using the notation type[] The type referred to in these instances is the type nested
within the <info> tag (for Amazon EC2 types this is defined in the WSDL).
For example, the <imagesSet> element in the following XML snippet is of type xsd:string[]:
<imagesSet>
<item>
<imageId>ami-61a54008</imageId>
</item>
<item>
<imageId>ami-61b54608</imageId>
</item>
</imagesSet>
And the <instancesSet> element in the following XML snippet is of type
ec2:RunInstanceItemType[]:
<instancesSet>
<item>
<imageId>ami-60a54009</imageId>
<minCount>10</minCount>
<maxCount>30</maxCount>
</item>
<item>
<imageId>ami-60b54209</imageId>
<minCount>5</minCount>
<maxCount>20</maxCount>
</item>
</instancesSet>
Amazon EC2
Developer Guide
53
API Error Codes
Summary of Error Codes
SOAP
Fault-
Code/
Error-
Code
Definition Notes
Cli-
ent.Auth
Failure
User not authorized. Common cause is trying to run an AMI for which
you do not have permission.
Cli-
ent.Inva
lidMani-
fest
Specified AMI has an unparsable
Manifest.
Cli-
ent.Inva
lidAMIID
Specified AMI ID is not valid. If this error contains "Malformed" it further im-
plies your id is not of the valid format.
Cli-
ent.Inva
lidIn-
stanceID
Specified instance ID is not valid. If this error contains "Malformed" it further im-
plies your id is not of the valid format.
Cli-
ent.Inva
lid-
Group-
Name
Specified group name is invalid.
Cli-
ent.Inva
lidRe-
serva-
tionID
Specified reservation ID is invalid. If this error contains "Malformed" it further im-
plies your id is not of the valid format.
Cli-
ent.Inva
lid-
Group.Du
plicate
Attempt to create a duplicate group.
Cli-
ent.Inst
anceLim-
itEx-
ceeded
User has max allowed concurrent
running instances.
Each user has a concurrent running instance limit.
For new users during public beta, this limit is 20.
Cli-
ent.Inva
lid-
Group.In
Use
Specific group can not be deleted be-
cause it is in use.
Amazon EC2
Developer Guide
54
Previous Page Next Page