Describe Instances

Operation Name

Describe Instances

Function Overview

Describe instances in Amazon EC2.

Properties

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 the name to show on the script canvas.  
Required settings
Item name Required/Optional Use of variables Description Remarks
Destination Required Not available Select a global resource.
  • [Add]:
    Add a new global resource.
  • [Edit list]:
    Global resource settings can be edited in “Edit resource list” screen.
  
Comment
Item name Required/Optional Use of variables Description Remarks
Comment Optional Not available You can write a short description of this adapter.
The description will be reflected in the specifications.		  

Schema

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 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) cannot be got, it is empty.
instanceId Outputs the instance ID.  
instanceName Outputs the Name tag value.  
instanceState Outputs the instance state.
  • [running]: State in which the instance is running.
  • [pending]: State in which the instance is starting up.
  • [stopping]: State in which the instance is stopping.
  • [stopped]: State in which the instance is stopped.
  • [shutting-down]: State in which the instance is shutting down.
  • [terminated]: State in which 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. Outputs in accordance with the date format set in DataSpider. 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 is not supported.

PSP Usage

PSP is not supported.

Available Component Variables

Component variable name Description Remarks
error_code When an error (AmazonServiceException) occurs, the corresponding error code of Amazon Web Services is stored.
  • Default value is null.
status_code When an error (AmazonServiceException) occurs, the HTTP status code is stored.
  • Default value is null.
message_category When an error occurs, category of the corresponding message code is stored.
  • Default value is null.
message_code When an error occurs, code of the corresponding message code is stored.
  • Default value is null.
message_level When an error occurs, severity of the corresponding message code is stored.
  • Default value is null.
error_type When an error occurs, the error type is stored.
  • Default value is null.
  • The error type would be in the following format.
    Example: “java.io.FileNotFoundException”
  • The contents that will be stored may vary depending on DataSpider Servista versions.
error_message When an error occurs, the error message is stored.
  • Default value is null.
  • The contents that will be stored may vary depending on DataSpider Servista versions.
error_trace When an error occurs, trace information of the error is stored.
  • Default value is null.
  • The contents that will be stored may vary depending on DataSpider Servista versions and client applications.

Specification Limits

None.

Major Exceptions

Exception name Cause Solution
ResourceNotFoundException
Resource definition is not found. Name: []		 [Destination] is not specified. Specify [Destination].
ResourceNotFoundException
Resource definition is not found. Name: [<global resource name>]		 The resource definition selected in [Destination] is not found. Check the global resource specified in [Destination].
InvalidPropertyConfigurationException
<property name> is not specified.		 [<property name>] is not specified. Specify [<property name>].
com.amazonaws.AmazonClientException
Unable to execute HTTP request: Connect to ec2.amazonaws.com/ec2.amazonaws.com/xxx.xxx.xxx.xxx timed out		 Could not send a request to Amazon EC2, as the millisecond specified in [Timeout] has been elapsed. Increase the millisecond of [Timeout], or check the connection status of the destination Amazon EC2.
com.amazonaws.AmazonClientException
Unable to execute HTTP request: <endpoint>		 There is something wrong with [Endpoint] of the global resource specified in [Destination]. Check the settings of the global resource specified in [Destination].

Notes