Describe Instances

Operation name

Describe Instances

Function overview

Gets information about instances in Amazon EC2.

Properties

= Remarks =

For details on use of variables, refer to Variables.

Basic settings

Item name	Required/Optional	Use of variables	Description	Remarks
Name	Required	Not available	Enter a name that is used on the script canvas.

Required settings

Item name	Required/Optional	Use of variables	Description	Remarks
Destination	Required	Not available	Select a connection resource. Add A new connection resource can be added. Edit list Connection resource settings can be edited in > HULFT INTEGRATE > Connections.

Item name

Required/Optional

Use of variables

Description

Remarks

Destination

Required

Not available

Select a connection resource.

Add: A new connection resource can be added.
Edit list: Connection resource settings can be edited in > HULFT INTEGRATE > Connections.

Comment

Item name	Required/Optional	Use of variables	Description	Remarks
Comment	Optional	Not available	You can write a short description of this connector.

Schemas

Input schema

None.

Output schema

<?xml version="1.0"?>
<instances>
  <instance amiLaunchIndex="" architecture="" availabilityZone="" image="" instanceId="" instanceName="" instanceState=""
  instanceType="" kernelId="" keyPairName="" launchTime="" monitoringState="" ownerId="" privateDnsName="" privateIpAddress=""
  publicDnsName="" publicIpAddress="" ramDiskId="" reservationId="" rootDevice="" rootDeviceType="" spotInstanceRequestId=""
  stateTransitionReason="" subnetId="" tenancy="" virtualizationType="" vpcId="">
    <tags>
      <tag key="" value="" />
    </tags>
    <securityGroups>
      <securityGroup id="" name="" />
    </securityGroups>
  </instance>
</instances>

Element name	Attribute name	Description	Remarks
instances
instance		Appears once for each instance.
	amiLaunchIndex	Outputs the AMI Launch Index.
	architecture	Outputs the architecture of instance.
	availabilityZone	Outputs the availability zone (AZ) where the instance exists.
	image	Outputs the name of Amazon Machine Image (AMI).	When the name of Amazon Machine Image (AMI) can't be gotten, this will be empty.
	instanceId	Outputs the instance ID.
	instanceName	Outputs the Name tag value.
	instanceState	Outputs the instance state. running The instance is running. pending The instance is starting up. stopping The instance is stopping. stopped The instance is stopped. shutting-down The instance is shutting down. terminated The instance is terminated.
	instanceType	Outputs the instance type. t1.micro Micro on demand instance/micro. m1.small Standard on demand instance/small. m1.large Standard on demand instance/large. m1.xlarge Standard on demand instance/extra large. m2.xlarge High memory on demand instance/extra large. m2.2xlarge High memory on demand instance/double extra large. m2.4xlarge High memory on demand instance/quadruple extra large. c1.medium High CPU on demand instance/medium. c1.xlarge High CPU on demand instance/extra large. cc1.4xlarge Cluster compute instance/quadruple extra large. cg1.4xlarge Cluster GPU instance/quadruple extra large.
	kernelId	Outputs the Kernel ID.
	keyPairName	Outputs the key pair name that is necessary during instance login.
	launchTime	Outputs the time when the instance was launched last.	The time is output in accordance with the date format set in HULFT Square. For more details on date format, refer to Data types.
	monitoringState	Outputs the monitoring state of the instance. enabled Monitoring of instance is enabled. disabled Monitoring of instance is disabled. pending Monitoring of instance is pending.
	ownerId	Outputs the owner ID of the Amazon Machine Image (AMI).
	privateDnsName	Outputs the private DNS name of the instance.
	privateIpAddress	Outputs the private IP address of the instance.
	publicDnsName	Outputs the public DNS name of the instance.
	publicIpAddress	Outputs the public IP address of the instance.
	ramDiskId	Outputs the RAM Disk ID.
	reservationId	Outputs the Reservation ID.
	rootDevice	Outputs the root device name.
	rootDeviceType	Outputs the root device type. ebs The EBS type. instance-store The instance store type.
	spotInstanceRequestId	Outputs the spot instance request ID.
	stateTransitionReason	Outputs the State Transition Reason.
	subnetId	Outputs the Subnet ID.
	tenancy	Outputs the Tenancy.
	virtualizationType	Outputs the Virtualization Type.
	vpcId	Outputs the VPC ID.
Tags
tag		Outputs for each tag set in an instance.
	key	Outputs the tag key.
	value	Outputs the tag value.
securityGroups
securityGroup		Outputs for each security group set in an instance.
	id	Outputs the Group ID of the security group.
	name	Outputs the name of the security group.

Mass data processing

Mass data processing isn't supported.

Parallel Stream Processing

PSP isn't supported.

Available component variables

Component variable name	Description	Remarks
error_code	When an error (AmazonServiceException) occurs, the error code of Amazon Web Services corresponding to the error is stored.	The default value is null.
status_code	When an error (AmazonServiceException) occurs, the HTTP status code is stored.	The default value is null.
message_category	When an error occurs, the category of the message code corresponding to the error is stored.	The default value is null.
message_code	When an error occurs, the code of the message code corresponding to the error is stored.	The default value is null.
message_level	When an error occurs, the severity of the message code corresponding to the error is stored.	The default value is null.
error_type	When an error occurs, the error type is stored.	The default value is null. The format of the error type is as follows. Example: java.io.FileNotFoundException
error_message	When an error occurs, the error message is stored.	The default value is null.
error_trace	When an error occurs, the trace information for the error is stored.	The default value is null.

Message codes, exception messages, and limitations

Connector	Message code	Exception message	Limitations
Messages and limitations of the Amazon EC2 connector