| XQUERY/XSLT API DOCUMENTATION 4.2 |
All XQuery & XSLT Functions MarkLogic Built-In Functions Admin (xdmp:) AppServer (xdmp:) Classifier (cts:) Debug (dbg:) Document Conversion (xdmp:) Extension (xdmp:) Documents, Directories, Properties, and Locks Functions Extension Functions Function Values Functions HTTP Functions JSON Functions MarkLogic Server Functions Search Functions XML Functions XQuery Context Functions XSLT Functions map (map:) Math (math:) Profile (prof:) Search (cts:) cts:query Constructors Functions Geospatial Functions Geospatial Lexicon Functions Lexicon Functions Search Functions Search Clustering Functions Security (xdmp:) Server Monitoring (xdmp:) Spell (spell:) Update (xdmp:) XQuery Library Modules Admin Library (admin:) Actions Functions Appserver Functions Database Functions Forest Functions Group Functions Host Functions Mimetypes Functions Scheduler Functions Alerting (alert:) Elastic Compute Cloud (ec2:) Entity Enrichment (entity:) Flexible Replication (flexrep:) Geospatial Supporting Functions GEO Functions GeoRSS Functions GML Functions KML Functions MCGM Functions Information Studio (info:) Information Studio Developer (infodev:) Library Services (dls:) cts:query Constructor Functions Document Management Functions Document Update Functions Retention Policy Functions XInclude Functions Modular Documents XInclude Functions XPointer Functions PKI (pki:) Plugin (plugin:) Search (search:) Security-sec (sec:) Spelling Dictionary Management (spell:) Thesaurus (thsr:) Triggers (trgr:) Triggers Library (trgr:) WordProcessingML (ooxml:) ZIP Package (ooxml:) CPF Functions Content Processing Framework (cpf:) CSS Conversion (css:) DocBook Conversion (dbk:) Domains (dom:) Excel Conversion (excel:) Generic Conversion (cvt:) Links (lnk:) MSWord Conversion (msword:) PDF Conversion (pdf:) Pipelines (p:) Powerpoint Conversion (ppt:) XHTML Conversion (xhtml:) W3C-Standard Functions Accessor (fn:) AnyURI (fn:) Boolean (fn:) Context (fn:) DurationDateTime (fn:) Error and Trace (fn:) Node (fn:) Numeric (fn:) QName (fn:) Sequence (fn:) String (fn:) XSLT (fn:) W3C XQuery/XSLT Reference W3C XQuery Functions W3C XQuery Language W3C XSLT Language
This page was generated September 12, 2012 6:02 AM | XQuery & XSLT Built-In & Modules Function Reference
Module: Elastic Compute Cloud
The Elastic Compute Cloud (EC2) API module contains functions that allow you to write scripts to configure EC2. EC2 is installed as the following file: `install_dir/Modules/MarkLogic/ec2-2009-11-30.xqy` where `install_dir` is the directory in which MarkLogic Server is installed. To use the `ec2-2009-11-30.xqy` module in your own XQuery modules, include the following line in your XQuery prolog:
       import module namespace ec2 = "http://marklogic.com/ec2"
               at "/MarkLogic/ec2-2009-11-30.xqy";
The library uses the `ec2:` namespace, which is not predefined in the server. MarkLogic recommends enabling the URI Lexicon when using EC2; the URI lexicon will improve performance, especially when the database grows to a large number of documents.
Function Summary
ec2:add-snapshot-create-volume-permission-groups | This function calls the Amazon ModifySnapshotAttribute function and passes the the names of the groups to be given permission to create the snapshot.
ec2:add-snapshot-create-volume-permission-users | This function calls the Amazon ModifySnapshotAttribute function and passes the IDs of the users to be given permission to create the snapshot.
ec2:allocate-address | This function calls the Amazon AllocateAddress function.
ec2:associate-address | This function calls the Amazon AssociateAddress function.
ec2:attach-volume | This function calls the Amazon AttachVolume function.
ec2:authorize-group-ingress | This function calls the Amazon AuthorizeSecurityGroupIngress function.
ec2:authorize-icmp-ingress | This function calls the Amazon AuthorizeSecurityGroupIngress function and passes icmp as the IpPermissions.n.IpProtocol parameter.
ec2:authorize-tcp-ingress | This function calls the Amazon AuthorizeSecurityGroupIngress function and passes tcp as the IpPermissions.n.IpProtocol parameter.
ec2:authorize-udp-ingress | This function calls the Amazon AuthorizeSecurityGroupIngress function and passes udp as the IpPermissions.n.IpProtocol parameter.
ec2:create-key-pair | This function calls the Amazon CreateKeyPair function.
ec2:create-security-group | This function calls the Amazon CreateSecurityGroup function.
ec2:create-snapshot | This function calls the Amazon CreateSnapshot function.
ec2:create-volume | This function calls the Amazon CreateVolume function without a SnapshotId parameter.
ec2:create-volume-from-snapshot | This function calls the Amazon CreateVolume function with a $snapshot-id parameter.
ec2:delete-key-pair | This function calls the Amazon DeleteKeyPair function.
ec2:delete-security-group | This function calls the Amazon DeleteSecurityGroup function.
ec2:delete-snapshot | This function calls the Amazon DeleteSnapshot function.
ec2:delete-volume | This function calls the Amazon DeleteVolume function.
ec2:describe-addresses | This function calls the Amazon DescribeAddresses function.
ec2:describe-availability-zones | This function calls the Amazon DescribeAvailabilityZones function.
ec2:describe-images | This function calls the Amazon DescribeImages function.
ec2:describe-instance-block-device-mapping | This function calls the Amazon DescribeInstanceAttribute function and passes blockDeviceMapping as the Attribute parameter.
ec2:describe-instance-disable-api-termination | This function calls the Amazon DescribeInstanceAttribute function and passes disableApiTermination as the Attribute parameter.
ec2:describe-instance-initiated-shutdown-behavior | This function calls the Amazon DescribeInstanceAttribute function and passes instanceInitiatedShutdownBehavior as the Attribute parameter.
ec2:describe-instance-kernel | This function calls the Amazon DescribeInstanceAttribute function and passes kernel as the Attribute parameter.
ec2:describe-instance-ramdisk | This function calls the Amazon DescribeInstanceAttribute function and passes ramdisk as the Attribute parameter.
ec2:describe-instance-root-device-name | This function calls the Amazon DescribeInstanceAttribute function and passes rootDeviceName as the Attribute parameter.
ec2:describe-instance-type | This function calls the Amazon DescribeInstanceAttribute function and passes instanceType as the Attribute parameter.
ec2:describe-instance-user-data | This function calls the Amazon DescribeInstanceAttribute function and passes userData as the Attribute parameter.
ec2:describe-instances | This function calls the Amazon DescribeInstances function.
ec2:describe-key-pairs | This function calls the Amazon DescribeKeyPairs function.
ec2:describe-regions | This function calls the Amazon DescribeRegions function.
ec2:describe-security-groups | This function calls the Amazon DescribeSecurityGroups function.
ec2:describe-snapshot-create-volume-permission | This function calls the Amazon DescribeSnapshotAttribute function and passes createVolumePermission as the Attribute parameter.
ec2:describe-snapshots | This function calls the Amazon DescribeSnapshots function.
ec2:describe-volumes | This function calls the Amazon DescribeVolumes function.
ec2:detach-volume | This function calls the Amazon DetachVolume function.
ec2:disassociate-address | This function calls the Amazon DisassociateAddress function.
ec2:get-console-output | This function calls the Amazon GetConsoleOutput function.
ec2:modify-instance-block-device-mapping | This function calls the Amazon ModifyInstanceAttribute function and passes blockDeviceMapping as the Attribute parameter.
ec2:modify-instance-disable-api-termination | This function calls the Amazon ModifyInstanceAttribute function and passes disableApiTermination as the Attribute parameter.
ec2:modify-instance-initiated-shutdown-behavior | This function calls the Amazon ModifyInstanceAttribute function and passes instanceInitiatedShutdownBehavior as the Attribute parameter.
ec2:modify-instance-kernel | This function calls the Amazon ModifyInstanceAttribute function and passes kernel as the Attribute parameter.
ec2:modify-instance-ramdisk | This function calls the Amazon ModifyInstanceAttribute function and passes ramdisk as the Attribute parameter.
ec2:modify-instance-root-device-name | This function calls the Amazon ModifyInstanceAttribute function and passes rootDeviceName as the Attribute parameter.
ec2:modify-instance-type | This function calls the Amazon ModifyInstanceAttribute function and passes instanceType as the Attribute parameter.
ec2:modify-instance-user-data | This function calls the Amazon ModifyInstanceAttribute function and passes userData as the Attribute parameter.
ec2:monitor-instances | This function calls the Amazon MonitorInstances function.
ec2:reboot-instances | This function calls the Amazon RebootInstances function.
ec2:release-address | This function calls the Amazon ReleaseAddress function.
ec2:remove-snapshot-create-volume-permission-groups | This function calls the Amazon ModifySnapshotAttribute function and passes the the names of the groups to be denied permission to create the snapshot.
ec2:remove-snapshot-create-volume-permission-users | This function calls the Amazon ModifySnapshotAttribute function and passes the IDs of the users to be denied permission to create the snapshot.
ec2:reset-instance-kernel | This function calls the Amazon ResetInstanceAttribute function and passes kernel as the Attribute parameter.
ec2:reset-instance-ramdisk | This function calls the Amazon ResetInstanceAttribute function and passes ramdisk as the Attribute parameter.
ec2:reset-snapshot-create-volume-permission | This function calls the Amazon ResetSnapshotAttribute function.
ec2:revoke-group-ingress | This function calls the Amazon RevokeSecurityGroupIngress function and sets the UserId and GroupName parameters.
ec2:revoke-icmp-ingress | This function calls the Amazon RevokeSecurityGroupIngress function, passes icmp as the IpProtocol parameter, and sets the FromPort, ToPort, and CidrIp parameters.
ec2:revoke-tcp-ingress | This function calls the Amazon RevokeSecurityGroupIngress function, passes tcp as the IpProtocol parameter.
ec2:revoke-udp-ingress | This function calls the Amazon RevokeSecurityGroupIngress function, passes udp as the IpProtocol parameter.
ec2:run-instances | This function calls the Amazon RunInstances function.
ec2:start-instances | This function calls the Amazon StartInstances function.
ec2:stop-instances | This function calls the Amazon StopInstances function.
ec2:terminate-instances | This function calls the Amazon TerminateInstances function.
ec2:unmonitor-instances | This function calls the Amazon UnmonitorInstances function.
Function Detail
ec2:add-snapshot-create-volume-permission-groups(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $snapshot-ids as xs:string*,
| $user-groups as xs:string*
) as node()
Summary: This function calls the Amazon ModifySnapshotAttribute function and passes the the names of the groups to be given permission to create the snapshot. This function sets `add` as the OperationType parameter and `createVolumePermission` as the Attribute parameter.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$snapshot-ids : Sets the SnapshotId parameter on the Amazon function.
$user-groups : Sets the UserGroup parameter on the Amazon function.
ec2:add-snapshot-create-volume-permission-users(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $snapshot-ids as xs:string*,
| $user-ids as xs:string*
) as node()
Summary: This function calls the Amazon ModifySnapshotAttribute function and passes the IDs of the users to be given permission to create the snapshot. This function sets `add` as the OperationType parameter and `createVolumePermission` as the Attribute parameter.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$snapshot-ids : Sets the SnapshotId parameter on the Amazon function.
$user-ids : Sets the UserId parameter on the Amazon function.
ec2:allocate-address(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string
) as node()
Summary: This function calls the Amazon AllocateAddress function.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
ec2:associate-address(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $public-ip as xs:string,
| $instance-id as xs:string
) as node()
Summary: This function calls the Amazon AssociateAddress function.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$public-ip : Sets the PublicIp parameter on the Amazon function.
$instance-id : Sets the InstanceId parameter on the Amazon function.
ec2:attach-volume(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $volume-id as xs:string,
| $instance-id as xs:string,
| $device as xs:string
) as node()
Summary: This function calls the Amazon AttachVolume function.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$volume-id : Sets the VolumeId parameter on the Amazon function.
$instance-id : Sets the InstanceId parameter on the Amazon function.
$device : Sets the Device parameter on the Amazon function.
ec2:authorize-group-ingress(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $group-name as xs:string,
| $source-group-owner-id as xs:string,
| $source-group-name as xs:string
) as node()
Summary: This function calls the Amazon AuthorizeSecurityGroupIngress function.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$group-name : Sets the GroupName parameter on the Amazon function.
$source-group-owner-id : Sets the IpPermissions.n.Groups.m.UserId parameter on the Amazon function.
$source-group-name : Sets the IpPermissions.n.Groups.m.GroupName parameter on the Amazon function.
ec2:authorize-icmp-ingress(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $group-name as xs:string,
| $icmp-type as xs:integer,
| $icmp-code as xs:integer,
| $cidr-ip as xs:string
) as node()
Summary: This function calls the Amazon AuthorizeSecurityGroupIngress function and passes `icmp` as the IpPermissions.n.IpProtocol parameter.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$group-name : Sets the GroupName parameter on the Amazon function.
$icmp-type : Sets the IpPermissions.n.FromPort parameter on the Amazon function.
$icmp-code : Sets the IpPermissions.n.ToPort parameter on the Amazon function.
$cidr-ip : Sets the IpPermissions.n.IpRanges.m.CidrIp parameter on the Amazon function.
ec2:authorize-tcp-ingress(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $group-name as xs:string,
| $port-range as xs:integer+,
| $cidr-ip as xs:string
) as node()
Summary: This function calls the Amazon AuthorizeSecurityGroupIngress function and passes `tcp` as the IpPermissions.n.IpProtocol parameter.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$group-name : Sets the GroupName parameter on the Amazon function.
$port-range : Sets both the IpPermissions.n.FromPort and IpPermissions.n.ToPort parameters on the Amazon function. Specify value as (FromPort, ToPort).
$cidr-ip : Sets the CidrIp parameter on the Amazon function.
ec2:authorize-udp-ingress(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $group-name as xs:string,
| $port-range as xs:integer+,
| $cidr-ip as xs:string
) as node()
Summary: This function calls the Amazon AuthorizeSecurityGroupIngress function and passes `udp` as the IpPermissions.n.IpProtocol parameter.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$group-name : Sets the GroupName parameter on the Amazon function.
$port-range : Sets both the IpPermissions.n.FromPort and IpPermissions.n.ToPort parameters on the Amazon function. Specify value as (FromPort, ToPort).
$cidr-ip : Sets the CidrIp parameter on the Amazon function.
ec2:create-key-pair(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $key-name as xs:string
) as node()
Summary: This function calls the Amazon CreateKeyPair function.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$key-name : Sets the KeyName parameter on the Amazon function.
ec2:create-security-group(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $group-name as xs:string,
| $group-description as xs:string
) as node()
Summary: This function calls the Amazon CreateSecurityGroup function.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$group-name : Sets the GroupName parameter on the Amazon function.
$group-description : Sets the GroupDescription parameter on the Amazon function.
ec2:create-snapshot(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $volume-id as xs:string,
| [$description as xs:string?]
) as node()
Summary: This function calls the Amazon CreateSnapshot function.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$volume-id : Sets the VolumeId parameter on the Amazon function.
$description (optional): Sets the Description parameter on the Amazon function.
ec2:create-volume(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $availability-zone as xs:string,
| $size as xs:integer
) as node()
Summary: This function calls the Amazon CreateVolume function without a SnapshotId parameter.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$availability-zone : Sets the AvailabilityZone parameter on the Amazon function.
$size : Sets the Size parameter on the Amazon function.
ec2:create-volume-from-snapshot(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $availability-zone as xs:string,
| $snapshot-id as xs:string,
| [$size as xs:integer?]
) as node()
Summary: This function calls the Amazon CreateVolume function with a `$snapshot-id` parameter.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$availability-zone : Sets the AvailabilityZone parameter on the Amazon function.
$snapshot-id : Sets the SnapshotId parameter on the Amazon function.
$size (optional): Sets the Size parameter on the Amazon function.
ec2:delete-key-pair(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $key-name as xs:string
) as node()
Summary: This function calls the Amazon DeleteKeyPair function.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$key-name : Sets the KeyName parameter on the Amazon function.
ec2:delete-security-group(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $group-name as xs:string
) as node()
Summary: This function calls the Amazon DeleteSecurityGroup function.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$group-name : Sets the GroupName parameter on the Amazon function.
ec2:delete-snapshot(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $snapshot-id as xs:string
) as node()
Summary: This function calls the Amazon DeleteSnapshot function.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$snapshot-id : Sets the SnapshotId parameter on the Amazon function.
ec2:delete-volume(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $volume-id as xs:string
) as node()
Summary: This function calls the Amazon DeleteVolume function.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$volume-id : Sets the VolumeId parameter on the Amazon function.
ec2:describe-addresses(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| [$public-ips as xs:string*]
) as node()
Summary: This function calls the Amazon DescribeAddresses function.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$public-ips (optional): Sets the PublicIp.n parameter on the Amazon function.
ec2:describe-availability-zones(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| [$zone-name as xs:string*]
) as node()
Summary: This function calls the Amazon DescribeAvailabilityZones function.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$zone-name (optional): Sets the ZoneName parameter on the Amazon function.
ec2:describe-images(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| [$image-ids as xs:string*],
| [$executable-by as xs:string*],
| [$owners as xs:string*]
) as node()
Summary: This function calls the Amazon DescribeImages function.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$image-ids (optional): Sets the ImageId parameter on the Amazon function.
$executable-by (optional): Sets the ExecutableBy parameter on the Amazon function.
$owners (optional): Sets the Owner parameter on the Amazon function.
ec2:describe-instance-block-device-mapping(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $instance-ids as xs:string
) as node()
Summary: This function calls the Amazon DescribeInstanceAttribute function and passes `blockDeviceMapping` as the Attribute parameter.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$instance-ids : Sets the InstanceId parameter on the Amazon function.
ec2:describe-instance-disable-api-termination(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $instance-ids as xs:string
) as node()
Summary: This function calls the Amazon DescribeInstanceAttribute function and passes `disableApiTermination` as the Attribute parameter.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$instance-ids : Sets the InstanceId parameter on the Amazon function.
ec2:describe-instance-initiated-shutdown-behavior(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $instance-ids as xs:string
) as node()
Summary: This function calls the Amazon DescribeInstanceAttribute function and passes `instanceInitiatedShutdownBehavior` as the Attribute parameter.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$instance-ids : Sets the InstanceId parameter on the Amazon function.
ec2:describe-instance-kernel(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $instance-ids as xs:string
) as node()
Summary: This function calls the Amazon DescribeInstanceAttribute function and passes `kernel` as the Attribute parameter.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$instance-ids : Sets the InstanceId parameter on the Amazon function.
ec2:describe-instance-ramdisk(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $instance-ids as xs:string
) as node()
Summary: This function calls the Amazon DescribeInstanceAttribute function and passes `ramdisk` as the Attribute parameter.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$instance-ids : Sets the InstanceId parameter on the Amazon function.
ec2:describe-instance-root-device-name(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $instance-ids as xs:string
) as node()
Summary: This function calls the Amazon DescribeInstanceAttribute function and passes `rootDeviceName` as the Attribute parameter.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$instance-ids : Sets the InstanceId parameter on the Amazon function.
ec2:describe-instance-type(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $instance-ids as xs:string
) as node()
Summary: This function calls the Amazon DescribeInstanceAttribute function and passes `instanceType` as the Attribute parameter.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$instance-ids : Sets the InstanceId parameter on the Amazon function.
ec2:describe-instance-user-data(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $instance-ids as xs:string
) as node()
Summary: This function calls the Amazon DescribeInstanceAttribute function and passes `userData` as the Attribute parameter.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$instance-ids : Sets the InstanceId parameter on the Amazon function.
ec2:describe-instances(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| [$instance-ids as xs:string*]
) as node()
Summary: This function calls the Amazon DescribeInstances function.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$instance-ids (optional): Sets the InstanceId.n parameter on the Amazon function.
ec2:describe-key-pairs(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| [$key-names as xs:string*]
) as node()
Summary: This function calls the Amazon DescribeKeyPairs function.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$key-names (optional): Sets the KeyName.n parameter on the Amazon function.
ec2:describe-regions(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| [$region-names as xs:string*]
) as node()
Summary: This function calls the Amazon DescribeRegions function.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$region-names (optional): Sets the RegionName.n parameter on the Amazon function.
ec2:describe-security-groups(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| [$group-names as xs:string*]
) as node()
Summary: This function calls the Amazon DescribeSecurityGroups function.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$group-names (optional): Sets the GroupName.n parameter on the Amazon function.
ec2:describe-snapshot-create-volume-permission(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $snapshot-ids as xs:string*
) as node()
Summary: This function calls the Amazon DescribeSnapshotAttribute function and passes `createVolumePermission` as the Attribute parameter.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$snapshot-ids : Sets the SnapshotId.n parameter on the Amazon function.
ec2:describe-snapshots(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| [$snapshot-ids as xs:string*],
| [$owners as xs:string*],
| [$restorable-bys as xs:string*]
) as node()
Summary: This function calls the Amazon DescribeSnapshots function.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$snapshot-ids (optional): Sets the SnapshotId.n parameter on the Amazon function.
$owners (optional): Sets the Owner parameter on the Amazon function.
$restorable-bys (optional): Sets the RestorableBy parameter on the Amazon function.
ec2:describe-volumes(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| [$volume-ids as xs:string*]
) as node()
Summary: This function calls the Amazon DescribeVolumes function.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$volume-ids (optional): Sets the VolumeId.n parameter on the Amazon function.
ec2:detach-volume(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $volume-id as xs:string,
| [$instance-id as xs:string?],
| [$device as xs:string?],
| [$force as xs:boolean?]
) as node()
Summary: This function calls the Amazon DetachVolume function.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$volume-id : Sets the VolumeId parameter on the Amazon function.
$instance-id (optional): Sets the InstanceId parameter on the Amazon function.
$device (optional): Sets the Device parameter on the Amazon function.
$force (optional): Sets the Force parameter on the Amazon function.
ec2:disassociate-address(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $public-ip as xs:string
) as node()
Summary: This function calls the Amazon DisassociateAddress function.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$public-ip : Sets the PublicIp parameter on the Amazon function.
ec2:get-console-output(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $instance-id as xs:string
) as node()
Summary: This function calls the Amazon GetConsoleOutput function.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$instance-id : Sets the InstanceId parameter on the Amazon function.
ec2:modify-instance-block-device-mapping(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $instance-id as xs:string,
| $value as xs:string
) as node()
Summary: This function calls the Amazon ModifyInstanceAttribute function and passes `blockDeviceMapping` as the Attribute parameter.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$instance-id : Sets the InstanceId parameter on the Amazon function.
$value : Sets the Value parameter on the Amazon function.
ec2:modify-instance-disable-api-termination(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $instance-id as xs:string,
| $value as xs:boolean
) as node()
Summary: This function calls the Amazon ModifyInstanceAttribute function and passes `disableApiTermination` as the Attribute parameter.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$instance-id : Sets the InstanceId parameter on the Amazon function.
$value : Sets the Value parameter on the Amazon function.
ec2:modify-instance-initiated-shutdown-behavior(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $instance-id as xs:string,
| $value as xs:string
) as node()
Summary: This function calls the Amazon ModifyInstanceAttribute function and passes `instanceInitiatedShutdownBehavior` as the Attribute parameter.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$instance-id : Sets the InstanceId parameter on the Amazon function.
$value : Sets the Value parameter on the Amazon function.
ec2:modify-instance-kernel(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $instance-id as xs:string,
| $value as xs:string
) as node()
Summary: This function calls the Amazon ModifyInstanceAttribute function and passes `kernel` as the Attribute parameter.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$instance-id : Sets the InstanceId parameter on the Amazon function.
$value : Sets the Value parameter on the Amazon function.
ec2:modify-instance-ramdisk(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $instance-id as xs:string,
| $value as xs:string
) as node()
Summary: This function calls the Amazon ModifyInstanceAttribute function and passes `ramdisk` as the Attribute parameter.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$instance-id : Sets the InstanceId parameter on the Amazon function.
$value : Sets the Value parameter on the Amazon function.
ec2:modify-instance-root-device-name(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $instance-id as xs:string,
| $value as xs:string
) as node()
Summary: This function calls the Amazon ModifyInstanceAttribute function and passes `rootDeviceName` as the Attribute parameter.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$instance-id : Sets the InstanceId parameter on the Amazon function.
$value : Sets the Value parameter on the Amazon function.
ec2:modify-instance-type(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $instance-id as xs:string,
| $value as xs:string
) as node()
Summary: This function calls the Amazon ModifyInstanceAttribute function and passes `instanceType` as the Attribute parameter.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$instance-id : Sets the InstanceId parameter on the Amazon function.
$value : Sets the Value parameter on the Amazon function.
ec2:modify-instance-user-data(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $instance-id as xs:string,
| $value as xs:string
) as node()
Summary: This function calls the Amazon ModifyInstanceAttribute function and passes `userData` as the Attribute parameter.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$instance-id : Sets the InstanceId parameter on the Amazon function.
$value : Sets the Value parameter on the Amazon function.
ec2:monitor-instances(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $instance-ids as xs:string+
) as node()
Summary: This function calls the Amazon MonitorInstances function.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$instance-ids : Sets the InstanceId.n parameter on the Amazon function.
ec2:reboot-instances(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $instance-ids as xs:string+
) as node()
Summary: This function calls the Amazon RebootInstances function.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$instance-ids : Sets the InstanceId.n parameter on the Amazon function.
ec2:release-address(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $public-ip as xs:string
) as node()
Summary: This function calls the Amazon ReleaseAddress function.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$public-ip : Sets the PublicIp parameter on the Amazon function.
ec2:remove-snapshot-create-volume-permission-groups(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $snapshot-ids as xs:string*,
| $user-groups as xs:string*
) as node()
Summary: This function calls the Amazon ModifySnapshotAttribute function and passes the the names of the groups to be denied permission to create the snapshot. This function sets `remove` as the OperationType parameter and `createVolumePermission` as the Attribute parameter.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$snapshot-ids : Sets the SnapshotId parameter on the Amazon function.
$user-groups : Sets the UserGroup parameter on the Amazon function.
ec2:remove-snapshot-create-volume-permission-users(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $snapshot-ids as xs:string*,
| $user-ids as xs:string*
) as node()
Summary: This function calls the Amazon ModifySnapshotAttribute function and passes the IDs of the users to be denied permission to create the snapshot. This function sets `remove` as the OperationType parameter and `createVolumePermission` as the Attribute parameter.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$snapshot-ids : Sets the SnapshotId parameter on the Amazon function.
$user-ids : Sets the UserId parameter on the Amazon function.
ec2:reset-instance-kernel(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $instance-ids as xs:string*
) as node()
Summary: This function calls the Amazon ResetInstanceAttribute function and passes `kernel` as the Attribute parameter.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$instance-ids : Sets the InstanceId parameter on the Amazon function.
ec2:reset-instance-ramdisk(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $instance-ids as xs:string*
) as node()
Summary: This function calls the Amazon ResetInstanceAttribute function and passes `ramdisk` as the Attribute parameter.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$instance-ids : Sets the InstanceId parameter on the Amazon function.
ec2:reset-snapshot-create-volume-permission(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $snapshot-ids as xs:string*
) as node()
Summary: This function calls the Amazon ResetSnapshotAttribute function.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$snapshot-ids : Sets the SnapshotId parameter on the Amazon function.
ec2:revoke-group-ingress(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $group-name as xs:string,
| $source-group-owner-id as xs:string,
| $source-group-name as xs:string
) as node()
Summary: This function calls the Amazon RevokeSecurityGroupIngress function and sets the UserId and GroupName parameters.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$group-name : Sets the GroupName parameter on the Amazon function.
$source-group-owner-id : Sets the UserId parameter on the Amazon function.
$source-group-name : Sets the GroupName parameter on the Amazon function.
ec2:revoke-icmp-ingress(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $group-name as xs:string,
| $icmp-type as xs:integer,
| $icmp-code as xs:integer,
| $cidr-ip as xs:string
) as node()
Summary: This function calls the Amazon RevokeSecurityGroupIngress function, passes `icmp` as the IpProtocol parameter, and sets the FromPort, ToPort, and CidrIp parameters.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$group-name : Sets the GroupName parameter on the Amazon function.
$icmp-type : Sets the FromPort parameter on the Amazon function.
$icmp-code : Sets the ToPort parameter on the Amazon function.
$cidr-ip : Sets the CidrIp parameter on the Amazon function.
ec2:revoke-tcp-ingress(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $group-name as xs:string,
| $port-range as xs:integer+,
| $cidr-ip as xs:string
) as node()
Summary: This function calls the Amazon RevokeSecurityGroupIngress function, passes `tcp` as the IpProtocol parameter.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$group-name : Sets the GroupName parameter on the Amazon function.
$port-range : Sets both the FromPort and ToPort parametersr on the Amazon function. Specify value as (FromPort, ToPort).
$cidr-ip : Sets the CidrIp parameter on the Amazon function.
ec2:revoke-udp-ingress(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $group-name as xs:string,
| $port-range as xs:integer+,
| $cidr-ip as xs:string
) as node()
Summary: This function calls the Amazon RevokeSecurityGroupIngress function, passes `udp` as the IpProtocol parameter.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$group-name : Sets the GroupName parameter on the Amazon function.
$port-range : Sets both the FromPort and ToPort parameters on the Amazon function. Specify value as (FromPort, ToPort).
$cidr-ip : Sets the CidrIp parameter on the Amazon function.
ec2:run-instances(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $image-id as xs:string,
| $min-count as xs:integer,
| $max-count as xs:integer,
| $instance-type as xs:string?,
| $key-pair as xs:string?,
| $security-group as xs:string*,
| $instance-options as xs:string*
) as node()
Summary: This function calls the Amazon RunInstances function.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$image-id : Sets the ImageId parameter on the Amazon function.
$min-count : Sets the MinCount parameter on the Amazon function.
$max-count : Sets the MaxCount parameter on the Amazon function.
$instance-type : Sets the InstanceType parameter on the Amazon function.
$key-pair : Sets the KeyName parameter on the Amazon function.
$security-group : Sets the SecurityGroup.n parameter on the Amazon function.
$instance-options : Sets the any number of optional parameters on the Amazon function. Specify using the form: ("name=value", "name=value").
ec2:start-instances(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $instance-ids as xs:string+
) as node()
Summary: This function calls the Amazon StartInstances function.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$instance-ids : Sets the InstanceId parameter on the Amazon function.
ec2:stop-instances(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $instance-ids as xs:string+,
| $force as xs:boolean
) as node()
Summary: This function calls the Amazon StopInstances function.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$instance-ids : Sets the InstanceId parameter on the Amazon function.
$force : Sets the Force parameter on the Amazon function.
ec2:terminate-instances(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $instance-ids as xs:string+
) as node()
Summary: This function calls the Amazon TerminateInstances function.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$instance-ids : Sets the InstanceId parameter on the Amazon function.
ec2:unmonitor-instances(
| $access-key as xs:string,
| $secret-key as xs:string,
| $ec2-region as xs:string,
| $instance-ids as xs:string+
) as node()
Summary: This function calls the Amazon UnmonitorInstances function.
Parameters:
$access-key : Your Amazon Access Key ID obtained from your account's Security Credentials.
$secret-key : Your Amazon Secret Access Key obtained from your account's Security Credentials.
$ec2-region : The EC2 region you wish to manage. Determines the web service endpoint to be used. Example: "us-east-1"
$instance-ids : Sets the InstanceId.n parameter on the Amazon function.

© Copyright 2002-2012 MarkLogic Corporation. All rights reserved.