# mulesoft Amazon EC2 Connector - Full Documentation --- product: Amazon EC2 Connector version: 2.5 --- # Amazon EC2 Connector 2.5 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Amazon EC2 (Amazon EC2 Connector) provides connectivity to the Amazon Elastic Compute Cloud (Amazon EC2) API, enabling you to interface with Amazon EC2 to launch as many or as few virtual servers as you need, configure security and networking, and manage storage. ## Before You Begin To use Amazon EC2 Connector, you must be familiar with: - The Amazon EC2 API - Anypoint Connectors - Mule runtime engine (Mule) - Elements and global elements in a Mule flow - Creating a Mule app using Anypoint Studio or Anypoint Code Builder Before creating an app, you must have: - AWS Identity and Access Management (IAM) user account credentials - A secret access key to IAM - Access to EC2 via the AWS cloud ## Common Use Cases for the Connector Common use cases for the connector include: - Creating an EBS volume to attach to an instance in the same availability zone - Attaching an EBS volume to a running or stopped Amazon EC2 instance - Restarting an Amazon EBS-backed AMI that you’ve previously stopped - Stopping an Amazon EC2 instance ## Audience - New users, read: - [Using Anypoint Studio to Configure the Connector](https://docs.mulesoft.com/amazon-ec2-connector/2.5/amazon-ec2-connector-studio) to create your Mule app - [Examples](https://docs.mulesoft.com/amazon-ec2-connector/2.5/amazon-ec2-connector-examples), which provide one or more use cases for the connector - Advanced users, read: - [XML and Maven Support](https://docs.mulesoft.com/amazon-ec2-connector/2.5/amazon-ec2-connector-xml-maven) - [Examples](https://docs.mulesoft.com/amazon-ec2-connector/2.5/amazon-ec2-connector-examples), which provides one or more use cases for the connector ## Authentication Types Amazon EC2 Connector connections use the following authentication types: - Basic Uses a session token provided by Amazon STS to connect to Amazon EC2 - Role Uses the Amazon role ARN that uniquely identifies the role to allow cross-account access For information about configuring these authentication types, see [Using Anypoint Studio to Configure Amazon EC2](https://docs.mulesoft.com/amazon-ec2-connector/2.5/amazon-ec2-connector-studio). ## Next Step After you complete the prerequisites and try the examples, you are ready to create your own app and configure the connector using [Using Anypoint Studio to Configure Amazon EC2 Connector](https://docs.mulesoft.com/amazon-ec2-connector/2.5/amazon-ec2-connector-studio). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [Amazon EC2 Connector Reference](https://docs.mulesoft.com/amazon-ec2-connector/2.5/amazon-ec2-connector-reference) - [Salesforce Help](https://help.salesforce.com) --- product: Amazon EC2 Connector version: 2.5 --- # Amazon EC2 Connector 2.5 Example > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This example creates an Amazon EBS (Elastic Block Store) volume that you can attach to an Amazon EC2 instance that is in the same availability zone as the volume. The example includes configuring global elements for Anypoint Connector for Amazon EC2 (Amazon EC2 Connector), configuring additional properties such as volume size and type, configuring the **Set Payload** component, adding and configuring the **Logger** component, and testing your application’s use of the connector. The following image shows the Mule flow for this example: ![Flow for creating an EBS volume](/mulesoft/current/en-us/amazon-ec2-connector/2.5/_images/amazon-ec2-create-volume-usecase-flow.png) This example uses variables for some field values. You can either: - Replace the variables with their values in the code. - Provide the values for each variable in a properties file and then refer to that file from the connector configuration. If you don’t know how to use a properties file, see [Configuring Property Placeholders](https://docs.mulesoft.com/mule-runtime/latest/mule-app-properties-to-configure). ## Configure Global Elements for the Connector 1. Create a new Mule project in Anypoint Studio. 2. Create a file named `mule-artifact.properties` to store your Amazon credentials. 3. Add the following properties to the `mule-artifact.properties` file: ```text amazon.accesskey= amazon.secretkey= amazon.region= amazon.sessionToken= ``` 4. Save the `mule-artifact.properties` file in the project’s `src/main/resources` directory. 5. Drag the **HTTP Listener** component to the canvas. 6. Add a global element for **HTTP Listener**: 1. Select **Listener** on the canvas. 2. In the configuration screen for the operation, click the plus sign (**+**) next to the **Connector configuration** field to access the global element configuration fields. 3. In the **Global Element Properties** dialog, provide the following values: - **Name** `Listener` - **Host** `localhost` - **Port** `8081` The following image shows an example of the **HTTP Listener** global element configuration: ![Global element configuration for HTTP Listener](/mulesoft/current/en-us/amazon-ec2-connector/2.5/_images/http-listener-config.png) 4. Click **OK**. 7. Drag the Amazon EC2 Connector **Create volume** operation next to the **Listener** component. 8. Add a new Amazon EC2 global element: 1. Select the **Create volume** operation on the canvas. 2. In the configuration screen for the operation, click the plus sign (**+**) next to the **Connector configuration** field to access the global element configuration fields. 9. Configure the global element as follows: - **Name** `Amazon EC2 Configuration` - **Session Token** Session token used to validate the temporary security credentials - **Access Key** Alphanumeric text string that uniquely identifies the user who owns the account - **Secret Key** Key that acts as the password - **Region Endpoint** Region to select from the drop-down menu for the Amazon EC2 client The following image shows an example of what the configuration looks like: ![EC2 global configuration](/mulesoft/current/en-us/amazon-ec2-connector/2.5/_images/mule-amazon-ec2-global-config.png) The corresponding XML looks like this: ```xml ``` 10. Click **Test Connection** to confirm that Mule can connect with the Amazon EC2 instance. 11. If the connection is successful, click **OK** to save the configurations. Otherwise, review or correct any incorrect parameters, then test again. ## Configure Additional Properties 1. Select the **Create volume** operation on the Studio canvas. 2. In the **General** tab, enter the following values: 1. Enter a value for **Display Name**. This example uses `Create volume`. 2. In the **Basic Settings** section, select the name of the Amazon EC2 configuration you created in [Configure Global Elements for the Connector](https://docs.mulesoft.com/amazon-ec2-connector/2.5/amazon-ec2-connector-studio). 3. In the **General** section, enter values for the following fields: - **Availability Zone** Amazon availability zone you have access to. This example uses `us-east-1a`. - **Size** Size of the volume in gibibytes (GiBs). This example uses `5`. - **Volume Type** The default volume type is **Standard**. ![Publish message connector props](/mulesoft/current/en-us/amazon-ec2-connector/2.5/_images/amazon-ec2-create-volume-props.png) 3. Verify that your XML looks like this: ```xml ``` ## Configure the Set Payload Component 1. In the **Mule Palette** view, select **Set Payload** and drag it to the right of the Amazon EC2 **Create volume** operation. The **Set Payload** transformer sends the response to the client in the browser. 2. In the canvas, select **Set Payload** and set the **Value** field to `#[payload.volume.volumeId]`. This prints the volume ID of the EBS volume. The following image shows the **Set Payload** configuration: ![EC2 Create Volume payload transformer](/mulesoft/current/en-us/amazon-ec2-connector/2.5/_images/amazon-ec2-create-volume-payload.png) ## Add and Configure the Logger Component 1. In the **Mule Palette** view, select **Logger** and drag it to the right of the **Set Payload** component. The **Logger** component displays the volume ID that is transformed by the **Set Payload** component from the **Create Volume** operation in the Mule console. 2. In the canvas, select **Logger** and enter the following values: - **Message** `#[payload]` - **Level** `INFO` ![EC2 create volume logger](/mulesoft/current/en-us/amazon-ec2-connector/2.5/_images/amazon-ec2-create-volume-logger-props.png) 3. Save the project. ## Test the App 1. In **Package Explorer**, right-click the project and select **Run As > Mule Application**. 2. Browse to `http://localhost:8081/createVolume`. You see the generated volume ID in the browser and console. ### Example Mule App XML Code Copy and paste this code into your XML Editor to quickly load the flow for this example use case into your Mule app: ```xml ``` ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Amazon EC2 Connector version: 2.5 --- # Amazon EC2 Connector 2.5 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt ## Configurations --- ### Configuration #### Parameters
NameTypeDescriptionDefault ValueRequired

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types to provide to this configuration.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime purges the instances when appropriate.

#### Connection Types ##### Basic ###### Parameters
NameTypeDescriptionDefault ValueRequired

Session Token

String

The session token provided by Amazon STS.

Connection Timeout

Number

The amount of time to wait (in milliseconds) when initially establishing a connection before the connector gives up and times out. A value of 0 means infinity and is not recommended.

50000

Max Connections

Number

Sets the maximum number of allowed open HTTP connections.

Socket Timeout

Number

The amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection times out. A value of 0 means infinity and is not recommended.

50000

Access Key

String

The access key provided by Amazon.

x

Secret Key

String

The secret key provided by Amazon.

x

Try Default AWSCredentials Provider Chain

Boolean

Set this field to true to obtain credentials from the AWS environment. See: https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/credentials.html

false

Region Endpoint

String

Set the topic region endpoint.

US_EAST_1

TLS Configuration

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Host

String

The optional proxy host.

Port

Number

The optional proxy port.

Username

String

The optional proxy username.

Password

String

The optional proxy password.

Domain

String

The optional proxy domain.

Workstation

String

The optional proxy workstation.

##### Role ###### Parameters
NameTypeDescriptionDefault ValueRequired

Role ARN

String

Role ARN that uniquely identifies the role to assume to gain cross-account access.

x

Connection Timeout

Number

Duration (in milliseconds) when initially establishing a connection before the connector gives up and times out. A value of 0 means infinity and is not recommended.

50000

Max Connections

Number

Sets the maximum number of allowed open HTTP connections.

Socket Timeout

Number

Duration (in milliseconds) to transfer data over an established, open connection before the connection times out. A value of 0 means infinity and is not recommended.

50000

Access Key

String

Access key provided by Amazon.

x

Secret Key

String

Secret key provided by Amazon.

x

Try Default AWSCredentials Provider Chain

Boolean

Set this field to true to obtain credentials from the AWS environment. See: https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/credentials.html

false

Region Endpoint

String

Set the topic region endpoint.

US_EAST_1

TLS Configuration

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Host

String

Optional proxy host.

Port

Number

Optional proxy port.

Username

String

Optional proxy username.

Password

String

Optional proxy password.

Domain

String

Optional proxy domain.

Workstation

String

Optional proxy workstation.

## Supported Operations - [Allocate Address](#allocateAddress) - [Assign IPv6 Addresses](#assignIpv6Addresses) - [Assign Private IP Addresses](#assignPrivateIpAddresses) - [Associate Address](#associateAddress) - [Associate IAM Instance Profile](#associateIamInstanceProfile) - [Attach Network Interface](#attachNetworkInterface) - [Attach Volume](#attachVolume) - [Authorize Security Group Egress](#authorizeSecurityGroupEgress) - [Authorize Security Group Ingress](#authorizeSecurityGroupIngress) - [Copy Snapshot](#copySnapshot) - [Create Image](#createImage) - [Create Key Pair](#createKeyPair) - [Create Network Interface](#createNetworkInterface) - [Create Security Group](#createSecurityGroup) - [Create Snapshot](#createSnapshot) - [Create Tags](#createTags) - [Create Volume](#createVolume) - [Delete Key Pair](#deleteKeyPair) - [Delete Network Interface](#deleteNetworkInterface) - [Delete Security Group](#deleteSecurityGroup) - [Delete Snapshot](#deleteSnapshot) - [Delete Tags](#deleteTags) - [Delete Volume](#deleteVolume) - [Deregister Image](#deregisterImage) - [Describe Addresses](#describeAddresses) - [Describe Availability Zones](#describeAvailabilityZones) - [Describe IAM Instance Profile Associations](#describeIamInstanceProfileAssociations) - [Describe Image Attribute](#describeImageAttribute) - [Describe Images](#describeImages) - [Describe Instance Attribute](#describeInstanceAttribute) - [Describe Instance Status](#describeInstanceStatus) - [Describe Instances](#describeInstances) - [Describe Key Pairs](#describeKeyPairs) - [Describe Moving Addresses](#describeMovingAddresses) - [Describe Network Interface Attribute](#describeNetworkInterfaceAttribute) - [Describe Network Interfaces](#describeNetworkInterfaces) - [Describe Regions](#describeRegions) - [Describe Security Group References](#describeSecurityGroupReferences) - [Describe Security Groups](#describeSecurityGroups) - [Describe Snapshot Attribute](#describeSnapshotAttribute) - [Describe Snapshots](#describeSnapshots) - [Describe Stale Security Groups](#describeStaleSecurityGroups) - [Describe Tags](#describeTags) - [Describe Volume Attribute](#describeVolumeAttribute) - [Describe Volume Status](#describeVolumeStatus) - [Describe Volumes](#describeVolumes) - [Describe Volumes Modifications](#describeVolumesModifications) - [Detach Network Interface](#detachNetworkInterface) - [Detach Volume](#detachVolume) - [Disassociate Address](#disassociateAddress) - [Disassociate IAM Instance Profile](#disassociateIamInstanceProfile) - [Enable Volume I/O](#enableVolumeIo) - [Get Console Output](#getConsoleOutput) - [Get Console Screenshot](#getConsoleScreenshot) - [Get Password Data](#getPasswordData) - [Import Key Pair](#importKeyPair) - [Modify Image Attribute](#modifyImageAttribute) - [Modify Instance Attribute](#modifyInstanceAttribute) - [Modify Network Interface Attribute](#modifyNetworkInterfaceAttribute) - [Modify Snapshot Attribute](#modifySnapshotAttribute) - [Modify Volume](#modifyVolume) - [Modify Volume Attribute](#modifyVolumeAttribute) - [Monitor Instances](#monitorInstances) - [Move Address To VPC](#moveAddressToVpc) - [Reboot Instances](#rebootInstances) - [Release Address](#releaseAddress) - [Replace IAM Instance Profile Association](#replaceIamInstanceProfileAssociation) - [Report Instance Status](#reportInstanceStatus) - [Reset Image Attribute](#resetImageAttribute) - [Reset Instance Attribute](#resetInstanceAttribute) - [Reset Network Interface Attribute](#resetNetworkInterfaceAttribute) - [Reset Snapshot Attribute](#resetSnapshotAttribute) - [Restore Address To Classic](#restoreAddressToClassic) - [Revoke Security Group Egress](#revokeSecurityGroupEgress) - [Revoke Security Group Ingress](#revokeSecurityGroupIngress) - [Run Instances](#runInstances) - [Start Instances](#startInstances) - [Stop Instances](#stopInstances) - [Terminate Instances](#terminateInstances) - [Unassign IPv6 Addresses](#unassignIpv6Addresses) - [Unassign Private IP Addresses](#unassignPrivateIpAddresses) - [Unmonitor Instances](#unmonitorInstances) ## Operations ### Allocate Address `` Acquires an elastic IP address. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Domain

String

Set to vpc to allocate the address for use with instances in a VPC. By default, if the Region supports EC2-Classic, this value is standard. Valid values are standard and vpc.

standard

Target Variable

String

Name of a variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Allocate Address Result

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Assign IPv6 Addresses `` Assigns one or more IPv6 addresses to the specified network interface. #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Network Interface Id

String

The ID of the network interface.

x

Ipv6 Address Count

Number

The number of IPv6 addresses to assign to the network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can’t use this option if specifying specific IPv6 addresses.

Ipv6 Addresses

Array of String

One or more specific IPv6 addresses to be assigned to the network interface. You can’t use this option if you’re specifying a number of IPv6 addresses.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Assign IPv6 Addresses Result

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Assign Private IP Addresses `` Assigns one or more secondary private IP addresses to the specified network interface. #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Network Interface Id

String

The ID of the network interface.

x

Allow Reassignment

Boolean

Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

false

Private Ip Addresses

Array of String

One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can’t specify this parameter when also specifying a number of secondary IP addresses.

Secondary Private Ip Address Count

Number

The number of secondary IP addresses to assign to the network interface. You can’t specify this parameter when also specifying private IP addresses.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Associate Address `` Associates an Elastic IP address with an instance or a network interface. Associating an Elastic IP address with an interface in a different network border group is not allowed. > [!NOTE] This operation is idempotent. If you perform the operation more than once, an error is not > returned, and each time the Elastic IP address is remapped to the same instance, you might be > charged. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Allocation Id

String

EC2-VPC - The allocation ID. This is required for EC2-VPC.

Allow Reassociation

Boolean

EC2-VPC - For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface. Otherwise, the operation fails.

false

Instance Id

String

The ID of the instance.

Network Interface Id

String

EC2-VPC - ID of the network interface.

Private Ip Address

String

EC2-VPC - Primary or secondary private IP address to associate with the Elastic IP address.

Public Ip

String

Elastic IP address. This is required for EC2-Classic.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Associate IAM Instance Profile `` Associates an IAM instance profile with a running or stopped instance. Associating more than one IAM instance profile with an instance is not allowed. #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Instance Id

String

ID of the instance.

x

Profile Name

String

Name of the IAM instance profile.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

IAM Instance Profile Association

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Attach Network Interface `` Attaches a network interface to an instance. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Device Index

Number

Index of the device for the network interface attachment.

x

Instance Id

String

ID of the instance.

x

Network Interface Id

String

ID of the network interface.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Attach Volume `` Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name. Encrypted EBS volumes can be attached only to instances that support Amazon EBS encryption. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Volume Id

String

The ID of the EBS volume.

x

Instance Id

String

The ID of the instance.

x

Device

String

The device name to expose to the instance (for example, /dev/sdh or xvdh).

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Volume Attachment

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Authorize Security Group Egress `` (EC2-VPC only) Adds one or more egress rules to a security group to use with a VPC. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Group Id

String

The ID of the security group.

x

Cidr Ip

String

The CIDR IPv4 address range.

Ip Protocol

String

The IP protocol name or number.

From Port

Number

The start of port range for the TCP and UDP protocols, or an ICMP type number.

To Port

Number

The end of port range for the TCP and UDP protocols, or an ICMP type number.

Ip Permissions

Array of IP Permission

Sets of IP permissions.

Source Security Group Name

String

The name of a destination security group.

Source Security Group Owner Id

String

The AWS account number for a destination security group.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Authorize Security Group Ingress `` Adds one or more ingress rules to a security group. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Group Id

String

ID or name of the security group. For security groups in a non-default VPC, you must specify the group ID (rather than the Group Name).

Group Name

String

Specifies the name of the security group for EC2-Classic and default VPC.

Cidr Ip

String

IPv4 address range in CIDR format.

Ip Protocol

String

IP protocol name (tcp, udp, icmp) or number. For icmpv6, specify a set of IP permissions.

From Port

Number

Start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.

To Port

Number

End of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code number.

Ip Permissions

Array of IP Permission

A set of IP permissions.

Source Security Group Name

String

EC2-Classic, default VPC - The name of the source security group.

Source Security Group Owner Id

String

In EC2-Classic, the AWS account number for the source security group, if the source security group is in a different account. You can’t specify this parameter in combination with the CIDR IP address range, IP protocol, Start and End of port range parameters.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Copy Snapshot `` Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy the snapshot within the same region, or from one region to another. You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs). Copies of encrypted EBS snapshots remain encrypted and copies of unencrypted snapshots remain unencrypted. To encrypt unencrypted snapshots, specify the `Encrypted` parameter during the copy snapshot operation. Encrypted snapshot copies use the default AWS Key Management Service (AWS KMS) customer key (CMK). You can use the `KmsKeyId` parameter to specify a non-default CMK. To copy an encrypted snapshot that is shared from another account, you must have permissions for the CMK that is used to encrypt the snapshot. Snapshots that are created by the `copySnapshot` action have a random volume ID that must not be used for any other purpose. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Source Snapshot Id

String

ID of the EBS snapshot to copy.

x

Source Region

Enumeration, one of:

  • APNORTHEAST1

  • APNORTHEAST2

  • APSOUTH1

  • APSOUTHEAST1

  • APSOUTHEAST2

  • CACENTRAL1

  • EUCENTRAL1

  • EUWEST1

  • EUWEST2

  • SAEAST1

  • USEAST1

  • USEAST2

  • USWEST1

  • USWEST2

ID of the region that contains the snapshot to copy.

x

Description

String

Description for the EBS snapshot.

Destination Region

String. Enumeration, one of:

  • APNORTHEAST1

  • APNORTHEAST2

  • APSOUTH1

  • APSOUTHEAST1

  • APSOUTHEAST2

  • CACENTRAL1

  • EUCENTRAL1

  • EUWEST1

  • EUWEST2

  • SAEAST1

  • USEAST1

  • USEAST2

  • USWEST1

  • USWEST2

Destination region to use in the PresignedUrl parameter of a copy snapshot operation. The snapshot is copied to the regional endpoint to which you send the HTTP request.

Presigned Url

String

The pre-signed URL that facilitates copying an encrypted snapshot.

Encrypted

Boolean

Specifies whether the destination snapshot should be encrypted.

false

Kms Key Id

String

Full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Create Image `` Creates an Amazon EBS-backed AMI from a running or stopped instance. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Instance Id

String

Instance information.

x

I Name

String

Instance name.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

String

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Create Key Pair `` Creates a new 2048-bit RSA key pair with the specified name. The public key is stored by Amazon EC2 and the private key is returned to you. The private key is returned as an unencrypted PEM-encoded PKCS#8 private key. If a key with the specified name already exists, Amazon EC2 returns an error. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Key Name

String

Unique name for the key pair.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Key Pair

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Create Network Interface `` Creates a network interface in the specified subnet. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Subnet Id

String

The ID of the subnet to associate with the network interface.

x

Description

String

A description for the network interface.

Groups

Array of String

The IDs of one or more security groups.

Ipv6 Address Count

Number

The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range.

Ipv6 Addresses

Array of String

One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can’t use this option if you’re specifying a number of IPv6 addresses.

Private Ip Address

String

The primary private IPv4 address of the network interface.

Private Ip Addresses

One or more private IPv4 addresses.

Secondary Private Ip Address Count

Number

The number of secondary private IPv4 addresses to assign to a network interface.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Network Interface

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Create Security Group `` Creates a security group. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Vpc Id

String

ID of the VPC.

Group Name

String

Name of the security group.

x

Description

String

Description for the security group.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Create Snapshot `` Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance. When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot. You can take a snapshot of an attached volume that is in use, but snapshots capture only the data that is written to your EBS volume at the time the snapshot command is issued. Data that is cached by any apps or the operating system is excluded. Your snapshot should be complete if you can pause file systems on the volume long enough to take the snapshot. If you can’t pause all file writes to the volume, to ensure a consistent and complete snapshot, do the following: 1. Unmount the volume from within the instance. 2. Issue the snapshot command. 3. Remount the volume. You can remount and use your volume while the snapshot status is pending. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Volume Id

String

ID of the EBS volume.

x

Description

String

Description for the snapshot.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Snapshot

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Create Tags `` Adds or overwrites one or more tags for the specified Amazon EC2 resources. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Resources

Array of String

List of IDs of one or more resources to tag. For example, ami-1a2b3c4d.

x

Tags

Array of Tag

List of one or more tags. The value parameter is required, but if you don’t want the tag to have a value, specify the parameter with no value, and Mule sets the value to an empty string.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Create Volume `` Creates an EBS volume to attach to an instance that is in the same Availability Zone. The volume is created in the regional endpoint to which you send the HTTP request. You can create a new empty volume or restore a volume from an EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume. To create encrypted volumes, use the `Encrypted` parameter. Encrypted volumes can be attached only to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Availability Zone

String

The Amazon availability zone in which to create the volume.

x

Encrypted

Boolean

Specifies whether to encrypt the volume.

false

Iops

Number

Only valid for provisioned IOPS SSD volumes. The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 50 IOPS/GiB.

Kms Key Id

String

Full ARN of the AWS Key Management Service (AWS KMS) customer key (CMK) to use when creating the encrypted volume.

Size

Number

The size of the volume, in GiBs.

Snapshot Id

String

The snapshot from which to create the volume.

Volume Type

Enumeration, one of:

  • Standard

  • Io1

  • Gp2

  • Sc1

  • St1

The volume type.

Standard

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Volume

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Delete Key Pair `` Removes the public key from Amazon EC2 and deletes the specified key pair. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Key Name

String

Name of the key pair to delete.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Delete Network Interface `` Deletes the specified network interface. You must detach the network interface before you can delete it. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Network Interface Id

String

ID of the network interface.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Delete Security Group `` Deletes a security group. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Group Id

String

The security group ID is required for nondefault VPC.

Group Name

String

For EC2-Classic and default VPC, name of the security group.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Delete Snapshot `` Deletes the specified snapshot. When you make periodic snapshots of a volume, the snapshots are incremental, which means that only the blocks that changes on the device since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data that is not needed for any other snapshot is removed. This ensures that, no matter which prior snapshots were deleted, all active snapshots have access to all the information needed to restore the volume. You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must de-register the AMI before you can delete the snapshot. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Snapshot Id

String

ID of the EBS snapshot.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Delete Tags `` Deletes the specified set of tags from the specified set of resources. This call is designed to follow a `DescribeTags` call so you can first determine what tags a resource has. You can then call `DeleteTags` with the resource ID and the specific tags you want to delete. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Resources

Array of String

List of resource IDs, for example: ami-1a2b3c4d. You can specify more than one resource ID.

x

Tags

Array of Tag

List of one or more tags to delete. If you omit the value parameter, Mule deletes the tag regardless of its value. If you specify this parameter with an empty string as the value, Mule deletes the key only if its value is an empty string.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Delete Volume `` Deletes the specified EBS volume. The volume must be in the available state (not attached to an instance). The volume might remain in the deleting state for several minutes. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Volume Id

String

ID of the volume.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Deregister Image `` Deregisters the specified AMI. Once deregistered, the AMI cannot be used to launch new instances. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Image Id

String

AMI ID to deregister.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Describe Addresses `` Describes one or more of your Elastic IP addresses. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Allocation Ids

Array of String

For EC2-VPC, one or more allocation IDs.

Filters

Array of Filter

One or more filters. Filter names and values are case-sensitive.

Public Ips

Array of String

For EC2-Classic, one or more Elastic IP addresses.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Address

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Describe Availability Zones `` Describes one or more of the Availability Zones that are currently available to the account. The results include only the zones for the region you’re currently using. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Zone Names

Array of String

The names of one or more Availability Zones.

Filters

Array of Filter

One or more filters.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Availability Zone

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Describe IAM Instance Profile Associations `` Describes your IAM instance profile associations. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Association Ids

Array of String

One or more IAM instance profile associations.

Filters

Array of Filter

One or more filters.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of IAM Instance Profile Association

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Describe Image Attribute `` Describes attributes of an AMI. You can specify only one attribute at a time. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Image Id

String

ID of the AMI.

x

Attribute

String

The attribute to reset (currently you can reset only the launch permission attribute).

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Image Attribute

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Describe Images `` Describes the images in AWS (AMIs, AKIs, and ARIs). Images available to you include public images, private images that you own, and private images owned by other AWS accounts for which you have explicit launch permissions. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Image

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Describe Instance Attribute `` Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: - `blockDeviceMapping` - `disableApiTermination` - `ebsOptimized`, `groupSet` - `instanceInitiatedShutdownBehavior` - `instanceType` - `kernel` - `productCodes` - `ramdisk` - `rootDeviceName` - `sourceDestCheck` - `sriovNetSupport` - `userData` Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Attribute

String

Instance attribute.

x

Instance Id

String

ID of the instance.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Instance Attribute

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Describe Instance Status `` Describes the status of one or more instances. By default, only running instances are described, unless otherwise specified. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Instance Ids

Array of String

One or more instance IDs.

Filters

Array of Filter

One or more filters.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Instance Status

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Describe Instances `` Describes one or more of your instances. If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you don’t specify instance IDs or filters, Amazon EC2 returns information for all instances, which can have a performance impact. If you specify an invalid instance ID, an error is returned. If you specify an instance that you don’t own, that instance is not included in the returned results. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Instance Ids

Array of String

One or more instance IDs.

Filters

Array of Filter

One or more filters.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Reservation

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Describe Key Pairs `` Describes one or more of your key pairs. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Key Names

Array of String

One or more key pair names for which the describeKeyPairs service needs to return information. When the list is null or empty, it returns all the available key pairs' information.

Filters

Array of Filter

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Key Pair Info

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Describe Moving Addresses `` Describes the Elastic IP addresses to move to the EC2-VPC platform, or to restore to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Filters

Array of Filter

One or more filters.

Public Ips

Array of String

One or more Elastic IP addresses.

Streaming Strategy

Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Message of Move Address Status payload and Request ID Attribute attributes

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 2](#exceptionthrows2) ### Describe Network Interface Attribute `` Describes a network interface attribute. You can specify only one attribute at a time. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Attribute

String

The attribute of the network interface. This parameter is required.

x

Network Interface Id

String

The ID of the network interface.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Describe Network Interface Attribute Result

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Describe Network Interfaces `` Describes one or more of your network interfaces. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Filters

Array of Filter

One or more filters.

Network Interface Ids

Array of String

One or more network interface IDs.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Network Interface

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Describe Regions `` Describes one or more regions that are currently available to you. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Region Names

Array of String

The names of one or more regions.

Filters

Array of Filter

One or more filters.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Region

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Describe Security Group References `` (EC2-VPC only) Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you’ve specified in this request. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Group Ids

Array of String

One or more security group IDs in your account.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Security Group Reference

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Describe Security Groups `` Describes one or more of your security groups. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Group Ids

Array of String

One or more security group IDs.

Group Names

Array of String

(EC2-Classic and default VPC only) One or more security group names.

Filters

Array of Filter

One or more filters.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Security Group

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Describe Snapshot Attribute `` Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Snapshot Id

String

ID of the EBS snapshot.

x

Attribute

Enumeration, one of:

  • ProductCodes

  • CreateVolumePermission

The snapshot attribute to view.

CreateVolumePermission

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Describe Snapshot Attribute Result

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Describe Snapshots `` Describes one or more of the EBS snapshots available to you. Available snapshots include: - Public snapshots available for any AWS account to launch - Private snapshots that you own - Private snapshots owned by another AWS account but for which you have explicit create volume permissions The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions. If you specify: - One or more snapshot IDs, only snapshots that have the specified IDs are returned. - An invalid snapshot ID, an error is returned. - A snapshot ID for which you do not have access, it is not included in the returned results. - One or more snapshot owners using the OwnerIds option, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners: `amazon` for snapshots owned by Amazon, or `self` for snapshots that you own. - A list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots): `self` for snapshots you own or to which you have explicit permissions, or `all` for public snapshots. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Snapshot Ids

Array of String

One or more snapshot IDs.

Owner Ids

Array of String

Returns the snapshots owned by the specified owner.

Restorable By User Ids

Array of String

One or more AWS accounts IDs that can create volumes from the snapshot.

Filters

Array of Filter

One or more filters.

Streaming Strategy

Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Message of Snapshot payload and Request ID Attribute attributes

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 2](#exceptionthrows2) ### Describe Stale Security Groups `` (EC2-VPC only) Describes the stale security group rules for security groups in a specified VPC. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Vpc Id

String

The ID of the VPC.

x

Streaming Strategy

Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Message of Stale Security Group payload and Request ID Attribute attributes

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 2](#exceptionthrows2) ### Describe Tags `` Describes one or more of the tags for your EC2 resources. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Filters

Array of Filter

One or more filters

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Tag Description

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Describe Volume Attribute `` Describes the specified attribute of the specified volume. You can specify only one attribute at a time. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Volume Id

String

The ID of the volume.

x

Attribute Name

Enumeration, one of:

  • AutoEnableIO

  • ProductCodes

The attribute of the volume.

AutoEnableIO

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Describe Volume Attribute Result

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Describe Volume Status `` Describes the status of the specified volumes and provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. If an issue occurs on the volume’s underlying host, volume performance can be affected. If the volume’s underlying host experiences a power outage or system issue, after the system is restored, data inconsistencies on the volume are possible. Volume events notify you if this occurs. Volume actions notify you if any action must be taken in response to the event. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Volume Ids

Array of String

One or more volume IDs.

Filters

Array of Filter

One or more filters.

Streaming Strategy

Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Message of Volume Status Item payload and Request ID Attribute attributes

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 2](#exceptionthrows2) ### Describe Volumes `` Describes the specified EBS volumes. If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The `MaxResults` parameter sets the maximum number of results returned in a single page. If the list of results exceeds your `MaxResults` value, then that number of results is returned along with a `NextToken` value that can be passed to a subsequent `DescribeVolumes` request to retrieve the remaining results. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Volume Ids

Array of String

One or more volume IDs.

Filters

Array of Filter

One or more filters.

Streaming Strategy

Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Message of Volume payload and Request ID Attribute attributes

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 2](#exceptionthrows2) ### Describe Volumes Modifications `` Reports the current modification status of EBS volumes. Current-generation EBS volumes support modification of attributes including type, size, and (for io1 volumes) IOPS provisioning while either attached to or detached from an instance. Following an action from the API or the console to modify a volume, the status of the modification can be modifying, optimizing, completed, or failed. If a volume has never been modified, then certain elements of the returned VolumeModification objects are null. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Volume Ids

Array of String

One or more volume IDs for which in-progress modifications will be described.

Filters

Array of Filter

One or more filters.

Streaming Strategy

Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Message of Volume Modification payload and Request ID Attribute attributes

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 2](#exceptionthrows2) ### Detach Network Interface `` Detaches a network interface from an instance. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Attachment Id

String

The ID of the network interface.

x

Force

Boolean

Specifies whether to force a detachment.

false

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Detach Volume `` Detaches an EBS volume from an instance. You must unmount any file systems on the device within your operating system before detaching the volume. Failure to do so can result in the volume becoming stuck in the busy state while detaching. If this happens, detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot the instance, or all three. If an EBS volume is the root device of an instance, it can’t be detached while the instance is running. To detach the root volume, stop the instance first. When a volume with an AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Volume Id

String

The ID of the volume.

x

Device

String

The device name.

Force

Boolean

Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally).

false

Instance Id

String

The ID of the instance.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Volume Attachment

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Disassociate Address `` Disassociates an Elastic IP address from the instance or network interface it’s associated with. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Association Id

String

Association ID. Required for EC2-VPC.

Public Ip

String

EC2-Classic Elastic IP address. Required for EC2-Classic.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Disassociate IAM Instance Profile `` Disassociates an IAM instance profile from a running or stopped instance. Use DescribeIamInstanceProfileAssociations to get the association ID. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Association Id

String

The ID of the IAM instance profile association.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

IAM Instance Profile Association

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Enable Volume I/O `` Enables input and output operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Volume Id

String

ID of the volume.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Get Console Output `` Retrieves console output for the specified instance. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Instance Id

String

The ID of the instance.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Get Console Output Result

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Get Console Screenshot `` Retrieve a JPG-format screenshot of a running instance to help with troubleshooting. The returned content is Base64-encoded. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Instance Id

String

ID of the instance.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Get Console Screenshot Result

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Get Password Data `` Retrieves the encrypted administrator password for an instance running Windows. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Instance Id

String

The ID of the Windows instance.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Get Password Data Result

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1). ### Import Key Pair `` Imports the public key from an RSA key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. The private key is never transferred between you and AWS. #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Key Name

String

A unique name for the key pair.

x

Public Key Material

String

The public key which must be base64-encoded.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Import Key Pair Result

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Modify Image Attribute `` Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Image Id

String

ID of the AMI.

x

Description

String

Description of the AMI.

Attribute

String

Name of the attribute to modify.

Operation Type

String

Type of operation.

Launch Permissions

Launch permissions for the AMI.

Product Codes

Array of String

The DevPay product codes. After you add a product code to an AMI, it can’t be removed.

Value

String

Value of the attribute to modify.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Modify Instance Attribute `` Modifies the specified attribute of the specified instance. You can specify only one attribute at a time. To modify some attributes, the instance must be stopped. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Instance Id

String

ID of the instance.

x

Attribute

String

Name of the attribute.

x

Value

String

New value for the attribute.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Modify Network Interface Attribute `` Modifies the specified network interface attribute. You can specify only one attribute at a time. Be careful while using this operation. - To modify only the **Description** attribute, pass only the description along with **Network Interface Id**. - To modify **Attachment Id**, only send **Attachment Id** and **Delete On Termination** set to `false`. - To modify **Groups**, send `groupSet` along with **Network Interface Id**. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Network Interface Id

String

ID of the network interface.

x

Attachment Id

String

ID of the network interface attachment.

Description

String

Description for the network interface.

Groups

Array of String

Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it’s just the default security group in the VPC. You must specify the ID of the security group, not the name.

Delete On Termination

Boolean

Indicates whether the network interface is deleted when the instance is terminated.

false

Source Dest Check

Boolean

Indicates whether source or destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.

false

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Modify Snapshot Attribute `` Adds or removes permission settings for the specified snapshot. You can add or remove specified AWS account IDs from a snapshot’s list of create volume permissions, but you cannot do both in a single API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls. You can’t make encrypted snapshots and snapshots with AWS Marketplace product codes public. Snapshots encrypted with your default CMK cannot be shared with other accounts. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Snapshot Id

String

ID of the snapshot.

x

Attribute

Enumeration, one of:

  • ProductCodes

  • CreateVolumePermission

The snapshot attribute to modify.

CreateVolumePermission

Operation Type

Enumeration, one of:

  • Add

  • Remove

Type of operation to perform to the attribute.

Add

Group Names

Array of String

Group to modify for the snapshot.

User Ids

Array of String

Account ID to modify for the snapshot.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Modify Volume `` You can modify several parameters of an existing EBS volume, including volume size, volume type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance type, it might be possible to apply these changes without stopping the instance or detaching the volume from it. When you complete a resize operation on your volume, you need to extend the volume’s file-system size to take advantage of the new storage capacity. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Volume Id

String

ID of the volume to modify.

x

Iops

Number

Target IOPS rate of the volume to modify.

Size

Number

Target size in GiB of the volume to modify.

Volume Type

Enumeration, one of:

  • Standard

  • Io1

  • Gp2

  • Sc1

  • St1

Target EBS volume type of the volume to be modified

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Volume Modification

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Modify Volume Attribute `` Modifies a volume attribute. By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent. This behavior prevents undetectable latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume. You can change the default behavior to resume I/O operations. It is best to change the default behavior only for boot volumes or for volumes that are stateless or disposable. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Volume Id

String

ID of the volume.

x

Auto Enable IO

Boolean

Indicates whether the volume should be auto-enabled for I/O operations.

true

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Monitor Instances `` Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Instance Ids

Array of String

One or more instance IDs.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Instance Monitoring

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Move Address To VPC `` Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account for more than 24 hours, and it must not be associated with an instance. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Public Ip

String

The Elastic IP address.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Move Address To VPC Result

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Reboot Instances `` Requests a reboot of one or more instances. This operation is asynchronous, meaning that it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored. If an instance does not cleanly shut down within four minutes, Amazon EC2 performs a hard reboot. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Instance Ids

Array of String

One or more instance IDs.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Release Address `` Releases the specified Elastic IP address. After an Elastic IP address is released, it is sent to the IP address pool and might be unavailable to you. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Allocation Id

String

Required allocation ID for EC2-VPC.

Public Ip

String

Required Elastic IP address for EC2-Classic.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Replace IAM Instance Profile Association `` Replaces an IAM instance profile for the specified running instance. You can use this action to change the IAM instance profile that’s associated with an instance without having to disassociate the existing IAM instance profile first. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Association Id

String

ID of the existing IAM instance profile association

x

Profile Name

String

Name of the instance profile to replace.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

IAM Instance Profile Association

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Report Instance Status `` Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by `DescribeInstanceStatus`, use `ReportInstanceStatus` to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks. Use of this action does not change the value returned by DescribeInstanceStatus. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Instance Ids

Array of String

One or more instance IDs.

x

Reason Codes

Array of String

One or more reason codes that describes the health state of your instance.

x

Status

String

The status of all instances listed.

x

Description

String

Descriptive text about the health state of your instance.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Reset Image Attribute `` Resets an attribute of an AMI to its default value. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Image Id

String

ID of the AMI.

x

Attribute

String

Attribute to reset. Currently, you can only reset the launch permission attribute).

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Reset Instance Attribute `` Resets an attribute of an instance to its default value. To reset the kernel or RAM disk, the instance must be in a stopped state. To reset the `sourceDestCheck`, the instance can be either running or stopped. The `sourceDestCheck` attribute controls whether source or destination checking is enabled. The default value is `true`, which means checking is enabled. This value must be `false` for a NAT instance to perform NAT. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Instance Id

String

ID of the instance.

x

Attribute

String

Attribute to reset. You can reset only the following attributes:

  • kernel

  • ramdisk

  • sourceDestCheck

To change an instance attribute, use ModifyInstanceAttribute.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Reset Network Interface Attribute `` Resets a network interface attribute. You can specify only one attribute at a time. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Network Interface Id

String

ID of the network interface.

x

Source Dest Check

String

Source or destination checking attribute. Resets the value to true.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Reset Snapshot Attribute `` Resets permission settings for the specified snapshot. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Snapshot Id

String

ID of the snapshot.

x

Attribute

Enumeration, one of:

  • ProductCodes

  • CreateVolumePermission

The attribute to reset.

CreateVolumePermission

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Restore Address To Classic `` Restores an elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Public Ip

String

Elastic IP address.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Restore Address To Classic Result

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Revoke Security Group Egress `` (EC2-VPC only) Removes one or more egress rules from a security group for EC2-VPC. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Group Id

String

ID of the security group.

x

Cidr Ip

String

CIDR IP address range.

Ip Protocol

String

IP protocol name or number.

From Port

Number

Start of port range for the TCP and UDP protocols, or an ICMP type number.

To Port

Number

End of port range for the TCP and UDP protocols, or an ICMP type number.

Ip Permissions

Array of IP Permission

A set of IP permissions.

Source Security Group Name

String

Name of a destination security group.

Source Security Group Owner Id

String

AWS account number for a destination security group.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Revoke Security Group Ingress `` Removes one or more ingress rules from a security group. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Group Id

String

ID of the security group.

Group Name

String

EC2-Classic, default VPC - The name of the security group.

Cidr Ip

String

CIDR IP address range.

Ip Protocol

String

IP protocol name (tcp, udp, icmp) or number.

From Port

Number

Start of port range for the TCP and UDP protocols, or an ICMP type number.

To Port

Number

The end of port range for the TCP and UDP protocols, or an ICMP code number.

Ip Permissions

Array of IP Permission

A set of IP permissions.

Source Security Group Name

String

For EC2-Classic, default VPC, this is the name of the source security group.

Source Security Group Owner Id

String

For EC2-Classic, this is the AWS account ID of the source security group, if the source security group is in a different account.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Run Instances `` Launches the specified number of instances of an AMI for which you have permissions. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Image Id

String

ID of the AMI, which you can get by calling describe-images.

x

Min Count

Number

Minimum number of instances to launch.

1

Max Count

Number

Maximum number of instances to launch.

1

Security Groups

Array of String

One or more security group names.

Security Group Ids

Array of String

One or more security group IDs.

Keyname

String

Name of the key pair.

Subnet Id

String

ID of the subnet to launch the instance into.

Instance Type

String

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Reservation

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Start Instances `` Starts an Amazon EBS-backed AMI that you’ve previously stopped. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Instance Ids

Array of String

One or more instance IDs.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Instance State Change

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Stop Instances `` Stops an Amazon EBS-backed instance. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Instance Ids

Array of String

One or more instance IDs.

x

Force

Boolean

Forces the instances to stop.

false

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Instance State Change

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Terminate Instances `` Shuts down one or more instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds. Terminated instances remain visible after termination (approximately one hour). Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Instance Ids

Array of String

One or more instance IDs.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Instance State Change

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Unassign IPv6 Addresses `` Unassigns one or more IPv6 addresses from a network interface. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Ipv6 Addresses

Array of String

IPv6 addresses to unassign from the network interface.

x

Network Interface Id

String

ID of the network interface.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Unassign IPv6 Addresses Result

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Unassign Private IP Addresses `` Unassigns one or more secondary private IP addresses from a network interface. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Network Interface Id

String

ID of the network interface.

x

Private Ip Addresses

Array of String

Secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Unmonitor Instances `` Disables detailed monitoring for a running instance. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Instance Ids

Array of String

One or more instance IDs.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Instance Monitoring

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ## Types Amazon EC2 Connector supports only the types that are documented. ### TLS
FieldTypeDescriptionDefault ValueRequired

Enabled Protocols

String

A comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma-separated list of cipher suites enabled for this context.

Trust Store

Key Store

Revocation Check

### Trust Store
FieldTypeDescriptionDefault ValueRequired

Path

String

The location of the truststore, which is resolved relative to the current classpath and file system, if possible.

Password

String

The password used to protect the truststore.

Type

String

The type of truststore used.

Algorithm

String

The algorithm used by the truststore.

Insecure

Boolean

If true, no certificate validations are performed, which makes connections vulnerable to attacks. Use at your own risk.

### Key Store
FieldTypeDescriptionDefault ValueRequired

Path

String

The location of the keystore, which is resolved relative to the current classpath and file system, if possible.

Type

String

The type of keystore used.

Alias

String

When the keystore contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.

Key Password

String

The password used to protect the private key.

Password

String

The password used to protect the keystore.

Algorithm

String

The algorithm used by the keystore.

### Standard Revocation Check
FieldTypeDescriptionDefault ValueRequired

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before).

Soft Fail

Boolean

Avoid verification failure when the revocation server can not be reached or is busy.

### Custom OCSP Responder
FieldTypeDescriptionDefault ValueRequired

Url

String

The URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response (must be in the trust store), if present.

### CRL File
FieldTypeDescriptionDefault ValueRequired

Path

String

The path to the CRL file.

### Reconnection
FieldTypeDescriptionDefault ValueRequired

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

The reconnection strategy to use.

### Reconnect
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often to reconnect (in milliseconds).

Count

Number

The number of reconnection attempts to make.

### Reconnect Forever
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often in milliseconds to reconnect.

### Expiration Policy
FieldTypeDescriptionDefault ValueRequired

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance can be idle before it’s eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute.

### Allocate Address Result
FieldTypeDescriptionDefault ValueRequired

Allocation Id

String

Assigned allocation ID that represents the allocation of the Elastic IP address used with instances in a VPC.

Domain

String

Specifies whether to use the Elastic IP address with instances in a VPC (vpc) or in EC2-Class (standard).

Public Ip

String

Elastic IP address.

### Request ID Attribute
FieldTypeDescriptionDefault ValueRequired

Request Id

String

Request ID included in the response

### Assign IPv6 Addresses Result
FieldTypeDescriptionDefault ValueRequired

Assigned Ipv6 Addresses

Array of String

One or more IPv6 addresses assigned to the specified network interface

Network Interface Id

String

ID of the network interface

### IAM Instance Profile Association
FieldTypeDescriptionDefault ValueRequired

Association Id

String

ID of the association

Iam Instance Profile

Instance Id

String

ID of the instance

State

String

State of the association

Timestamp

DateTime

Time the IAM instance profile was associated with the instance

### IAM Instance Profile
FieldTypeDescriptionDefault ValueRequired

Arn

String

ARN of the instance profile

Id

String

ID of the instance profile

### Volume Attachment
FieldTypeDescriptionDefault ValueRequired

Attach Time

DateTime

Timestamp of when the attachment was initiated

Delete On Termination

Boolean

Specifies whether to delete the EBS volume when the instance is terminated

Device

String

Name of the device

Instance Id

String

ID of the instance

State

String

Attachment state of the volume

Volume Id

String

ID of the volume

### IP Permission
FieldTypeDescriptionDefault ValueRequired

From Port

Number

Start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.

Ip Protocol

String

Name of the IP protocol. Valid values include:

  • tcp

  • udp

  • icmp

  • icmpv6

Ipv4 Ranges

Array of String

IPv4 ranges.

Ipv6 Ranges

Array of String

IPv6 ranges.

Prefix List Ids

Array of String

Prefix list IDs.

To Port

Number

End of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.

User Id Group Pairs

### User ID Group Pair
FieldTypeDescriptionDefault ValueRequired

Group Id

String

ID of the security group.

Group Name

String

Name of the security group. Use this parameter for a security group in EC2-Classic or a default VPC only.

Peering Status

String

If applicable, status of the VPC peering connection.

User Id

String

AWS account ID.

Vpc Id

String

If applicable, VPC ID for the referenced security group.

Vpc Peering Connection Id

String

VPC peering connection ID, if applicable.

### Key Pair
FieldTypeDescriptionDefault ValueRequired

Key Fingerprint

String

SHA-1 digest of the DER encoded private key if CreateKeyPair was used to create the key pair. If ImportKeyPair was used to create the key pair, this is the MD5 public key fingerprint as described in section 4 of RFC4716.

Key Material

String

Key Name

String

Name of the key pair.

### Network Interface
FieldTypeDescriptionDefault ValueRequired

Association

Attachment

Availability Zone

String

Availability zone

Description

String

Description for the network interface

Groups

Security groups for the network interface

Interface Type

String

Type of network interface

Ipv6 Addresses

Array of String

IPv6 addresses associated with the network interface

Mac Address

String

MAC address of the network interface

Network Interface Id

String

ID of the network interface

Owner Id

String

AWS account ID of the owner of the network interface

Private Dns Name

String

Name of the private DNS

Private Ip Address

String

IPv4 address of the network interface within the subnet

Private Ip Addresses

Private IPv4 addresses associated with the network interface

Requester Id

String

Entity ID that launched the instance on your behalf

Requester Managed

Boolean

Whether the network interface is managed by AWS

Source Dest Check

Boolean

Specifies whether to validate traffic to or from the instance

Status

String

Status of the network interface

Subnet Id

String

ID of the subnet

Tag Set

Array of Tag

Tags assigned to the network interface

Vpc Id

String

ID of the VPC

### Network Interface Association
FieldTypeDescriptionDefault ValueRequired

Allocation Id

String

Allocation ID

Association Id

String

Association ID

Ip Owner Id

String

Elastic IP address owner ID

Public Dns Name

String

Name of the public DNS

Public Ip

String

Elastic IP address bound to the network interface

### Network Interface Attachment
FieldTypeDescriptionDefault ValueRequired

Attach Time

DateTime

Time the attachment was initiated.

Attachment Id

String

Network interface attachment ID.

Delete On Termination

Boolean

If true, deletes the network interface when the instance is terminated.

Device Index

Number

Device index of the network interface attachment on the instance.

Instance Id

String

ID of the instance.

Instance Owner Id

String

AWS account ID of the instance owner.

Status

String

Attachment state. Valid values include:

  • attaching

  • attached

  • detaching

  • detached

### Group Identifier
FieldTypeDescriptionDefault ValueRequired

Group Id

String

ID of the security group

Group Name

String

Name of the security group

### Network Interface Private IP Address
FieldTypeDescriptionDefault ValueRequired

Association

Primary

Boolean

If true, the IPv4 address is the primary private IPv4 address of the network interface.

Private Dns Name

String

Name of the private DNS.

Private Ip Address

String

Private IPv4 address.

### Tag
FieldTypeDescriptionDefault ValueRequired

Key

String

Key of the tag. Tag keys are case-sensitive and have a maximum of 127 Unicode characters. The tag key cannot begin with aws:

Value

String

Value of the tag. Tag values are case-sensitive and have a maximum of 255 Unicode characters.

### Private IP Address Specification
FieldTypeDescriptionDefault ValueRequired

Primary

Boolean

If true, the IPv4 address is the primary private IPv4 address. There can be only one primary IPv4.

Private Ip Address

String

Private IPv4 addresses.

### Snapshot
FieldTypeDescriptionDefault ValueRequired

Data Encryption Key Id

String

Data encryption key identifier for the snapshot.

Description

String

Description of the snapshot.

Encrypted

Boolean

If true, the snapshot is encrypted.

Kms Key Id

String

ARN of the AWS Key Management Service (AWS KMS) customer key (CMK) used to protect the volume encryption key for the parent volume.

Owner Alias

String

AWS owner alias from the Amazon-maintained list. This is not the AWS account alias that was set using the IAM console.

Owner Id

String

AWS account ID of the snapshot owner.

Progress

String

Percentage of progress of the snapshot.

Snapshot Id

String

ID of the snapshot.

Start Time

DateTime

Time when the snapshot was initiated.

State

String

The state of the snapshot. Valid values include:

  • pending

  • completed

  • error

State Message

String

Displays details about the state of the snapshot to help you diagnose why an error occurs.

Tags

Array of Tag

Tags associated with the snapshot.

Volume Id

String

ID of the volume that was used to create the snapshot.

Volume Size

Number

Size of the volume in GiB.

### Volume
FieldTypeDescriptionDefault ValueRequired

Attachments

Availability Zone

String

Availability zone for the volume.

Create Time

DateTime

Time

Time the creation of the volume is initiated.

Encrypted

Boolean

If true, the volume is encrypted.

Iops

Number

Number of I/O operation per second that the volume supports.

Kms Key Id

String

ARN of the AWS Key Management Service (AWS KMS) customer key (CMK) used to protect the volume encryption key for the parent volume.

Size

Number

Size of the volume in GiB.

Snapshot Id

String

ID of the snapshot.

State

String

State of the volume. String can be:

  • creating

  • available

  • in-use

  • deleting

Tags

Array of Tag

Tags associated with the volume

Volume Id

String

ID of the volume

Volume Type

String

Volume type. String can be:

  • standard

  • io1

  • io2

  • gp2

  • sc1

  • st1

### Address
FieldTypeDescriptionDefault ValueRequired

Allocation Id

String

Allocation ID

Association Id

String

ID of the association of the address with a VPC instance

Domain

String

Specifies whether to use the Elastic IP address with instances in a VPC (vpc) or in EC2-Class (standard)

Instance Id

String

ID of the instance the address is associated with

Network Interface Id

String

ID of the network interface

Network Interface Owner Id

String

ID of the AWS account that owns the network interface

Private Ip Address

String

Private IP address that is associated with the Elastic IP address

Public Ip

String

Elastic IP address

### Filter
FieldTypeDescriptionDefault ValueRequired

(DEPRECATED) Name

String

Use the Filter Name field instead. Name of the filter. Filter names are case-sensitive.

Filter Name

String

Name of the filter. Filter names are case-sensitive.

Values

Array of String

Filter values, which are case-sensitive

### Availability Zone
FieldTypeDescriptionDefault ValueRequired

Messages

Array of String

Messages about the availability zone

Region Name

String

Name of the region

State

String

State of the availability zone. Valid values include:

  • available

  • information

  • impaired

  • unavailable

Zone Name

String

Name of the availability zone

### Image Attribute
FieldTypeDescriptionDefault ValueRequired

Block Device Mappings

Block device mapping entries.

Description

String

Description for the image.

Image Id

String

ID of the image.

Kernel Id

String

ID of the kernel associated with the image.

Launch Permissions

Launch permissions associated with the AMI.

Product Codes

Array of Product Code

Product codes associated with the AMI.

Ramdisk Id

String

RAM disk associated with the image. This parameter applies only to machine images.

Sriov Net Support

String

Whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

### Block Device Mapping
FieldTypeDescriptionDefault ValueRequired

Device Name

String

Name of the device

Ebs

Used to automatically set up EBS volumes when the instance is launched

No Device

String

Specify a device to suppress in the block device mapping of the AMI

Virtual Name

String

Virtual device name

### EBS Block Device
FieldTypeDescriptionDefault ValueRequired

Delete On Termination

Boolean

If true, the EBS volume is deleted when the instance is terminated

Encrypted

Boolean

Determines whether the encryption state of an EBS volume is changed when it is restored from a backing snapshot

Iops

Number

Number of I/O operations per second the volume supports

Snapshot Id

String

ID of the snapshot

Volume Size

Number

Size of the volume in GiB

Volume Type

String

Type of volume. Valid values include:

  • standard

  • io1

  • io2

  • gp2

  • sc1

  • st1

gp2

### Launch Permission
FieldTypeDescriptionDefault ValueRequired

Group

String

Name of the group

User Id

String

AWS account ID

### Product Code
FieldTypeDescriptionDefault ValueRequired

Product Code Id

String

Product code ID.

Product Code Type

String

Product code type. Valid values include:

  • devpay

  • marketplace

### Image
FieldTypeDescriptionDefault ValueRequired

Architecture

String

Architecture of the image.

Block Device Mappings

Block device mapping entries.

Creation Date

String

Date and time the image was created.

Description

String

Ena Support

Boolean

If true, enhanced networking with ENA is enabled.

Hypervisor

String

Hypervisor type of the image.

Image Id

String

AMI ID.

Image Location

String

Location of the AMI.

Image Owner Alias

String

AWS account alias, or AWS account ID of the AMI owner.

Image Type

String

Type of image. Valid values include:

  • machine

  • kernel

  • ramdisk

Kernel Id

String

ID of the kernel associated with the image, if applicable.

Name

String

Name of the AMI provided when the image was created.

Owner Id

String

AWS account ID of the image owner.

Platform

String

For Windows AMIs, this value is set to windows, otherwise, it is left blank.

Product Codes

Array of Product Code

Product codes associated with the AMI.

Public

Boolean

If true, the image has public launch permissions; if false, the image has only implicit and explicit launch permissions.

Ramdisk Id

String

ID of the RAM disk associated with the image. This parameter is applicable only to machine image types.

Root Device Name

String

Device name of the root device volume, for example: /dev/sda1.

Root Device Type

String

Type of root device used by the AMI. Valid values include:

  • ebs

  • instance-store

Sriov Net Support

String

Whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

State

String

State of the image.

State Reason

Reason for the state change.

Tags

Array of Tag

Tags associated with the image.

Virtualization Type

String

Type of virtualization of the AMI. Valid values include:

  • hvm

  • paravirtual

### State Reason
FieldTypeDescriptionDefault ValueRequired

Code

String

Reason code for the state change.

Message

String

Message for the state change:

  • Server.InsufficientInstanceCapacity
    There was insufficient capacity available to satisfy the launch request.

  • Server.InternalError
    An internal error caused the instance to terminate during launch.

  • Server.ScheduledStop
    The instance was stopped due to a scheduled retirement.

  • Server.SpotInstanceShutdown
    The instance was stopped because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.

  • Server.SpotInstanceTermination
    The instance was terminated because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.

  • Client.InstanceInitiatedShutdown
    The instance was shut down using the shutdown -h command from the instance.

  • Client.InstanceTerminated
    The instance was terminated or rebooted during AMI creation.

  • Client.InternalError
    Client error caused the instance to terminate during launch.

  • Client.InvalidSnapshot.NotFound
    Specified snapshot was not found.

  • Client.UserInitiatedHibernate
    Hibernation was initiated on the instance.

  • Client.UserInitiatedShutdown
    Instance was shut down using the Amazon EC2 API.

  • Client.VolumeLimitExceeded
    Limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your account limits.

### Instance Attribute
FieldTypeDescriptionDefault ValueRequired

Block Device Mappings

Disable Api Termination

Boolean

If the value is true, the instance can’t be terminated using the Amazon EC2 console, CLI, or API. If the value is false, you can terminate the instance using the Amazon EC2 console, CLI, or API.

Ebs Optimized

Boolean

Whether to optimize the instance for Amazon EBS I/O. This is not available with all instance types, as there additional usage charges associated with using an EBS Optimized instance.

Ena Support

Boolean

If true, enhanced networking with ENA is enabled.

Groups

Instance Id

String

ID of the instance

Instance Initiated Shutdown Behavior

String

Specifies whether to stop or terminate the instance when shutdown is initiated from the instance.

Instance Type

String

Type of instance

Kernel Id

String

ID of the kernel associated with the instance

Product Codes

Array of Product Code

Ramdisk Id

String

ID of the RAM disk associated with the instance

Root Device Name

String

Device name of the root device volume

Source Dest Check

Boolean

A value of true means that source or destination checking is enabled. A value of false means that source or destination checking is disabled. The value must be false for an instance that is launched in a VPC to perform NAT.

Sriov Net Support

String

Whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

User Data

String

User data.

### Instance Block Device Mapping
FieldTypeDescriptionDefault ValueRequired

Device Name

String

Name of the device

Ebs

### EBS Instance Block Device
FieldTypeDescriptionDefault ValueRequired

Attach Time

DateTime

Timestamp for when the attachment was initiated.

Delete On Termination

Boolean

Whether to delete the instance upon termination.

Status

String

State of the attachment. Valid values include:

  • attaching

  • attached

  • detaching

  • detached

Volume Id

String

ID of the volume.

### Instance Status
FieldTypeDescriptionDefault ValueRequired

Availability Zone

String

Availability zone for the instance

Events

Instance Id

String

ID of the instance

Instance State

Instance Status

System Status

### Instance Status Event
FieldTypeDescriptionDefault ValueRequired

Code

String

Code for the event. Valid values include:

  • instance-reboot

  • system-reboot

  • system-maintenance

  • instance-retirement

  • instance-stop

Description

String

Description of the event.

Not After

DateTime

Specifies the latest scheduled time the event can end.

Not Before

DateTime

Specifies the earliest scheduled time the event can start.

### Instance State
FieldTypeDescriptionDefault ValueRequired

Code

Number

16-bit unsigned integer state code of the instance. Valid values include:

  • 0 : pending

  • 16 : running

  • 32 : shutting-down

  • 48 : terminated

  • 64 : stopping

  • 80 : stopped

Name

String

### Instance Status Summary
FieldTypeDescriptionDefault ValueRequired

Details

Status

String

Status of the instance. Valid values include:

  • ok

  • impaired

  • insufficient-data

  • not-applicable

  • initializing

### Instance Status Details
FieldTypeDescriptionDefault ValueRequired

Impaired Since

DateTime

Timestamp of the status check failure.

Name

String

Type of the instance status. Valid value is reachability.

Status

String

Status of the instance. Valid values include:

  • passed

  • failed

  • insufficient-data

  • initializing

### Reservation
FieldTypeDescriptionDefault ValueRequired

Group Names

Array of String

Names of the groups

Groups

Instances

Array of Instance

Owner Id

String

ID of the AWS account that owns the reservation

Requester Id

String

ID of the requester that launched the instances, for example, AWS Management Console

Reservation Id

String

ID of the reservation

### Instance
FieldTypeDescriptionDefault ValueRequired

Ami Launch Index

Number

AMI launch index that to use to find this instance in the launch group

Architecture

String

Image architecture. Valid values include:

  • i386

  • x86_64

  • arm64

Block Device Mappings

Client Token

String

Idempotency token that was provided when the instance was launched

Ebs Optimized

Boolean

Whether to optimize the instance for Amazon EBS I/O. This is not available with all instance types, as there additional usage charges associated with using an EBS Optimized instance.

Ena Support

Boolean

Specifies whether to enable enhanced networking with ENA

Hypervisor

String

Hypervisor type of the instance. Valid values include:

  • ovm

  • xen
    The xen value is used for both Xen and Nitro hypervisors

Iam Instance Profile

Image Id

String

ID of the AMI used to launch the instance

Instance Id

String

ID of the instance

Instance Lifecycle

String

Specifies the lifecycle of the instance. Valid values include:

  • spot

  • scheduled

Instance Type

String

Type of instance. See the Amazon API Reference for valid values.

Kernel Id

String

ID of the kernel associated with the instance

Key Name

String

Name of the key pair associated with the instance

Launch Time

DateTime

Time the instance was launched

Monitoring

String

Monitoring for the instance

Network Interfaces

Placement

Platform

String

Valid value is Windows for instances launched on a Windows platform. Otherwise, leave this value blank.

Private Dns Name

String

For IPv4, this is the private DNS hostname assigned to the instance. The DNS hostname can only be used inside the Amazon EC2 network and is not available until the instance is in the running state.

Private Ip Address

String

Private IPv4 address assigned to the instance

Product Codes

Array of Product Code

Product codes attached to the instance

Public Dns Name

String

Public DNS name

Public Ip Address

String

Public IP address assigned to the instance

Ramdisk Id

String

ID of the RAM disk associated with the instance

Root Device Name

String

Name of the root device volume

Root Device Type

String

Type of the root device used by the AMI. Valid values include:

  • ebs

  • instance-store

Security Groups

Source Dest Check

Boolean

A value of true means that source or destination checking is enabled. A value of false means that source or destination checking is disabled. The value must be false for an instance that is launched in a VPC to perform NAT.

Spot Instance Request Id

String

ID of the request

Sriov Net Support

String

Whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

State

State Reason

State Transition Reason

String

Subnet Id

String

ID of the subnet the instance is running in

Tags

Array of Tag

Virtualization Type

String

Virtualization type of the instance

Vpc Id

String

ID of the VPC the instance is running in

### Instance Network Interface
FieldTypeDescriptionDefault ValueRequired

Association

Attachment

Description

String

Description of the network interface

Groups

Ipv6 Addresses

Array of String

IPv6 addresses associated with the network interface

Mac Address

String

MAC address of the network interface

Network Interface Id

String

ID of the network interface

Owner Id

String

ID of the AWS account that created the network interface

Private Dns Name

String

Name of the private DNS

Private Ip Address

String

IPv4 address of the network interface that is within the subnet

Private Ip Addresses

Source Dest Check

Boolean

A value of true means that source or destination checking is enabled. A value of false means that source or destination checking is disabled. The value must be false for an instance that is launched in a VPC to perform NAT.

Status

String

Network interface status. Valid values are:

  • available

  • associated

  • attaching

  • in-use

  • detaching

Subnet Id

String

ID of the subnet

Vpc Id

String

ID of the VPC

### Instance Network Interface Association
FieldTypeDescriptionDefault ValueRequired

Ip Owner Id

String

ID of the Elastic IP address owner

Public Dns Name

String

Public DNS name

Public Ip

String

Public IP address or Elastic IP address that is bound to the network interface

### Instance Network Interface Attachment
FieldTypeDescriptionDefault ValueRequired

Attach Time

DateTime

Timestamp of when the attachment was initiated

Attachment Id

String

ID of the network interface attachment

Delete On Termination

Boolean

Specifies whether to delete the instance when it’s terminated

Device Index

Number

Index of the device that is on the instance for the network interface attachment

Status

String

State of the attachment

### Instance Private IP Address
FieldTypeDescriptionDefault ValueRequired

Association

Primary

Boolean

If true, designates this IPv4 address as the primary private IP address of the network interface

Private Dns Name

String

Private IPv4 DNS name

Private Ip Address

String

Private IPv4 address of the network interface

### Placement
FieldTypeDescriptionDefault ValueRequired

Affinity

String

Affinity setting for the instance on the dedicated host

Availability Zone

String

Availability Zone of the instance

Group Name

String

Name of the placement group that contains the instance

Host Id

String

ID of the dedicated host

Tenancy

String

Tenancey of the instance, if the instance is running in a VPC

### Key Pair Info
FieldTypeDescriptionDefault ValueRequired

Key Fingerprint

String

SHA-1 digest of the DER encoded private key if CreateKeyPair was used to create the key pair. If ImportKeyPair was used to create the key pair, this is the MD5 public key fingerprint as described in section 4 of RFC4716.

Key Name

String

Name of the key pair

### Move Address Status
FieldTypeDescriptionDefault ValueRequired

Move Status

String

Status of the Elastic IP address to move to the EC2-VPC platform, or to restore to the EC2-Classic platform. Valid values include:

  • movingToVpc

  • restoringToClassic

Public Ip

String

Elastic IP address

### Repeatable In Memory Iterable
FieldTypeDescriptionDefault ValueRequired

Initial Buffer Size

Number

The number of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to Buffer size increment, with an upper limit of maxInMemorySize. Default value is 100 instances.

100

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances.

Max Buffer Size

Number

The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

### Repeatable File Store Iterable
FieldTypeDescriptionDefault ValueRequired

Max in Memory Size

Number

The maximum number of instances to keep in memory. If more than that is required, content starts to buffer on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

### Describe Network Interface Attribute Result
FieldTypeDescriptionDefault ValueRequired

Attachment

Description

String

Description of the network interface

Groups

Network Interface Id

String

ID of the network interface

Source Dest Check

Boolean

A value of true means that source or destination checking is enabled. A value of false means that source or destination checking is disabled. The value must be false for an instance that is launched in a VPC to perform NAT.

### Region
FieldTypeDescriptionDefault ValueRequired

Endpoint

String

Endpoint of the Region service

Region Name

String

Name of the region

### Security Group Reference
FieldTypeDescriptionDefault ValueRequired

Group Id

String

ID of the security group

Referencing Vpc Id

String

ID of the VPC with the referenced security group

Vpc Peering Connection Id

String

ID of the VPC peering connection

### Security Group
FieldTypeDescriptionDefault ValueRequired

Description

String

Description for the security group

Group Id

String

ID of the security group

Group Name

String

Name of the security group

Ip Permissions

Array of IP Permission

Ip Permissions Egress

Array of IP Permission

Owner Id

String

AWS account ID of the security group owner

Tags

Array of Tag

Vpc Id

String

ID of the security group VPC

### Describe Snapshot Attribute Result
FieldTypeDescriptionDefault ValueRequired

Create Volume Permissions

Product Codes

Array of Product Code

Snapshot Id

String

ID of the snapshot

### Create Volume Permission
FieldTypeDescriptionDefault ValueRequired

Group

String

Group to add or remove. Valid value is all.

User Id

String

AWS account ID to add or remove.

### Stale Security Group
FieldTypeDescriptionDefault ValueRequired

Description

String

Description for the security group

Group Id

String

ID of the security group

Group Name

String

Name of the security group

Stale Ip Permissions

Stale Ip Permissions Egress

Vpc Id

String

ID of the security group VPC

### Stale IP Permission
FieldTypeDescriptionDefault ValueRequired

From Port

Number

Start of the port range for the TCP and UDP protocols. Can also be an ICMP type number. A value of -1 indicates all ICMP types.

Ip Protocol

String

IP protocol name for tcip, udp, and icmp, or a protocol number. Does not apply to stale security group rules.

Ip Ranges

Array of String

IP ranges. Does not apply to stale security group rules.

Prefix List Ids

Array of String

Prefix list IDs. Does not apply to stale security group rules.

To Port

Number

End of the port range for the TCP and UDP protocols. Can also be an ICMP type number. A value of -1 indicates all ICMP types.

User Id Group Pairs

### Tag Description
FieldTypeDescriptionDefault ValueRequired

Key

String

Tag key

Resource Id

String

ID of the resource

Resource Type

String

Type of the resource

Value

String

Tag value

### Describe Volume Attribute Result
FieldTypeDescriptionDefault ValueRequired

Auto Enable IO

Boolean

State of the autoEnableIO attribute

Product Codes

Array of Product Code

Volume Id

String

ID of the volume

### Volume Status Item
FieldTypeDescriptionDefault ValueRequired

Actions

Details of the operation

Availability Zone

String

Volume’s availability zone

Events

List of events associated with the volume

Volume Id

String

ID of the volume

Volume Status

Status of the volume

### Volume Status Action
FieldTypeDescriptionDefault ValueRequired

Code

String

Code that identifies the operation

Description

String

Description of the operation

Event Id

String

ID of the event associated with the operation

Event Type

String

Type of event associated with the operation

### Volume Status Event
FieldTypeDescriptionDefault ValueRequired

Description

String

Description of the event

Event Id

String

ID of the event

Event Type

String

Type of event

Not After

DateTime

Timestamp for the latest end time of the event

Not Before

DateTime

Timestamp for the earliest start of the event

### Volume Status Info
FieldTypeDescriptionDefault ValueRequired

Details

Status

String

Intended status of the volume status

### Volume Status Details
FieldTypeDescriptionDefault ValueRequired

Name

String

Name of the volume

Status

String

Status of the volume (ok, impaired, insufficient-data)

### Volume Modification
FieldTypeDescriptionDefault ValueRequired

End Time

DateTime

Completion or failure time of the modification.

Modification State

String

Current state of the modification (modifying, optimizing, completed, failed). For unmodified volumes, the state is null.

Original Iops

Number

Original IOPS rate of the volume.

Original Size

Number

Original size of the volume in G1B.

Original Volume Type

String

Original EBS volume type of the volume.

Progress

Number

Progress of the volume modification from 0 to 100 percent complete.

Start Time

DateTime

Start time of the modification.

Status Message

String

Status message about the modification progress.

Target Iops

Number

Target IOPS rate of the volume.

Target Size

Number

Target size of the volume in GiB.

Target Volume Type

String

Target EBS volume type of the volume.

Volume Id

String

ID of the volume.

### Get Console Output Result
FieldTypeDescriptionDefault ValueRequired

Instance Id

String

ID of the instance

Output

String

Base-64-encoded console output

Timestamp

DateTime

Timestamp of when the output was last updated

### Get Console Screenshot Result
FieldTypeDescriptionDefault ValueRequired

Image Data

String

Data that constitutes the image

Instance Id

String

ID of the instance

### Get Password Data Result
FieldTypeDescriptionDefault ValueRequired

Instance Id

String

ID of the Windows instance

Password Data

String

Password of the instance

Timestamp

DateTime

Timestamp of when the data was last updated

### Import Key Pair Result
FieldTypeDescriptionDefault ValueRequired

Key Fingerprint

String

SHA-1 digest of the DER encoded private key if CreateKeyPair was used to create the key pair. If ImportKeyPair was used to create the key pair, this is the MD5 public key fingerprint as described in section 4 of RFC4716.

Key Name

String

Name of the key pair

### Instance Monitoring
FieldTypeDescriptionDefault ValueRequired

Instance Id

String

ID of the instance

Monitoring

String

Monitoring for the instance

### Move Address To VPC Result
FieldTypeDescriptionDefault ValueRequired

Allocation Id

String

Elastic IP address allocation ID

Status

String

Status for the move of the IP address. Valid values include:

  • MoveInProgress

  • InVpc

  • InClassic

### Restore Address To Classic Result
FieldTypeDescriptionDefault ValueRequired

Public Ip

String

Elastic IP address

Status

String

Status of the IP address move

### Instance State Change
FieldTypeDescriptionDefault ValueRequired

Current State

Instance Id

String

ID of the instance

Previous State

### Unassign IPv6 Addresses Result
FieldTypeDescriptionDefault ValueRequired

Network Interface Id

String

ID of the network interface

Unassigned Ipv6 Addresses

Array of String

IPv6 addresses to unassign from the network interface

## Exception Throw List - 1 - EC2:ACTIVE\_VPC\_PEERING\_CONNECTION\_PER\_VPC\_LIMIT\_EXCEEDED - EC2:ADDRESS\_LIMIT\_EXCEEDED - EC2:ASN\_CONFLICT - EC2:ATTACHMENT\_LIMIT\_EXCEEDED - EC2:AUTH\_FAILURE - EC2:BLOCKED - EC2:BOOT\_FOR\_VOLUME\_TYPE\_UNSUPPORTED - EC2:BUNDLING\_IN\_PROGRESS - EC2:CANNOT\_DELETE - EC2:CIDR\_CONFLICT - EC2:CONCURRENT\_SNAPSHOT\_LIMIT\_EXCEEDED - EC2:CONCURRENT\_TAG\_ACCESS - EC2:CONNECTIVITY - EC2:CUSTOMER\_GATEWAY\_LIMIT\_EXCEEDED - EC2:CUSTOMER\_KEY\_HAS\_BEEN\_REVOKED - EC2:DEFAULT\_VPC\_ALREADY\_EXISTS - EC2:DELETE\_CONVERSION\_TASK\_ERROR - EC2:DEPENDENCY\_VIOLATION - EC2:DISALLOWED\_FOR\_DEDICATED\_TENANCY\_NETWORK - EC2:DISK\_IMAGE\_SIZE\_TOO\_LARGE - EC2:DRY\_RUN\_OPERATION - EC2:EIP\_MIGRATED\_TO\_VPC - EC2:ENCRYPTED\_VOLUMES\_NOT\_SUPPORTED - EC2:FILTER\_LIMIT\_EXCEEDED - EC2:FLEET\_NOT\_IN\_MODIFIABLE\_STATE - EC2:FLOW\_LOG\_ALREADY\_EXISTS - EC2:FLOW\_LOGS\_LIMIT\_EXCEEDED - EC2:GATEWAY\_NOT\_ATTACHED - EC2:HOST\_ALREADY\_COVERED\_BY\_RESERVATION - EC2:HOST\_LIMIT\_EXCEEDED - EC2:IDEMPOTENT\_INSTANCE\_TERMINATED - EC2:IDEMPOTENT\_PARAMETER\_MISMATCH - EC2:INACCESSIBLE\_STORAGE\_LOCATION - EC2:INCOMPATIBLE\_HOST\_REQUIREMENTS - EC2:INCOMPLETE\_SIGNATURE - EC2:INCORRECT\_INSTANCE\_STATE - EC2:INCORRECT\_STATE - EC2:INSTANCE\_ALREADY\_LINKED - EC2:INSTANCE\_LIMIT\_EXCEEDED - EC2:INSUFFICIENT\_ADDRESS\_CAPACITY - EC2:INSUFFICIENT\_CAPACITY - EC2:INSUFFICIENT\_CAPACITY\_ON\_HOST - EC2:INSUFFICIENT\_FREE\_ADDRESSES\_IN\_SUBNET - EC2:INSUFFICIENT\_HOST\_CAPACITY - EC2:INSUFFICIENT\_INSTANCE\_CAPACITY - EC2:INSUFFICIENT\_RESERVED\_INSTANCE\_CAPACITY - EC2:INSUFFICIENT\_RESERVED\_INSTANCES\_CAPACITY - EC2:INTERNAL\_ERROR - EC2:INTERNAL\_FAILURE - EC2:INTERNET\_GATEWAY\_LIMIT\_EXCEEDED - EC2:INVALID\_ACTION - EC2:INVALID\_ADDRESS\_ID\_NOT\_FOUND - EC2:INVALID\_ADDRESS\_LOCKED - EC2:INVALID\_ADDRESS\_MALFORMED - EC2:INVALID\_ADDRESS\_NOT\_FOUND - EC2:INVALID\_AFFINITY - EC2:INVALID\_ALLOCATION\_ID\_NOT\_FOUND - EC2:INVALID\_AMI\_ATTRIBUTE\_ITEM\_VALUE - EC2:INVALID\_AMI\_NAME\_DUPLICATE - EC2:INVALID\_AMI\_NAME\_MALFORMED - EC2:INVALID\_AMIID\_MALFORMED - EC2:INVALID\_AMIID\_NOT\_FOUND - EC2:INVALID\_AMIID\_UNAVAILABLE - EC2:INVALID\_ASSOCIATION\_ID\_NOT\_FOUND - EC2:INVALID\_ATTACHMENT\_ID\_NOT\_FOUND - EC2:INVALID\_ATTACHMENT\_NOT\_FOUND - EC2:INVALID\_AUTO\_PLACEMENT - EC2:INVALID\_AVAILABILITY\_ZONE - EC2:INVALID\_BLOCK\_DEVICE\_MAPPING - EC2:INVALID\_BUNDLE\_ID\_NOT\_FOUND - EC2:INVALID\_CHARACTER - EC2:INVALID\_CIDR\_IN\_USE - EC2:INVALID\_CLIENT\_TOKEN - EC2:INVALID\_CLIENT\_TOKEN\_ID - EC2:INVALID\_CONVERSION\_TASK\_ID - EC2:INVALID\_CONVERSION\_TASK\_ID\_MALFORMED - EC2:INVALID\_CUSTOMER\_GATEWAY\_DUPLICATE\_IP\_ADDRESS - EC2:INVALID\_CUSTOMER\_GATEWAY\_ID\_MALFORMED - EC2:INVALID\_CUSTOMER\_GATEWAY\_ID\_NOT\_FOUND - EC2:INVALID\_CUSTOMER\_GATEWAY\_STATE - EC2:INVALID\_DEVICE\_IN\_USE - EC2:INVALID\_DHCP\_OPTION\_ID\_NOT\_FOUND - EC2:INVALID\_DHCP\_OPTIONS\_ID\_MALFORMED - EC2:INVALID\_DHCP\_OPTIONS\_ID\_NOT\_FOUND - EC2:INVALID\_EXPORT\_TASK\_ID\_NOT\_FOUND - EC2:INVALID\_FILTER - EC2:INVALID\_FLOW\_LOG\_ID\_NOT\_FOUND - EC2:INVALID\_FORMAT - EC2:INVALID\_FPGA\_IMAGE\_ID\_MALFORMED - EC2:INVALID\_FPGA\_IMAGE\_ID\_NOT\_FOUND - EC2:INVALID\_GATEWAY\_ID\_NOT\_FOUND - EC2:INVALID\_GROUP\_DUPLICATE - EC2:INVALID\_GROUP\_ID\_MALFORMED - EC2:INVALID\_GROUP\_IN\_USE - EC2:INVALID\_GROUP\_NOT\_FOUND - EC2:INVALID\_GROUP\_RESERVED - EC2:INVALID\_HOST\_CONFIGURATION - EC2:INVALID\_HOST\_ID - EC2:INVALID\_HOST\_ID\_MALFORMED - EC2:INVALID\_HOST\_ID\_NOT\_FOUND - EC2:INVALID\_HOST\_RESERVATION\_ID\_MALFORMED - EC2:INVALID\_HOST\_RESERVATION\_OFFERING\_ID\_MALFORMED - EC2:INVALID\_HOST\_STATE - EC2:INVALID\_ID - EC2:INVALID\_INPUT - EC2:INVALID\_INSTANCE\_ATTRIBUTE\_VALUE - EC2:INVALID\_INSTANCE\_FAMILY - EC2:INVALID\_INSTANCE\_ID - EC2:INVALID\_INSTANCE\_ID\_MALFORMED - EC2:INVALID\_INSTANCE\_ID\_NOT\_FOUND - EC2:INVALID\_INSTANCE\_ID\_NOT\_LINKABLE - EC2:INVALID\_INSTANCE\_STATE - EC2:INVALID\_INSTANCE\_TYPE - EC2:INVALID\_INTERFACE\_IP\_ADDRESS\_LIMIT\_EXCEEDED - EC2:INVALID\_INTERNET\_GATEWAY\_ID\_MALFORMED - EC2:INVALID\_INTERNET\_GATEWAY\_ID\_NOT\_FOUND - EC2:INVALID\_IP\_ADDRESS\_IN\_USE - EC2:INVALID\_KEY\_FORMAT - EC2:INVALID\_KEY\_PAIR\_DUPLICATE - EC2:INVALID\_KEY\_PAIR\_FORMAT - EC2:INVALID\_KEY\_PAIR\_NOT\_FOUND - EC2:INVALID\_MANIFEST - EC2:INVALID\_MAX\_RESULTS - EC2:INVALID\_NAT\_GATEWAY\_ID\_NOT\_FOUND - EC2:INVALID\_NETWORK\_ACL\_ENTRY\_NOT\_FOUND - EC2:INVALID\_NETWORK\_ACL\_ID\_MALFORMED - EC2:INVALID\_NETWORK\_ACL\_ID\_NOT\_FOUND - EC2:INVALID\_NETWORK\_INTERFACE\_ATTACHMENT\_ID\_MALFORMED - EC2:INVALID\_NETWORK\_INTERFACE\_ID\_MALFORMED - EC2:INVALID\_NETWORK\_INTERFACE\_ID\_NOT\_FOUND - EC2:INVALID\_NETWORK\_INTERFACE\_IN\_USE - EC2:INVALID\_NEXT\_TOKEN - EC2:INVALID\_OPTION\_CONFLICT - EC2:INVALID\_PAGINATION\_TOKEN - EC2:INVALID\_PARAMETER - EC2:INVALID\_PARAMETER\_COMBINATION - EC2:INVALID\_PARAMETER\_VALUE - EC2:INVALID\_PERMISSION\_DUPLICATE - EC2:INVALID\_PERMISSION\_MALFORMED - EC2:INVALID\_PERMISSION\_NOT\_FOUND - EC2:INVALID\_PLACEMENT\_GROUP\_DUPLICATE - EC2:INVALID\_PLACEMENT\_GROUP\_IN\_USE - EC2:INVALID\_PLACEMENT\_GROUP\_UNKNOWN - EC2:INVALID\_POLICY\_DOCUMENT - EC2:INVALID\_PREFIX\_LIST\_ID\_MALFORMED - EC2:INVALID\_PREFIX\_LIST\_ID\_NOT\_FOUND - EC2:INVALID\_PRODUCT\_INFO - EC2:INVALID\_PURCHASE\_TOKEN\_EXPIRED - EC2:INVALID\_PURCHASE\_TOKEN\_MALFORMED - EC2:INVALID\_QUANTITY - EC2:INVALID\_QUERY\_PARAMETER - EC2:INVALID\_REGION - EC2:INVALID\_REQUEST - EC2:INVALID\_RESERVATION\_ID\_MALFORMED - EC2:INVALID\_RESERVATION\_ID\_NOT\_FOUND - EC2:INVALID\_RESERVED\_INSTANCES\_ID - EC2:INVALID\_RESERVED\_INSTANCES\_OFFERING\_ID - EC2:INVALID\_RESOURCE\_TYPE\_UNKNOWN - EC2:INVALID\_ROUTE\_INVALID\_STATE - EC2:INVALID\_ROUTE\_MALFORMED - EC2:INVALID\_ROUTE\_NOT\_FOUND - EC2:INVALID\_ROUTE\_TABLE\_ID\_MALFORMED - EC2:INVALID\_ROUTE\_TABLE\_ID\_NOT\_FOUND - EC2:INVALID\_SCHEDULED\_INSTANCE - EC2:INVALID\_SECURITY\_GROUP\_ID\_NOT\_FOUND - EC2:INVALID\_SECURITY\_REQUEST\_HAS\_EXPIRED - EC2:INVALID\_SERVICE\_NAME - EC2:INVALID\_SNAPSHOT\_ID\_MALFORMED - EC2:INVALID\_SNAPSHOT\_IN\_USE - EC2:INVALID\_SNAPSHOT\_NOT\_FOUND - EC2:INVALID\_SPOT\_DATAFEED\_NOT\_FOUND - EC2:INVALID\_SPOT\_FLEET\_REQUEST\_CONFIG - EC2:INVALID\_SPOT\_FLEET\_REQUEST\_ID\_MALFORMED - EC2:INVALID\_SPOT\_FLEET\_REQUEST\_ID\_NOT\_FOUND - EC2:INVALID\_SPOT\_INSTANCE\_REQUEST\_ID\_MALFORMED - EC2:INVALID\_SPOT\_INSTANCE\_REQUEST\_ID\_NOT\_FOUND - EC2:INVALID\_STATE - EC2:INVALID\_STATE\_TRANSITION - EC2:INVALID\_SUBNET - EC2:INVALID\_SUBNET\_CONFLICT - EC2:INVALID\_SUBNET\_ID\_NOT\_FOUND - EC2:INVALID\_SUBNET\_RANGE - EC2:INVALID\_TARGET\_ARN\_UNKNOWN - EC2:INVALID\_TENANCY - EC2:INVALID\_TIME - EC2:INVALID\_USER\_ID\_MALFORMED - EC2:INVALID\_VOLUME\_ID\_DUPLICATE - EC2:INVALID\_VOLUME\_ID\_MALFORMED - EC2:INVALID\_VOLUME\_ID\_ZONE\_MISMATCH - EC2:INVALID\_VOLUME\_NOT\_FOUND - EC2:INVALID\_VOLUME\_ZONE\_MISMATCH - EC2:INVALID\_VPC\_ENDPOINT\_ID\_MALFORMED - EC2:INVALID\_VPC\_ENDPOINT\_ID\_NOT\_FOUND - EC2:INVALID\_VPC\_ID\_MALFORMED - EC2:INVALID\_VPC\_ID\_NOT\_FOUND - EC2:INVALID\_VPC\_PEERING\_CONNECTION\_ID\_MALFORMED - EC2:INVALID\_VPC\_PEERING\_CONNECTION\_ID\_NOT\_FOUND - EC2:INVALID\_VPC\_PEERING\_CONNECTION\_STATE\_DNS\_HOSTNAMES\_DISABLED - EC2:INVALID\_VPC\_RANGE - EC2:INVALID\_VPC\_STATE - EC2:INVALID\_VPN\_CONNECTION\_ID - EC2:INVALID\_VPN\_CONNECTION\_ID\_NOT\_FOUND - EC2:INVALID\_VPN\_CONNECTION\_INVALID\_STATE - EC2:INVALID\_VPN\_CONNECTION\_INVALID\_TYPE - EC2:INVALID\_VPN\_GATEWAY\_ATTACHMENT\_NOT\_FOUND - EC2:INVALID\_VPN\_GATEWAY\_ID\_NOT\_FOUND - EC2:INVALID\_VPN\_GATEWAY\_STATE - EC2:INVALID\_ZONE\_NOT\_FOUND - EC2:KEY\_PAIR\_LIMIT\_EXCEEDED - EC2:LEGACY\_SECURITY\_GROUP - EC2:LIMIT\_PRICE\_EXCEEDED - EC2:MALFORMED\_QUERY\_STRING - EC2:MAX\_IOPS\_LIMIT\_EXCEEDED - EC2:MAX\_SCHEDULED\_INSTANCE\_CAPACITY\_EXCEEDED - EC2:MAX\_SPOT\_FLEET\_REQUEST\_COUNT\_EXCEEDED - EC2:MAX\_SPOT\_INSTANCE\_COUNT\_EXCEEDED - EC2:MISSING\_ACTION - EC2:MISSING\_AUTHENTICATION\_TOKEN - EC2:MISSING\_INPUT - EC2:MISSING\_PARAMETER - EC2:NAT\_GATEWAY\_LIMIT\_EXCEEDED - EC2:NAT\_GATEWAY\_MALFORMED - EC2:NAT\_GATEWAY\_NOT\_FOUND - EC2:NETWORK\_ACL\_ENTRY\_ALREADY\_EXISTS - EC2:NETWORK\_ACL\_ENTRY\_LIMIT\_EXCEEDED - EC2:NETWORK\_ACL\_LIMIT\_EXCEEDED - EC2:NETWORK\_INTERFACE\_LIMIT\_EXCEEDED - EC2:NO\_SUCH\_VERSION - EC2:NON\_EBS\_INSTANCE - EC2:NOT\_EXPORTABLE - EC2:OPERATION\_NOT\_PERMITTED - EC2:OPT\_IN\_REQUIRED - EC2:OUTSTANDING\_VPC\_PEERING\_CONNECTION\_LIMIT\_EXCEEDED - EC2:PENDING\_SNAPSHOT\_LIMIT\_EXCEEDED - EC2:PENDING\_VERIFICATION - EC2:PENDING\_VPC\_PEERING\_CONNECTION\_LIMIT\_EXCEEDED - EC2:PLACEMENT\_GROUP\_LIMIT\_EXCEEDED - EC2:PRIVATE\_IP\_ADDRESS\_LIMIT\_EXCEEDED - EC2:REQUEST\_EXPIRED - EC2:REQUEST\_LIMIT\_EXCEEDED - EC2:REQUEST\_RESOURCE\_COUNT\_EXCEEDED - EC2:RESERVED\_INSTANCES\_COUNT\_EXCEEDED - EC2:RESERVED\_INSTANCES\_LIMIT\_EXCEEDED - EC2:RESERVED\_INSTANCES\_UNAVAILABLE - EC2:RESOURCE\_ALREADY\_ASSIGNED - EC2:RESOURCE\_ALREADY\_ASSOCIATED - EC2:RESOURCE\_COUNT\_EXCEEDED - EC2:RESOURCE\_COUNT\_LIMIT\_EXCEEDED - EC2:RESOURCE\_LIMIT\_EXCEEDED - EC2:RETRY\_EXHAUSTED - EC2:ROUTE\_ALREADY\_EXISTS - EC2:ROUTE\_LIMIT\_EXCEEDED - EC2:ROUTE\_TABLE\_LIMIT\_EXCEEDED - EC2:RULES\_PER\_SECURITY\_GROUP\_LIMIT\_EXCEEDED - EC2:SCHEDULED\_INSTANCE\_LIMIT\_EXCEEDED - EC2:SCHEDULED\_INSTANCE\_PARAMETER\_MISMATCH - EC2:SCHEDULED\_INSTANCE\_SLOT\_NOT\_OPEN - EC2:SCHEDULED\_INSTANCE\_SLOT\_UNAVAILABLE - EC2:SECURITY\_GROUP\_LIMIT\_EXCEEDED - EC2:SECURITY\_GROUPS\_PER\_INSTANCE\_LIMIT\_EXCEEDED - EC2:SECURITY\_GROUPS\_PER\_INTERFACE\_LIMIT\_EXCEEDED - EC2:SERVICE\_UNAVAILABLE - EC2:SIGNATURE\_DOES\_NOT\_MATCH - EC2:SNAPSHOT\_COPY\_UNSUPPORTED\_INTER\_REGION - EC2:SNAPSHOT\_CREATION\_PER\_VOLUME\_RATE\_EXCEEDED - EC2:SNAPSHOT\_LIMIT\_EXCEEDED - EC2:SUBNET\_LIMIT\_EXCEEDED - EC2:TAG\_LIMIT\_EXCEEDED - EC2:UNAUTHORIZED\_OPERATION - EC2:UNAVAILABLE - EC2:UNAVAILABLE\_HOST\_REQUIREMENTS - EC2:UNKNOWN - EC2:UNKNOWN\_PARAMETER - EC2:UNKNOWN\_PRINCIPAL\_TYPE\_UNSUPPORTED - EC2:UNKNOWN\_VOLUME\_TYPE - EC2:UNSUPPORTED - EC2:UNSUPPORTED\_HOST\_CONFIGURATION - EC2:UNSUPPORTED\_INSTANCE\_ATTRIBUTE - EC2:UNSUPPORTED\_INSTANCE\_TYPE\_ON\_HOST - EC2:UNSUPPORTED\_OPERATION - EC2:UNSUPPORTED\_PROTOCOL - EC2:UNSUPPORTED\_TENANCY - EC2:VALIDATION\_ERROR - EC2:VOLUME\_IN\_USE - EC2:VOLUME\_IOPS\_LIMIT - EC2:VOLUME\_LIMIT\_EXCEEDED - EC2:VOLUME\_TYPE\_NOT\_AVAILABLE\_IN\_ZONE - EC2:VPC\_CIDR\_CONFLICT - EC2:VPC\_ENDPOINT\_LIMIT\_EXCEEDED - EC2:VPC\_ID\_NOT\_SPECIFIED - EC2:VPC\_LIMIT\_EXCEEDED - EC2:VPC\_PEERING\_CONNECTION\_ALREADY\_EXISTS - EC2:VPC\_PEERING\_CONNECTIONS\_PER\_VPC\_LIMIT\_EXCEEDED - EC2:VPC\_RESOURCE\_NOT\_SPECIFIED - EC2:VPN\_CONNECTION\_LIMIT\_EXCEEDED - EC2:VPN\_GATEWAY\_ATTACHMENT\_LIMIT\_EXCEEDED - EC2:VPN\_GATEWAY\_LIMIT\_EXCEEDED - EC2:ZONES\_MISMATCHED ## Exception Throw List - 2 - EC2:ACTIVE\_VPC\_PEERING\_CONNECTION\_PER\_VPC\_LIMIT\_EXCEEDED - EC2:ADDRESS\_LIMIT\_EXCEEDED - EC2:ASN\_CONFLICT - EC2:ATTACHMENT\_LIMIT\_EXCEEDED - EC2:AUTH\_FAILURE - EC2:BLOCKED - EC2:BOOT\_FOR\_VOLUME\_TYPE\_UNSUPPORTED - EC2:BUNDLING\_IN\_PROGRESS - EC2:CANNOT\_DELETE - EC2:CIDR\_CONFLICT - EC2:CONCURRENT\_SNAPSHOT\_LIMIT\_EXCEEDED - EC2:CONCURRENT\_TAG\_ACCESS - EC2:CUSTOMER\_GATEWAY\_LIMIT\_EXCEEDED - EC2:CUSTOMER\_KEY\_HAS\_BEEN\_REVOKED - EC2:DEFAULT\_VPC\_ALREADY\_EXISTS - EC2:DELETE\_CONVERSION\_TASK\_ERROR - EC2:DEPENDENCY\_VIOLATION - EC2:DISALLOWED\_FOR\_DEDICATED\_TENANCY\_NETWORK - EC2:DISK\_IMAGE\_SIZE\_TOO\_LARGE - EC2:DRY\_RUN\_OPERATION - EC2:EIP\_MIGRATED\_TO\_VPC - EC2:ENCRYPTED\_VOLUMES\_NOT\_SUPPORTED - EC2:FILTER\_LIMIT\_EXCEEDED - EC2:FLEET\_NOT\_IN\_MODIFIABLE\_STATE - EC2:FLOW\_LOG\_ALREADY\_EXISTS - EC2:FLOW\_LOGS\_LIMIT\_EXCEEDED - EC2:GATEWAY\_NOT\_ATTACHED - EC2:HOST\_ALREADY\_COVERED\_BY\_RESERVATION - EC2:HOST\_LIMIT\_EXCEEDED - EC2:IDEMPOTENT\_INSTANCE\_TERMINATED - EC2:IDEMPOTENT\_PARAMETER\_MISMATCH - EC2:INACCESSIBLE\_STORAGE\_LOCATION - EC2:INCOMPATIBLE\_HOST\_REQUIREMENTS - EC2:INCOMPLETE\_SIGNATURE - EC2:INCORRECT\_INSTANCE\_STATE - EC2:INCORRECT\_STATE - EC2:INSTANCE\_ALREADY\_LINKED - EC2:INSTANCE\_LIMIT\_EXCEEDED - EC2:INSUFFICIENT\_ADDRESS\_CAPACITY - EC2:INSUFFICIENT\_CAPACITY - EC2:INSUFFICIENT\_CAPACITY\_ON\_HOST - EC2:INSUFFICIENT\_FREE\_ADDRESSES\_IN\_SUBNET - EC2:INSUFFICIENT\_HOST\_CAPACITY - EC2:INSUFFICIENT\_INSTANCE\_CAPACITY - EC2:INSUFFICIENT\_RESERVED\_INSTANCE\_CAPACITY - EC2:INSUFFICIENT\_RESERVED\_INSTANCES\_CAPACITY - EC2:INTERNAL\_ERROR - EC2:INTERNAL\_FAILURE - EC2:INTERNET\_GATEWAY\_LIMIT\_EXCEEDED - EC2:INVALID\_ACTION - EC2:INVALID\_ADDRESS\_ID\_NOT\_FOUND - EC2:INVALID\_ADDRESS\_LOCKED - EC2:INVALID\_ADDRESS\_MALFORMED - EC2:INVALID\_ADDRESS\_NOT\_FOUND - EC2:INVALID\_AFFINITY - EC2:INVALID\_ALLOCATION\_ID\_NOT\_FOUND - EC2:INVALID\_AMI\_ATTRIBUTE\_ITEM\_VALUE - EC2:INVALID\_AMI\_NAME\_DUPLICATE - EC2:INVALID\_AMI\_NAME\_MALFORMED - EC2:INVALID\_AMIID\_MALFORMED - EC2:INVALID\_AMIID\_NOT\_FOUND - EC2:INVALID\_AMIID\_UNAVAILABLE - EC2:INVALID\_ASSOCIATION\_ID\_NOT\_FOUND - EC2:INVALID\_ATTACHMENT\_ID\_NOT\_FOUND - EC2:INVALID\_ATTACHMENT\_NOT\_FOUND - EC2:INVALID\_AUTO\_PLACEMENT - EC2:INVALID\_AVAILABILITY\_ZONE - EC2:INVALID\_BLOCK\_DEVICE\_MAPPING - EC2:INVALID\_BUNDLE\_ID\_NOT\_FOUND - EC2:INVALID\_CHARACTER - EC2:INVALID\_CIDR\_IN\_USE - EC2:INVALID\_CLIENT\_TOKEN - EC2:INVALID\_CLIENT\_TOKEN\_ID - EC2:INVALID\_CONVERSION\_TASK\_ID - EC2:INVALID\_CONVERSION\_TASK\_ID\_MALFORMED - EC2:INVALID\_CUSTOMER\_GATEWAY\_DUPLICATE\_IP\_ADDRESS - EC2:INVALID\_CUSTOMER\_GATEWAY\_ID\_MALFORMED - EC2:INVALID\_CUSTOMER\_GATEWAY\_ID\_NOT\_FOUND - EC2:INVALID\_CUSTOMER\_GATEWAY\_STATE - EC2:INVALID\_DEVICE\_IN\_USE - EC2:INVALID\_DHCP\_OPTION\_ID\_NOT\_FOUND - EC2:INVALID\_DHCP\_OPTIONS\_ID\_MALFORMED - EC2:INVALID\_DHCP\_OPTIONS\_ID\_NOT\_FOUND - EC2:INVALID\_EXPORT\_TASK\_ID\_NOT\_FOUND - EC2:INVALID\_FILTER - EC2:INVALID\_FLOW\_LOG\_ID\_NOT\_FOUND - EC2:INVALID\_FORMAT - EC2:INVALID\_FPGA\_IMAGE\_ID\_MALFORMED - EC2:INVALID\_FPGA\_IMAGE\_ID\_NOT\_FOUND - EC2:INVALID\_GATEWAY\_ID\_NOT\_FOUND - EC2:INVALID\_GROUP\_DUPLICATE - EC2:INVALID\_GROUP\_ID\_MALFORMED - EC2:INVALID\_GROUP\_IN\_USE - EC2:INVALID\_GROUP\_NOT\_FOUND - EC2:INVALID\_GROUP\_RESERVED - EC2:INVALID\_HOST\_CONFIGURATION - EC2:INVALID\_HOST\_ID - EC2:INVALID\_HOST\_ID\_MALFORMED - EC2:INVALID\_HOST\_ID\_NOT\_FOUND - EC2:INVALID\_HOST\_RESERVATION\_ID\_MALFORMED - EC2:INVALID\_HOST\_RESERVATION\_OFFERING\_ID\_MALFORMED - EC2:INVALID\_HOST\_STATE - EC2:INVALID\_ID - EC2:INVALID\_INPUT - EC2:INVALID\_INSTANCE\_ATTRIBUTE\_VALUE - EC2:INVALID\_INSTANCE\_FAMILY - EC2:INVALID\_INSTANCE\_ID - EC2:INVALID\_INSTANCE\_ID\_MALFORMED - EC2:INVALID\_INSTANCE\_ID\_NOT\_FOUND - EC2:INVALID\_INSTANCE\_ID\_NOT\_LINKABLE - EC2:INVALID\_INSTANCE\_STATE - EC2:INVALID\_INSTANCE\_TYPE - EC2:INVALID\_INTERFACE\_IP\_ADDRESS\_LIMIT\_EXCEEDED - EC2:INVALID\_INTERNET\_GATEWAY\_ID\_MALFORMED - EC2:INVALID\_INTERNET\_GATEWAY\_ID\_NOT\_FOUND - EC2:INVALID\_IP\_ADDRESS\_IN\_USE - EC2:INVALID\_KEY\_FORMAT - EC2:INVALID\_KEY\_PAIR\_DUPLICATE - EC2:INVALID\_KEY\_PAIR\_FORMAT - EC2:INVALID\_KEY\_PAIR\_NOT\_FOUND - EC2:INVALID\_MANIFEST - EC2:INVALID\_MAX\_RESULTS - EC2:INVALID\_NAT\_GATEWAY\_ID\_NOT\_FOUND - EC2:INVALID\_NETWORK\_ACL\_ENTRY\_NOT\_FOUND - EC2:INVALID\_NETWORK\_ACL\_ID\_MALFORMED - EC2:INVALID\_NETWORK\_ACL\_ID\_NOT\_FOUND - EC2:INVALID\_NETWORK\_INTERFACE\_ATTACHMENT\_ID\_MALFORMED - EC2:INVALID\_NETWORK\_INTERFACE\_ID\_MALFORMED - EC2:INVALID\_NETWORK\_INTERFACE\_ID\_NOT\_FOUND - EC2:INVALID\_NETWORK\_INTERFACE\_IN\_USE - EC2:INVALID\_NEXT\_TOKEN - EC2:INVALID\_OPTION\_CONFLICT - EC2:INVALID\_PAGINATION\_TOKEN - EC2:INVALID\_PARAMETER - EC2:INVALID\_PARAMETER\_COMBINATION - EC2:INVALID\_PARAMETER\_VALUE - EC2:INVALID\_PERMISSION\_DUPLICATE - EC2:INVALID\_PERMISSION\_MALFORMED - EC2:INVALID\_PERMISSION\_NOT\_FOUND - EC2:INVALID\_PLACEMENT\_GROUP\_DUPLICATE - EC2:INVALID\_PLACEMENT\_GROUP\_IN\_USE - EC2:INVALID\_PLACEMENT\_GROUP\_UNKNOWN - EC2:INVALID\_POLICY\_DOCUMENT - EC2:INVALID\_PREFIX\_LIST\_ID\_MALFORMED - EC2:INVALID\_PREFIX\_LIST\_ID\_NOT\_FOUND - EC2:INVALID\_PRODUCT\_INFO - EC2:INVALID\_PURCHASE\_TOKEN\_EXPIRED - EC2:INVALID\_PURCHASE\_TOKEN\_MALFORMED - EC2:INVALID\_QUANTITY - EC2:INVALID\_QUERY\_PARAMETER - EC2:INVALID\_REGION - EC2:INVALID\_REQUEST - EC2:INVALID\_RESERVATION\_ID\_MALFORMED - EC2:INVALID\_RESERVATION\_ID\_NOT\_FOUND - EC2:INVALID\_RESERVED\_INSTANCES\_ID - EC2:INVALID\_RESERVED\_INSTANCES\_OFFERING\_ID - EC2:INVALID\_RESOURCE\_TYPE\_UNKNOWN - EC2:INVALID\_ROUTE\_INVALID\_STATE - EC2:INVALID\_ROUTE\_MALFORMED - EC2:INVALID\_ROUTE\_NOT\_FOUND - EC2:INVALID\_ROUTE\_TABLE\_ID\_MALFORMED - EC2:INVALID\_ROUTE\_TABLE\_ID\_NOT\_FOUND - EC2:INVALID\_SCHEDULED\_INSTANCE - EC2:INVALID\_SECURITY\_GROUP\_ID\_NOT\_FOUND - EC2:INVALID\_SECURITY\_REQUEST\_HAS\_EXPIRED - EC2:INVALID\_SERVICE\_NAME - EC2:INVALID\_SNAPSHOT\_ID\_MALFORMED - EC2:INVALID\_SNAPSHOT\_IN\_USE - EC2:INVALID\_SNAPSHOT\_NOT\_FOUND - EC2:INVALID\_SPOT\_DATAFEED\_NOT\_FOUND - EC2:INVALID\_SPOT\_FLEET\_REQUEST\_CONFIG - EC2:INVALID\_SPOT\_FLEET\_REQUEST\_ID\_MALFORMED - EC2:INVALID\_SPOT\_FLEET\_REQUEST\_ID\_NOT\_FOUND - EC2:INVALID\_SPOT\_INSTANCE\_REQUEST\_ID\_MALFORMED - EC2:INVALID\_SPOT\_INSTANCE\_REQUEST\_ID\_NOT\_FOUND - EC2:INVALID\_STATE - EC2:INVALID\_STATE\_TRANSITION - EC2:INVALID\_SUBNET - EC2:INVALID\_SUBNET\_CONFLICT - EC2:INVALID\_SUBNET\_ID\_NOT\_FOUND - EC2:INVALID\_SUBNET\_RANGE - EC2:INVALID\_TARGET\_ARN\_UNKNOWN - EC2:INVALID\_TENANCY - EC2:INVALID\_TIME - EC2:INVALID\_USER\_ID\_MALFORMED - EC2:INVALID\_VOLUME\_ID\_DUPLICATE - EC2:INVALID\_VOLUME\_ID\_MALFORMED - EC2:INVALID\_VOLUME\_ID\_ZONE\_MISMATCH - EC2:INVALID\_VOLUME\_NOT\_FOUND - EC2:INVALID\_VOLUME\_ZONE\_MISMATCH - EC2:INVALID\_VPC\_ENDPOINT\_ID\_MALFORMED - EC2:INVALID\_VPC\_ENDPOINT\_ID\_NOT\_FOUND - EC2:INVALID\_VPC\_ID\_MALFORMED - EC2:INVALID\_VPC\_ID\_NOT\_FOUND - EC2:INVALID\_VPC\_PEERING\_CONNECTION\_ID\_MALFORMED - EC2:INVALID\_VPC\_PEERING\_CONNECTION\_ID\_NOT\_FOUND - EC2:INVALID\_VPC\_PEERING\_CONNECTION\_STATE\_DNS\_HOSTNAMES\_DISABLED - EC2:INVALID\_VPC\_RANGE - EC2:INVALID\_VPC\_STATE - EC2:INVALID\_VPN\_CONNECTION\_ID - EC2:INVALID\_VPN\_CONNECTION\_ID\_NOT\_FOUND - EC2:INVALID\_VPN\_CONNECTION\_INVALID\_STATE - EC2:INVALID\_VPN\_CONNECTION\_INVALID\_TYPE - EC2:INVALID\_VPN\_GATEWAY\_ATTACHMENT\_NOT\_FOUND - EC2:INVALID\_VPN\_GATEWAY\_ID\_NOT\_FOUND - EC2:INVALID\_VPN\_GATEWAY\_STATE - EC2:INVALID\_ZONE\_NOT\_FOUND - EC2:KEY\_PAIR\_LIMIT\_EXCEEDED - EC2:LEGACY\_SECURITY\_GROUP - EC2:LIMIT\_PRICE\_EXCEEDED - EC2:MALFORMED\_QUERY\_STRING - EC2:MAX\_IOPS\_LIMIT\_EXCEEDED - EC2:MAX\_SCHEDULED\_INSTANCE\_CAPACITY\_EXCEEDED - EC2:MAX\_SPOT\_FLEET\_REQUEST\_COUNT\_EXCEEDED - EC2:MAX\_SPOT\_INSTANCE\_COUNT\_EXCEEDED - EC2:MISSING\_ACTION - EC2:MISSING\_AUTHENTICATION\_TOKEN - EC2:MISSING\_INPUT - EC2:MISSING\_PARAMETER - EC2:NAT\_GATEWAY\_LIMIT\_EXCEEDED - EC2:NAT\_GATEWAY\_MALFORMED - EC2:NAT\_GATEWAY\_NOT\_FOUND - EC2:NETWORK\_ACL\_ENTRY\_ALREADY\_EXISTS - EC2:NETWORK\_ACL\_ENTRY\_LIMIT\_EXCEEDED - EC2:NETWORK\_ACL\_LIMIT\_EXCEEDED - EC2:NETWORK\_INTERFACE\_LIMIT\_EXCEEDED - EC2:NO\_SUCH\_VERSION - EC2:NON\_EBS\_INSTANCE - EC2:NOT\_EXPORTABLE - EC2:OPERATION\_NOT\_PERMITTED - EC2:OPT\_IN\_REQUIRED - EC2:OUTSTANDING\_VPC\_PEERING\_CONNECTION\_LIMIT\_EXCEEDED - EC2:PENDING\_SNAPSHOT\_LIMIT\_EXCEEDED - EC2:PENDING\_VERIFICATION - EC2:PENDING\_VPC\_PEERING\_CONNECTION\_LIMIT\_EXCEEDED - EC2:PLACEMENT\_GROUP\_LIMIT\_EXCEEDED - EC2:PRIVATE\_IP\_ADDRESS\_LIMIT\_EXCEEDED - EC2:REQUEST\_EXPIRED - EC2:REQUEST\_LIMIT\_EXCEEDED - EC2:REQUEST\_RESOURCE\_COUNT\_EXCEEDED - EC2:RESERVED\_INSTANCES\_COUNT\_EXCEEDED - EC2:RESERVED\_INSTANCES\_LIMIT\_EXCEEDED - EC2:RESERVED\_INSTANCES\_UNAVAILABLE - EC2:RESOURCE\_ALREADY\_ASSIGNED - EC2:RESOURCE\_ALREADY\_ASSOCIATED - EC2:RESOURCE\_COUNT\_EXCEEDED - EC2:RESOURCE\_COUNT\_LIMIT\_EXCEEDED - EC2:RESOURCE\_LIMIT\_EXCEEDED - EC2:ROUTE\_ALREADY\_EXISTS - EC2:ROUTE\_LIMIT\_EXCEEDED - EC2:ROUTE\_TABLE\_LIMIT\_EXCEEDED - EC2:RULES\_PER\_SECURITY\_GROUP\_LIMIT\_EXCEEDED - EC2:SCHEDULED\_INSTANCE\_LIMIT\_EXCEEDED - EC2:SCHEDULED\_INSTANCE\_PARAMETER\_MISMATCH - EC2:SCHEDULED\_INSTANCE\_SLOT\_NOT\_OPEN - EC2:SCHEDULED\_INSTANCE\_SLOT\_UNAVAILABLE - EC2:SECURITY\_GROUP\_LIMIT\_EXCEEDED - EC2:SECURITY\_GROUPS\_PER\_INSTANCE\_LIMIT\_EXCEEDED - EC2:SECURITY\_GROUPS\_PER\_INTERFACE\_LIMIT\_EXCEEDED - EC2:SERVICE\_UNAVAILABLE - EC2:SIGNATURE\_DOES\_NOT\_MATCH - EC2:SNAPSHOT\_COPY\_UNSUPPORTED\_INTER\_REGION - EC2:SNAPSHOT\_CREATION\_PER\_VOLUME\_RATE\_EXCEEDED - EC2:SNAPSHOT\_LIMIT\_EXCEEDED - EC2:SUBNET\_LIMIT\_EXCEEDED - EC2:TAG\_LIMIT\_EXCEEDED - EC2:UNAUTHORIZED\_OPERATION - EC2:UNAVAILABLE - EC2:UNAVAILABLE\_HOST\_REQUIREMENTS - EC2:UNKNOWN - EC2:UNKNOWN\_PARAMETER - EC2:UNKNOWN\_PRINCIPAL\_TYPE\_UNSUPPORTED - EC2:UNKNOWN\_VOLUME\_TYPE - EC2:UNSUPPORTED - EC2:UNSUPPORTED\_HOST\_CONFIGURATION - EC2:UNSUPPORTED\_INSTANCE\_ATTRIBUTE - EC2:UNSUPPORTED\_INSTANCE\_TYPE\_ON\_HOST - EC2:UNSUPPORTED\_OPERATION - EC2:UNSUPPORTED\_PROTOCOL - EC2:UNSUPPORTED\_TENANCY - EC2:VALIDATION\_ERROR - EC2:VOLUME\_IN\_USE - EC2:VOLUME\_IOPS\_LIMIT - EC2:VOLUME\_LIMIT\_EXCEEDED - EC2:VOLUME\_TYPE\_NOT\_AVAILABLE\_IN\_ZONE - EC2:VPC\_CIDR\_CONFLICT - EC2:VPC\_ENDPOINT\_LIMIT\_EXCEEDED - EC2:VPC\_ID\_NOT\_SPECIFIED - EC2:VPC\_LIMIT\_EXCEEDED - EC2:VPC\_PEERING\_CONNECTION\_ALREADY\_EXISTS - EC2:VPC\_PEERING\_CONNECTIONS\_PER\_VPC\_LIMIT\_EXCEEDED - EC2:VPC\_RESOURCE\_NOT\_SPECIFIED - EC2:VPN\_CONNECTION\_LIMIT\_EXCEEDED - EC2:VPN\_GATEWAY\_ATTACHMENT\_LIMIT\_EXCEEDED - EC2:VPN\_GATEWAY\_LIMIT\_EXCEEDED - EC2:ZONES\_MISMATCHED ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Amazon EC2 Connector version: 2.5 --- # Amazon EC2 Connector 2.5 XML and Maven Support > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Studio: - If you manually code a Mule runtime engine (Mule) app in XML, either from the Anypoint Studio XML editor or from a text editor, you can access the connector from your app by adding reference statements to both your XML Mule flow and the Apache Maven `pom.xml` file. - If you add the connector in Studio, Studio automatically populates the XML code with the connector’s namespace and schema location and it also adds a dependency to the `pom.xml` file. ## Add a Namespace for the Connector 1. Include the Amazon EC2 namespace and schema location in your configuration file. Namespace: `http://www.mulesoft.org/schema/mule/ec2` Schema Location: `http://www.mulesoft.org/schema/mule/ec2/current/mule-ec2.xsd` These statements appear in the `` block that starts a Mule app: ```xml ``` 2. Create a global Amazon EC2 configuration outside your flows, using the following global configuration code: ```xml ``` ## Add a POM File Dependency The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app. If you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to this connector: ```xml com.mulesoft.connectors mule-amazon-ec2-connector x.x.x mule-plugin ``` Replace `x.x.x` with the version that corresponds to the connector you are using. To obtain the most up-to-date `pom.xml` file information: 1. Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/). 2. In Exchange, click **Login** and supply your Anypoint Platform username and password. 3. In Exchange, search for `amazon ec2`. 4. Select **Amazon EC2 Connector**. 5. Click **Dependency Snippets** near the upper right of the screen. ## Next Step After completing your namespace and `pom.xml` file, you can try the [Examples](https://docs.mulesoft.com/amazon-ec2-connector/2.5/amazon-ec2-connector-examples). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Amazon EC2 Connector version: 3.0 is-latest-version: true --- # Amazon EC2 Connector 3.0 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Amazon EC2 (Amazon EC2 Connector) provides connectivity to the Amazon Elastic Compute Cloud (Amazon EC2) API, enabling you to interface with Amazon EC2 to launch as many or as few virtual servers as you need, configure security and networking, and manage storage. ## Before You Begin To use Amazon EC2 Connector, you must be familiar with: - The Amazon EC2 API - Anypoint Connectors - Mule runtime engine (Mule) - Elements and global elements in a Mule flow - Creating a Mule app using Anypoint Studio or Anypoint Code Builder Before creating an app, you must have: - AWS Identity and Access Management (IAM) user account credentials - A secret access key to IAM - Access to EC2 via the AWS cloud ## Common Use Cases for the Connector Common use cases for the connector include: - Creating an EBS volume to attach to an instance in the same availability zone - Attaching an EBS volume to a running or stopped Amazon EC2 instance - Restarting an Amazon EBS-backed AMI that you’ve previously stopped - Stopping an Amazon EC2 instance ## Audience - New users, read: - [Using Anypoint Studio to Configure the Connector](https://docs.mulesoft.com/amazon-ec2-connector/latest/amazon-ec2-connector-studio) to create your Mule app - [Examples](https://docs.mulesoft.com/amazon-ec2-connector/latest/amazon-ec2-connector-examples), which provide one or more use cases for the connector - Advanced users, read: - [XML and Maven Support](https://docs.mulesoft.com/amazon-ec2-connector/latest/amazon-ec2-connector-xml-maven) - [Examples](https://docs.mulesoft.com/amazon-ec2-connector/latest/amazon-ec2-connector-examples), which provides one or more use cases for the connector ## Authentication Types Amazon EC2 Connector connections use the following authentication types: - Basic Uses a session token provided by Amazon STS to connect to Amazon EC2 - Role Uses the Amazon role ARN that uniquely identifies the role to allow cross-account access For information about configuring these authentication types, see [Using Anypoint Studio to Configure Amazon EC2](https://docs.mulesoft.com/amazon-ec2-connector/latest/amazon-ec2-connector-studio). ## Next Step After you complete the prerequisites and try the examples, you are ready to create your own app and configure the connector using [Using Anypoint Studio to Configure Amazon EC2 Connector](https://docs.mulesoft.com/amazon-ec2-connector/latest/amazon-ec2-connector-studio). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [Amazon EC2 Connector Reference](https://docs.mulesoft.com/amazon-ec2-connector/latest/amazon-ec2-connector-reference) - [Salesforce Help](https://help.salesforce.com) --- product: Amazon EC2 Connector version: 3.0 is-latest-version: true --- # Amazon EC2 Connector 3.0 Example > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This example creates an Amazon EBS (Elastic Block Store) volume that you can attach to an Amazon EC2 instance that is in the same availability zone as the volume. The example includes configuring global elements for Anypoint Connector for Amazon EC2 (Amazon EC2 Connector), configuring additional properties such as volume size and type, configuring the **Set Payload** component, adding and configuring the **Logger** component, and testing your application’s use of the connector. The following image shows the Mule flow for this example: ![Flow for creating an EBS volume](/mulesoft/current/en-us/amazon-ec2-connector/latest/_images/amazon-ec2-create-volume-usecase-flow.png) This example uses variables for some field values. You can either: - Replace the variables with their values in the code. - Provide the values for each variable in a properties file and then refer to that file from the connector configuration. If you don’t know how to use a properties file, see [Configuring Property Placeholders](https://docs.mulesoft.com/mule-runtime/latest/mule-app-properties-to-configure). ## Configure Global Elements for the Connector 1. Create a new Mule project in Anypoint Studio. 2. Create a file named `mule-artifact.properties` to store your Amazon credentials. 3. Add the following properties to the `mule-artifact.properties` file: ```text amazon.accesskey= amazon.secretkey= amazon.region= amazon.sessionToken= ``` 4. Save the `mule-artifact.properties` file in the project’s `src/main/resources` directory. 5. Drag the **HTTP Listener** component to the canvas. 6. Add a global element for **HTTP Listener**: 1. Select **Listener** on the canvas. 2. In the configuration screen for the operation, click the plus sign (**+**) next to the **Connector configuration** field to access the global element configuration fields. 3. In the **Global Element Properties** dialog, provide the following values: - **Name** `Listener` - **Host** `localhost` - **Port** `8081` The following image shows an example of the **HTTP Listener** global element configuration: ![Global element configuration for HTTP Listener](/mulesoft/current/en-us/amazon-ec2-connector/latest/_images/http-listener-config.png) 4. Click **OK**. 7. Drag the Amazon EC2 Connector **Create volume** operation next to the **Listener** component. 8. Add a new Amazon EC2 global element: 1. Select the **Create volume** operation on the canvas. 2. In the configuration screen for the operation, click the plus sign (**+**) next to the **Connector configuration** field to access the global element configuration fields. 9. Configure the global element as follows: - **Name** `Amazon EC2 Configuration` - **Session Token** Session token used to validate the temporary security credentials - **Access Key** Alphanumeric text string that uniquely identifies the user who owns the account - **Secret Key** Key that acts as the password - **Region Endpoint** Region to select from the drop-down menu for the Amazon EC2 client The following image shows an example of what the configuration looks like: ![EC2 global configuration](/mulesoft/current/en-us/amazon-ec2-connector/latest/_images/mule-amazon-ec2-global-config.png) The corresponding XML looks like this: ```xml ``` 10. Click **Test Connection** to confirm that Mule can connect with the Amazon EC2 instance. 11. If the connection is successful, click **OK** to save the configurations. Otherwise, review or correct any incorrect parameters, then test again. ## Configure Additional Properties 1. Select the **Create volume** operation on the Studio canvas. 2. In the **General** tab, enter the following values: 1. Enter a value for **Display Name**. This example uses `Create volume`. 2. In the **Basic Settings** section, select the name of the Amazon EC2 configuration you created in [Configure Global Elements for the Connector](https://docs.mulesoft.com/amazon-ec2-connector/latest/amazon-ec2-connector-studio). 3. In the **General** section, enter values for the following fields: - **Availability Zone** Amazon availability zone you have access to. This example uses `us-east-1a`. - **Size** Size of the volume in gibibytes (GiBs). This example uses `5`. - **Volume Type** The default volume type is **Standard**. ![Publish message connector props](/mulesoft/current/en-us/amazon-ec2-connector/latest/_images/amazon-ec2-create-volume-props.png) 3. Verify that your XML looks like this: ```xml ``` ## Configure the Set Payload Component 1. In the **Mule Palette** view, select **Set Payload** and drag it to the right of the Amazon EC2 **Create volume** operation. The **Set Payload** transformer sends the response to the client in the browser. 2. In the canvas, select **Set Payload** and set the **Value** field to `#[payload.volume.volumeId]`. This prints the volume ID of the EBS volume. The following image shows the **Set Payload** configuration: ![EC2 Create Volume payload transformer](/mulesoft/current/en-us/amazon-ec2-connector/latest/_images/amazon-ec2-create-volume-payload.png) ## Add and Configure the Logger Component 1. In the **Mule Palette** view, select **Logger** and drag it to the right of the **Set Payload** component. The **Logger** component displays the volume ID that is transformed by the **Set Payload** component from the **Create Volume** operation in the Mule console. 2. In the canvas, select **Logger** and enter the following values: - **Message** `#[payload]` - **Level** `INFO` ![EC2 create volume logger](/mulesoft/current/en-us/amazon-ec2-connector/latest/_images/amazon-ec2-create-volume-logger-props.png) 3. Save the project. ## Test the App 1. In **Package Explorer**, right-click the project and select **Run As > Mule Application**. 2. Browse to `http://localhost:8081/createVolume`. You see the generated volume ID in the browser and console. ### Example Mule App XML Code Copy and paste this code into your XML Editor to quickly load the flow for this example use case into your Mule app: ```xml ``` ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Amazon EC2 Connector version: 3.0 is-latest-version: true --- # Amazon EC2 Connector 3.0 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt ## Configurations --- ### Configuration #### Parameters
NameTypeDescriptionDefault ValueRequired

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types to provide to this configuration.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime purges the instances when appropriate.

#### Connection Types ##### Basic ###### Parameters
NameTypeDescriptionDefault ValueRequired

Session Token

String

The session token provided by Amazon STS.

Connection Timeout

Number

The amount of time to wait (in milliseconds) when initially establishing a connection before the connector gives up and times out. A value of 0 means infinity and is not recommended.

50000

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Max Connections

Number

Sets the maximum number of allowed open HTTP connections.

Socket Timeout

Number

The amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection times out. A value of 0 means infinity and is not recommended.

50000

Socket Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Socket Timeout field.

SECONDS

Access Key

String

The access key provided by Amazon.

x

Secret Key

String

The secret key provided by Amazon.

x

Try Default AWSCredentials Provider Chain

Boolean

Set this field to true to obtain credentials from the AWS environment. See: https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/credentials.html

false

Region Endpoint

String

Set the topic region endpoint.

US_EAST_1

Custom Service Endpoint

String

Sets a custom service endpoint. Useful when a non-standard service endpoint is required, such as a VPC endpoint.

TLS Configuration

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Host

String

The optional proxy host.

Port

Number

The optional proxy port.

Username

String

The optional proxy username.

Password

String

The optional proxy password.

Domain

String

The optional proxy domain.

Workstation

String

The optional proxy workstation.

##### Role ###### Parameters
NameTypeDescriptionDefault ValueRequired

Role ARN

String

Role ARN that uniquely identifies the role to assume to gain cross-account access.

x

Custom STS Endpoint

String

Sets a custom STS endpoint. Useful when a non-standard service endpoint is required, such as a VPC endpoint.

Connection Timeout

Number

Duration (in milliseconds) when initially establishing a connection before the connector gives up and times out. A value of 0 means infinity and is not recommended.

50000

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Max Connections

Number

Sets the maximum number of allowed open HTTP connections.

Socket Timeout

Number

Duration (in milliseconds) to transfer data over an established, open connection before the connection times out. A value of 0 means infinity and is not recommended.

50000

Socket Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Socket Timeout field.

SECONDS

Access Key

String

Access key provided by Amazon.

x

Secret Key

String

Secret key provided by Amazon.

x

Try Default AWSCredentials Provider Chain

Boolean

Set this field to true to obtain credentials from the AWS environment. See: https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/credentials.html

false

Region Endpoint

String

Set the topic region endpoint.

US_EAST_1

Custom Service Endpoint

String

Sets a custom service endpoint. Useful when a non-standard service endpoint is required, such as a VPC endpoint.

TLS Configuration

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Host

String

Optional proxy host.

Port

Number

Optional proxy port.

Username

String

Optional proxy username.

Password

String

Optional proxy password.

Domain

String

Optional proxy domain.

Workstation

String

Optional proxy workstation.

## Supported Operations - [Allocate Address](#allocateAddress) - [Assign IPv6 Addresses](#assignIpv6Addresses) - [Assign Private IP Addresses](#assignPrivateIpAddresses) - [Associate Address](#associateAddress) - [Associate IAM Instance Profile](#associateIamInstanceProfile) - [Attach Network Interface](#attachNetworkInterface) - [Attach Volume](#attachVolume) - [Authorize Security Group Egress](#authorizeSecurityGroupEgress) - [Authorize Security Group Ingress](#authorizeSecurityGroupIngress) - [Copy Snapshot](#copySnapshot) - [Create Image](#createImage) - [Create Key Pair](#createKeyPair) - [Create Network Interface](#createNetworkInterface) - [Create Security Group](#createSecurityGroup) - [Create Snapshot](#createSnapshot) - [Create Tags](#createTags) - [Create Volume](#createVolume) - [Delete Key Pair](#deleteKeyPair) - [Delete Network Interface](#deleteNetworkInterface) - [Delete Security Group](#deleteSecurityGroup) - [Delete Snapshot](#deleteSnapshot) - [Delete Tags](#deleteTags) - [Delete Volume](#deleteVolume) - [Deregister Image](#deregisterImage) - [Describe Addresses](#describeAddresses) - [Describe Availability Zones](#describeAvailabilityZones) - [Describe IAM Instance Profile Associations](#describeIamInstanceProfileAssociations) - [Describe Image Attribute](#describeImageAttribute) - [Describe Images](#describeImages) - [Describe Instance Attribute](#describeInstanceAttribute) - [Describe Instance Status](#describeInstanceStatus) - [Describe Instances](#describeInstances) - [Describe Key Pairs](#describeKeyPairs) - [Describe Moving Addresses](#describeMovingAddresses) - [Describe Network Interface Attribute](#describeNetworkInterfaceAttribute) - [Describe Network Interfaces](#describeNetworkInterfaces) - [Describe Regions](#describeRegions) - [Describe Security Group References](#describeSecurityGroupReferences) - [Describe Security Groups](#describeSecurityGroups) - [Describe Snapshot Attribute](#describeSnapshotAttribute) - [Describe Snapshots](#describeSnapshots) - [Describe Stale Security Groups](#describeStaleSecurityGroups) - [Describe Tags](#describeTags) - [Describe Volume Attribute](#describeVolumeAttribute) - [Describe Volume Status](#describeVolumeStatus) - [Describe Volumes](#describeVolumes) - [Describe Volumes Modifications](#describeVolumesModifications) - [Detach Network Interface](#detachNetworkInterface) - [Detach Volume](#detachVolume) - [Disassociate Address](#disassociateAddress) - [Disassociate IAM Instance Profile](#disassociateIamInstanceProfile) - [Enable Volume I/O](#enableVolumeIo) - [Get Console Output](#getConsoleOutput) - [Get Console Screenshot](#getConsoleScreenshot) - [Get Password Data](#getPasswordData) - [Import Key Pair](#importKeyPair) - [Modify Image Attribute](#modifyImageAttribute) - [Modify Instance Attribute](#modifyInstanceAttribute) - [Modify Network Interface Attribute](#modifyNetworkInterfaceAttribute) - [Modify Snapshot Attribute](#modifySnapshotAttribute) - [Modify Volume](#modifyVolume) - [Modify Volume Attribute](#modifyVolumeAttribute) - [Monitor Instances](#monitorInstances) - [Move Address To VPC](#moveAddressToVpc) - [Reboot Instances](#rebootInstances) - [Release Address](#releaseAddress) - [Replace IAM Instance Profile Association](#replaceIamInstanceProfileAssociation) - [Report Instance Status](#reportInstanceStatus) - [Reset Image Attribute](#resetImageAttribute) - [Reset Instance Attribute](#resetInstanceAttribute) - [Reset Network Interface Attribute](#resetNetworkInterfaceAttribute) - [Reset Snapshot Attribute](#resetSnapshotAttribute) - [Restore Address To Classic](#restoreAddressToClassic) - [Revoke Security Group Egress](#revokeSecurityGroupEgress) - [Revoke Security Group Ingress](#revokeSecurityGroupIngress) - [Run Instances](#runInstances) - [Start Instances](#startInstances) - [Stop Instances](#stopInstances) - [Terminate Instances](#terminateInstances) - [Unassign IPv6 Addresses](#unassignIpv6Addresses) - [Unassign Private IP Addresses](#unassignPrivateIpAddresses) - [Unmonitor Instances](#unmonitorInstances) ## Operations ### Allocate Address `` Acquires an elastic IP address. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Domain

String

Set to vpc to allocate the address for use with instances in a VPC. By default, if the Region supports EC2-Classic, this value is standard. Valid values are standard and vpc.

standard

Target Variable

String

Name of a variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Allocate Address Result

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Assign IPv6 Addresses `` Assigns one or more IPv6 addresses to the specified network interface. #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Network Interface Id

String

The ID of the network interface.

x

Ipv6 Address Count

Number

The number of IPv6 addresses to assign to the network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can’t use this option if specifying specific IPv6 addresses.

Ipv6 Addresses

Array of String

One or more specific IPv6 addresses to be assigned to the network interface. You can’t use this option if you’re specifying a number of IPv6 addresses.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Assign IPv6 Addresses Result

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Assign Private IP Addresses `` Assigns one or more secondary private IP addresses to the specified network interface. #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Network Interface Id

String

The ID of the network interface.

x

Allow Reassignment

Boolean

Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

false

Private Ip Addresses

Array of String

One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can’t specify this parameter when also specifying a number of secondary IP addresses.

Secondary Private Ip Address Count

Number

The number of secondary IP addresses to assign to the network interface. You can’t specify this parameter when also specifying private IP addresses.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Associate Address `` Associates an Elastic IP address with an instance or a network interface. Associating an Elastic IP address with an interface in a different network border group is not allowed. > [!NOTE] This operation is idempotent. If you perform the operation more than once, an error is not > returned, and each time the Elastic IP address is remapped to the same instance, you might be > charged. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Allocation Id

String

EC2-VPC - The allocation ID. This is required for EC2-VPC.

Allow Reassociation

Boolean

EC2-VPC - For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface. Otherwise, the operation fails.

false

Instance Id

String

The ID of the instance.

Network Interface Id

String

EC2-VPC - ID of the network interface.

Private Ip Address

String

EC2-VPC - Primary or secondary private IP address to associate with the Elastic IP address.

Public Ip

String

Elastic IP address. This is required for EC2-Classic.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Associate IAM Instance Profile `` Associates an IAM instance profile with a running or stopped instance. Associating more than one IAM instance profile with an instance is not allowed. #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Instance Id

String

ID of the instance.

x

Profile Name

String

Name of the IAM instance profile.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

IAM Instance Profile Association

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Attach Network Interface `` Attaches a network interface to an instance. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Device Index

Number

Index of the device for the network interface attachment.

x

Instance Id

String

ID of the instance.

x

Network Interface Id

String

ID of the network interface.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Attach Volume `` Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name. Encrypted EBS volumes can be attached only to instances that support Amazon EBS encryption. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Volume Id

String

The ID of the EBS volume.

x

Instance Id

String

The ID of the instance.

x

Device

String

The device name to expose to the instance (for example, /dev/sdh or xvdh).

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Volume Attachment

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Authorize Security Group Egress `` (EC2-VPC only) Adds one or more egress rules to a security group to use with a VPC. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Group Id

String

The ID of the security group.

x

Cidr Ip

String

The CIDR IPv4 address range.

Ip Protocol

String

The IP protocol name or number.

From Port

Number

The start of port range for the TCP and UDP protocols, or an ICMP type number.

To Port

Number

The end of port range for the TCP and UDP protocols, or an ICMP type number.

Ip Permissions

Array of IP Permission

Sets of IP permissions.

Source Security Group Name

String

The name of a destination security group.

Source Security Group Owner Id

String

The AWS account number for a destination security group.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Authorize Security Group Ingress `` Adds one or more ingress rules to a security group. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Group Id

String

ID or name of the security group. For security groups in a non-default VPC, you must specify the group ID (rather than the Group Name).

Group Name

String

Specifies the name of the security group for EC2-Classic and default VPC.

Cidr Ip

String

IPv4 address range in CIDR format.

Ip Protocol

String

IP protocol name (tcp, udp, icmp) or number. For icmpv6, specify a set of IP permissions.

From Port

Number

Start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.

To Port

Number

End of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code number.

Ip Permissions

Array of IP Permission

A set of IP permissions.

Source Security Group Name

String

EC2-Classic, default VPC - The name of the source security group.

Source Security Group Owner Id

String

In EC2-Classic, the AWS account number for the source security group, if the source security group is in a different account. You can’t specify this parameter in combination with the CIDR IP address range, IP protocol, Start and End of port range parameters.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Copy Snapshot `` Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy the snapshot within the same region, or from one region to another. You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs). Copies of encrypted EBS snapshots remain encrypted and copies of unencrypted snapshots remain unencrypted. To encrypt unencrypted snapshots, specify the `Encrypted` parameter during the copy snapshot operation. Encrypted snapshot copies use the default AWS Key Management Service (AWS KMS) customer key (CMK). You can use the `KmsKeyId` parameter to specify a non-default CMK. To copy an encrypted snapshot that is shared from another account, you must have permissions for the CMK that is used to encrypt the snapshot. Snapshots that are created by the `copySnapshot` action have a random volume ID that must not be used for any other purpose. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Source Snapshot Id

String

ID of the EBS snapshot to copy.

x

Source Region

Enumeration, one of:

  • APNORTHEAST1

  • APNORTHEAST2

  • APSOUTH1

  • APSOUTHEAST1

  • APSOUTHEAST2

  • CACENTRAL1

  • EUCENTRAL1

  • EUWEST1

  • EUWEST2

  • SAEAST1

  • USEAST1

  • USEAST2

  • USWEST1

  • USWEST2

ID of the region that contains the snapshot to copy.

x

Description

String

Description for the EBS snapshot.

Destination Region

String. Enumeration, one of:

  • APNORTHEAST1

  • APNORTHEAST2

  • APSOUTH1

  • APSOUTHEAST1

  • APSOUTHEAST2

  • CACENTRAL1

  • EUCENTRAL1

  • EUWEST1

  • EUWEST2

  • SAEAST1

  • USEAST1

  • USEAST2

  • USWEST1

  • USWEST2

Destination region to use in the PresignedUrl parameter of a copy snapshot operation. The snapshot is copied to the regional endpoint to which you send the HTTP request.

Presigned Url

String

The pre-signed URL that facilitates copying an encrypted snapshot.

Encrypted

Boolean

Specifies whether the destination snapshot should be encrypted.

false

Kms Key Id

String

Full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Create Image `` Creates an Amazon EBS-backed AMI from a running or stopped instance. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Instance Id

String

Instance information.

x

I Name

String

Instance name.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

#### Output

Type

String

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Create Key Pair `` Creates a new 2048-bit RSA key pair with the specified name. The public key is stored by Amazon EC2 and the private key is returned to you. The private key is returned as an unencrypted PEM-encoded PKCS#8 private key. If a key with the specified name already exists, Amazon EC2 returns an error. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Key Name

String

Unique name for the key pair.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Key Pair

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Create Network Interface `` Creates a network interface in the specified subnet. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Subnet Id

String

The ID of the subnet to associate with the network interface.

x

Description

String

A description for the network interface.

Groups

Array of String

The IDs of one or more security groups.

Ipv6 Address Count

Number

The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range.

Ipv6 Addresses

Array of String

One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can’t use this option if you’re specifying a number of IPv6 addresses.

Private Ip Address

String

The primary private IPv4 address of the network interface.

Private Ip Addresses

One or more private IPv4 addresses.

Secondary Private Ip Address Count

Number

The number of secondary private IPv4 addresses to assign to a network interface.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Network Interface

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Create Security Group `` Creates a security group. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Vpc Id

String

ID of the VPC.

Group Name

String

Name of the security group.

x

Description

String

Description for the security group.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Create Snapshot `` Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance. When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot. You can take a snapshot of an attached volume that is in use, but snapshots capture only the data that is written to your EBS volume at the time the snapshot command is issued. Data that is cached by any apps or the operating system is excluded. Your snapshot should be complete if you can pause file systems on the volume long enough to take the snapshot. If you can’t pause all file writes to the volume, to ensure a consistent and complete snapshot, do the following: 1. Unmount the volume from within the instance. 2. Issue the snapshot command. 3. Remount the volume. You can remount and use your volume while the snapshot status is pending. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Volume Id

String

ID of the EBS volume.

x

Description

String

Description for the snapshot.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Snapshot

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Create Tags `` Adds or overwrites one or more tags for the specified Amazon EC2 resources. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Resources

Array of String

List of IDs of one or more resources to tag. For example, ami-1a2b3c4d.

x

Tags

Array of Tag

List of one or more tags. The value parameter is required, but if you don’t want the tag to have a value, specify the parameter with no value, and Mule sets the value to an empty string.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Create Volume `` Creates an EBS volume to attach to an instance that is in the same Availability Zone. The volume is created in the regional endpoint to which you send the HTTP request. You can create a new empty volume or restore a volume from an EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume. To create encrypted volumes, use the `Encrypted` parameter. Encrypted volumes can be attached only to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Availability Zone

String

The Amazon availability zone in which to create the volume.

x

Encrypted

Boolean

Specifies whether to encrypt the volume.

false

Iops

Number

Only valid for provisioned IOPS SSD volumes. The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 50 IOPS/GiB.

Kms Key Id

String

Full ARN of the AWS Key Management Service (AWS KMS) customer key (CMK) to use when creating the encrypted volume.

Size

Number

The size of the volume, in GiBs.

Snapshot Id

String

The snapshot from which to create the volume.

Volume Type

Enumeration, one of:

  • Standard

  • Io1

  • Gp2

  • Sc1

  • St1

The volume type.

Standard

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Volume

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Delete Key Pair `` Removes the public key from Amazon EC2 and deletes the specified key pair. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Key Name

String

Name of the key pair to delete.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Delete Network Interface `` Deletes the specified network interface. You must detach the network interface before you can delete it. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Network Interface Id

String

ID of the network interface.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Delete Security Group `` Deletes a security group. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Group Id

String

The security group ID is required for nondefault VPC.

Group Name

String

For EC2-Classic and default VPC, name of the security group.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Delete Snapshot `` Deletes the specified snapshot. When you make periodic snapshots of a volume, the snapshots are incremental, which means that only the blocks that changes on the device since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data that is not needed for any other snapshot is removed. This ensures that, no matter which prior snapshots were deleted, all active snapshots have access to all the information needed to restore the volume. You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must de-register the AMI before you can delete the snapshot. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Snapshot Id

String

ID of the EBS snapshot.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Delete Tags `` Deletes the specified set of tags from the specified set of resources. This call is designed to follow a `DescribeTags` call so you can first determine what tags a resource has. You can then call `DeleteTags` with the resource ID and the specific tags you want to delete. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Resources

Array of String

List of resource IDs, for example: ami-1a2b3c4d. You can specify more than one resource ID.

x

Tags

Array of Tag

List of one or more tags to delete. If you omit the value parameter, Mule deletes the tag regardless of its value. If you specify this parameter with an empty string as the value, Mule deletes the key only if its value is an empty string.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Delete Volume `` Deletes the specified EBS volume. The volume must be in the available state (not attached to an instance). The volume might remain in the deleting state for several minutes. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Volume Id

String

ID of the volume.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Deregister Image `` Deregisters the specified AMI. Once deregistered, the AMI cannot be used to launch new instances. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Image Id

String

AMI ID to deregister.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Describe Addresses `` Describes one or more of your Elastic IP addresses. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Allocation Ids

Array of String

For EC2-VPC, one or more allocation IDs.

Filters

Array of Filter

One or more filters. Filter names and values are case-sensitive.

Public Ips

Array of String

For EC2-Classic, one or more Elastic IP addresses.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Address

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Describe Availability Zones `` Describes one or more of the Availability Zones that are currently available to the account. The results include only the zones for the region you’re currently using. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Zone Names

Array of String

The names of one or more Availability Zones.

Filters

Array of Filter

One or more filters.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Availability Zone

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Describe IAM Instance Profile Associations `` Describes your IAM instance profile associations. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Association Ids

Array of String

One or more IAM instance profile associations.

Filters

Array of Filter

One or more filters.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of IAM Instance Profile Association

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Describe Image Attribute `` Describes attributes of an AMI. You can specify only one attribute at a time. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Image Id

String

ID of the AMI.

x

Attribute

String

The attribute to reset (currently you can reset only the launch permission attribute).

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Image Attribute

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Describe Images `` Describes the images in AWS (AMIs, AKIs, and ARIs). Images available to you include public images, private images that you own, and private images owned by other AWS accounts for which you have explicit launch permissions. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Image

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Describe Instance Attribute `` Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: - `blockDeviceMapping` - `disableApiTermination` - `ebsOptimized`, `groupSet` - `instanceInitiatedShutdownBehavior` - `instanceType` - `kernel` - `productCodes` - `ramdisk` - `rootDeviceName` - `sourceDestCheck` - `sriovNetSupport` - `userData` Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Attribute

String

Instance attribute.

x

Instance Id

String

ID of the instance.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Instance Attribute

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Describe Instance Status `` Describes the status of one or more instances. By default, only running instances are described, unless otherwise specified. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Instance Ids

Array of String

One or more instance IDs.

Filters

Array of Filter

One or more filters.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Instance Status

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Describe Instances `` Describes one or more of your instances. If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you don’t specify instance IDs or filters, Amazon EC2 returns information for all instances, which can have a performance impact. If you specify an invalid instance ID, an error is returned. If you specify an instance that you don’t own, that instance is not included in the returned results. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Instance Ids

Array of String

One or more instance IDs.

Filters

Array of Filter

One or more filters.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Reservation

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Describe Key Pairs `` Describes one or more of your key pairs. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Key Names

Array of String

One or more key pair names for which the describeKeyPairs service needs to return information. When the list is null or empty, it returns all the available key pairs' information.

Filters

Array of Filter

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Key Pair Info

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Describe Moving Addresses `` Describes the Elastic IP addresses to move to the EC2-VPC platform, or to restore to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Filters

Array of Filter

One or more filters.

Public Ips

Array of String

One or more Elastic IP addresses.

Streaming Strategy

Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Message of Move Address Status payload and Request ID Attribute attributes

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 2](#exceptionthrows2) ### Describe Network Interface Attribute `` Describes a network interface attribute. You can specify only one attribute at a time. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Attribute

String

The attribute of the network interface. This parameter is required.

x

Network Interface Id

String

The ID of the network interface.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Describe Network Interface Attribute Result

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Describe Network Interfaces `` Describes one or more of your network interfaces. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Filters

Array of Filter

One or more filters.

Network Interface Ids

Array of String

One or more network interface IDs.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Network Interface

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Describe Regions `` Describes one or more regions that are currently available to you. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Region Names

Array of String

The names of one or more regions.

Filters

Array of Filter

One or more filters.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Region

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Describe Security Group References `` (EC2-VPC only) Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you’ve specified in this request. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Group Ids

Array of String

One or more security group IDs in your account.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Security Group Reference

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Describe Security Groups `` Describes one or more of your security groups. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Group Ids

Array of String

One or more security group IDs.

Group Names

Array of String

(EC2-Classic and default VPC only) One or more security group names.

Filters

Array of Filter

One or more filters.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Security Group

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Describe Snapshot Attribute `` Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Snapshot Id

String

ID of the EBS snapshot.

x

Attribute

Enumeration, one of:

  • ProductCodes

  • CreateVolumePermission

The snapshot attribute to view.

CreateVolumePermission

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Describe Snapshot Attribute Result

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Describe Snapshots `` Describes one or more of the EBS snapshots available to you. Available snapshots include: - Public snapshots available for any AWS account to launch - Private snapshots that you own - Private snapshots owned by another AWS account but for which you have explicit create volume permissions The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions. If you specify: - One or more snapshot IDs, only snapshots that have the specified IDs are returned. - An invalid snapshot ID, an error is returned. - A snapshot ID for which you do not have access, it is not included in the returned results. - One or more snapshot owners using the OwnerIds option, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners: `amazon` for snapshots owned by Amazon, or `self` for snapshots that you own. - A list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots): `self` for snapshots you own or to which you have explicit permissions, or `all` for public snapshots. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Snapshot Ids

Array of String

One or more snapshot IDs.

Owner Ids

Array of String

Returns the snapshots owned by the specified owner.

Restorable By User Ids

Array of String

One or more AWS accounts IDs that can create volumes from the snapshot.

Filters

Array of Filter

One or more filters.

Streaming Strategy

Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Message of Snapshot payload and Request ID Attribute attributes

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 2](#exceptionthrows2) ### Describe Stale Security Groups `` (EC2-VPC only) Describes the stale security group rules for security groups in a specified VPC. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Vpc Id

String

The ID of the VPC.

x

Streaming Strategy

Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Message of Stale Security Group payload and Request ID Attribute attributes

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 2](#exceptionthrows2) ### Describe Tags `` Describes one or more of the tags for your EC2 resources. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Filters

Array of Filter

One or more filters

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Tag Description

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Describe Volume Attribute `` Describes the specified attribute of the specified volume. You can specify only one attribute at a time. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Volume Id

String

The ID of the volume.

x

Attribute Name

Enumeration, one of:

  • AutoEnableIO

  • ProductCodes

The attribute of the volume.

AutoEnableIO

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Describe Volume Attribute Result

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Describe Volume Status `` Describes the status of the specified volumes and provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. If an issue occurs on the volume’s underlying host, volume performance can be affected. If the volume’s underlying host experiences a power outage or system issue, after the system is restored, data inconsistencies on the volume are possible. Volume events notify you if this occurs. Volume actions notify you if any action must be taken in response to the event. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Volume Ids

Array of String

One or more volume IDs.

Filters

Array of Filter

One or more filters.

Streaming Strategy

Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Message of Volume Status Item payload and Request ID Attribute attributes

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 2](#exceptionthrows2) ### Describe Volumes `` Describes the specified EBS volumes. If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The `MaxResults` parameter sets the maximum number of results returned in a single page. If the list of results exceeds your `MaxResults` value, then that number of results is returned along with a `NextToken` value that can be passed to a subsequent `DescribeVolumes` request to retrieve the remaining results. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Volume Ids

Array of String

One or more volume IDs.

Filters

Array of Filter

One or more filters.

Streaming Strategy

Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Message of Volume payload and Request ID Attribute attributes

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 2](#exceptionthrows2) ### Describe Volumes Modifications `` Reports the current modification status of EBS volumes. Current-generation EBS volumes support modification of attributes including type, size, and (for io1 volumes) IOPS provisioning while either attached to or detached from an instance. Following an action from the API or the console to modify a volume, the status of the modification can be modifying, optimizing, completed, or failed. If a volume has never been modified, then certain elements of the returned VolumeModification objects are null. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Volume Ids

Array of String

One or more volume IDs for which in-progress modifications will be described.

Filters

Array of Filter

One or more filters.

Streaming Strategy

Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Message of Volume Modification payload and Request ID Attribute attributes

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 2](#exceptionthrows2) ### Detach Network Interface `` Detaches a network interface from an instance. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Attachment Id

String

The ID of the network interface.

x

Force

Boolean

Specifies whether to force a detachment.

false

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Detach Volume `` Detaches an EBS volume from an instance. You must unmount any file systems on the device within your operating system before detaching the volume. Failure to do so can result in the volume becoming stuck in the busy state while detaching. If this happens, detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot the instance, or all three. If an EBS volume is the root device of an instance, it can’t be detached while the instance is running. To detach the root volume, stop the instance first. When a volume with an AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Volume Id

String

The ID of the volume.

x

Device

String

The device name.

Force

Boolean

Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally).

false

Instance Id

String

The ID of the instance.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Volume Attachment

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Disassociate Address `` Disassociates an Elastic IP address from the instance or network interface it’s associated with. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Association Id

String

Association ID. Required for EC2-VPC.

Public Ip

String

EC2-Classic Elastic IP address. Required for EC2-Classic.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Disassociate IAM Instance Profile `` Disassociates an IAM instance profile from a running or stopped instance. Use DescribeIamInstanceProfileAssociations to get the association ID. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Association Id

String

The ID of the IAM instance profile association.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

IAM Instance Profile Association

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Enable Volume I/O `` Enables input and output operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Volume Id

String

ID of the volume.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Get Console Output `` Retrieves console output for the specified instance. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Instance Id

String

The ID of the instance.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Get Console Output Result

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Get Console Screenshot `` Retrieve a JPG-format screenshot of a running instance to help with troubleshooting. The returned content is Base64-encoded. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Instance Id

String

ID of the instance.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Get Console Screenshot Result

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Get Password Data `` Retrieves the encrypted administrator password for an instance running Windows. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Instance Id

String

The ID of the Windows instance.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Get Password Data Result

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1). ### Import Key Pair `` Imports the public key from an RSA key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. The private key is never transferred between you and AWS. #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Key Name

String

A unique name for the key pair.

x

Public Key Material

String

The public key which must be base64-encoded.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Import Key Pair Result

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Modify Image Attribute `` Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Image Id

String

ID of the AMI.

x

Description

String

Description of the AMI.

Attribute

String

Name of the attribute to modify.

Operation Type

String

Type of operation.

Launch Permissions

Launch permissions for the AMI.

Product Codes

Array of String

The DevPay product codes. After you add a product code to an AMI, it can’t be removed.

Value

String

Value of the attribute to modify.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Modify Instance Attribute `` Modifies the specified attribute of the specified instance. You can specify only one attribute at a time. To modify some attributes, the instance must be stopped. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Instance Id

String

ID of the instance.

x

Attribute

String

Name of the attribute.

x

Value

String

New value for the attribute.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Modify Network Interface Attribute `` Modifies the specified network interface attribute. You can specify only one attribute at a time. Be careful while using this operation. - To modify only the **Description** attribute, pass only the description along with **Network Interface Id**. - To modify **Attachment Id**, only send **Attachment Id** and **Delete On Termination** set to `false`. - To modify **Groups**, send `groupSet` along with **Network Interface Id**. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Network Interface Id

String

ID of the network interface.

x

Attachment Id

String

ID of the network interface attachment.

Description

String

Description for the network interface.

Groups

Array of String

Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it’s just the default security group in the VPC. You must specify the ID of the security group, not the name.

Delete On Termination

Boolean

Indicates whether the network interface is deleted when the instance is terminated.

false

Source Dest Check

Boolean

Indicates whether source or destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.

false

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Modify Snapshot Attribute `` Adds or removes permission settings for the specified snapshot. You can add or remove specified AWS account IDs from a snapshot’s list of create volume permissions, but you cannot do both in a single API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls. You can’t make encrypted snapshots and snapshots with AWS Marketplace product codes public. Snapshots encrypted with your default CMK cannot be shared with other accounts. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Snapshot Id

String

ID of the snapshot.

x

Attribute

Enumeration, one of:

  • ProductCodes

  • CreateVolumePermission

The snapshot attribute to modify.

CreateVolumePermission

Operation Type

Enumeration, one of:

  • Add

  • Remove

Type of operation to perform to the attribute.

Add

Group Names

Array of String

Group to modify for the snapshot.

User Ids

Array of String

Account ID to modify for the snapshot.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Modify Volume `` You can modify several parameters of an existing EBS volume, including volume size, volume type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance type, it might be possible to apply these changes without stopping the instance or detaching the volume from it. When you complete a resize operation on your volume, you need to extend the volume’s file-system size to take advantage of the new storage capacity. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Volume Id

String

ID of the volume to modify.

x

Iops

Number

Target IOPS rate of the volume to modify.

Size

Number

Target size in GiB of the volume to modify.

Volume Type

Enumeration, one of:

  • Standard

  • Io1

  • Gp2

  • Sc1

  • St1

Target EBS volume type of the volume to be modified

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Volume Modification

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Modify Volume Attribute `` Modifies a volume attribute. By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent. This behavior prevents undetectable latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume. You can change the default behavior to resume I/O operations. It is best to change the default behavior only for boot volumes or for volumes that are stateless or disposable. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Volume Id

String

ID of the volume.

x

Auto Enable IO

Boolean

Indicates whether the volume should be auto-enabled for I/O operations.

true

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Monitor Instances `` Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Instance Ids

Array of String

One or more instance IDs.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Instance Monitoring

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Move Address To VPC `` Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account for more than 24 hours, and it must not be associated with an instance. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Public Ip

String

The Elastic IP address.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Move Address To VPC Result

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Reboot Instances `` Requests a reboot of one or more instances. This operation is asynchronous, meaning that it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored. If an instance does not cleanly shut down within four minutes, Amazon EC2 performs a hard reboot. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Instance Ids

Array of String

One or more instance IDs.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Release Address `` Releases the specified Elastic IP address. After an Elastic IP address is released, it is sent to the IP address pool and might be unavailable to you. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Allocation Id

String

Required allocation ID for EC2-VPC.

Public Ip

String

Required Elastic IP address for EC2-Classic.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Replace IAM Instance Profile Association `` Replaces an IAM instance profile for the specified running instance. You can use this action to change the IAM instance profile that’s associated with an instance without having to disassociate the existing IAM instance profile first. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Association Id

String

ID of the existing IAM instance profile association

x

Profile Name

String

Name of the instance profile to replace.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

IAM Instance Profile Association

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Report Instance Status `` Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by `DescribeInstanceStatus`, use `ReportInstanceStatus` to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks. Use of this action does not change the value returned by DescribeInstanceStatus. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Instance Ids

Array of String

One or more instance IDs.

x

Reason Codes

Array of String

One or more reason codes that describes the health state of your instance.

x

Status

String

The status of all instances listed.

x

Description

String

Descriptive text about the health state of your instance.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Reset Image Attribute `` Resets an attribute of an AMI to its default value. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Image Id

String

ID of the AMI.

x

Attribute

String

Attribute to reset. Currently, you can only reset the launch permission attribute).

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Reset Instance Attribute `` Resets an attribute of an instance to its default value. To reset the kernel or RAM disk, the instance must be in a stopped state. To reset the `sourceDestCheck`, the instance can be either running or stopped. The `sourceDestCheck` attribute controls whether source or destination checking is enabled. The default value is `true`, which means checking is enabled. This value must be `false` for a NAT instance to perform NAT. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Instance Id

String

ID of the instance.

x

Attribute

String

Attribute to reset. You can reset only the following attributes:

  • kernel

  • ramdisk

  • sourceDestCheck

To change an instance attribute, use ModifyInstanceAttribute.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Reset Network Interface Attribute `` Resets a network interface attribute. You can specify only one attribute at a time. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Network Interface Id

String

ID of the network interface.

x

Source Dest Check

String

Source or destination checking attribute. Resets the value to true.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Reset Snapshot Attribute `` Resets permission settings for the specified snapshot. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Snapshot Id

String

ID of the snapshot.

x

Attribute

Enumeration, one of:

  • ProductCodes

  • CreateVolumePermission

The attribute to reset.

CreateVolumePermission

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Restore Address To Classic `` Restores an elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Public Ip

String

Elastic IP address.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Restore Address To Classic Result

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Revoke Security Group Egress `` (EC2-VPC only) Removes one or more egress rules from a security group for EC2-VPC. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Group Id

String

ID of the security group.

x

Cidr Ip

String

CIDR IP address range.

Ip Protocol

String

IP protocol name or number.

From Port

Number

Start of port range for the TCP and UDP protocols, or an ICMP type number.

To Port

Number

End of port range for the TCP and UDP protocols, or an ICMP type number.

Ip Permissions

Array of IP Permission

A set of IP permissions.

Source Security Group Name

String

Name of a destination security group.

Source Security Group Owner Id

String

AWS account number for a destination security group.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Revoke Security Group Ingress `` Removes one or more ingress rules from a security group. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Group Id

String

ID of the security group.

Group Name

String

EC2-Classic, default VPC - The name of the security group.

Cidr Ip

String

CIDR IP address range.

Ip Protocol

String

IP protocol name (tcp, udp, icmp) or number.

From Port

Number

Start of port range for the TCP and UDP protocols, or an ICMP type number.

To Port

Number

The end of port range for the TCP and UDP protocols, or an ICMP code number.

Ip Permissions

Array of IP Permission

A set of IP permissions.

Source Security Group Name

String

For EC2-Classic, default VPC, this is the name of the source security group.

Source Security Group Owner Id

String

For EC2-Classic, this is the AWS account ID of the source security group, if the source security group is in a different account.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Run Instances `` Launches the specified number of instances of an AMI for which you have permissions. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Image Id

String

ID of the AMI, which you can get by calling describe-images.

x

Min Count

Number

Minimum number of instances to launch.

1

Max Count

Number

Maximum number of instances to launch.

1

Security Groups

Array of String

One or more security group names.

Security Group Ids

Array of String

One or more security group IDs.

Keyname

String

Name of the key pair.

Subnet Id

String

ID of the subnet to launch the instance into.

Instance Type

String

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Reservation

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Start Instances `` Starts an Amazon EBS-backed AMI that you’ve previously stopped. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Instance Ids

Array of String

One or more instance IDs.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Instance State Change

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Stop Instances `` Stops an Amazon EBS-backed instance. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Instance Ids

Array of String

One or more instance IDs.

x

Force

Boolean

Forces the instances to stop.

false

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Instance State Change

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Terminate Instances `` Shuts down one or more instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds. Terminated instances remain visible after termination (approximately one hour). Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Instance Ids

Array of String

One or more instance IDs.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Instance State Change

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Unassign IPv6 Addresses `` Unassigns one or more IPv6 addresses from a network interface. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Ipv6 Addresses

Array of String

IPv6 addresses to unassign from the network interface.

x

Network Interface Id

String

ID of the network interface.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Unassign IPv6 Addresses Result

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Unassign Private IP Addresses `` Unassigns one or more secondary private IP addresses from a network interface. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Network Interface Id

String

ID of the network interface.

x

Private Ip Addresses

Array of String

Secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ### Unmonitor Instances `` Disables detailed monitoring for a running instance. Amazon EC2 Connector supports only the following parameters for this operation: #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Instance Ids

Array of String

One or more instance IDs.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Instance Monitoring

Attributes Type

### For Configurations - [Configuration](#config) #### Throws See [Exception Throw List - 1](#exceptionthrows1) ## Types Amazon EC2 Connector supports only the types that are documented. ### TLS
FieldTypeDescriptionDefault ValueRequired

Enabled Protocols

String

A comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma-separated list of cipher suites enabled for this context.

Trust Store

Key Store

Revocation Check

### Trust Store
FieldTypeDescriptionDefault ValueRequired

Path

String

The location of the truststore, which is resolved relative to the current classpath and file system, if possible.

Password

String

The password used to protect the truststore.

Type

String

The type of truststore used.

Algorithm

String

The algorithm used by the truststore.

Insecure

Boolean

If true, no certificate validations are performed, which makes connections vulnerable to attacks. Use at your own risk.

### Key Store
FieldTypeDescriptionDefault ValueRequired

Path

String

The location of the keystore, which is resolved relative to the current classpath and file system, if possible.

Type

String

The type of keystore used.

Alias

String

When the keystore contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.

Key Password

String

The password used to protect the private key.

Password

String

The password used to protect the keystore.

Algorithm

String

The algorithm used by the keystore.

### Standard Revocation Check
FieldTypeDescriptionDefault ValueRequired

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before).

Soft Fail

Boolean

Avoid verification failure when the revocation server can not be reached or is busy.

### Custom OCSP Responder
FieldTypeDescriptionDefault ValueRequired

Url

String

The URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response (must be in the trust store), if present.

### CRL File
FieldTypeDescriptionDefault ValueRequired

Path

String

The path to the CRL file.

### Reconnection
FieldTypeDescriptionDefault ValueRequired

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

The reconnection strategy to use.

### Reconnect
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often to reconnect (in milliseconds).

Count

Number

The number of reconnection attempts to make.

### Reconnect Forever
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often in milliseconds to reconnect.

### Expiration Policy
FieldTypeDescriptionDefault ValueRequired

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance can be idle before it’s eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute.

### Allocate Address Result
FieldTypeDescriptionDefault ValueRequired

Allocation Id

String

Assigned allocation ID that represents the allocation of the Elastic IP address used with instances in a VPC.

Domain

String

Specifies whether to use the Elastic IP address with instances in a VPC (vpc) or in EC2-Class (standard).

Public Ip

String

Elastic IP address.

### Request ID Attribute
FieldTypeDescriptionDefault ValueRequired

Request Id

String

Request ID included in the response

### Assign IPv6 Addresses Result
FieldTypeDescriptionDefault ValueRequired

Assigned Ipv6 Addresses

Array of String

One or more IPv6 addresses assigned to the specified network interface

Network Interface Id

String

ID of the network interface

### IAM Instance Profile Association
FieldTypeDescriptionDefault ValueRequired

Association Id

String

ID of the association

Iam Instance Profile

Instance Id

String

ID of the instance

State

String

State of the association

Timestamp

DateTime

Time the IAM instance profile was associated with the instance

### IAM Instance Profile
FieldTypeDescriptionDefault ValueRequired

Arn

String

ARN of the instance profile

Id

String

ID of the instance profile

### Volume Attachment
FieldTypeDescriptionDefault ValueRequired

Attach Time

DateTime

Timestamp of when the attachment was initiated

Delete On Termination

Boolean

Specifies whether to delete the EBS volume when the instance is terminated

Device

String

Name of the device

Instance Id

String

ID of the instance

State

String

Attachment state of the volume

Volume Id

String

ID of the volume

### IP Permission
FieldTypeDescriptionDefault ValueRequired

From Port

Number

Start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.

Ip Protocol

String

Name of the IP protocol. Valid values include:

  • tcp

  • udp

  • icmp

  • icmpv6

Ipv4 Ranges

Array of String

IPv4 ranges.

Ipv6 Ranges

Array of String

IPv6 ranges.

Prefix List Ids

Array of String

Prefix list IDs.

To Port

Number

End of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.

User Id Group Pairs

### User ID Group Pair
FieldTypeDescriptionDefault ValueRequired

Group Id

String

ID of the security group.

Group Name

String

Name of the security group. Use this parameter for a security group in EC2-Classic or a default VPC only.

Peering Status

String

If applicable, status of the VPC peering connection.

User Id

String

AWS account ID.

Vpc Id

String

If applicable, VPC ID for the referenced security group.

Vpc Peering Connection Id

String

VPC peering connection ID, if applicable.

### Key Pair
FieldTypeDescriptionDefault ValueRequired

Key Fingerprint

String

SHA-1 digest of the DER encoded private key if CreateKeyPair was used to create the key pair. If ImportKeyPair was used to create the key pair, this is the MD5 public key fingerprint as described in section 4 of RFC4716.

Key Material

String

Key Name

String

Name of the key pair.

### Network Interface
FieldTypeDescriptionDefault ValueRequired

Association

Attachment

Availability Zone

String

Availability zone

Description

String

Description for the network interface

Groups

Security groups for the network interface

Interface Type

String

Type of network interface

Ipv6 Addresses

Array of String

IPv6 addresses associated with the network interface

Mac Address

String

MAC address of the network interface

Network Interface Id

String

ID of the network interface

Owner Id

String

AWS account ID of the owner of the network interface

Private Dns Name

String

Name of the private DNS

Private Ip Address

String

IPv4 address of the network interface within the subnet

Private Ip Addresses

Private IPv4 addresses associated with the network interface

Requester Id

String

Entity ID that launched the instance on your behalf

Requester Managed

Boolean

Whether the network interface is managed by AWS

Source Dest Check

Boolean

Specifies whether to validate traffic to or from the instance

Status

String

Status of the network interface

Subnet Id

String

ID of the subnet

Tag Set

Array of Tag

Tags assigned to the network interface

Vpc Id

String

ID of the VPC

### Network Interface Association
FieldTypeDescriptionDefault ValueRequired

Allocation Id

String

Allocation ID

Association Id

String

Association ID

Ip Owner Id

String

Elastic IP address owner ID

Public Dns Name

String

Name of the public DNS

Public Ip

String

Elastic IP address bound to the network interface

### Network Interface Attachment
FieldTypeDescriptionDefault ValueRequired

Attach Time

DateTime

Time the attachment was initiated.

Attachment Id

String

Network interface attachment ID.

Delete On Termination

Boolean

If true, deletes the network interface when the instance is terminated.

Device Index

Number

Device index of the network interface attachment on the instance.

Instance Id

String

ID of the instance.

Instance Owner Id

String

AWS account ID of the instance owner.

Status

String

Attachment state. Valid values include:

  • attaching

  • attached

  • detaching

  • detached

### Group Identifier
FieldTypeDescriptionDefault ValueRequired

Group Id

String

ID of the security group

Group Name

String

Name of the security group

### Network Interface Private IP Address
FieldTypeDescriptionDefault ValueRequired

Association

Primary

Boolean

If true, the IPv4 address is the primary private IPv4 address of the network interface.

Private Dns Name

String

Name of the private DNS.

Private Ip Address

String

Private IPv4 address.

### Tag
FieldTypeDescriptionDefault ValueRequired

Key

String

Key of the tag. Tag keys are case-sensitive and have a maximum of 127 Unicode characters. The tag key cannot begin with aws:

Value

String

Value of the tag. Tag values are case-sensitive and have a maximum of 255 Unicode characters.

### Private IP Address Specification
FieldTypeDescriptionDefault ValueRequired

Primary

Boolean

If true, the IPv4 address is the primary private IPv4 address. There can be only one primary IPv4.

Private Ip Address

String

Private IPv4 addresses.

### Snapshot
FieldTypeDescriptionDefault ValueRequired

Data Encryption Key Id

String

Data encryption key identifier for the snapshot.

Description

String

Description of the snapshot.

Encrypted

Boolean

If true, the snapshot is encrypted.

Kms Key Id

String

ARN of the AWS Key Management Service (AWS KMS) customer key (CMK) used to protect the volume encryption key for the parent volume.

Owner Alias

String

AWS owner alias from the Amazon-maintained list. This is not the AWS account alias that was set using the IAM console.

Owner Id

String

AWS account ID of the snapshot owner.

Progress

String

Percentage of progress of the snapshot.

Snapshot Id

String

ID of the snapshot.

Start Time

DateTime

Time when the snapshot was initiated.

State

String

The state of the snapshot. Valid values include:

  • pending

  • completed

  • error

State Message

String

Displays details about the state of the snapshot to help you diagnose why an error occurs.

Tags

Array of Tag

Tags associated with the snapshot.

Volume Id

String

ID of the volume that was used to create the snapshot.

Volume Size

Number

Size of the volume in GiB.

### Volume
FieldTypeDescriptionDefault ValueRequired

Attachments

Availability Zone

String

Availability zone for the volume.

Create Time

DateTime

Time

Time the creation of the volume is initiated.

Encrypted

Boolean

If true, the volume is encrypted.

Iops

Number

Number of I/O operation per second that the volume supports.

Kms Key Id

String

ARN of the AWS Key Management Service (AWS KMS) customer key (CMK) used to protect the volume encryption key for the parent volume.

Size

Number

Size of the volume in GiB.

Snapshot Id

String

ID of the snapshot.

State

String

State of the volume. String can be:

  • creating

  • available

  • in-use

  • deleting

Tags

Array of Tag

Tags associated with the volume

Volume Id

String

ID of the volume

Volume Type

String

Volume type. String can be:

  • standard

  • io1

  • io2

  • gp2

  • sc1

  • st1

### Address
FieldTypeDescriptionDefault ValueRequired

Allocation Id

String

Allocation ID

Association Id

String

ID of the association of the address with a VPC instance

Domain

String

Specifies whether to use the Elastic IP address with instances in a VPC (vpc) or in EC2-Class (standard)

Instance Id

String

ID of the instance the address is associated with

Network Interface Id

String

ID of the network interface

Network Interface Owner Id

String

ID of the AWS account that owns the network interface

Private Ip Address

String

Private IP address that is associated with the Elastic IP address

Public Ip

String

Elastic IP address

### Filter
FieldTypeDescriptionDefault ValueRequired

(DEPRECATED) Name

String

Use the Filter Name field instead. Name of the filter. Filter names are case-sensitive.

Filter Name

String

Name of the filter. Filter names are case-sensitive.

Values

Array of String

Filter values, which are case-sensitive

### Availability Zone
FieldTypeDescriptionDefault ValueRequired

Messages

Array of String

Messages about the availability zone

Region Name

String

Name of the region

State

String

State of the availability zone. Valid values include:

  • available

  • information

  • impaired

  • unavailable

Zone Name

String

Name of the availability zone

### Image Attribute
FieldTypeDescriptionDefault ValueRequired

Block Device Mappings

Block device mapping entries.

Description

String

Description for the image.

Image Id

String

ID of the image.

Kernel Id

String

ID of the kernel associated with the image.

Launch Permissions

Launch permissions associated with the AMI.

Product Codes

Array of Product Code

Product codes associated with the AMI.

Ramdisk Id

String

RAM disk associated with the image. This parameter applies only to machine images.

Sriov Net Support

String

Whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

### Block Device Mapping
FieldTypeDescriptionDefault ValueRequired

Device Name

String

Name of the device

Ebs

Used to automatically set up EBS volumes when the instance is launched

No Device

String

Specify a device to suppress in the block device mapping of the AMI

Virtual Name

String

Virtual device name

### EBS Block Device
FieldTypeDescriptionDefault ValueRequired

Delete On Termination

Boolean

If true, the EBS volume is deleted when the instance is terminated

Encrypted

Boolean

Determines whether the encryption state of an EBS volume is changed when it is restored from a backing snapshot

Iops

Number

Number of I/O operations per second the volume supports

Snapshot Id

String

ID of the snapshot

Volume Size

Number

Size of the volume in GiB

Volume Type

String

Type of volume. Valid values include:

  • standard

  • io1

  • io2

  • gp2

  • sc1

  • st1

gp2

### Launch Permission
FieldTypeDescriptionDefault ValueRequired

Group

String

Name of the group

User Id

String

AWS account ID

### Product Code
FieldTypeDescriptionDefault ValueRequired

Product Code Id

String

Product code ID.

Product Code Type

String

Product code type. Valid values include:

  • devpay

  • marketplace

### Image
FieldTypeDescriptionDefault ValueRequired

Architecture

String

Architecture of the image.

Block Device Mappings

Block device mapping entries.

Creation Date

String

Date and time the image was created.

Description

String

Ena Support

Boolean

If true, enhanced networking with ENA is enabled.

Hypervisor

String

Hypervisor type of the image.

Image Id

String

AMI ID.

Image Location

String

Location of the AMI.

Image Owner Alias

String

AWS account alias, or AWS account ID of the AMI owner.

Image Type

String

Type of image. Valid values include:

  • machine

  • kernel

  • ramdisk

Kernel Id

String

ID of the kernel associated with the image, if applicable.

Name

String

Name of the AMI provided when the image was created.

Owner Id

String

AWS account ID of the image owner.

Platform

String

For Windows AMIs, this value is set to windows, otherwise, it is left blank.

Product Codes

Array of Product Code

Product codes associated with the AMI.

Public

Boolean

If true, the image has public launch permissions; if false, the image has only implicit and explicit launch permissions.

Ramdisk Id

String

ID of the RAM disk associated with the image. This parameter is applicable only to machine image types.

Root Device Name

String

Device name of the root device volume, for example: /dev/sda1.

Root Device Type

String

Type of root device used by the AMI. Valid values include:

  • ebs

  • instance-store

Sriov Net Support

String

Whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

State

String

State of the image.

State Reason

Reason for the state change.

Tags

Array of Tag

Tags associated with the image.

Virtualization Type

String

Type of virtualization of the AMI. Valid values include:

  • hvm

  • paravirtual

### State Reason
FieldTypeDescriptionDefault ValueRequired

Code

String

Reason code for the state change.

Message

String

Message for the state change:

  • Server.InsufficientInstanceCapacity
    There was insufficient capacity available to satisfy the launch request.

  • Server.InternalError
    An internal error caused the instance to terminate during launch.

  • Server.ScheduledStop
    The instance was stopped due to a scheduled retirement.

  • Server.SpotInstanceShutdown
    The instance was stopped because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.

  • Server.SpotInstanceTermination
    The instance was terminated because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.

  • Client.InstanceInitiatedShutdown
    The instance was shut down using the shutdown -h command from the instance.

  • Client.InstanceTerminated
    The instance was terminated or rebooted during AMI creation.

  • Client.InternalError
    Client error caused the instance to terminate during launch.

  • Client.InvalidSnapshot.NotFound
    Specified snapshot was not found.

  • Client.UserInitiatedHibernate
    Hibernation was initiated on the instance.

  • Client.UserInitiatedShutdown
    Instance was shut down using the Amazon EC2 API.

  • Client.VolumeLimitExceeded
    Limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your account limits.

### Instance Attribute
FieldTypeDescriptionDefault ValueRequired

Block Device Mappings

Disable Api Termination

Boolean

If the value is true, the instance can’t be terminated using the Amazon EC2 console, CLI, or API. If the value is false, you can terminate the instance using the Amazon EC2 console, CLI, or API.

Ebs Optimized

Boolean

Whether to optimize the instance for Amazon EBS I/O. This is not available with all instance types, as there additional usage charges associated with using an EBS Optimized instance.

Ena Support

Boolean

If true, enhanced networking with ENA is enabled.

Groups

Instance Id

String

ID of the instance

Instance Initiated Shutdown Behavior

String

Specifies whether to stop or terminate the instance when shutdown is initiated from the instance.

Instance Type

String

Type of instance

Kernel Id

String

ID of the kernel associated with the instance

Product Codes

Array of Product Code

Ramdisk Id

String

ID of the RAM disk associated with the instance

Root Device Name

String

Device name of the root device volume

Source Dest Check

Boolean

A value of true means that source or destination checking is enabled. A value of false means that source or destination checking is disabled. The value must be false for an instance that is launched in a VPC to perform NAT.

Sriov Net Support

String

Whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

User Data

String

User data.

### Instance Block Device Mapping
FieldTypeDescriptionDefault ValueRequired

Device Name

String

Name of the device

Ebs

### EBS Instance Block Device
FieldTypeDescriptionDefault ValueRequired

Attach Time

DateTime

Timestamp for when the attachment was initiated.

Delete On Termination

Boolean

Whether to delete the instance upon termination.

Status

String

State of the attachment. Valid values include:

  • attaching

  • attached

  • detaching

  • detached

Volume Id

String

ID of the volume.

### Instance Status
FieldTypeDescriptionDefault ValueRequired

Availability Zone

String

Availability zone for the instance

Events

Instance Id

String

ID of the instance

Instance State

Instance Status

System Status

### Instance Status Event
FieldTypeDescriptionDefault ValueRequired

Code

String

Code for the event. Valid values include:

  • instance-reboot

  • system-reboot

  • system-maintenance

  • instance-retirement

  • instance-stop

Description

String

Description of the event.

Not After

DateTime

Specifies the latest scheduled time the event can end.

Not Before

DateTime

Specifies the earliest scheduled time the event can start.

### Instance State
FieldTypeDescriptionDefault ValueRequired

Code

Number

16-bit unsigned integer state code of the instance. Valid values include:

  • 0 : pending

  • 16 : running

  • 32 : shutting-down

  • 48 : terminated

  • 64 : stopping

  • 80 : stopped

Name

String

### Instance Status Summary
FieldTypeDescriptionDefault ValueRequired

Details

Status

String

Status of the instance. Valid values include:

  • ok

  • impaired

  • insufficient-data

  • not-applicable

  • initializing

### Instance Status Details
FieldTypeDescriptionDefault ValueRequired

Impaired Since

DateTime

Timestamp of the status check failure.

Name

String

Type of the instance status. Valid value is reachability.

Status

String

Status of the instance. Valid values include:

  • passed

  • failed

  • insufficient-data

  • initializing

### Reservation
FieldTypeDescriptionDefault ValueRequired

Group Names

Array of String

Names of the groups

Groups

Instances

Array of Instance

Owner Id

String

ID of the AWS account that owns the reservation

Requester Id

String

ID of the requester that launched the instances, for example, AWS Management Console

Reservation Id

String

ID of the reservation

### Instance
FieldTypeDescriptionDefault ValueRequired

Ami Launch Index

Number

AMI launch index that to use to find this instance in the launch group

Architecture

String

Image architecture. Valid values include:

  • i386

  • x86_64

  • arm64

Block Device Mappings

Client Token

String

Idempotency token that was provided when the instance was launched

Cpu Options

CPU options for the instance.

Ebs Optimized

Boolean

Whether to optimize the instance for Amazon EBS I/O. This is not available with all instance types, as there additional usage charges associated with using an EBS Optimized instance.

Ena Support

Boolean

Specifies whether to enable enhanced networking with ENA

Hypervisor

String

Hypervisor type of the instance. Valid values include:

  • ovm

  • xen
    The xen value is used for both Xen and Nitro hypervisors

Iam Instance Profile

Image Id

String

ID of the AMI used to launch the instance

Instance Id

String

ID of the instance

Instance Lifecycle

String

Specifies the lifecycle of the instance. Valid values include:

  • spot

  • scheduled

Instance Type

String

Type of instance. See the Amazon API Reference for valid values.

Kernel Id

String

ID of the kernel associated with the instance

Key Name

String

Name of the key pair associated with the instance

Launch Time

DateTime

Time the instance was launched

Monitoring

String

Monitoring for the instance

Network Interfaces

Placement

Platform

String

Valid value is Windows for instances launched on a Windows platform. Otherwise, leave this value blank.

Private Dns Name

String

For IPv4, this is the private DNS hostname assigned to the instance. The DNS hostname can only be used inside the Amazon EC2 network and is not available until the instance is in the running state.

Private Ip Address

String

Private IPv4 address assigned to the instance

Product Codes

Array of Product Code

Product codes attached to the instance

Public Dns Name

String

Public DNS name

Public Ip Address

String

Public IP address assigned to the instance

Ramdisk Id

String

ID of the RAM disk associated with the instance

Root Device Name

String

Name of the root device volume

Root Device Type

String

Type of the root device used by the AMI. Valid values include:

  • ebs

  • instance-store

Security Groups

Source Dest Check

Boolean

A value of true means that source or destination checking is enabled. A value of false means that source or destination checking is disabled. The value must be false for an instance that is launched in a VPC to perform NAT.

Spot Instance Request Id

String

ID of the request

Sriov Net Support

String

Whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

State

State Reason

State Transition Reason

String

Subnet Id

String

ID of the subnet the instance is running in

Tags

Array of Tag

Virtualization Type

String

Virtualization type of the instance

Vpc Id

String

ID of the VPC the instance is running in

### CPU Options
FieldTypeDescriptionDefault ValueRequired

Core Count

Number

Number of CPU cores for the instance.

Threads Per Core

Number

Number of threads per CPU core.

### Instance Network Interface
FieldTypeDescriptionDefault ValueRequired

Association

Attachment

Description

String

Description of the network interface

Groups

Ipv6 Addresses

Array of String

IPv6 addresses associated with the network interface

Mac Address

String

MAC address of the network interface

Network Interface Id

String

ID of the network interface

Owner Id

String

ID of the AWS account that created the network interface

Private Dns Name

String

Name of the private DNS

Private Ip Address

String

IPv4 address of the network interface that is within the subnet

Private Ip Addresses

Source Dest Check

Boolean

A value of true means that source or destination checking is enabled. A value of false means that source or destination checking is disabled. The value must be false for an instance that is launched in a VPC to perform NAT.

Status

String

Network interface status. Valid values are:

  • available

  • associated

  • attaching

  • in-use

  • detaching

Subnet Id

String

ID of the subnet

Vpc Id

String

ID of the VPC

### Instance Network Interface Association
FieldTypeDescriptionDefault ValueRequired

Ip Owner Id

String

ID of the Elastic IP address owner

Public Dns Name

String

Public DNS name

Public Ip

String

Public IP address or Elastic IP address that is bound to the network interface

### Instance Network Interface Attachment
FieldTypeDescriptionDefault ValueRequired

Attach Time

DateTime

Timestamp of when the attachment was initiated

Attachment Id

String

ID of the network interface attachment

Delete On Termination

Boolean

Specifies whether to delete the instance when it’s terminated

Device Index

Number

Index of the device that is on the instance for the network interface attachment

Status

String

State of the attachment

### Instance Private IP Address
FieldTypeDescriptionDefault ValueRequired

Association

Primary

Boolean

If true, designates this IPv4 address as the primary private IP address of the network interface

Private Dns Name

String

Private IPv4 DNS name

Private Ip Address

String

Private IPv4 address of the network interface

### Placement
FieldTypeDescriptionDefault ValueRequired

Affinity

String

Affinity setting for the instance on the dedicated host

Availability Zone

String

Availability Zone of the instance

Group Name

String

Name of the placement group that contains the instance

Host Id

String

ID of the dedicated host

Tenancy

String

Tenancey of the instance, if the instance is running in a VPC

### Key Pair Info
FieldTypeDescriptionDefault ValueRequired

Key Fingerprint

String

SHA-1 digest of the DER encoded private key if CreateKeyPair was used to create the key pair. If ImportKeyPair was used to create the key pair, this is the MD5 public key fingerprint as described in section 4 of RFC4716.

Key Name

String

Name of the key pair

### Move Address Status
FieldTypeDescriptionDefault ValueRequired

Move Status

String

Status of the Elastic IP address to move to the EC2-VPC platform, or to restore to the EC2-Classic platform. Valid values include:

  • movingToVpc

  • restoringToClassic

Public Ip

String

Elastic IP address

### Repeatable In Memory Iterable
FieldTypeDescriptionDefault ValueRequired

Initial Buffer Size

Number

The number of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to Buffer size increment, with an upper limit of maxInMemorySize. Default value is 100 instances.

100

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances.

Max Buffer Size

Number

The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

### Repeatable File Store Iterable
FieldTypeDescriptionDefault ValueRequired

Max in Memory Size

Number

The maximum number of instances to keep in memory. If more than that is required, content starts to buffer on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

### Describe Network Interface Attribute Result
FieldTypeDescriptionDefault ValueRequired

Attachment

Description

String

Description of the network interface

Groups

Network Interface Id

String

ID of the network interface

Source Dest Check

Boolean

A value of true means that source or destination checking is enabled. A value of false means that source or destination checking is disabled. The value must be false for an instance that is launched in a VPC to perform NAT.

### Region
FieldTypeDescriptionDefault ValueRequired

Endpoint

String

Endpoint of the Region service

Region Name

String

Name of the region

### Security Group Reference
FieldTypeDescriptionDefault ValueRequired

Group Id

String

ID of the security group

Referencing Vpc Id

String

ID of the VPC with the referenced security group

Vpc Peering Connection Id

String

ID of the VPC peering connection

### Security Group
FieldTypeDescriptionDefault ValueRequired

Description

String

Description for the security group

Group Id

String

ID of the security group

Group Name

String

Name of the security group

Ip Permissions

Array of IP Permission

Ip Permissions Egress

Array of IP Permission

Owner Id

String

AWS account ID of the security group owner

Tags

Array of Tag

Vpc Id

String

ID of the security group VPC

### Describe Snapshot Attribute Result
FieldTypeDescriptionDefault ValueRequired

Create Volume Permissions

Product Codes

Array of Product Code

Snapshot Id

String

ID of the snapshot

### Create Volume Permission
FieldTypeDescriptionDefault ValueRequired

Group

String

Group to add or remove. Valid value is all.

User Id

String

AWS account ID to add or remove.

### Stale Security Group
FieldTypeDescriptionDefault ValueRequired

Description

String

Description for the security group

Group Id

String

ID of the security group

Group Name

String

Name of the security group

Stale Ip Permissions

Stale Ip Permissions Egress

Vpc Id

String

ID of the security group VPC

### Stale IP Permission
FieldTypeDescriptionDefault ValueRequired

From Port

Number

Start of the port range for the TCP and UDP protocols. Can also be an ICMP type number. A value of -1 indicates all ICMP types.

Ip Protocol

String

IP protocol name for tcip, udp, and icmp, or a protocol number. Does not apply to stale security group rules.

Ip Ranges

Array of String

IP ranges. Does not apply to stale security group rules.

Prefix List Ids

Array of String

Prefix list IDs. Does not apply to stale security group rules.

To Port

Number

End of the port range for the TCP and UDP protocols. Can also be an ICMP type number. A value of -1 indicates all ICMP types.

User Id Group Pairs

### Tag Description
FieldTypeDescriptionDefault ValueRequired

Key

String

Tag key

Resource Id

String

ID of the resource

Resource Type

String

Type of the resource

Value

String

Tag value

### Describe Volume Attribute Result
FieldTypeDescriptionDefault ValueRequired

Auto Enable IO

Boolean

State of the autoEnableIO attribute

Product Codes

Array of Product Code

Volume Id

String

ID of the volume

### Volume Status Item
FieldTypeDescriptionDefault ValueRequired

Actions

Details of the operation

Availability Zone

String

Volume’s availability zone

Events

List of events associated with the volume

Volume Id

String

ID of the volume

Volume Status

Status of the volume

### Volume Status Action
FieldTypeDescriptionDefault ValueRequired

Code

String

Code that identifies the operation

Description

String

Description of the operation

Event Id

String

ID of the event associated with the operation

Event Type

String

Type of event associated with the operation

### Volume Status Event
FieldTypeDescriptionDefault ValueRequired

Description

String

Description of the event

Event Id

String

ID of the event

Event Type

String

Type of event

Not After

DateTime

Timestamp for the latest end time of the event

Not Before

DateTime

Timestamp for the earliest start of the event

### Volume Status Info
FieldTypeDescriptionDefault ValueRequired

Details

Status

String

Intended status of the volume status

### Volume Status Details
FieldTypeDescriptionDefault ValueRequired

Name

String

Name of the volume

Status

String

Status of the volume (ok, impaired, insufficient-data)

### Volume Modification
FieldTypeDescriptionDefault ValueRequired

End Time

DateTime

Completion or failure time of the modification.

Modification State

String

Current state of the modification (modifying, optimizing, completed, failed). For unmodified volumes, the state is null.

Original Iops

Number

Original IOPS rate of the volume.

Original Size

Number

Original size of the volume in G1B.

Original Volume Type

String

Original EBS volume type of the volume.

Progress

Number

Progress of the volume modification from 0 to 100 percent complete.

Start Time

DateTime

Start time of the modification.

Status Message

String

Status message about the modification progress.

Target Iops

Number

Target IOPS rate of the volume.

Target Size

Number

Target size of the volume in GiB.

Target Volume Type

String

Target EBS volume type of the volume.

Volume Id

String

ID of the volume.

### Get Console Output Result
FieldTypeDescriptionDefault ValueRequired

Instance Id

String

ID of the instance

Output

String

Base-64-encoded console output

Timestamp

DateTime

Timestamp of when the output was last updated

### Get Console Screenshot Result
FieldTypeDescriptionDefault ValueRequired

Image Data

String

Data that constitutes the image

Instance Id

String

ID of the instance

### Get Password Data Result
FieldTypeDescriptionDefault ValueRequired

Instance Id

String

ID of the Windows instance

Password Data

String

Password of the instance

Timestamp

DateTime

Timestamp of when the data was last updated

### Import Key Pair Result
FieldTypeDescriptionDefault ValueRequired

Key Fingerprint

String

SHA-1 digest of the DER encoded private key if CreateKeyPair was used to create the key pair. If ImportKeyPair was used to create the key pair, this is the MD5 public key fingerprint as described in section 4 of RFC4716.

Key Name

String

Name of the key pair

### Instance Monitoring
FieldTypeDescriptionDefault ValueRequired

Instance Id

String

ID of the instance

Monitoring

String

Monitoring for the instance

### Move Address To VPC Result
FieldTypeDescriptionDefault ValueRequired

Allocation Id

String

Elastic IP address allocation ID

Status

String

Status for the move of the IP address. Valid values include:

  • MoveInProgress

  • InVpc

  • InClassic

### Restore Address To Classic Result
FieldTypeDescriptionDefault ValueRequired

Public Ip

String

Elastic IP address

Status

String

Status of the IP address move

### Instance State Change
FieldTypeDescriptionDefault ValueRequired

Current State

Instance Id

String

ID of the instance

Previous State

### Unassign IPv6 Addresses Result
FieldTypeDescriptionDefault ValueRequired

Network Interface Id

String

ID of the network interface

Unassigned Ipv6 Addresses

Array of String

IPv6 addresses to unassign from the network interface

## Exception Throw List - 1 - EC2:ACTIVE\_VPC\_PEERING\_CONNECTION\_PER\_VPC\_LIMIT\_EXCEEDED - EC2:ADDRESS\_LIMIT\_EXCEEDED - EC2:ASN\_CONFLICT - EC2:ATTACHMENT\_LIMIT\_EXCEEDED - EC2:AUTH\_FAILURE - EC2:BLOCKED - EC2:BOOT\_FOR\_VOLUME\_TYPE\_UNSUPPORTED - EC2:BUNDLING\_IN\_PROGRESS - EC2:CANNOT\_DELETE - EC2:CIDR\_CONFLICT - EC2:CONCURRENT\_SNAPSHOT\_LIMIT\_EXCEEDED - EC2:CONCURRENT\_TAG\_ACCESS - EC2:CONNECTIVITY - EC2:CUSTOMER\_GATEWAY\_LIMIT\_EXCEEDED - EC2:CUSTOMER\_KEY\_HAS\_BEEN\_REVOKED - EC2:DEFAULT\_VPC\_ALREADY\_EXISTS - EC2:DELETE\_CONVERSION\_TASK\_ERROR - EC2:DEPENDENCY\_VIOLATION - EC2:DISALLOWED\_FOR\_DEDICATED\_TENANCY\_NETWORK - EC2:DISK\_IMAGE\_SIZE\_TOO\_LARGE - EC2:DRY\_RUN\_OPERATION - EC2:EIP\_MIGRATED\_TO\_VPC - EC2:ENCRYPTED\_VOLUMES\_NOT\_SUPPORTED - EC2:FILTER\_LIMIT\_EXCEEDED - EC2:FLEET\_NOT\_IN\_MODIFIABLE\_STATE - EC2:FLOW\_LOG\_ALREADY\_EXISTS - EC2:FLOW\_LOGS\_LIMIT\_EXCEEDED - EC2:GATEWAY\_NOT\_ATTACHED - EC2:HOST\_ALREADY\_COVERED\_BY\_RESERVATION - EC2:HOST\_LIMIT\_EXCEEDED - EC2:IDEMPOTENT\_INSTANCE\_TERMINATED - EC2:IDEMPOTENT\_PARAMETER\_MISMATCH - EC2:INACCESSIBLE\_STORAGE\_LOCATION - EC2:INCOMPATIBLE\_HOST\_REQUIREMENTS - EC2:INCOMPLETE\_SIGNATURE - EC2:INCORRECT\_INSTANCE\_STATE - EC2:INCORRECT\_STATE - EC2:INSTANCE\_ALREADY\_LINKED - EC2:INSTANCE\_LIMIT\_EXCEEDED - EC2:INSUFFICIENT\_ADDRESS\_CAPACITY - EC2:INSUFFICIENT\_CAPACITY - EC2:INSUFFICIENT\_CAPACITY\_ON\_HOST - EC2:INSUFFICIENT\_FREE\_ADDRESSES\_IN\_SUBNET - EC2:INSUFFICIENT\_HOST\_CAPACITY - EC2:INSUFFICIENT\_INSTANCE\_CAPACITY - EC2:INSUFFICIENT\_RESERVED\_INSTANCE\_CAPACITY - EC2:INSUFFICIENT\_RESERVED\_INSTANCES\_CAPACITY - EC2:INTERNAL\_ERROR - EC2:INTERNAL\_FAILURE - EC2:INTERNET\_GATEWAY\_LIMIT\_EXCEEDED - EC2:INVALID\_ACTION - EC2:INVALID\_ADDRESS\_ID\_NOT\_FOUND - EC2:INVALID\_ADDRESS\_LOCKED - EC2:INVALID\_ADDRESS\_MALFORMED - EC2:INVALID\_ADDRESS\_NOT\_FOUND - EC2:INVALID\_AFFINITY - EC2:INVALID\_ALLOCATION\_ID\_NOT\_FOUND - EC2:INVALID\_AMI\_ATTRIBUTE\_ITEM\_VALUE - EC2:INVALID\_AMI\_NAME\_DUPLICATE - EC2:INVALID\_AMI\_NAME\_MALFORMED - EC2:INVALID\_AMIID\_MALFORMED - EC2:INVALID\_AMIID\_NOT\_FOUND - EC2:INVALID\_AMIID\_UNAVAILABLE - EC2:INVALID\_ASSOCIATION\_ID\_NOT\_FOUND - EC2:INVALID\_ATTACHMENT\_ID\_NOT\_FOUND - EC2:INVALID\_ATTACHMENT\_NOT\_FOUND - EC2:INVALID\_AUTO\_PLACEMENT - EC2:INVALID\_AVAILABILITY\_ZONE - EC2:INVALID\_BLOCK\_DEVICE\_MAPPING - EC2:INVALID\_BUNDLE\_ID\_NOT\_FOUND - EC2:INVALID\_CHARACTER - EC2:INVALID\_CIDR\_IN\_USE - EC2:INVALID\_CLIENT\_TOKEN - EC2:INVALID\_CLIENT\_TOKEN\_ID - EC2:INVALID\_CONVERSION\_TASK\_ID - EC2:INVALID\_CONVERSION\_TASK\_ID\_MALFORMED - EC2:INVALID\_CUSTOMER\_GATEWAY\_DUPLICATE\_IP\_ADDRESS - EC2:INVALID\_CUSTOMER\_GATEWAY\_ID\_MALFORMED - EC2:INVALID\_CUSTOMER\_GATEWAY\_ID\_NOT\_FOUND - EC2:INVALID\_CUSTOMER\_GATEWAY\_STATE - EC2:INVALID\_DEVICE\_IN\_USE - EC2:INVALID\_DHCP\_OPTION\_ID\_NOT\_FOUND - EC2:INVALID\_DHCP\_OPTIONS\_ID\_MALFORMED - EC2:INVALID\_DHCP\_OPTIONS\_ID\_NOT\_FOUND - EC2:INVALID\_EXPORT\_TASK\_ID\_NOT\_FOUND - EC2:INVALID\_FILTER - EC2:INVALID\_FLOW\_LOG\_ID\_NOT\_FOUND - EC2:INVALID\_FORMAT - EC2:INVALID\_FPGA\_IMAGE\_ID\_MALFORMED - EC2:INVALID\_FPGA\_IMAGE\_ID\_NOT\_FOUND - EC2:INVALID\_GATEWAY\_ID\_NOT\_FOUND - EC2:INVALID\_GROUP\_DUPLICATE - EC2:INVALID\_GROUP\_ID\_MALFORMED - EC2:INVALID\_GROUP\_IN\_USE - EC2:INVALID\_GROUP\_NOT\_FOUND - EC2:INVALID\_GROUP\_RESERVED - EC2:INVALID\_HOST\_CONFIGURATION - EC2:INVALID\_HOST\_ID - EC2:INVALID\_HOST\_ID\_MALFORMED - EC2:INVALID\_HOST\_ID\_NOT\_FOUND - EC2:INVALID\_HOST\_RESERVATION\_ID\_MALFORMED - EC2:INVALID\_HOST\_RESERVATION\_OFFERING\_ID\_MALFORMED - EC2:INVALID\_HOST\_STATE - EC2:INVALID\_ID - EC2:INVALID\_INPUT - EC2:INVALID\_INSTANCE\_ATTRIBUTE\_VALUE - EC2:INVALID\_INSTANCE\_FAMILY - EC2:INVALID\_INSTANCE\_ID - EC2:INVALID\_INSTANCE\_ID\_MALFORMED - EC2:INVALID\_INSTANCE\_ID\_NOT\_FOUND - EC2:INVALID\_INSTANCE\_ID\_NOT\_LINKABLE - EC2:INVALID\_INSTANCE\_STATE - EC2:INVALID\_INSTANCE\_TYPE - EC2:INVALID\_INTERFACE\_IP\_ADDRESS\_LIMIT\_EXCEEDED - EC2:INVALID\_INTERNET\_GATEWAY\_ID\_MALFORMED - EC2:INVALID\_INTERNET\_GATEWAY\_ID\_NOT\_FOUND - EC2:INVALID\_IP\_ADDRESS\_IN\_USE - EC2:INVALID\_KEY\_FORMAT - EC2:INVALID\_KEY\_PAIR\_DUPLICATE - EC2:INVALID\_KEY\_PAIR\_FORMAT - EC2:INVALID\_KEY\_PAIR\_NOT\_FOUND - EC2:INVALID\_MANIFEST - EC2:INVALID\_MAX\_RESULTS - EC2:INVALID\_NAT\_GATEWAY\_ID\_NOT\_FOUND - EC2:INVALID\_NETWORK\_ACL\_ENTRY\_NOT\_FOUND - EC2:INVALID\_NETWORK\_ACL\_ID\_MALFORMED - EC2:INVALID\_NETWORK\_ACL\_ID\_NOT\_FOUND - EC2:INVALID\_NETWORK\_INTERFACE\_ATTACHMENT\_ID\_MALFORMED - EC2:INVALID\_NETWORK\_INTERFACE\_ID\_MALFORMED - EC2:INVALID\_NETWORK\_INTERFACE\_ID\_NOT\_FOUND - EC2:INVALID\_NETWORK\_INTERFACE\_IN\_USE - EC2:INVALID\_NEXT\_TOKEN - EC2:INVALID\_OPTION\_CONFLICT - EC2:INVALID\_PAGINATION\_TOKEN - EC2:INVALID\_PARAMETER - EC2:INVALID\_PARAMETER\_COMBINATION - EC2:INVALID\_PARAMETER\_VALUE - EC2:INVALID\_PERMISSION\_DUPLICATE - EC2:INVALID\_PERMISSION\_MALFORMED - EC2:INVALID\_PERMISSION\_NOT\_FOUND - EC2:INVALID\_PLACEMENT\_GROUP\_DUPLICATE - EC2:INVALID\_PLACEMENT\_GROUP\_IN\_USE - EC2:INVALID\_PLACEMENT\_GROUP\_UNKNOWN - EC2:INVALID\_POLICY\_DOCUMENT - EC2:INVALID\_PREFIX\_LIST\_ID\_MALFORMED - EC2:INVALID\_PREFIX\_LIST\_ID\_NOT\_FOUND - EC2:INVALID\_PRODUCT\_INFO - EC2:INVALID\_PURCHASE\_TOKEN\_EXPIRED - EC2:INVALID\_PURCHASE\_TOKEN\_MALFORMED - EC2:INVALID\_QUANTITY - EC2:INVALID\_QUERY\_PARAMETER - EC2:INVALID\_REGION - EC2:INVALID\_REQUEST - EC2:INVALID\_RESERVATION\_ID\_MALFORMED - EC2:INVALID\_RESERVATION\_ID\_NOT\_FOUND - EC2:INVALID\_RESERVED\_INSTANCES\_ID - EC2:INVALID\_RESERVED\_INSTANCES\_OFFERING\_ID - EC2:INVALID\_RESOURCE\_TYPE\_UNKNOWN - EC2:INVALID\_ROUTE\_INVALID\_STATE - EC2:INVALID\_ROUTE\_MALFORMED - EC2:INVALID\_ROUTE\_NOT\_FOUND - EC2:INVALID\_ROUTE\_TABLE\_ID\_MALFORMED - EC2:INVALID\_ROUTE\_TABLE\_ID\_NOT\_FOUND - EC2:INVALID\_SCHEDULED\_INSTANCE - EC2:INVALID\_SECURITY\_GROUP\_ID\_NOT\_FOUND - EC2:INVALID\_SECURITY\_REQUEST\_HAS\_EXPIRED - EC2:INVALID\_SERVICE\_NAME - EC2:INVALID\_SNAPSHOT\_ID\_MALFORMED - EC2:INVALID\_SNAPSHOT\_IN\_USE - EC2:INVALID\_SNAPSHOT\_NOT\_FOUND - EC2:INVALID\_SPOT\_DATAFEED\_NOT\_FOUND - EC2:INVALID\_SPOT\_FLEET\_REQUEST\_CONFIG - EC2:INVALID\_SPOT\_FLEET\_REQUEST\_ID\_MALFORMED - EC2:INVALID\_SPOT\_FLEET\_REQUEST\_ID\_NOT\_FOUND - EC2:INVALID\_SPOT\_INSTANCE\_REQUEST\_ID\_MALFORMED - EC2:INVALID\_SPOT\_INSTANCE\_REQUEST\_ID\_NOT\_FOUND - EC2:INVALID\_STATE - EC2:INVALID\_STATE\_TRANSITION - EC2:INVALID\_SUBNET - EC2:INVALID\_SUBNET\_CONFLICT - EC2:INVALID\_SUBNET\_ID\_NOT\_FOUND - EC2:INVALID\_SUBNET\_RANGE - EC2:INVALID\_TARGET\_ARN\_UNKNOWN - EC2:INVALID\_TENANCY - EC2:INVALID\_TIME - EC2:INVALID\_USER\_ID\_MALFORMED - EC2:INVALID\_VOLUME\_ID\_DUPLICATE - EC2:INVALID\_VOLUME\_ID\_MALFORMED - EC2:INVALID\_VOLUME\_ID\_ZONE\_MISMATCH - EC2:INVALID\_VOLUME\_NOT\_FOUND - EC2:INVALID\_VOLUME\_ZONE\_MISMATCH - EC2:INVALID\_VPC\_ENDPOINT\_ID\_MALFORMED - EC2:INVALID\_VPC\_ENDPOINT\_ID\_NOT\_FOUND - EC2:INVALID\_VPC\_ID\_MALFORMED - EC2:INVALID\_VPC\_ID\_NOT\_FOUND - EC2:INVALID\_VPC\_PEERING\_CONNECTION\_ID\_MALFORMED - EC2:INVALID\_VPC\_PEERING\_CONNECTION\_ID\_NOT\_FOUND - EC2:INVALID\_VPC\_PEERING\_CONNECTION\_STATE\_DNS\_HOSTNAMES\_DISABLED - EC2:INVALID\_VPC\_RANGE - EC2:INVALID\_VPC\_STATE - EC2:INVALID\_VPN\_CONNECTION\_ID - EC2:INVALID\_VPN\_CONNECTION\_ID\_NOT\_FOUND - EC2:INVALID\_VPN\_CONNECTION\_INVALID\_STATE - EC2:INVALID\_VPN\_CONNECTION\_INVALID\_TYPE - EC2:INVALID\_VPN\_GATEWAY\_ATTACHMENT\_NOT\_FOUND - EC2:INVALID\_VPN\_GATEWAY\_ID\_NOT\_FOUND - EC2:INVALID\_VPN\_GATEWAY\_STATE - EC2:INVALID\_ZONE\_NOT\_FOUND - EC2:KEY\_PAIR\_LIMIT\_EXCEEDED - EC2:LEGACY\_SECURITY\_GROUP - EC2:LIMIT\_PRICE\_EXCEEDED - EC2:MALFORMED\_QUERY\_STRING - EC2:MAX\_IOPS\_LIMIT\_EXCEEDED - EC2:MAX\_SCHEDULED\_INSTANCE\_CAPACITY\_EXCEEDED - EC2:MAX\_SPOT\_FLEET\_REQUEST\_COUNT\_EXCEEDED - EC2:MAX\_SPOT\_INSTANCE\_COUNT\_EXCEEDED - EC2:MISSING\_ACTION - EC2:MISSING\_AUTHENTICATION\_TOKEN - EC2:MISSING\_INPUT - EC2:MISSING\_PARAMETER - EC2:NAT\_GATEWAY\_LIMIT\_EXCEEDED - EC2:NAT\_GATEWAY\_MALFORMED - EC2:NAT\_GATEWAY\_NOT\_FOUND - EC2:NETWORK\_ACL\_ENTRY\_ALREADY\_EXISTS - EC2:NETWORK\_ACL\_ENTRY\_LIMIT\_EXCEEDED - EC2:NETWORK\_ACL\_LIMIT\_EXCEEDED - EC2:NETWORK\_INTERFACE\_LIMIT\_EXCEEDED - EC2:NO\_SUCH\_VERSION - EC2:NON\_EBS\_INSTANCE - EC2:NOT\_EXPORTABLE - EC2:OPERATION\_NOT\_PERMITTED - EC2:OPT\_IN\_REQUIRED - EC2:OUTSTANDING\_VPC\_PEERING\_CONNECTION\_LIMIT\_EXCEEDED - EC2:PENDING\_SNAPSHOT\_LIMIT\_EXCEEDED - EC2:PENDING\_VERIFICATION - EC2:PENDING\_VPC\_PEERING\_CONNECTION\_LIMIT\_EXCEEDED - EC2:PLACEMENT\_GROUP\_LIMIT\_EXCEEDED - EC2:PRIVATE\_IP\_ADDRESS\_LIMIT\_EXCEEDED - EC2:REQUEST\_EXPIRED - EC2:REQUEST\_LIMIT\_EXCEEDED - EC2:REQUEST\_RESOURCE\_COUNT\_EXCEEDED - EC2:RESERVED\_INSTANCES\_COUNT\_EXCEEDED - EC2:RESERVED\_INSTANCES\_LIMIT\_EXCEEDED - EC2:RESERVED\_INSTANCES\_UNAVAILABLE - EC2:RESOURCE\_ALREADY\_ASSIGNED - EC2:RESOURCE\_ALREADY\_ASSOCIATED - EC2:RESOURCE\_COUNT\_EXCEEDED - EC2:RESOURCE\_COUNT\_LIMIT\_EXCEEDED - EC2:RESOURCE\_LIMIT\_EXCEEDED - EC2:RETRY\_EXHAUSTED - EC2:ROUTE\_ALREADY\_EXISTS - EC2:ROUTE\_LIMIT\_EXCEEDED - EC2:ROUTE\_TABLE\_LIMIT\_EXCEEDED - EC2:RULES\_PER\_SECURITY\_GROUP\_LIMIT\_EXCEEDED - EC2:SCHEDULED\_INSTANCE\_LIMIT\_EXCEEDED - EC2:SCHEDULED\_INSTANCE\_PARAMETER\_MISMATCH - EC2:SCHEDULED\_INSTANCE\_SLOT\_NOT\_OPEN - EC2:SCHEDULED\_INSTANCE\_SLOT\_UNAVAILABLE - EC2:SECURITY\_GROUP\_LIMIT\_EXCEEDED - EC2:SECURITY\_GROUPS\_PER\_INSTANCE\_LIMIT\_EXCEEDED - EC2:SECURITY\_GROUPS\_PER\_INTERFACE\_LIMIT\_EXCEEDED - EC2:SERVICE\_UNAVAILABLE - EC2:SIGNATURE\_DOES\_NOT\_MATCH - EC2:SNAPSHOT\_COPY\_UNSUPPORTED\_INTER\_REGION - EC2:SNAPSHOT\_CREATION\_PER\_VOLUME\_RATE\_EXCEEDED - EC2:SNAPSHOT\_LIMIT\_EXCEEDED - EC2:SUBNET\_LIMIT\_EXCEEDED - EC2:TAG\_LIMIT\_EXCEEDED - EC2:UNAUTHORIZED\_OPERATION - EC2:UNAVAILABLE - EC2:UNAVAILABLE\_HOST\_REQUIREMENTS - EC2:UNKNOWN - EC2:UNKNOWN\_PARAMETER - EC2:UNKNOWN\_PRINCIPAL\_TYPE\_UNSUPPORTED - EC2:UNKNOWN\_VOLUME\_TYPE - EC2:UNSUPPORTED - EC2:UNSUPPORTED\_HOST\_CONFIGURATION - EC2:UNSUPPORTED\_INSTANCE\_ATTRIBUTE - EC2:UNSUPPORTED\_INSTANCE\_TYPE\_ON\_HOST - EC2:UNSUPPORTED\_OPERATION - EC2:UNSUPPORTED\_PROTOCOL - EC2:UNSUPPORTED\_TENANCY - EC2:VALIDATION\_ERROR - EC2:VOLUME\_IN\_USE - EC2:VOLUME\_IOPS\_LIMIT - EC2:VOLUME\_LIMIT\_EXCEEDED - EC2:VOLUME\_TYPE\_NOT\_AVAILABLE\_IN\_ZONE - EC2:VPC\_CIDR\_CONFLICT - EC2:VPC\_ENDPOINT\_LIMIT\_EXCEEDED - EC2:VPC\_ID\_NOT\_SPECIFIED - EC2:VPC\_LIMIT\_EXCEEDED - EC2:VPC\_PEERING\_CONNECTION\_ALREADY\_EXISTS - EC2:VPC\_PEERING\_CONNECTIONS\_PER\_VPC\_LIMIT\_EXCEEDED - EC2:VPC\_RESOURCE\_NOT\_SPECIFIED - EC2:VPN\_CONNECTION\_LIMIT\_EXCEEDED - EC2:VPN\_GATEWAY\_ATTACHMENT\_LIMIT\_EXCEEDED - EC2:VPN\_GATEWAY\_LIMIT\_EXCEEDED - EC2:ZONES\_MISMATCHED ## Exception Throw List - 2 - EC2:ACTIVE\_VPC\_PEERING\_CONNECTION\_PER\_VPC\_LIMIT\_EXCEEDED - EC2:ADDRESS\_LIMIT\_EXCEEDED - EC2:ASN\_CONFLICT - EC2:ATTACHMENT\_LIMIT\_EXCEEDED - EC2:AUTH\_FAILURE - EC2:BLOCKED - EC2:BOOT\_FOR\_VOLUME\_TYPE\_UNSUPPORTED - EC2:BUNDLING\_IN\_PROGRESS - EC2:CANNOT\_DELETE - EC2:CIDR\_CONFLICT - EC2:CONCURRENT\_SNAPSHOT\_LIMIT\_EXCEEDED - EC2:CONCURRENT\_TAG\_ACCESS - EC2:CUSTOMER\_GATEWAY\_LIMIT\_EXCEEDED - EC2:CUSTOMER\_KEY\_HAS\_BEEN\_REVOKED - EC2:DEFAULT\_VPC\_ALREADY\_EXISTS - EC2:DELETE\_CONVERSION\_TASK\_ERROR - EC2:DEPENDENCY\_VIOLATION - EC2:DISALLOWED\_FOR\_DEDICATED\_TENANCY\_NETWORK - EC2:DISK\_IMAGE\_SIZE\_TOO\_LARGE - EC2:DRY\_RUN\_OPERATION - EC2:EIP\_MIGRATED\_TO\_VPC - EC2:ENCRYPTED\_VOLUMES\_NOT\_SUPPORTED - EC2:FILTER\_LIMIT\_EXCEEDED - EC2:FLEET\_NOT\_IN\_MODIFIABLE\_STATE - EC2:FLOW\_LOG\_ALREADY\_EXISTS - EC2:FLOW\_LOGS\_LIMIT\_EXCEEDED - EC2:GATEWAY\_NOT\_ATTACHED - EC2:HOST\_ALREADY\_COVERED\_BY\_RESERVATION - EC2:HOST\_LIMIT\_EXCEEDED - EC2:IDEMPOTENT\_INSTANCE\_TERMINATED - EC2:IDEMPOTENT\_PARAMETER\_MISMATCH - EC2:INACCESSIBLE\_STORAGE\_LOCATION - EC2:INCOMPATIBLE\_HOST\_REQUIREMENTS - EC2:INCOMPLETE\_SIGNATURE - EC2:INCORRECT\_INSTANCE\_STATE - EC2:INCORRECT\_STATE - EC2:INSTANCE\_ALREADY\_LINKED - EC2:INSTANCE\_LIMIT\_EXCEEDED - EC2:INSUFFICIENT\_ADDRESS\_CAPACITY - EC2:INSUFFICIENT\_CAPACITY - EC2:INSUFFICIENT\_CAPACITY\_ON\_HOST - EC2:INSUFFICIENT\_FREE\_ADDRESSES\_IN\_SUBNET - EC2:INSUFFICIENT\_HOST\_CAPACITY - EC2:INSUFFICIENT\_INSTANCE\_CAPACITY - EC2:INSUFFICIENT\_RESERVED\_INSTANCE\_CAPACITY - EC2:INSUFFICIENT\_RESERVED\_INSTANCES\_CAPACITY - EC2:INTERNAL\_ERROR - EC2:INTERNAL\_FAILURE - EC2:INTERNET\_GATEWAY\_LIMIT\_EXCEEDED - EC2:INVALID\_ACTION - EC2:INVALID\_ADDRESS\_ID\_NOT\_FOUND - EC2:INVALID\_ADDRESS\_LOCKED - EC2:INVALID\_ADDRESS\_MALFORMED - EC2:INVALID\_ADDRESS\_NOT\_FOUND - EC2:INVALID\_AFFINITY - EC2:INVALID\_ALLOCATION\_ID\_NOT\_FOUND - EC2:INVALID\_AMI\_ATTRIBUTE\_ITEM\_VALUE - EC2:INVALID\_AMI\_NAME\_DUPLICATE - EC2:INVALID\_AMI\_NAME\_MALFORMED - EC2:INVALID\_AMIID\_MALFORMED - EC2:INVALID\_AMIID\_NOT\_FOUND - EC2:INVALID\_AMIID\_UNAVAILABLE - EC2:INVALID\_ASSOCIATION\_ID\_NOT\_FOUND - EC2:INVALID\_ATTACHMENT\_ID\_NOT\_FOUND - EC2:INVALID\_ATTACHMENT\_NOT\_FOUND - EC2:INVALID\_AUTO\_PLACEMENT - EC2:INVALID\_AVAILABILITY\_ZONE - EC2:INVALID\_BLOCK\_DEVICE\_MAPPING - EC2:INVALID\_BUNDLE\_ID\_NOT\_FOUND - EC2:INVALID\_CHARACTER - EC2:INVALID\_CIDR\_IN\_USE - EC2:INVALID\_CLIENT\_TOKEN - EC2:INVALID\_CLIENT\_TOKEN\_ID - EC2:INVALID\_CONVERSION\_TASK\_ID - EC2:INVALID\_CONVERSION\_TASK\_ID\_MALFORMED - EC2:INVALID\_CUSTOMER\_GATEWAY\_DUPLICATE\_IP\_ADDRESS - EC2:INVALID\_CUSTOMER\_GATEWAY\_ID\_MALFORMED - EC2:INVALID\_CUSTOMER\_GATEWAY\_ID\_NOT\_FOUND - EC2:INVALID\_CUSTOMER\_GATEWAY\_STATE - EC2:INVALID\_DEVICE\_IN\_USE - EC2:INVALID\_DHCP\_OPTION\_ID\_NOT\_FOUND - EC2:INVALID\_DHCP\_OPTIONS\_ID\_MALFORMED - EC2:INVALID\_DHCP\_OPTIONS\_ID\_NOT\_FOUND - EC2:INVALID\_EXPORT\_TASK\_ID\_NOT\_FOUND - EC2:INVALID\_FILTER - EC2:INVALID\_FLOW\_LOG\_ID\_NOT\_FOUND - EC2:INVALID\_FORMAT - EC2:INVALID\_FPGA\_IMAGE\_ID\_MALFORMED - EC2:INVALID\_FPGA\_IMAGE\_ID\_NOT\_FOUND - EC2:INVALID\_GATEWAY\_ID\_NOT\_FOUND - EC2:INVALID\_GROUP\_DUPLICATE - EC2:INVALID\_GROUP\_ID\_MALFORMED - EC2:INVALID\_GROUP\_IN\_USE - EC2:INVALID\_GROUP\_NOT\_FOUND - EC2:INVALID\_GROUP\_RESERVED - EC2:INVALID\_HOST\_CONFIGURATION - EC2:INVALID\_HOST\_ID - EC2:INVALID\_HOST\_ID\_MALFORMED - EC2:INVALID\_HOST\_ID\_NOT\_FOUND - EC2:INVALID\_HOST\_RESERVATION\_ID\_MALFORMED - EC2:INVALID\_HOST\_RESERVATION\_OFFERING\_ID\_MALFORMED - EC2:INVALID\_HOST\_STATE - EC2:INVALID\_ID - EC2:INVALID\_INPUT - EC2:INVALID\_INSTANCE\_ATTRIBUTE\_VALUE - EC2:INVALID\_INSTANCE\_FAMILY - EC2:INVALID\_INSTANCE\_ID - EC2:INVALID\_INSTANCE\_ID\_MALFORMED - EC2:INVALID\_INSTANCE\_ID\_NOT\_FOUND - EC2:INVALID\_INSTANCE\_ID\_NOT\_LINKABLE - EC2:INVALID\_INSTANCE\_STATE - EC2:INVALID\_INSTANCE\_TYPE - EC2:INVALID\_INTERFACE\_IP\_ADDRESS\_LIMIT\_EXCEEDED - EC2:INVALID\_INTERNET\_GATEWAY\_ID\_MALFORMED - EC2:INVALID\_INTERNET\_GATEWAY\_ID\_NOT\_FOUND - EC2:INVALID\_IP\_ADDRESS\_IN\_USE - EC2:INVALID\_KEY\_FORMAT - EC2:INVALID\_KEY\_PAIR\_DUPLICATE - EC2:INVALID\_KEY\_PAIR\_FORMAT - EC2:INVALID\_KEY\_PAIR\_NOT\_FOUND - EC2:INVALID\_MANIFEST - EC2:INVALID\_MAX\_RESULTS - EC2:INVALID\_NAT\_GATEWAY\_ID\_NOT\_FOUND - EC2:INVALID\_NETWORK\_ACL\_ENTRY\_NOT\_FOUND - EC2:INVALID\_NETWORK\_ACL\_ID\_MALFORMED - EC2:INVALID\_NETWORK\_ACL\_ID\_NOT\_FOUND - EC2:INVALID\_NETWORK\_INTERFACE\_ATTACHMENT\_ID\_MALFORMED - EC2:INVALID\_NETWORK\_INTERFACE\_ID\_MALFORMED - EC2:INVALID\_NETWORK\_INTERFACE\_ID\_NOT\_FOUND - EC2:INVALID\_NETWORK\_INTERFACE\_IN\_USE - EC2:INVALID\_NEXT\_TOKEN - EC2:INVALID\_OPTION\_CONFLICT - EC2:INVALID\_PAGINATION\_TOKEN - EC2:INVALID\_PARAMETER - EC2:INVALID\_PARAMETER\_COMBINATION - EC2:INVALID\_PARAMETER\_VALUE - EC2:INVALID\_PERMISSION\_DUPLICATE - EC2:INVALID\_PERMISSION\_MALFORMED - EC2:INVALID\_PERMISSION\_NOT\_FOUND - EC2:INVALID\_PLACEMENT\_GROUP\_DUPLICATE - EC2:INVALID\_PLACEMENT\_GROUP\_IN\_USE - EC2:INVALID\_PLACEMENT\_GROUP\_UNKNOWN - EC2:INVALID\_POLICY\_DOCUMENT - EC2:INVALID\_PREFIX\_LIST\_ID\_MALFORMED - EC2:INVALID\_PREFIX\_LIST\_ID\_NOT\_FOUND - EC2:INVALID\_PRODUCT\_INFO - EC2:INVALID\_PURCHASE\_TOKEN\_EXPIRED - EC2:INVALID\_PURCHASE\_TOKEN\_MALFORMED - EC2:INVALID\_QUANTITY - EC2:INVALID\_QUERY\_PARAMETER - EC2:INVALID\_REGION - EC2:INVALID\_REQUEST - EC2:INVALID\_RESERVATION\_ID\_MALFORMED - EC2:INVALID\_RESERVATION\_ID\_NOT\_FOUND - EC2:INVALID\_RESERVED\_INSTANCES\_ID - EC2:INVALID\_RESERVED\_INSTANCES\_OFFERING\_ID - EC2:INVALID\_RESOURCE\_TYPE\_UNKNOWN - EC2:INVALID\_ROUTE\_INVALID\_STATE - EC2:INVALID\_ROUTE\_MALFORMED - EC2:INVALID\_ROUTE\_NOT\_FOUND - EC2:INVALID\_ROUTE\_TABLE\_ID\_MALFORMED - EC2:INVALID\_ROUTE\_TABLE\_ID\_NOT\_FOUND - EC2:INVALID\_SCHEDULED\_INSTANCE - EC2:INVALID\_SECURITY\_GROUP\_ID\_NOT\_FOUND - EC2:INVALID\_SECURITY\_REQUEST\_HAS\_EXPIRED - EC2:INVALID\_SERVICE\_NAME - EC2:INVALID\_SNAPSHOT\_ID\_MALFORMED - EC2:INVALID\_SNAPSHOT\_IN\_USE - EC2:INVALID\_SNAPSHOT\_NOT\_FOUND - EC2:INVALID\_SPOT\_DATAFEED\_NOT\_FOUND - EC2:INVALID\_SPOT\_FLEET\_REQUEST\_CONFIG - EC2:INVALID\_SPOT\_FLEET\_REQUEST\_ID\_MALFORMED - EC2:INVALID\_SPOT\_FLEET\_REQUEST\_ID\_NOT\_FOUND - EC2:INVALID\_SPOT\_INSTANCE\_REQUEST\_ID\_MALFORMED - EC2:INVALID\_SPOT\_INSTANCE\_REQUEST\_ID\_NOT\_FOUND - EC2:INVALID\_STATE - EC2:INVALID\_STATE\_TRANSITION - EC2:INVALID\_SUBNET - EC2:INVALID\_SUBNET\_CONFLICT - EC2:INVALID\_SUBNET\_ID\_NOT\_FOUND - EC2:INVALID\_SUBNET\_RANGE - EC2:INVALID\_TARGET\_ARN\_UNKNOWN - EC2:INVALID\_TENANCY - EC2:INVALID\_TIME - EC2:INVALID\_USER\_ID\_MALFORMED - EC2:INVALID\_VOLUME\_ID\_DUPLICATE - EC2:INVALID\_VOLUME\_ID\_MALFORMED - EC2:INVALID\_VOLUME\_ID\_ZONE\_MISMATCH - EC2:INVALID\_VOLUME\_NOT\_FOUND - EC2:INVALID\_VOLUME\_ZONE\_MISMATCH - EC2:INVALID\_VPC\_ENDPOINT\_ID\_MALFORMED - EC2:INVALID\_VPC\_ENDPOINT\_ID\_NOT\_FOUND - EC2:INVALID\_VPC\_ID\_MALFORMED - EC2:INVALID\_VPC\_ID\_NOT\_FOUND - EC2:INVALID\_VPC\_PEERING\_CONNECTION\_ID\_MALFORMED - EC2:INVALID\_VPC\_PEERING\_CONNECTION\_ID\_NOT\_FOUND - EC2:INVALID\_VPC\_PEERING\_CONNECTION\_STATE\_DNS\_HOSTNAMES\_DISABLED - EC2:INVALID\_VPC\_RANGE - EC2:INVALID\_VPC\_STATE - EC2:INVALID\_VPN\_CONNECTION\_ID - EC2:INVALID\_VPN\_CONNECTION\_ID\_NOT\_FOUND - EC2:INVALID\_VPN\_CONNECTION\_INVALID\_STATE - EC2:INVALID\_VPN\_CONNECTION\_INVALID\_TYPE - EC2:INVALID\_VPN\_GATEWAY\_ATTACHMENT\_NOT\_FOUND - EC2:INVALID\_VPN\_GATEWAY\_ID\_NOT\_FOUND - EC2:INVALID\_VPN\_GATEWAY\_STATE - EC2:INVALID\_ZONE\_NOT\_FOUND - EC2:KEY\_PAIR\_LIMIT\_EXCEEDED - EC2:LEGACY\_SECURITY\_GROUP - EC2:LIMIT\_PRICE\_EXCEEDED - EC2:MALFORMED\_QUERY\_STRING - EC2:MAX\_IOPS\_LIMIT\_EXCEEDED - EC2:MAX\_SCHEDULED\_INSTANCE\_CAPACITY\_EXCEEDED - EC2:MAX\_SPOT\_FLEET\_REQUEST\_COUNT\_EXCEEDED - EC2:MAX\_SPOT\_INSTANCE\_COUNT\_EXCEEDED - EC2:MISSING\_ACTION - EC2:MISSING\_AUTHENTICATION\_TOKEN - EC2:MISSING\_INPUT - EC2:MISSING\_PARAMETER - EC2:NAT\_GATEWAY\_LIMIT\_EXCEEDED - EC2:NAT\_GATEWAY\_MALFORMED - EC2:NAT\_GATEWAY\_NOT\_FOUND - EC2:NETWORK\_ACL\_ENTRY\_ALREADY\_EXISTS - EC2:NETWORK\_ACL\_ENTRY\_LIMIT\_EXCEEDED - EC2:NETWORK\_ACL\_LIMIT\_EXCEEDED - EC2:NETWORK\_INTERFACE\_LIMIT\_EXCEEDED - EC2:NO\_SUCH\_VERSION - EC2:NON\_EBS\_INSTANCE - EC2:NOT\_EXPORTABLE - EC2:OPERATION\_NOT\_PERMITTED - EC2:OPT\_IN\_REQUIRED - EC2:OUTSTANDING\_VPC\_PEERING\_CONNECTION\_LIMIT\_EXCEEDED - EC2:PENDING\_SNAPSHOT\_LIMIT\_EXCEEDED - EC2:PENDING\_VERIFICATION - EC2:PENDING\_VPC\_PEERING\_CONNECTION\_LIMIT\_EXCEEDED - EC2:PLACEMENT\_GROUP\_LIMIT\_EXCEEDED - EC2:PRIVATE\_IP\_ADDRESS\_LIMIT\_EXCEEDED - EC2:REQUEST\_EXPIRED - EC2:REQUEST\_LIMIT\_EXCEEDED - EC2:REQUEST\_RESOURCE\_COUNT\_EXCEEDED - EC2:RESERVED\_INSTANCES\_COUNT\_EXCEEDED - EC2:RESERVED\_INSTANCES\_LIMIT\_EXCEEDED - EC2:RESERVED\_INSTANCES\_UNAVAILABLE - EC2:RESOURCE\_ALREADY\_ASSIGNED - EC2:RESOURCE\_ALREADY\_ASSOCIATED - EC2:RESOURCE\_COUNT\_EXCEEDED - EC2:RESOURCE\_COUNT\_LIMIT\_EXCEEDED - EC2:RESOURCE\_LIMIT\_EXCEEDED - EC2:ROUTE\_ALREADY\_EXISTS - EC2:ROUTE\_LIMIT\_EXCEEDED - EC2:ROUTE\_TABLE\_LIMIT\_EXCEEDED - EC2:RULES\_PER\_SECURITY\_GROUP\_LIMIT\_EXCEEDED - EC2:SCHEDULED\_INSTANCE\_LIMIT\_EXCEEDED - EC2:SCHEDULED\_INSTANCE\_PARAMETER\_MISMATCH - EC2:SCHEDULED\_INSTANCE\_SLOT\_NOT\_OPEN - EC2:SCHEDULED\_INSTANCE\_SLOT\_UNAVAILABLE - EC2:SECURITY\_GROUP\_LIMIT\_EXCEEDED - EC2:SECURITY\_GROUPS\_PER\_INSTANCE\_LIMIT\_EXCEEDED - EC2:SECURITY\_GROUPS\_PER\_INTERFACE\_LIMIT\_EXCEEDED - EC2:SERVICE\_UNAVAILABLE - EC2:SIGNATURE\_DOES\_NOT\_MATCH - EC2:SNAPSHOT\_COPY\_UNSUPPORTED\_INTER\_REGION - EC2:SNAPSHOT\_CREATION\_PER\_VOLUME\_RATE\_EXCEEDED - EC2:SNAPSHOT\_LIMIT\_EXCEEDED - EC2:SUBNET\_LIMIT\_EXCEEDED - EC2:TAG\_LIMIT\_EXCEEDED - EC2:UNAUTHORIZED\_OPERATION - EC2:UNAVAILABLE - EC2:UNAVAILABLE\_HOST\_REQUIREMENTS - EC2:UNKNOWN - EC2:UNKNOWN\_PARAMETER - EC2:UNKNOWN\_PRINCIPAL\_TYPE\_UNSUPPORTED - EC2:UNKNOWN\_VOLUME\_TYPE - EC2:UNSUPPORTED - EC2:UNSUPPORTED\_HOST\_CONFIGURATION - EC2:UNSUPPORTED\_INSTANCE\_ATTRIBUTE - EC2:UNSUPPORTED\_INSTANCE\_TYPE\_ON\_HOST - EC2:UNSUPPORTED\_OPERATION - EC2:UNSUPPORTED\_PROTOCOL - EC2:UNSUPPORTED\_TENANCY - EC2:VALIDATION\_ERROR - EC2:VOLUME\_IN\_USE - EC2:VOLUME\_IOPS\_LIMIT - EC2:VOLUME\_LIMIT\_EXCEEDED - EC2:VOLUME\_TYPE\_NOT\_AVAILABLE\_IN\_ZONE - EC2:VPC\_CIDR\_CONFLICT - EC2:VPC\_ENDPOINT\_LIMIT\_EXCEEDED - EC2:VPC\_ID\_NOT\_SPECIFIED - EC2:VPC\_LIMIT\_EXCEEDED - EC2:VPC\_PEERING\_CONNECTION\_ALREADY\_EXISTS - EC2:VPC\_PEERING\_CONNECTIONS\_PER\_VPC\_LIMIT\_EXCEEDED - EC2:VPC\_RESOURCE\_NOT\_SPECIFIED - EC2:VPN\_CONNECTION\_LIMIT\_EXCEEDED - EC2:VPN\_GATEWAY\_ATTACHMENT\_LIMIT\_EXCEEDED - EC2:VPN\_GATEWAY\_LIMIT\_EXCEEDED - EC2:ZONES\_MISMATCHED ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Amazon EC2 Connector version: 3.0 is-latest-version: true --- # Amazon EC2 Connector 3.0 XML and Maven Support > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Studio: - If you manually code a Mule runtime engine (Mule) app in XML, either from the Anypoint Studio XML editor or from a text editor, you can access the connector from your app by adding reference statements to both your XML Mule flow and the Apache Maven `pom.xml` file. - If you add the connector in Studio, Studio automatically populates the XML code with the connector’s namespace and schema location and it also adds a dependency to the `pom.xml` file. ## Add a Namespace for the Connector 1. Include the Amazon EC2 namespace and schema location in your configuration file. Namespace: `http://www.mulesoft.org/schema/mule/ec2` Schema Location: `http://www.mulesoft.org/schema/mule/ec2/current/mule-ec2.xsd` These statements appear in the `` block that starts a Mule app: ```xml ``` 2. Create a global Amazon EC2 configuration outside your flows, using the following global configuration code: ```xml ``` ## Add a POM File Dependency The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app. If you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to this connector: ```xml com.mulesoft.connectors mule-amazon-ec2-connector x.x.x mule-plugin ``` Replace `x.x.x` with the version that corresponds to the connector you are using. To obtain the most up-to-date `pom.xml` file information: 1. Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/). 2. In Exchange, click **Login** and supply your Anypoint Platform username and password. 3. In Exchange, search for `amazon ec2`. 4. Select **Amazon EC2 Connector**. 5. Click **Dependency Snippets** near the upper right of the screen. ## Next Step After completing your namespace and `pom.xml` file, you can try the [Examples](https://docs.mulesoft.com/amazon-ec2-connector/latest/amazon-ec2-connector-examples). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Amazon EC2 Connector version: 3.0 is-latest-version: true --- # Upgrading and Migrating Amazon EC2 Connector to Version 3.x > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Upgrade Anypoint Connector for Amazon EC2 (Amazon EC2 Connector) to version 3.x. ## Supported Upgrade Paths
From VersionTo Version

2.x

3.x

## Changes in This Release - The AWS SDK version is upgraded to v2.x.x. The response is now aligned with the new SDK specifications. ## Requirements Ensure your system meets the following compatibility requirements before you perform the upgrade:
Application/ServiceVersion

Mule runtime

4.2.0 and later

AWS SDK for Java

v2.35.3

OpenJDK

8, 11, and 17

## Upgrade Prerequisites Before you perform the upgrade, create a backup of your files, data, and configuration in case you need to restore to the previous version. ## Upgrade Steps Follow these steps to perform the upgrade to version 3.x: 1. In Anypoint Studio, create a Mule project. 2. In the **Mule Palette** view, click **Search in Exchange**. 3. In **Add Dependencies to Project**, enter `amazon ec2` in the search field. 4. In **Available modules**, select **Amazon EC2 Connector** and click **Add**. 5. Click **Finish**. 6. Verify that the Amazon EC2 Connector dependency version is 3.x in the `pom.xml` file in the Mule project. Studio upgrades the connector automatically. ## Post-Upgrade Steps After you install the latest version of the connector, verify that your error handling is updated to work with the minor changes in error codes in this version of the connector. ## Verify the Upgrade After you install the latest version of the connector, follow these steps to verify the upgrade: 1. In Studio, verify that there are no errors in the **Problems** or **Console** views. 2. Verify that there are no problems in the project `pom.xml` file. 3. Test the connection to verify that the operations work. ## Revert the Upgrade If it is necessary to revert to the previous version of Amazon EC2 Connector, change the Amazon EC2 Connector dependency version in the project’s `pom.xml` file to the previous version. You must update the project’s `pom.xml` file in Anypoint Studio. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Amazon EC2 Connector version: 2.5 --- # Using Anypoint Studio to Configure Amazon EC2 Connector 2.5 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files. To add and configure a connector in Studio: 1. [Create a Mule project](#create-mule-project). 2. [Add the connector to your Mule project](#add-connector-to-project). 3. [Configure a source for the connector’s flow](#configure-input-source). 4. [Add a connector operation to the flow](#add-connector-operation). 5. [Configure a global element for the connector](#configure-global-element). When you run the connector, you can view the app log to check for problems, as described in [View the App Log](#view-app-log). If you are new to configuring connectors in Studio, see [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio). If, after reading this topic, you need additional information about the connector fields, see the [Amazon EC2 Reference](https://docs.mulesoft.com/amazon-ec2-connector/2.5/amazon-ec2-connector-reference). ## Create a Mule Project In Studio, create a new Mule project in which to add and configure the connector: 1. In Studio, select **File > New > Mule Project**. 2. Enter a name for your Mule project and click **Finish**. ## Add the Connector to Your Mule Project Add Amazon EC2 Connector to your Mule project to automatically populate the XML code with the connector’s namespace and schema location and add the required dependencies to the project’s `pom.xml` file: 1. In the **Mule Palette** view, click **(X) Search in Exchange**. 2. In **Add Modules to Project**, type `amazon ec2` in the search field. 3. Click **Amazon EC2 Connector** in **Available modules**. 4. Click **Add**. 5. Click **Finish**. Adding a connector to a Mule project in Studio does not make that connector available to other projects in your Studio workspace. ## Configure a Source A source initiates a flow when a specified condition is met. You can configure one of these sources to use with Amazon EC2 Connector: - **HTTP > Listener** Initiates a flow each time it receives a request on the configured host and port - **Scheduler** Initiates a flow when a time-based condition is met For example, to configure an HTTP listener, follow these steps: 1. In the **Mule Palette** view, select **HTTP > Listener**. 2. Drag **Listener** to the Studio canvas. 3. On the **Listener** configuration screen, optionally change the value of the **Display Name** field. 4. Specify a value for the **Path** field. 5. Click the plus sign (**+**) next to the **Connector configuration** field to configure a global element that can be used by all instances of HTTP **Listener** in the app. 6. On the **General** tab, specify connection information for the connector. 7. On the **TLS** tab, optionally specify the TLS information for the connector. 8. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 9. Click **Test Connection** to confirm that Mule can connect with the specified server. 10. Click **OK**. ## Add a Connector Operation to the Flow When you add a connector operation to your flow, you immediately define a specific operation for that connector to perform. To add an operation for Amazon EC2 Connector, follow these steps: 1. In the **Mule Palette** view, select **Amazon EC2** and then select the desired operation. 2. Drag the operation onto the Studio canvas to the right of the source. ## Configure a Global Element for the Connector When you configure a connector, it’s best to configure a global element that all instances of that connector in the app can use. Configuring a global element requires you to provide the authentication credentials that the connector requires to access the target Amazon EC2 system. Amazon EC2 Connector supports Basic and Role authentication. To configure the global element for Amazon EC2 Connector, follow these steps: 1. Select the name of the connector in the Studio canvas. 2. In the configuration screen for the operation, click the plus sign (**+**) next to the **Connector configuration** field to access the global element configuration fields. 3. On the **General** tab, from **Connection**, select the authentication type: - [**Basic Authentication**](#basic_authentication) - [**Role Authentication**](#role-authentication) You can reference a configuration file that contains ANT-style property placeholders (recommended), or you can enter your authorization credentials in the global configuration properties. For information about the benefits of using property placeholders and how to configure them, see [Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview). 4. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 5. Click **Test Connection** to confirm that Mule can connect with the specified server. 6. Click **OK**. ### Basic Authentication Enter the following information on the **General** tab of the **Global Element Properties** screen to configure Basic authentication: - **Name** Name for the configuration - **Connection** Select **Basic**. - **Session Token** Session token provided by Amazon Security Token Service (STS) - **Access Key** Alphanumeric text string that uniquely identifies the user who owns the Amazon account - **Secret Key** Key provided by Amazon that serves as the password. - **Try Default AWS Credentials Provider Chain** Set to `true` to obtain credentials from the AWS environment. - **Region Endpoint** Endpoint of the service’s region The following image shows an example of configuring Basic authentication: ![To configure authentication](/mulesoft/current/en-us/amazon-ec2-connector/2.5/_images/mule-amazon-ec2-global-config.png) Figure 1. Basic authentication fields ### Role Authentication Enter the following information on the **General** tab of the global element configuration screen to configure Role authentication: - **Name** Name for the configuration. - **Connection** Select **Role**. - **Role ARN** Role to assume to gain cross-account access - **Access Key** Alphanumeric text string that uniquely identifies the user who owns the Amazon account - **Secret Key** Key provided by Amazon that serves as the password - **Try Default AWS Credentials Provider Chain** Set to `true` to obtain credentials from the AWS environment. - **Region Endpoint** Endpoint of the service’s region ## View the App Log To check for problems, you can view the app log as follows: - If you’re running the app from Anypoint Platform, the app log output is visible in the Anypoint Studio console window. - If you’re running the app using Mule from the command line, the app log output is visible in your OS console. Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also view the app log in the default location `MULE_HOME/logs/.log`. You can configure the location of the log path in the app log file `log4j2.xml`. ## Next Step After you configure a global element and connection information, configure the other fields for the connector. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Amazon EC2 Reference](https://docs.mulesoft.com/amazon-ec2-connector/2.5/amazon-ec2-connector-reference) - [Salesforce Help](https://help.salesforce.com) --- product: Amazon EC2 Connector version: 3.0 is-latest-version: true --- # Using Anypoint Studio to Configure Amazon EC2 Connector 3.0 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files. To add and configure a connector in Studio: 1. [Create a Mule project](#create-mule-project). 2. [Add the connector to your Mule project](#add-connector-to-project). 3. [Configure a source for the connector’s flow](#configure-input-source). 4. [Add a connector operation to the flow](#add-connector-operation). 5. [Configure a global element for the connector](#configure-global-element). When you run the connector, you can view the app log to check for problems, as described in [View the App Log](#view-app-log). If you are new to configuring connectors in Studio, see [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio). If, after reading this topic, you need additional information about the connector fields, see the [Amazon EC2 Reference](https://docs.mulesoft.com/amazon-ec2-connector/latest/amazon-ec2-connector-reference). ## Create a Mule Project In Studio, create a new Mule project in which to add and configure the connector: 1. In Studio, select **File > New > Mule Project**. 2. Enter a name for your Mule project and click **Finish**. ## Add the Connector to Your Mule Project Add Amazon EC2 Connector to your Mule project to automatically populate the XML code with the connector’s namespace and schema location and add the required dependencies to the project’s `pom.xml` file: 1. In the **Mule Palette** view, click **(X) Search in Exchange**. 2. In **Add Modules to Project**, type `amazon ec2` in the search field. 3. Click **Amazon EC2 Connector** in **Available modules**. 4. Click **Add**. 5. Click **Finish**. Adding a connector to a Mule project in Studio does not make that connector available to other projects in your Studio workspace. ## Configure a Source A source initiates a flow when a specified condition is met. You can configure one of these sources to use with Amazon EC2 Connector: - **HTTP > Listener** Initiates a flow each time it receives a request on the configured host and port - **Scheduler** Initiates a flow when a time-based condition is met For example, to configure an HTTP listener, follow these steps: 1. In the **Mule Palette** view, select **HTTP > Listener**. 2. Drag **Listener** to the Studio canvas. 3. On the **Listener** configuration screen, optionally change the value of the **Display Name** field. 4. Specify a value for the **Path** field. 5. Click the plus sign (**+**) next to the **Connector configuration** field to configure a global element that can be used by all instances of HTTP **Listener** in the app. 6. On the **General** tab, specify connection information for the connector. 7. On the **TLS** tab, optionally specify the TLS information for the connector. 8. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 9. Click **Test Connection** to confirm that Mule can connect with the specified server. 10. Click **OK**. ## Add a Connector Operation to the Flow When you add a connector operation to your flow, you immediately define a specific operation for that connector to perform. To add an operation for Amazon EC2 Connector, follow these steps: 1. In the **Mule Palette** view, select **Amazon EC2** and then select the desired operation. 2. Drag the operation onto the Studio canvas to the right of the source. ## Configure a Global Element for the Connector When you configure a connector, it’s best to configure a global element that all instances of that connector in the app can use. Configuring a global element requires you to provide the authentication credentials that the connector requires to access the target Amazon EC2 system. Amazon EC2 Connector supports Basic and Role authentication. To configure the global element for Amazon EC2 Connector, follow these steps: 1. Select the name of the connector in the Studio canvas. 2. In the configuration screen for the operation, click the plus sign (**+**) next to the **Connector configuration** field to access the global element configuration fields. 3. On the **General** tab, from **Connection**, select the authentication type: - [**Basic Authentication**](#basic_authentication) - [**Role Authentication**](#role-authentication) You can reference a configuration file that contains ANT-style property placeholders (recommended), or you can enter your authorization credentials in the global configuration properties. For information about the benefits of using property placeholders and how to configure them, see [Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview). 4. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 5. Click **Test Connection** to confirm that Mule can connect with the specified server. 6. Click **OK**. ### Basic Authentication Enter the following information on the **General** tab of the **Global Element Properties** screen to configure Basic authentication: - **Name** Name for the configuration - **Connection** Select **Basic**. - **Session Token** Session token provided by Amazon Security Token Service (STS) - **Access Key** Alphanumeric text string that uniquely identifies the user who owns the Amazon account - **Secret Key** Key provided by Amazon that serves as the password. - **Try Default AWS Credentials Provider Chain** Set to `true` to obtain credentials from the AWS environment. - **Region Endpoint** Endpoint of the service’s region The following image shows an example of configuring Basic authentication: ![To configure authentication](/mulesoft/current/en-us/amazon-ec2-connector/latest/_images/mule-amazon-ec2-global-config.png) Figure 1. Basic authentication fields ### Role Authentication Enter the following information on the **General** tab of the global element configuration screen to configure Role authentication: - **Name** Name for the configuration. - **Connection** Select **Role**. - **Role ARN** Role to assume to gain cross-account access - **Access Key** Alphanumeric text string that uniquely identifies the user who owns the Amazon account - **Secret Key** Key provided by Amazon that serves as the password - **Try Default AWS Credentials Provider Chain** Set to `true` to obtain credentials from the AWS environment. - **Region Endpoint** Endpoint of the service’s region ## View the App Log To check for problems, you can view the app log as follows: - If you’re running the app from Anypoint Platform, the app log output is visible in the Anypoint Studio console window. - If you’re running the app using Mule from the command line, the app log output is visible in your OS console. Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also view the app log in the default location `MULE_HOME/logs/.log`. You can configure the location of the log path in the app log file `log4j2.xml`. ## Next Step After you configure a global element and connection information, configure the other fields for the connector. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Amazon EC2 Reference](https://docs.mulesoft.com/amazon-ec2-connector/latest/amazon-ec2-connector-reference) - [Salesforce Help](https://help.salesforce.com)