Amazon Elastic Compute Cloud · You should also have worked through the Amazon Elastic Compute...
Transcript of Amazon Elastic Compute Cloud · You should also have worked through the Amazon Elastic Compute...
Amazon Elastic Compute CloudAPI Reference
API Version 2010-08-31
Amazon Elastic Compute Cloud: API ReferenceCopyright © 2010 Amazon Web Services LLC or its affiliates. All rights reserved.
Amazon Elastic Compute Cloud API Reference
Table of ContentsWelcome ............................................................................................................................................................. 1What's New ........................................................................................................................................................ 4API Overview ...................................................................................................................................................... 6
API Actions ............................................................................................................................................. 6Data Types and the Amazon EC2 WSDL ................................................................................................ 6API Versioning ........................................................................................................................................ 7Available Libraries ................................................................................................................................... 8
Amazon EC2 Query API ..................................................................................................................................... 9Common Query Parameters ................................................................................................................. 11List of Query Operations by Function ................................................................................................... 12ActivateLicense ..................................................................................................................................... 15AllocateAddress .................................................................................................................................... 16AssociateAddress ................................................................................................................................. 17AttachVolume ........................................................................................................................................ 19AuthorizeSecurityGroupIngress ............................................................................................................ 22BundleInstance ..................................................................................................................................... 25CancelBundleTask ................................................................................................................................ 30CancelSpotInstanceRequests .............................................................................................................. 34ConfirmProductInstance ....................................................................................................................... 36CreateImage ......................................................................................................................................... 38CreateKeyPair ....................................................................................................................................... 40CreatePlacementGroup ........................................................................................................................ 42CreateSecurityGroup ............................................................................................................................ 44CreateSnapshot .................................................................................................................................... 46CreateSpotDatafeedSubscription ......................................................................................................... 49CreateTags ........................................................................................................................................... 52CreateVolume ....................................................................................................................................... 54DeactivateLicense ................................................................................................................................ 57DeleteKeyPair ....................................................................................................................................... 58DeletePlacementGroup ........................................................................................................................ 60DeleteSecurityGroup ............................................................................................................................ 61DeleteSnapshot .................................................................................................................................... 63DeleteSpotDatafeedSubscription .......................................................................................................... 65DeleteTags ............................................................................................................................................ 67DeleteVolume ....................................................................................................................................... 70DeregisterImage ................................................................................................................................... 72DescribeAddresses .............................................................................................................................. 74DescribeAvailabilityZones ..................................................................................................................... 77DescribeBundleTasks ........................................................................................................................... 81DescribeImageAttribute ........................................................................................................................ 86DescribeImages .................................................................................................................................... 91DescribeInstanceAttribute .................................................................................................................. 101DescribeInstances .............................................................................................................................. 105DescribeKeyPairs ............................................................................................................................... 121DescribeLicenses ............................................................................................................................... 124DescribePlacementGroups ................................................................................................................. 125DescribeRegions ................................................................................................................................ 128DescribeReservedInstances ............................................................................................................... 131DescribeReservedInstancesOfferings ................................................................................................ 136DescribeSecurityGroups ..................................................................................................................... 141DescribeSnapshotAttribute ................................................................................................................. 147DescribeSnapshots ............................................................................................................................ 149DescribeSpotDatafeedSubscription .................................................................................................... 155DescribeSpotInstanceRequests ......................................................................................................... 157DescribeSpotPriceHistory ................................................................................................................... 167
Amazon Elastic Compute Cloud API Reference
DescribeTags ...................................................................................................................................... 171DescribeVolumes ................................................................................................................................ 177DetachVolume .................................................................................................................................... 183DisassociateAddress .......................................................................................................................... 186GetConsoleOutput .............................................................................................................................. 188GetPasswordData ............................................................................................................................... 190ImportKeyPair ..................................................................................................................................... 192ModifyImageAttribute .......................................................................................................................... 195ModifyInstanceAttribute ...................................................................................................................... 198ModifySnapshotAttribute ..................................................................................................................... 200MonitorInstances ................................................................................................................................ 202PurchaseReservedInstancesOffering ................................................................................................. 204RebootInstances ................................................................................................................................. 206RegisterImage .................................................................................................................................... 208ReleaseAddress ................................................................................................................................. 212RequestSpotInstances ........................................................................................................................ 214ResetImageAttribute ........................................................................................................................... 222ResetInstanceAttribute ....................................................................................................................... 224ResetSnapshotAttribute ...................................................................................................................... 226RevokeSecurityGroupIngress ............................................................................................................. 228RunInstances ...................................................................................................................................... 231StartInstances ..................................................................................................................................... 244StopInstances ..................................................................................................................................... 247TerminateInstances ............................................................................................................................ 251UnmonitorInstances ............................................................................................................................ 254
Amazon EC2 SOAP API ................................................................................................................................. 256List of SOAP Operations by Function ................................................................................................. 258ActivateLicense ................................................................................................................................... 261AllocateAddress .................................................................................................................................. 262AssociateAddress ............................................................................................................................... 264AttachVolume ...................................................................................................................................... 266AuthorizeSecurityGroupIngress .......................................................................................................... 269BundleInstance ................................................................................................................................... 274CancelBundleTask .............................................................................................................................. 280CancelSpotInstanceRequests ............................................................................................................ 284ConfirmProductInstance ..................................................................................................................... 287CreateImage ....................................................................................................................................... 289CreateKeyPair ..................................................................................................................................... 292CreatePlacementGroup ...................................................................................................................... 295CreateSecurityGroup .......................................................................................................................... 297CreateSnapshot .................................................................................................................................. 299CreateSpotDatafeedSubscription ....................................................................................................... 302CreateTags ......................................................................................................................................... 305CreateVolume ..................................................................................................................................... 308DeactivateLicense .............................................................................................................................. 311DeleteKeyPair ..................................................................................................................................... 312DeletePlacementGroup ...................................................................................................................... 314DeleteSecurityGroup .......................................................................................................................... 315DeleteSnapshot .................................................................................................................................. 317DeleteSpotDatafeedSubscription ........................................................................................................ 319DeleteTags .......................................................................................................................................... 321DeleteVolume ..................................................................................................................................... 325DeregisterImage ................................................................................................................................. 327DescribeAddresses ............................................................................................................................ 329DescribeAvailabilityZones ................................................................................................................... 333DescribeBundleTasks ......................................................................................................................... 337DescribeImageAttribute ...................................................................................................................... 344DescribeImages .................................................................................................................................. 350
Amazon Elastic Compute Cloud API Reference
DescribeInstanceAttribute .................................................................................................................. 362DescribeInstances .............................................................................................................................. 367DescribeKeyPairs ............................................................................................................................... 384DescribeLicenses ............................................................................................................................... 388DescribePlacementGroups ................................................................................................................. 389DescribeRegions ................................................................................................................................ 393DescribeReservedInstances ............................................................................................................... 397DescribeReservedInstancesOfferings ................................................................................................ 404DescribeSecurityGroups ..................................................................................................................... 410DescribeSnapshotAttribute ................................................................................................................. 417DescribeSnapshots ............................................................................................................................ 420DescribeSpotDatafeedSubscription .................................................................................................... 428DescribeSpotInstanceRequests ......................................................................................................... 430DescribeSpotPriceHistory ................................................................................................................... 442DescribeTags ...................................................................................................................................... 447DescribeVolumes ................................................................................................................................ 455DetachVolume .................................................................................................................................... 462DisassociateAddress .......................................................................................................................... 465GetConsoleOutput .............................................................................................................................. 467GetPasswordData ............................................................................................................................... 469ImportKeyPair ..................................................................................................................................... 471ModifyImageAttribute .......................................................................................................................... 474ModifyInstanceAttribute ...................................................................................................................... 479ModifySnapshotAttribute ..................................................................................................................... 483MonitorInstances ................................................................................................................................ 486PurchaseReservedInstancesOffering ................................................................................................. 489RebootInstances ................................................................................................................................. 491RegisterImage .................................................................................................................................... 493ReleaseAddress ................................................................................................................................. 498RequestSpotInstances ........................................................................................................................ 500ResetImageAttribute ........................................................................................................................... 512ResetInstanceAttribute ....................................................................................................................... 514ResetSnapshotAttribute ...................................................................................................................... 516RevokeSecurityGroupIngress ............................................................................................................. 518RunInstances ...................................................................................................................................... 522StartInstances ..................................................................................................................................... 538StopInstances ..................................................................................................................................... 542TerminateInstances ............................................................................................................................ 546UnmonitorInstances ............................................................................................................................ 550
Data Types ...................................................................................................................................................... 553AllocateAddressResponseType .......................................................................................................... 559AssociateAddressResponseType ....................................................................................................... 559AssociateAddressType ....................................................................................................................... 560AttachmentSetItemResponseType ..................................................................................................... 560AttachmentSetResponseType ............................................................................................................ 561AttachVolumeResponseType .............................................................................................................. 562AttachVolumeType .............................................................................................................................. 562AttributeBooleanValueType ................................................................................................................. 563AttributeValueType .............................................................................................................................. 563AuthorizeSecurityGroupIngressResponseType .................................................................................. 564AuthorizeSecurityGroupIngressType .................................................................................................. 565AvailabilityZoneItemType .................................................................................................................... 565AvailabilityZoneMessageSetType ....................................................................................................... 566AvailabilityZoneMessageType ............................................................................................................. 566AvailabilityZoneSetType ...................................................................................................................... 567BlockDeviceMappingItemType ............................................................................................................ 567BlockDeviceMappingType ................................................................................................................... 568BundleInstanceResponseType ........................................................................................................... 569
Amazon Elastic Compute Cloud API Reference
BundleInstanceS3StorageType .......................................................................................................... 569BundleInstanceTaskErrorType ............................................................................................................ 570BundleInstanceTasksSetType ............................................................................................................. 571BundleInstanceTaskStorageType ....................................................................................................... 571BundleInstanceTaskType .................................................................................................................... 572BundleInstanceType ........................................................................................................................... 573CancelBundleTaskResponseType ...................................................................................................... 574CancelBundleTaskType ...................................................................................................................... 574CancelSpotInstanceRequestsResponseSetItemType ........................................................................ 575CancelSpotInstanceRequestsResponseSetType ............................................................................... 575CancelSpotInstanceRequestsResponseType ..................................................................................... 576CancelSpotInstanceRequestsType ..................................................................................................... 576ConfirmProductInstanceResponseType ............................................................................................. 577ConfirmProductInstanceType ............................................................................................................. 577CreateImageResponseType ............................................................................................................... 578CreateImageType ............................................................................................................................... 578CreateKeyPairResponseType ............................................................................................................. 579CreateKeyPairType ............................................................................................................................. 580CreatePlacementGroupResponseType .............................................................................................. 580CreatePlacementGroupType .............................................................................................................. 580CreateSecurityGroupResponseType .................................................................................................. 580CreateSecurityGroupType .................................................................................................................. 581CreateSnapshotResponseType .......................................................................................................... 581CreateSnapshotType .......................................................................................................................... 582CreateSpotDatafeedSubscriptionResponseType ............................................................................... 583CreateSpotDatafeedSubscriptionType ................................................................................................ 583CreateVolumePermissionItemType ..................................................................................................... 584CreateVolumePermissionListType ...................................................................................................... 585CreateVolumePermissionOperationType ............................................................................................ 585CreateVolumeResponseType ............................................................................................................. 586CreateVolumeType ............................................................................................................................. 586DeleteKeyPairResponseType ............................................................................................................. 587DeleteKeyPairType .............................................................................................................................. 588DeletePlacementGroupResponseType ............................................................................................... 588DeletePlacementGroupType ............................................................................................................... 588DeleteSecurityGroupResponseType ................................................................................................... 588DeleteSecurityGroupType ................................................................................................................... 589DeleteSnapshotResponseType .......................................................................................................... 589DeleteSnapshotType ........................................................................................................................... 590DeleteSpotDatafeedSubscriptionResponseType ................................................................................ 590DeleteVolumeResponseType .............................................................................................................. 591DeleteVolumeType .............................................................................................................................. 591DeregisterImageResponseType ......................................................................................................... 592DeregisterImageType .......................................................................................................................... 592DescribeAddressesInfoType ............................................................................................................... 593DescribeAddressesItemType .............................................................................................................. 593DescribeAddressesResponseInfoType ............................................................................................... 594DescribeAddressesResponseItemType .............................................................................................. 594DescribeAddressesResponseType ..................................................................................................... 595DescribeAddressesType ..................................................................................................................... 595DescribeAvailabilityZonesResponseType ........................................................................................... 596DescribeAvailabilityZonesSetItemType ............................................................................................... 596DescribeAvailabilityZonesSetType ...................................................................................................... 597DescribeAvailabilityZonesType ........................................................................................................... 597DescribeBundleTasksInfoType ............................................................................................................ 598DescribeBundleTasksItemType ........................................................................................................... 598DescribeBundleTasksResponseType ................................................................................................. 599DescribeBundleTasksType .................................................................................................................. 599
Amazon Elastic Compute Cloud API Reference
DescribeImageAttributeResponseType .............................................................................................. 600DescribeImageAttributesGroup .......................................................................................................... 601DescribeImageAttributeType ............................................................................................................... 601DescribeImagesExecutableBySetType ............................................................................................... 602DescribeImagesExecutableByType .................................................................................................... 602DescribeImagesInfoType .................................................................................................................... 603DescribeImagesItemType ................................................................................................................... 603DescribeImagesOwnersType .............................................................................................................. 604DescribeImagesOwnerType ................................................................................................................ 604DescribeImagesResponseInfoType .................................................................................................... 605DescribeImagesResponseItemType ................................................................................................... 605DescribeImagesResponseType .......................................................................................................... 607DescribeImagesType .......................................................................................................................... 608DescribeInstanceAttributeResponseType ........................................................................................... 608DescribeInstanceAttributesGroup ....................................................................................................... 609DescribeInstanceAttributeType ........................................................................................................... 610DescribeInstancesInfoType ................................................................................................................. 611DescribeInstancesItemType ............................................................................................................... 611DescribeInstancesResponseType ...................................................................................................... 612DescribeInstancesType ...................................................................................................................... 612DescribeKeyPairsInfoType .................................................................................................................. 613DescribeKeyPairsItemType ................................................................................................................. 613DescribeKeyPairsResponseInfoType .................................................................................................. 614DescribeKeyPairsResponseItemType ................................................................................................. 614DescribeKeyPairsResponseType ........................................................................................................ 615DescribeKeyPairsType ........................................................................................................................ 615DescribePlacementGroupInfoType ..................................................................................................... 616DescribePlacementGroupItemType .................................................................................................... 616DescribePlacementGroupsResponseType ......................................................................................... 616DescribePlacementGroupsType ......................................................................................................... 616DescribeRegionsResponseType ......................................................................................................... 616DescribeRegionsSetItemType ............................................................................................................ 617DescribeRegionsSetType ................................................................................................................... 617DescribeRegionsType ......................................................................................................................... 618DescribeReservedInstancesOfferingsResponseSetItemType ............................................................ 618DescribeReservedInstancesOfferingsResponseSetType ................................................................... 619DescribeReservedInstancesOfferingsResponseType ........................................................................ 620DescribeReservedInstancesOfferingsSetItemType ............................................................................ 620DescribeReservedInstancesOfferingsSetType ................................................................................... 621DescribeReservedInstancesOfferingsType ......................................................................................... 621DescribeReservedInstancesResponseSetItemType .......................................................................... 622DescribeReservedInstancesResponseSetType ................................................................................. 623DescribeReservedInstancesResponseType ....................................................................................... 623DescribeReservedInstancesSetItemType ........................................................................................... 624DescribeReservedInstancesSetType .................................................................................................. 624DescribeReservedInstancesType ....................................................................................................... 625DescribeSecurityGroupsResponseType ............................................................................................. 625DescribeSecurityGroupsSetItemType ................................................................................................. 626DescribeSecurityGroupsSetType ........................................................................................................ 626DescribeSecurityGroupsType ............................................................................................................. 627DescribeSnapshotAttributeResponseType ......................................................................................... 627DescribeSnapshotAttributesGroup ..................................................................................................... 628DescribeSnapshotAttributeType ......................................................................................................... 628DescribeSnapshotsOwnersType ......................................................................................................... 629DescribeSnapshotsOwnerType .......................................................................................................... 629DescribeSnapshotsResponseType ..................................................................................................... 630DescribeSnapshotsRestorableBySetType .......................................................................................... 630DescribeSnapshotsRestorableByType ............................................................................................... 631
Amazon Elastic Compute Cloud API Reference
DescribeSnapshotsSetItemResponseType ........................................................................................ 631DescribeSnapshotsSetItemType ........................................................................................................ 632DescribeSnapshotsSetResponseType ............................................................................................... 633DescribeSnapshotsSetType ............................................................................................................... 633DescribeSnapshotsType ..................................................................................................................... 634DescribeSpotDatafeedSubscriptionResponseType ............................................................................ 634DescribeSpotInstanceRequestsResponseType .................................................................................. 635DescribeSpotInstanceRequestsType .................................................................................................. 635DescribeSpotPriceHistoryResponseType ........................................................................................... 636DescribeSpotPriceHistoryType ........................................................................................................... 636DescribeVolumesResponseType ........................................................................................................ 637DescribeVolumesSetItemResponseType ............................................................................................ 637DescribeVolumesSetItemType ............................................................................................................ 638DescribeVolumesSetResponseType ................................................................................................... 639DescribeVolumesSetType ................................................................................................................... 639DescribeVolumesType ........................................................................................................................ 640DetachVolumeResponseType ............................................................................................................. 640DetachVolumeType ............................................................................................................................. 641DisassociateAddressResponseType .................................................................................................. 642DisassociateAddressType ................................................................................................................... 642EbsBlockDeviceType .......................................................................................................................... 643EbsInstanceBlockDeviceMappingResponseType ............................................................................... 644EmptyElementType ............................................................................................................................. 644GetConsoleOutputResponseType ...................................................................................................... 646GetConsoleOutputType ...................................................................................................................... 646GetPasswordDataResponseType ....................................................................................................... 647GetPasswordDataType ....................................................................................................................... 647GroupItemType ................................................................................................................................... 648GroupSetType ..................................................................................................................................... 648InstanceBlockDeviceMappingItemType .............................................................................................. 649InstanceBlockDeviceMappingResponseItemType .............................................................................. 650InstanceBlockDeviceMappingResponseType ..................................................................................... 650InstanceBlockDeviceMappingType ..................................................................................................... 651InstanceEbsBlockDeviceType ............................................................................................................. 652InstanceIdSetType .............................................................................................................................. 652InstanceIdType .................................................................................................................................... 653InstanceMonitoringStateType ............................................................................................................. 653InstanceStateChangeSetType ............................................................................................................ 654InstanceStateChangeType .................................................................................................................. 654InstanceStateType .............................................................................................................................. 655InstanceTypeSetItemType ................................................................................................................... 656InstanceTypeSetType .......................................................................................................................... 656IpPermissionSetType .......................................................................................................................... 657IpPermissionType ............................................................................................................................... 657IpRangeItemType ................................................................................................................................ 658IpRangeSetType ................................................................................................................................. 659LaunchPermissionItemType ................................................................................................................ 659LaunchPermissionListType ................................................................................................................. 660LaunchPermissionOperationType ....................................................................................................... 660LaunchSpecificationType .................................................................................................................... 661ModifyImageAttributeResponseType .................................................................................................. 662ModifyImageAttributeType .................................................................................................................. 663ModifyInstanceAttributeResponseType .............................................................................................. 663ModifyInstanceAttributeType ............................................................................................................... 664ModifySnapshotAttributeResponseType ............................................................................................. 665ModifySnapshotAttributeType ............................................................................................................. 665MonitoringInstanceType ...................................................................................................................... 666MonitorInstancesResponseSetItemType ............................................................................................ 666
Amazon Elastic Compute Cloud API Reference
MonitorInstancesResponseSetType ................................................................................................... 667MonitorInstancesResponseType ......................................................................................................... 668MonitorInstancesSetItemType ............................................................................................................ 668MonitorInstancesSetType ................................................................................................................... 669MonitorInstancesType ......................................................................................................................... 669NullableAttributeBooleanValueType .................................................................................................... 670NullableAttributeValueType ................................................................................................................. 670PlacementGroupInfoType ................................................................................................................... 671PlacementGroupSetType .................................................................................................................... 671PlacementRequestType ...................................................................................................................... 671PlacementResponseType ................................................................................................................... 672ProductCodeItemType ........................................................................................................................ 672ProductCodeListType .......................................................................................................................... 673ProductCodeSetType .......................................................................................................................... 673ProductCodesSetItemType ................................................................................................................. 674ProductCodesSetType ........................................................................................................................ 674ProductCodeType ............................................................................................................................... 675ProductDescriptionSetItemType ......................................................................................................... 675ProductDescriptionSetType ................................................................................................................ 676PurchaseReservedInstancesOfferingResponseType ......................................................................... 676PurchaseReservedInstancesOfferingType ......................................................................................... 677RebootInstancesInfoType ................................................................................................................... 677RebootInstancesItemType .................................................................................................................. 678RebootInstancesResponseType ......................................................................................................... 678RebootInstancesType ......................................................................................................................... 679RegionItemType .................................................................................................................................. 679RegionSetType ................................................................................................................................... 680RegisterImageResponseType ............................................................................................................. 680RegisterImageType ............................................................................................................................. 681ReleaseAddressResponseType .......................................................................................................... 682ReleaseAddressType .......................................................................................................................... 682RequestSpotInstancesResponseType ................................................................................................ 683RequestSpotInstancesType ................................................................................................................ 683ReservationInfoType ........................................................................................................................... 685ReservationSetType ............................................................................................................................ 685ResetImageAttributeResponseType ................................................................................................... 686ResetImageAttributesGroup ............................................................................................................... 686ResetImageAttributeType ................................................................................................................... 687ResetInstanceAttributeResponseType ................................................................................................ 687ResetInstanceAttributesGroup ............................................................................................................ 688ResetInstanceAttributeType ................................................................................................................ 688ResetSnapshotAttributeResponseType .............................................................................................. 689ResetSnapshotAttributesGroup .......................................................................................................... 689ResetSnapshotAttributeType .............................................................................................................. 690RevokeSecurityGroupIngressResponseType ..................................................................................... 690RevokeSecurityGroupIngressType ..................................................................................................... 691RunInstancesResponseType .............................................................................................................. 692RunInstancesType .............................................................................................................................. 692RunningInstancesItemType ................................................................................................................ 694RunningInstancesSetType .................................................................................................................. 696SecurityGroupItemType ...................................................................................................................... 697SecurityGroupSetType ........................................................................................................................ 697SpotDatafeedSubscriptionType .......................................................................................................... 698SpotInstanceRequestIdSetItemType .................................................................................................. 699SpotInstanceRequestIdSetType ......................................................................................................... 699SpotInstanceRequestSetItemType ..................................................................................................... 700SpotInstanceRequestSetType ............................................................................................................ 701SpotInstanceStateFaultType ............................................................................................................... 702
Amazon Elastic Compute Cloud API Reference
SpotPriceHistorySetItemType ............................................................................................................. 702SpotPriceHistorySetType .................................................................................................................... 703StartInstancesResponseType ............................................................................................................. 703StartInstancesType ............................................................................................................................. 704StateReasonType ............................................................................................................................... 704StopInstancesResponseType ............................................................................................................. 706StopInstancesType ............................................................................................................................. 706TerminateInstancesResponseType ..................................................................................................... 707TerminateInstancesType ..................................................................................................................... 707UserDataType ..................................................................................................................................... 708UserIdGroupPairSetType .................................................................................................................... 708UserIdGroupPairType ......................................................................................................................... 709
API Error Codes ............................................................................................................................................. 710Glossary ......................................................................................................................................................... 716Document Conventions .................................................................................................................................. 719Index ............................................................................................................................................................... 722
Amazon Elastic Compute Cloud API Reference
Welcome
Topics
• Who Should Read This Guide (p. 1)
• Reader Feedback (p. 2)
• How This Guide Is Organized (p. 2)
• Amazon EC2 Resources (p. 2)
This is the Amazon Elastic Compute Cloud API Reference Guide. This section describes who shouldread this guide, how the guide is organized, and other resources related to Amazon Elastic ComputeCloud.
The Amazon Elastic Compute Cloud is occasionally referred to within this guide as simply "Amazon EC2";all copyrights and legal protections still apply.
Who Should Read This GuideThis guide is for programmers that need detailed information about the Amazon EC2 SOAP and QueryAPIs.
Required Knowledge and SkillsUse of this guide assumes you are familiar with the following:
• XML (For an overview, go to the W3 Schools XML Tutorial)
• Basic understanding of web services (go to W3 Schools Web Services Tutorial)
• Query or SOAP
• One or more programming languages
You should also have worked through the Amazon Elastic Compute Cloud Getting Started Guide, set upyour development environment, and have a general understanding of the service. Additionally, you shouldrefer to the Amazon Elastic Compute Cloud Developer Guide for high level concepts and examples ofhow to use major Amazon EC2 features.
API Version 2010-08-311
Amazon Elastic Compute Cloud API ReferenceWho Should Read This Guide
Reader FeedbackThe online version of this guide provides a link at the top of each page that enables you to enter feedbackabout this guide. We strive to make our guides as complete, error free, and easy to read as possible.Youcan help by giving us feedback. Thank you in advance!
How This Guide Is OrganizedThis guide is organized into several major sections described in the following table.
Relevant SectionsInformation
API Overview (p. 6)Overview of the APIs and conventions.
Amazon EC2 SOAP API (p. 256)Comprehensive reference to the SOAPAPIs.
Amazon EC2 Query API (p. 9)Comprehensive reference to the QueryAPIs.
Data Types (p. 553)Comprehensive reference to the SOAPdata types.
API Error Codes (p. 710)Error code information.
Glossary (p. 716)Amazon EC2 terms.
Document Conventions (p. 719)Typographic and symbol conventions.
Amazon EC2 ResourcesThe following table lists related resources that you'll find useful as you work with this service.
DescriptionResource
The Getting Started Guide provides a quick tutorial of theservice based on a simple use case. Examples andinstructions are included.
Amazon Elastic Compute Cloud GettingStarted Guide
The User Guide provides conceptual information aboutAmazon EC2 and describes how to use Amazon EC2 featuresusing the AWS Management Console and command linetools.
Amazon Elastic Compute Cloud UserGuide
The Developer Guide provides conceptual information aboutAmazon EC2 and describes how to use Amazon EC2 featuresusing the SOAP and Query APIs.
Amazon Elastic Compute CloudDeveloper Guide
API Version 2010-08-312
Amazon Elastic Compute Cloud API ReferenceReader Feedback
DescriptionResource
The Command Line Reference contains a comprehensivedescription of all the command line tools and their options.
Amazon Elastic Compute CloudCommand Line Reference
The FAQ covers the top questions developers have askedabout this product.
Amazon EC2 Technical FAQ
The Release Notes give a high-level overview of the currentrelease.They specifically note any new features, corrections,and known issues.
Amazon EC2 Release Notes
A central starting point to find documentation, code samples,release notes, and other information to help you buildinnovative applications with AWS.
AWS Developer Resource Center
The console allows you to perform most of the functions ofAmazon EC2 and other AWS products without programming.
AWS Management Console
A community-based forum for developers to discuss technicalquestions related to Amazon Web Services.
Discussion Forums
The home page for AWS Technical Support, including accessto our Developer Forums, Technical FAQs, Service Statuspage, and AWS Premium Support (if you are subscribed tothis program).
AWS Support Center
The primary web page for information about AWS PremiumSupport, a one-on-one, fast-response support channel to helpyou build and run applications on AWS Infrastructure Services.
AWS Premium Support Information
The primary web page for information about Amazon EC2.Amazon EC2 Product Information
This form is only for account questions. For technicalquestions, use the Discussion Forums.
Form for questions related to your AWSaccount: Contact Us
Detailed information about the copyright and trademark usageat Amazon.com and other topics.
Conditions of Use
API Version 2010-08-313
Amazon Elastic Compute Cloud API ReferenceAmazon EC2 Resources
What's New
This What's New is associated with the 2010-08-31 release of Amazon EC2.This guide was last updatedon September 20, 2010.
The following table describes the important changes since the last release of the Amazon EC2documentation set.
Release DateDescriptionChange
19 September2010
Added information about filters to many of the describe actions.
Added information about creating, describing, and deletingtags.
For more information about the Query API actions for tags,see CreateTags (p. 52), DeleteTags (p. 67), andDescribeTags (p. 171).
For more information about the SOAP API actions for tags,see CreateTags (p. 305), DeleteTags (p. 321), andDescribeTags (p. 447).
Filters and Tags
19 September2010
Updated RunInstances to include a ClientToken parameterto ensure idempotency.
For more information about the change to RunInstances(Query API), see RunInstances (p. 231).
For more information about the change to RunInstances(SOAP API), see RunInstances (p. 522).
Idempotent InstanceLaunch
19 September2010
Added ImportKeyPair .
For more information (Query API), see ImportKeyPair (p. 192).
For more information (SOAP API), see ImportKeyPair (p. 471).
Import Key Pair
API Version 2010-08-314
Amazon Elastic Compute Cloud API Reference
Release DateDescriptionChange
12 July 2010Added information about placement groups, which you usewith cluster compute instances.
For more information about the Query API actions forplacement groups, see CreatePlacementGroup (p. 42),DescribePlacementGroups (p. 125), andDeletePlacementGroup (p. 60).
For more information about the SOAP API actions forplacement groups, see CreatePlacementGroup (p. 295),DescribePlacementGroups (p. 389), andDeletePlacementGroup (p. 314).
Placement Groups forCluster ComputeInstances
12 July 2010Amazon VPC users can now specify the IP address to assignan instance launched in a VPC.
For information about using the PrivateIpAddressparameter with the Query API's RunInstances action, seeRunInstances (p. 231).
For information about using the privateIpAddressparameter with the SOAP API's RunInstances action, seeRunInstances (p. 522).
Amazon VPC IPAddress Designation
21 May 2010Updated the list of errors to include Client.Blocked,Client.InsufficientInstanceCapacity,Client.PendingVerification, andClient.Unsupported. For more information, see API ErrorCodes (p. 710).
Error List Update
28 April 2010Clarified the information about authorizing security grouppermissions. For more information, seeAuthorizeSecurityGroupIngress (p. 22) (for the Query API) andAuthorizeSecurityGroupIngress (p. 269) (for the SOAP API).
Security GroupPermissions
28 April 2010Amazon EC2 now supports the Asia Pacific (Singapore)Region. The new endpoint for requests to this Region isec2.ap-southeast-1.amazonaws.com.
New Region
1 February2010
Clarified that you can't stop and start Spot Instances that usean Amazon EBS root device. For more information aboutstopping instances, see StopInstances (p. 247) (for the QueryAPI) and StopInstances (p. 542) (for the SOAP API).
Clarification aboutSpot Instances
14 December2009
To support customers that use Amazon EC2 instances, buthave more flexible usage requirements (e.g., when instancesrun, how long they run, or whether usage completes within aspecific timeframe), Amazon EC2 now provides Spot Instances.A Spot Instance is an instance that Amazon EC2 automaticallyruns for you when its maximum price is greater than the SpotPrice. For conceptual information about Spot Instances, go tothe Amazon Elastic Compute Cloud Developer Guide orAmazon Elastic Compute Cloud User Guide.
Spot Instances
API Version 2010-08-315
Amazon Elastic Compute Cloud API Reference
API Overview
Topics
• API Actions (p. 6)
• Data Types and the Amazon EC2 WSDL (p. 6)
• API Versioning (p. 7)
• Available Libraries (p. 8)
Amazon EC2 provides two APIs: SOAP and Query.
This section discusses the operations available in the Amazon EC2 APIs, their semantics, and theirrequired parameters. Examples of requests and responses are also provided.
Note
The same XML body is returned in both the Query API and SOAP API.
For detailed information about Amazon EC2 features and their associated APIs, refer to theAmazon Elastic Compute Cloud Developer Guide.
API ActionsActions encapsulate the possible interactions with Amazon EC2.These can be viewed as remote procedurecalls and consist of a request and response message pair. Requests must be signed, allowing AmazonEC2 to authenticate them. For clarity, the sample requests and responses illustrating each of the operationsdescribed in this reference are not signed.
Data Types and the Amazon EC2 WSDLThe current version of the Amazon EC2 WSDL is available at:http://ec2.amazonaws.com/doc/2010-08-31/AmazonEC2.wsdl. Some libraries can generate code directlyfrom the WSDL. Other libraries require a little more work on your part.
Values provided as parameters to the various operations must be of the indicated type. Standard XSDtypes (like string, boolean, int) are prefixed with xsd:. Complex types defined by the Amazon EC2WSDL are prefixed with ec2:.
API Version 2010-08-316
Amazon Elastic Compute Cloud API ReferenceAPI Actions
Parameters that consist of lists of information are defined within our WSDL to require <info> tags aroundeach member. Throughout the API, type references for parameters that accept such a list of values arespecified using the notation type[] The type referred to in these instances is the type nested within the<info> tag (for Amazon EC2 types this is defined in the WSDL).
For example, the <imagesSet> element in the following XML snippet is of type xsd:string[].
<imagesSet> <item> <imageId>ami-61a54008</imageId> </item> <item> <imageId>ami-61b54608</imageId> </item></imagesSet>
The <instancesSet> element in the following XML snippet is of type xsd:string[].
<instancesSet> <item> <imageId>ami-60a54009</imageId> <minCount>10</minCount> <maxCount>30</maxCount> </item> <item> <imageId>ami-60b54209</imageId> <minCount>5</minCount> <maxCount>20</maxCount> </item></instancesSet>
API VersioningBecause features and changes can introduce incompatible API changes, all Amazon EC2 API updatesare versioned. By including a version in the request, clients receive responses they can process.
Each API revision is assigned a version in date form (the current API version is 2010-08-31). Thisversion is included in the request as part of the document namespace when using our SOAP API and asa Version parameter when using our Query API. The response that Amazon EC2 returns honors theversion included in the request.
SOAP clients that retrieve the Amazon EC2 WSDL at runtime and generate their requests dynamicallyusing that WSDL should reference the WSDL for the version of the API that the client was developedagainst.This ensures that the client software continues to work even if backward incompatible API changesare introduced. The WSDL for each supported API version is available from the following URI:
http://ec2.amazonaws.com/doc/<api-version>/AmazonEC2.wsdl
The WSDL for latest version of our API is available from the following URI:
http://ec2.amazonaws.com/doc/2010-08-31/AmazonEC2.wsdl
Note
The WSDL should be treated as a moving target as it will always map to the latest release of theAmazon EC2 SOAP API. If your software depends on retrieving the WSDL at runtime, we stronglyrecommend you reference the specific version of the WSDL you are developing against.
API Version 2010-08-317
Amazon Elastic Compute Cloud API ReferenceAPI Versioning
Available LibrariesAWS provides libraries, sample code, tutorials, and other resources for software developers who preferto build applications using language-specific APIs instead of SOAP and Query. These libraries providebasic functions (not included in the APIs), such as request authentication, request retries, and errorhandling so that it is easier to get started. Libraries and resources are available for the following languages:
• Java
• PHP
• Python
• Ruby
• Windows and .NET
For libraries and sample code in all languages, go to Sample Code & Libraries.
API Version 2010-08-318
Amazon Elastic Compute Cloud API ReferenceAvailable Libraries
Amazon EC2 Query API
Topics
• Common Query Parameters (p. 11)
• List of Query Operations by Function (p. 12)
• ActivateLicense (p. 15)
• AllocateAddress (p. 16)
• AssociateAddress (p. 17)
• AttachVolume (p. 19)
• AuthorizeSecurityGroupIngress (p. 22)
• BundleInstance (p. 25)
• CancelBundleTask (p. 30)
• CancelSpotInstanceRequests (p. 34)
• ConfirmProductInstance (p. 36)
• CreateImage (p. 38)
• CreateKeyPair (p. 40)
• CreatePlacementGroup (p. 42)
• CreateSecurityGroup (p. 44)
• CreateSnapshot (p. 46)
• CreateSpotDatafeedSubscription (p. 49)
• CreateTags (p. 52)
• CreateVolume (p. 54)
• DeactivateLicense (p. 57)
• DeleteKeyPair (p. 58)
• DeletePlacementGroup (p. 60)
• DeleteSecurityGroup (p. 61)
• DeleteSnapshot (p. 63)
• DeleteSpotDatafeedSubscription (p. 65)
• DeleteTags (p. 67)
• DeleteVolume (p. 70)
• DeregisterImage (p. 72)
• DescribeAddresses (p. 74)
• DescribeAvailabilityZones (p. 77)
API Version 2010-08-319
Amazon Elastic Compute Cloud API Reference
• DescribeBundleTasks (p. 81)
• DescribeImageAttribute (p. 86)
• DescribeImages (p. 91)
• DescribeInstanceAttribute (p. 101)
• DescribeInstances (p. 105)
• DescribeKeyPairs (p. 121)
• DescribeLicenses (p. 124)
• DescribePlacementGroups (p. 125)
• DescribeRegions (p. 128)
• DescribeReservedInstances (p. 131)
• DescribeReservedInstancesOfferings (p. 136)
• DescribeSecurityGroups (p. 141)
• DescribeSnapshotAttribute (p. 147)
• DescribeSnapshots (p. 149)
• DescribeSpotDatafeedSubscription (p. 155)
• DescribeSpotInstanceRequests (p. 157)
• DescribeSpotPriceHistory (p. 167)
• DescribeTags (p. 171)
• DescribeVolumes (p. 177)
• DetachVolume (p. 183)
• DisassociateAddress (p. 186)
• GetConsoleOutput (p. 188)
• GetPasswordData (p. 190)
• ImportKeyPair (p. 192)
• ModifyImageAttribute (p. 195)
• ModifyInstanceAttribute (p. 198)
• ModifySnapshotAttribute (p. 200)
• MonitorInstances (p. 202)
• PurchaseReservedInstancesOffering (p. 204)
• RebootInstances (p. 206)
• RegisterImage (p. 208)
• ReleaseAddress (p. 212)
• RequestSpotInstances (p. 214)
• ResetImageAttribute (p. 222)
• ResetInstanceAttribute (p. 224)
• ResetSnapshotAttribute (p. 226)
• RevokeSecurityGroupIngress (p. 228)
• RunInstances (p. 231)
• StartInstances (p. 244)
• StopInstances (p. 247)
• TerminateInstances (p. 251)
• UnmonitorInstances (p. 254)
API Version 2010-08-3110
Amazon Elastic Compute Cloud API Reference
Common Query ParametersAll Query operations share a set of common parameters that must be present in each call.
RequiredDescriptionName
YesIndicates the action to perform.
Example: RunInstances
Action
YesThe API version to use, as specified in the WSDL.
Example: 2010-08-31
Version
YesThe Access Key ID for the request sender. This identifiesthe account which will be charged for usage of the service.The account with which the Access Key ID is associatedmust be signed up for Amazon EC2, or requests will notbe accepted.
AKIADQKE4SARGYLE
AWSAccessKeyId
YesThe date and time at which the request is signed, in theformat YYYY-MM-DDThh:mm:ssZ. For more information,go to ISO 8601.
Example: 2006-07-07T15:04:56Z
Timestamp
YesThe date and time at which the signature included in therequest expires, in the format YYYY-MM-DDThh:mm:ssZ.
Example: 2006-07-07T15:04:56Z
Expires
YesThe request signature. For more information, go to theAmazon Elastic Compute Cloud Developer Guide.
Example: Qnpl4Qk/7tINHzfXCiT7VbBatDA=
Signature
YesThe hash algorithm you use to create the requestsignature. Valid values: HmacSHA256 | HmacSHA1. Formore information, go to the Amazon Elastic Compute CloudDeveloper Guide.
Example: HmacSHA256
SignatureMethod
YesThe signature version you use to sign the request. Set thisvalue to 2. For more information, go to the Amazon ElasticCompute Cloud Developer Guide.
Example: 2
SignatureVersion
Note
The Timestamp parameter can be used instead of Expires. Requests must include eitherTimestamp or Expires, but cannot contain both.
Parameter values must be URL-encoded. This is true for any Query parameter passed to Amazon EC2and is typically necessary in the Signature parameter. Some clients do this automatically, but this isnot the norm.
API Version 2010-08-3111
Amazon Elastic Compute Cloud API ReferenceCommon Query Parameters
List of Query Operations by FunctionAmazon DevPay
• ConfirmProductInstance (p. 36)
AMIs
• CreateImage (p. 38)
• DeregisterImage (p. 72)
• DescribeImageAttribute (p. 86)
• DescribeImages (p. 91)
• ModifyImageAttribute (p. 195)
Availability Zones and Regions
• DescribeAvailabilityZones (p. 77)
• DescribeRegions (p. 128)
Elastic Block Store
• AttachVolume (p. 19)
• CreateSnapshot (p. 46)
• CreateVolume (p. 54)
• DeleteSnapshot (p. 63)
• DeleteVolume (p. 70)
• DescribeSnapshotAttribute (p. 147)
• DescribeSnapshots (p. 149)
• DescribeVolumes (p. 177)
• DetachVolume (p. 183)
• ModifySnapshotAttribute (p. 200)
• ResetSnapshotAttribute (p. 226)
Elastic IP Addresses
• AllocateAddress (p. 16)
• AssociateAddress (p. 17)
• DescribeAddresses (p. 74)
• DisassociateAddress (p. 186)
• ReleaseAddress (p. 212)
General
• GetConsoleOutput (p. 188)
API Version 2010-08-3112
Amazon Elastic Compute Cloud API ReferenceList of Query Operations by Function
Images
• RegisterImage (p. 208)
• ResetImageAttribute (p. 222)
Instances
• DescribeInstanceAttribute (p. 101)
• DescribeInstances (p. 105)
• ModifyInstanceAttribute (p. 198)
• RebootInstances (p. 206)
• ResetInstanceAttribute (p. 224)
• RunInstances (p. 231)
• StartInstances (p. 244)
• StopInstances (p. 247)
• TerminateInstances (p. 251)
Key Pairs
• CreateKeyPair (p. 40)
• DeleteKeyPair (p. 58)
• DescribeKeyPairs (p. 121)
• ImportKeyPair (p. 192)
Monitoring
• MonitorInstances (p. 202)
• UnmonitorInstances (p. 254)
Placement Groups
• CreatePlacementGroup (p. 42)
• DeletePlacementGroup (p. 60)
• DescribePlacementGroups (p. 125)
Reserved Instances
• DescribeReservedInstances (p. 131)
• DescribeReservedInstancesOfferings (p. 136)
• PurchaseReservedInstancesOffering (p. 204)
Security Groups
• AuthorizeSecurityGroupIngress (p. 22)
• CreateSecurityGroup (p. 44)
API Version 2010-08-3113
Amazon Elastic Compute Cloud API ReferenceList of Query Operations by Function
• DeleteSecurityGroup (p. 61)
• DescribeSecurityGroups (p. 141)
• RevokeSecurityGroupIngress (p. 228)
Spot Instances
• CancelSpotInstanceRequests (p. 34)
• CreateSpotDatafeedSubscription (p. 49)
• DeleteSpotDatafeedSubscription (p. 65)
• DescribeSpotDatafeedSubscription (p. 155)
• DescribeSpotInstanceRequests (p. 157)
• DescribeSpotPriceHistory (p. 167)
• RequestSpotInstances (p. 214)
Tags
• CreateTags (p. 52)
• DeleteTags (p. 67)
• DescribeTags (p. 171)
Windows
• BundleInstance (p. 25)
• CancelBundleTask (p. 30)
• DescribeBundleTasks (p. 81)
• GetPasswordData (p. 190)
API Version 2010-08-3114
Amazon Elastic Compute Cloud API ReferenceList of Query Operations by Function
ActivateLicenseThis action is for the Microsoft Windows Server License Mobility Pilot for Amazon EC2, which is a pilotprogram offered by Microsoft that allows customers with Microsoft Enterprise Agreements (EA) to migratetheir existing Windows Server licenses to Amazon EC2. If you're interested in the program, go tohttp://aws.amazon.com/ec2/windows-license-mobility-pilot.
API Version 2010-08-3115
Amazon Elastic Compute Cloud API ReferenceActivateLicense
AllocateAddress
DescriptionAcquires an elastic IP address for use with your account.
Request ParametersThe AllocateAddress operation does not have any request parameters.
Response Elements
DescriptionName
AllocateAddressResponseType element.
Type: AllocateAddressResponseType (p. 559)
Ancestor: None
Children: requestId, publicIp
AllocateAddressResponseType
The ID of the request.
Type: xsd:string
Ancestor: AllocateAddressResponseType
Children: None
requestId
IP address for use with your account.
Type: xsd:string
Ancestor: AllocateAddressResponseType
Children: None
publicIp
Examples
Example RequestThis example returns an elastic IP address for use with the account.
https://ec2.amazonaws.com/?Action=AllocateAddress&AuthParams
Example Response<AllocateAddressResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <publicIp>67.202.55.255</publicIp></AllocateAddressResponse>
Related Operations• DescribeAddresses (p. 74)
• ReleaseAddress (p. 212)
• AssociateAddress (p. 17)
• DisassociateAddress (p. 186)
API Version 2010-08-3116
Amazon Elastic Compute Cloud API ReferenceAllocateAddress
AssociateAddress
DescriptionAssociates an elastic IP address with an instance. If the IP address is currently assigned to anotherinstance, the IP address is assigned to the new instance. This is an idempotent operation. If you enter itmore than once, Amazon EC2 does not return an error.
Request Parameters
RequiredDescriptionName
YesIP address that you are assigning to the instance.
Type: String
Default: None
PublicIp
YesThe instance to associate with the IP address.
Type: String
Default: None
InstanceId
Response Elements
DescriptionName
AssociateAddressResponseType element.
Type: AssociateAddressResponseType (p. 559)
Ancestor: None
Children: requestId, return
AssociateAddressResponseType
The ID of the request.
Type: xsd:string
Ancestor: AssociateAddressResponseType
Children: None
requestId
Returns true if instance and IP address successfully associated.Otherwise, returns an error.
Type: xsd:boolean
Ancestor: AssociateAddressResponseType
Children: None
return
Examples
Example RequestThis example associates an IP address with an instance.
https://ec2.amazonaws.com/?Action=AssociateAddress&InstanceId=i-2ea64347
API Version 2010-08-3117
Amazon Elastic Compute Cloud API ReferenceAssociateAddress
&PublicIp=67.202.55.255&AuthParams
Example Response<AssociateAddressResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <return>true</return></AssociateAddressResponse>
Related Operations• AllocateAddress (p. 16)
• DescribeAddresses (p. 74)
• ReleaseAddress (p. 212)
• DisassociateAddress (p. 186)
API Version 2010-08-3118
Amazon Elastic Compute Cloud API ReferenceRelated Operations
AttachVolume
DescriptionAttaches an Amazon EBS volume to a running instance and exposes it as the specified device.
Note
Windows instances currently support devices xvda through xvdp. Devices xvda and xvdb arereserved by the operating system, xvdc is assigned to drive C:\, and, depending on the instancetype, devices xvdd through xvde might be reserved by the instance stores. Any device that is notreserved can be attached to an Amazon EBS volume. For a list of devices that are reserved bythe instance stores, go to the Amazon Elastic Compute Cloud Developer Guide or Amazon ElasticCompute Cloud User Guide.
Request Parameters
RequiredDescriptionName
YesThe ID of the Amazon EBS volume. The volume andinstance must be within the same Availability Zone andthe instance must be running.
Type: String
Default: None
VolumeId
YesThe ID of the instance to which the volume attaches. Thevolume and instance must be within the same AvailabilityZone and the instance must be running.
Type: String
Default: None
InstanceId
YesSpecifies how the device is exposed to the instance (e.g.,/dev/sdh).
Type: String
Default: None
Device
Response Elements
DescriptionName
AttachVolumeResponseType element.
Type: AttachVolumeResponseType (p. 562)
Ancestor: None
Children: requestId, volumeId, instanceId, device, status,and attachTime
AttachVolumeResponseType
API Version 2010-08-3119
Amazon Elastic Compute Cloud API ReferenceAttachVolume
DescriptionName
The ID of the request.
Type: xsd:string
Ancestor: AttachVolumeResponseType
Children: None
requestId
The ID of the volume.
Type: xsd:string
Ancestor: AttachVolumeResponseType
Children: None
volumeId
The ID of the instance.
Type: xsd:string
Ancestor: AttachVolumeResponseType
Children: None
instanceId
The device as it is exposed to the instance.
Type: xsd:string
Ancestor: AttachVolumeResponseType
Children: None
device
Volume state.
Type: xsd:string
Valid Values: attaching | attached | detaching | detached
Ancestor: AttachVolumeResponseType
Children: None
status
Time stamp when the attachment initiated.
Type: xsd:dateTime
Ancestor: AttachVolumeResponseType
Children: None
attachTime
Examples
Example RequestThis example attaches volume vol-4d826724 to instance i-6058a509 and exposes it as /dev/sdh.For information on standard storage locations, go to the Amazon Elastic Compute Cloud Developer Guideor Amazon Elastic Compute Cloud User Guide.
https://ec2.amazonaws.com/?Action=AttachVolume&VolumeId=vol-4d826724&InstanceId=i-6058a509&Device=/dev/sdh&AuthParams
Example Response<AttachVolumeResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <volumeId>vol-4d826724</volumeId>
API Version 2010-08-3120
Amazon Elastic Compute Cloud API ReferenceExamples
<instanceId>i-6058a509</instanceId> <device>/dev/sdh</device> <status>attaching</status> <attachTime>2008-05-07T11:51:50.000Z</attachTime></AttachVolumeResponse>
Related Operations• CreateVolume (p. 54)
• DeleteVolume (p. 70)
• DescribeVolumes (p. 177)
• DetachVolume (p. 183)
API Version 2010-08-3121
Amazon Elastic Compute Cloud API ReferenceRelated Operations
AuthorizeSecurityGroupIngress
DescriptionAdds a rule to a security group. Specifically, this either gives one or more CIDR IP address rangespermission to access a security group in your account, or gives one or more security groups (called thesource groups) permission to access a security group in your account. A source group can be in yourown AWS account, or another.
The permission is comprised of the IP protocol (TCP, UDP or ICMP) and the CIDR range or source group.For TCP and UDP, you also specify the source and destination port ranges; for ICMP, you also specifythe ICMP types.You can use -1 as a wildcard for the ICMP type.
Permission changes are propagated to instances within the security group as quickly as possible. However,depending on the number of instances, a small delay might occur.
Caution
Adding hundreds of rules to a security group might cause problems when you access the instance.We recommend you condense your rules as much as possible.
Request Parameters
RequiredDescriptionName
NoDeprecatedUserId
YesName of the group to modify. The name must be valid,and the group must belong to your account.
Type: String
Default: None
GroupName
YesIP protocol.
Type: String
Valid Values: tcp | udp | icmp
Default: None
IpPermissions.n.IpProtocol
YesStart of port range for the TCP and UDP protocols, or anICMP type number. An ICMP type number of -1 indicatesa wildcard (i.e., any ICMP type number).
Type: Integer
Default: None
IpPermissions.n.FromPort
YesEnd of port range for the TCP and UDP protocols, or anICMP code. An ICMP code of -1 indicates a wildcard (i.e.,any ICMP code).
Type: Integer
Default: None
IpPermissions.n.ToPort
API Version 2010-08-3122
Amazon Elastic Compute Cloud API ReferenceAuthorizeSecurityGroupIngress
RequiredDescriptionName
ConditionalAWS account ID that owns the source security group.Cannot be used when specifying a CIDR IP address.
Type: String
Default: None
Condition: Required if giving access to one or more sourcesecurity groups.
IpPermissions.n.Groups.m.UserId
ConditionalName of the source security group. Cannot be used whenspecifying a CIDR IP address.
Type: String
Default: None
Condition: Required if giving access to one or more sourcesecurity groups.
IpPermissions.n.Groups.m.GroupName
ConditionalCIDR range. Cannot be used when specifying a sourcesecurity group.
Type: String
Default: None
Constraints: Valid CIDR IP address range.
Condition: Required if giving access to one or more IPaddress ranges.
IpPermissions.n.IpRanges.m.CidrIp
Response Elements
DescriptionName
AuthorizeSecurityGroupIngressResponseType element.
Type: AuthorizeSecurityGroupIngressResponseType (p. 564)
Ancestor: None
Children: requestId, return
AuthorizeSecurityGroupIngressResponseType
The ID of the request.
Type: xsd:string
Ancestor: AuthorizeSecurityGroupIngressResponseType
Children: None
requestId
Returns true if request is successful. Otherwise, returns an error.
Type: xsd:boolean
Ancestor: AuthorizeSecurityGroupIngressResponseType
Children: None
return
Examples
Example RequestThis example grants the 205.192.0.0/16 and 205.159.0.0/16 address ranges access to your websrvsecurity group on TCP port 80.
API Version 2010-08-3123
Amazon Elastic Compute Cloud API ReferenceResponse Elements
https://ec2.amazonaws.com/?Action=AuthorizeSecurityGroupIngress&GroupName=websrv&IpPermissions.1.IpProtocol=tcp&IpPermissions.1.FromPort=80&IpPermissions.1.ToPort=80&IpPermissions.1.IpRanges.1.CidrIp=205.192.0.0/16&IpPermissions.1.IpRanges.2.CidrIp=205.159.0.0/16&AuthParams
Example RequestThis example grants TCP port 80 access from the source group called OtherAccountGroup (in AWSaccount 999988887777) to your websrv security group.
https://ec2.amazonaws.com/?Action=AuthorizeSecurityGroupIngress&GroupName=websrv&IpPermissions.1.IpProtocol=tcp&IpPermissions.1.FromPort=80&IpPermissions.1.ToPort=80&IpPermissions.1.Groups.1.GroupName=OtherAccountGroup&IpPermissions.1.Groups.1.UserId=999988887777&AuthParams
Example Response<AuthorizeSecurityGroupIngressResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <return>true</return></AuthorizeSecurityGroupIngressResponse>
Related Operations• CreateSecurityGroup (p. 44)
• DescribeSecurityGroups (p. 141)
• RevokeSecurityGroupIngress (p. 228)
• DeleteSecurityGroup (p. 61)
API Version 2010-08-3124
Amazon Elastic Compute Cloud API ReferenceRelated Operations
BundleInstance
DescriptionBundles an Amazon S3-backed Windows instance.
Note
During bundling, only the root store (C:\) is bundled. Data on other instance stores is not preserved.
This procedure is not applicable for Linux and UNIX instances or Windows instances that useAmazon EBS volumes as their root devices.
Request Parameters
RequiredDescriptionName
YesThe ID of the instance to bundle.
Type: String
Default: None
InstanceId
YesThe bucket in which to store the AMI.You can specify abucket that you already own or a new bucket that AmazonEC2 creates on your behalf. If you specify a bucket thatbelongs to someone else, Amazon EC2 returns an error.
Type: String
Default: None
Storage.S3.Bucket
YesSpecifies the beginning of the file name of the AMI.
Type: String
Default: None
Storage.S3.Prefix
YesThe Access Key ID of the owner of the Amazon S3 bucket.
Type: String
Default: None
Storage.S3.AWSAccessKeyId
YesA Base64-encoded Amazon S3 upload policy that givesAmazon EC2 permission to upload items into Amazon S3on the user's behalf.
Type: String
Default: None
Storage.S3.UploadPolicy
YesThe signature of the Base64 encoded JSON document.
Type: String
Default: None
Storage.S3.UploadPolicySignature
JSON ParametersThe upload policy gives Amazon EC2 limited permission to upload items into your Amazon S3 bucket.The following table describes the required parameters for the upload policy JSON document. Parameter
API Version 2010-08-3125
Amazon Elastic Compute Cloud API ReferenceBundleInstance
names are case sensitive. For more information about upload policies and how to sign them, go to thesections about policy construction and signatures in the Amazon Simple Storage Service DeveloperGuide.
RequiredDescriptionName
YesThe expiration of the policy. We recommend 12 hoursor longer.
expiration
YesA list of restrictions on what can be uploaded toAmazon S3. Must contain the bucket and ACLconditions in this table.
conditions
YesThe bucket to store the AMI.bucket
YesThis must be set to ec2-bundle-read.acl
Response Elements
DescriptionName
BundleInstanceResponseType element.
Type: BundleInstanceResponseType (p. 569)
Ancestor: None
Children: requestId, bundleInstanceTask
BundleInstanceResponseType
The ID of the request.
Type: xsd:string
Ancestor: BundleInstanceResponseType
Children: None
requestId
Bundle task.
Type: BundleInstanceTaskType (p. 572)
Ancestor: BundleInstanceResponseType
Children: instanceId, bundleId, state, startTime,updateTime, storage, progress, and error
bundleInstanceTask
Instance associated with this bundle task.
Type: xsd:string
Ancestor: bundleInstanceTask
Children: None
instanceId
Identifier for this task.
Type: xsd:string
Ancestor: bundleInstanceTask
Children: None
bundleId
API Version 2010-08-3126
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
The state of the task.
Type: xsd:string
Valid Values: pending | waiting-for-shutdown | storing |canceling | complete | failed
Ancestor: bundleInstanceTask
Children: None
state
The time this task started.
Type: xsd:dateTime
Ancestor: bundleInstanceTask
Children: None
startTime
The time of the most recent update for the task.
Type: xsd:dateTime
Ancestor: bundleInstanceTask
Children: None
updateTime
Amazon S3 storage locations.
Type: BundleInstanceTaskStorageType (p. 571)
Ancestor: bundleInstanceTask
Children: S3
storage
Amazon S3 storage location.
Type: BundleInstanceS3StorageType (p. 569)
Ancestor: storage
Children:bucket, prefix, awsAccessKeyId, uploadPolicy, anduploadPolicySignature
S3
The bucket in which to store the AMI.You can specify a bucket thatyou already own or a new bucket that Amazon EC2 creates on yourbehalf. If you specify a bucket that belongs to someone else, AmazonEC2 returns an error.
Type: xsd:string
Ancestor: S3
Children: None
bucket
Specifies the beginning of the file name of the AMI.
Type: xsd:string
Ancestor: S3
Children: None
prefix
The Access Key ID of the owner of the Amazon S3 bucket.
Type: xsd:string
Ancestor: S3
Children: None
awsAccessKeyId
API Version 2010-08-3127
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
A Base64-encoded Amazon S3 upload policy that gives AmazonEC2 permission to upload items into Amazon S3 on the user's behalf.
Type: xsd:string
Ancestor: S3
Children: None
uploadPolicy
The signature of the Base64 encoded JSON document.
Type: xsd:string
Ancestor: S3
Children: None
uploadPolicySignature
The level of task completion, in percent (e.g., 20%).
Type: xsd:string
Ancestor: bundleInstanceTask
Children: None
progress
If the task fails, a description of the error.
Type: BundleInstanceTaskErrorType (p. 570)
Ancestor: bundleInstanceTask
Children: code, message
error
Error code.
Type: xsd:string
Ancestor: error
Children: None
code
Error message.
Type: xsd:string
Ancestor: error
Children: None
message
Examples
Example RequestThis example bundles the i-e468cd8d instance.
https://ec2.amazonaws.com/?Action=BundleInstance&InstanceId=-i-e468cd8d&Storage.S3.AWSAccessKeyId=10QMXFEV71ZS32XQFTR2&Storage.S3.Bucket=my-bucket &Storage.S3.Prefix=winami&Storage.S3.UploadPolicy=eyJleHBpcmF0aW9uIjogIjIwMDgtMDgtMzBUMDg6NDk6MDlaIi wiY29uZGl0aW9ucyI6IFt7ImJ1Y2tldCI6ICJteS1idWNrZXQifSxbInN0YXJ0cy13aXRoIiwgIiR rZXkiLCAibXktbmV3LWltYWdlIl0seyJhY2wiOiAiZWMyLWJ1bmRsZS1yZWFkIn1dfQ%3D%3D&Storage.S3.UploadPolicySignature=fh5tyyyQD8W4COEthj3nlGNtJMU%3D &AuthParams
API Version 2010-08-3128
Amazon Elastic Compute Cloud API ReferenceExamples
Example Response<BundleInstanceResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <requestId>bun-c1a540a8</requestId> <bundleInstanceTask> <instanceId>i-12345678</instanceId> <bundleId>bun-c1a540a8</bundleId> <state>bundling</state> <startTime>2008-10-07T11:41:50.000Z</startTime> <updateTime>2008-10-07T11:51:50.000Z</updateTime> <progress>70%</progress> <storage> <S3> <bucket>my-bucket</bucket> <prefix>winami</prefix> </S3> </storage> </bundleInstanceTask></BundleInstanceResponse>
Related Operations• CancelBundleTask (p. 30)
• DescribeBundleTasks (p. 81)
• CreateImage (p. 38)
API Version 2010-08-3129
Amazon Elastic Compute Cloud API ReferenceRelated Operations
CancelBundleTask
DescriptionCancels an Amazon EC2 bundling operation.
Request Parameters
RequiredDescriptionName
YesThe ID of the bundle task to cancel.
Type: String
Default: None
BundleId
Response Elements
DescriptionName
CancelBundleTaskResponseType element.
Type: CancelBundleTaskResponseType (p. 574)
Ancestor: None
Children: requestId, bundleInstanceTask
CancelBundleTaskResponseType
The ID of the request.
Type: xsd:string
Ancestor: CancelBundleTaskResponseType
Children: None
requestId
Bundle task to cancel.
Type: BundleInstanceTaskType (p. 572)
Ancestor: CancelBundleTaskResponseType
Children: instanceId, bundleId, state, startTime,updateTime, storage, progress, and error
bundleInstanceTask
Instance associated with this bundle task.
Type: xsd:string
Ancestor: bundleInstanceTask
Children: None
instanceId
Identifier for this task.
Type: xsd:string
Ancestor: bundleInstanceTask
Children: None
bundleId
API Version 2010-08-3130
Amazon Elastic Compute Cloud API ReferenceCancelBundleTask
DescriptionName
The state of the task.
Type: xsd:string
Valid Values: pending | waiting-for-shutdown | storing |canceling | complete | failed
Ancestor: bundleInstanceTask
Children: None
state
The time this task started.
Type: xsd:dateTime
Ancestor: bundleInstanceTask
Children: None
startTime
The time of the most recent update for the task.
Type: xsd:dateTime
Ancestor: bundleInstanceTask
Children: None
updateTime
Amazon S3 storage locations.
Type: BundleInstanceTaskStorageType (p. 571)
Ancestor: bundleInstanceTask
Children: S3
storage
Amazon S3 storage location.
Type: BundleInstanceS3StorageType (p. 569)
Ancestor: storage
Children:bucket, prefix, awsAccessKeyId, uploadPolicy, anduploadPolicySignature
S3
The bucket in which to store the AMI.You can specify a bucket thatyou already own or a new bucket that Amazon EC2 creates on yourbehalf. If you specify a bucket that belongs to someone else, AmazonEC2 returns an error.
Type: xsd:string
Ancestor: S3
Children: None
bucket
Specifies the beginning of the file name of the AMI.
Type: xsd:string
Ancestor: S3
Children: None
prefix
The Access Key ID of the owner of the Amazon S3 bucket.
Type: xsd:string
Ancestor: S3
Children: None
awsAccessKeyId
API Version 2010-08-3131
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
A Base64-encoded Amazon S3 upload policy that gives AmazonEC2 permission to upload items into Amazon S3 on the user's behalf.
Type: xsd:string
Ancestor: S3
Children: None
uploadPolicy
The signature of the Base64 encoded JSON document.
Type: xsd:string
Ancestor: S3
Children: None
uploadPolicySignature
The level of task completion, in percent (e.g., 20%).
Type: xsd:string
Ancestor: bundleInstanceTask
Children: None
progress
If the task fails, a description of the error.
Type: BundleInstanceTaskErrorType (p. 570)
Ancestor: bundleInstanceTask
Children: code, message
error
Error code.
Type: xsd:string
Ancestor: error
Children: None
code
Error message.
Type: xsd:string
Ancestor: error
Children: None
message
Examples
Example RequestThis example cancels the bun-cla322b9 bundle task.
https://ec2.amazonaws.com/?Action=CancelBundleTask&BundleId=bun-cla322b9&AuthParams
Example Response<CancelBundleTaskResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <bundleInstanceTask> <instanceId>i-12345678</instanceId> <bundleId>bun-cla322b9</bundleId> <state>canceling</state> <startTime>2008-10-07T11:41:50.000Z</startTime>
API Version 2010-08-3132
Amazon Elastic Compute Cloud API ReferenceExamples
<updateTime>2008-10-07T11:51:50.000Z</updateTime> <progress>20%</progress> <storage> <S3> <bucket>my-bucket</bucket> <prefix>my-new-image</prefix> </S3> </storage> </bundleInstanceTask></CancelBundleTaskResponse>
Related Operations• BundleInstance (p. 25)
• DescribeBundleTasks (p. 81)
API Version 2010-08-3133
Amazon Elastic Compute Cloud API ReferenceRelated Operations
CancelSpotInstanceRequests
DescriptionCancels one or more Spot Instance requests. Spot Instances are instances that Amazon EC2 starts onyour behalf when the maximum price that you specify exceeds the current Spot Price. Amazon EC2periodically sets the Spot Price based on available Spot Instance capacity and current spot instancerequests. For conceptual information about Spot Instances, refer to the Amazon Elastic Compute CloudDeveloper Guide or Amazon Elastic Compute Cloud User Guide.
Important
Canceling a Spot Instance request does not terminate running Spot Instances associated withthe request.
Request Parameters
RequiredDescriptionName
YesSpecifies the ID of the Spot Instance request.
Type: String
Default: None
SpotInstanceRequestId.n
Response Elements
DescriptionName
CancelSpotInstanceRequestsResponseType element.
Type: CancelSpotInstanceRequestsResponseType (p. 576)
Ancestor: None
Children: requestId, spotInstanceRequestSet
CancelSpotInstanceRequestsResponseType
The ID of the request.
Type: xsd:string
Ancestor: CancelSpotInstanceRequestsResponseType
Children: None
requestId
Spot Instance requests set.
Type: CancelSpotInstanceRequestsResponseSetType (p. 575)
Ancestor: CancelSpotInstanceRequestsResponseType
Children: item
spotInstanceRequestSet
Cancel Spot Instance requests item.
Type: CancelSpotInstanceRequestsResponseSetItemType (p. 575)
Ancestor: spotInstanceRequestSet
Children: spotInstanceRequestId, state
item
API Version 2010-08-3134
Amazon Elastic Compute Cloud API ReferenceCancelSpotInstanceRequests
DescriptionName
Specifies the ID of the Spot Instance request.
Type: xsd:string
Ancestor: item
Children: None
spotInstanceRequestId
The state of the Spot Instance request.
Type: xsd:string
Valid Values: active | open | closed | cancelled | failed
Ancestor: item
Children: None
state
Examples
Example RequestThis example cancels a Spot Instance request.
https://ec2.amazonaws.com/?Action=CancelSpotInstanceRequests&SpotInstanceRequestId.1=sir-e95fae02&AuthParams
Example Response<CancelSpotInstanceRequestsResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <requestId>59dbff89-35bd-4eac-99ed-be587ed81825</requestId> <spotInstanceRequestSet> <item> <spotInstanceRequestId>sir-e95fae02</spotInstanceRequestId> <state>cancelled</state> </item> </spotInstanceRequestSet></CancelSpotInstanceRequestsResponse>
Related Operations• DescribeSpotInstanceRequests (p. 157)
• RequestSpotInstances (p. 214)
• DescribeSpotPriceHistory (p. 167)
API Version 2010-08-3135
Amazon Elastic Compute Cloud API ReferenceExamples
ConfirmProductInstance
DescriptionVerifies whether a Amazon DevPay product code is associated with an instance.This can only be executedby the owner of the AMI and is useful when an AMI owner wants to verify whether a user's instance iseligible for support.
Request Parameters
RequiredDescriptionName
YesThe product code to confirm.
Type: String
Default: None
ProductCode
YesThe instance to confirm.
Type: String
Default: None
InstanceId
Response Elements
DescriptionName
ConfirmProductInstanceResponseType element.
Type: ConfirmProductInstanceResponseType (p. 577)
Ancestor: None
Children: requestId, return, and ownerId
ConfirmProductInstanceResponseType
The ID of the request.
Type: xsd:string
Ancestor: ConfirmProductInstanceResponseType
Children: None
requestId
Returns true if the product code is attached to the instance.Otherwise, returns an error.
Type: xsd:boolean
Ancestor: ConfirmProductInstanceResponseType
Children: None
return
The instance owner's account ID. Only present if the product codeis attached to the instance.
Type: xsd:string
Ancestor: ConfirmProductInstanceResponseType
Children: None
ownerId
API Version 2010-08-3136
Amazon Elastic Compute Cloud API ReferenceConfirmProductInstance
Examples
Example RequestThis example describes the confirms the product code is associated with the instance.
https://ec2.amazonaws.com/?Action=ConfirmProductInstance&ProductCode=774F4FF8&InstanceId=i-10a64379&AuthParams
Example Response<ConfirmProductInstanceResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <return>true</return> <ownerId>254933287430</ownerId></ConfirmProductInstanceResponse>
Related Operations• DescribeInstances (p. 105)
• RunInstances (p. 231)
API Version 2010-08-3137
Amazon Elastic Compute Cloud API ReferenceExamples
CreateImage
DescriptionCreates an AMI that uses an Amazon EBS root device from a "running" or "stopped" instance.
AMIs that use an Amazon EBS root device boot faster than AMIs that use instance stores. They can beup to 1 TiB in size, use storage that persists on instance failure, and can be stopped and started.
Request Parameters
RequiredDescriptionName
YesThe ID of the instance.
Type: String
Default: None
InstanceId
YesThe name of the AMI that was provided during imagecreation.
Type: String
Default: None
Constraints: 3-128 alphanumeric characters, parenthesis(()), commas (,), slashes (/), dashes (-), or underscores(_)
Name
NoThe description of the AMI that was provided during imagecreation.
Type: String
Default: None
Constraints: Up to 255 characters
Description
NoBy default this property is set to false, which meansAmazon EC2 attempts to cleanly shut down the instancebefore image creation and reboots the instance afterwards.When set to true, Amazon EC2 does not shut down theinstance before creating the image. When this option isused, file system integrity on the created image cannot beguaranteed.
Type: Boolean
Default: false
NoReboot
Response Elements
DescriptionName
CreateImageResponseType element.
Type: CreateImageResponseType (p. 578)
Ancestor: None
Children: requestId, imageId
CreateImageResponseType
API Version 2010-08-3138
Amazon Elastic Compute Cloud API ReferenceCreateImage
DescriptionName
The ID of the request.
Type: xsd:string
Ancestor: CreateImageResponseType
Children: None
requestId
The ID of the AMI.
Type: xsd:string
Ancestor: CreateImageResponseType
Children: None
imageId
Examples
Example RequestThis example creates an AMI from the i-10a64379 instance.
https://ec2.amazonaws.com/?Action=CreateImage&Description=Standard+Web+Server+v1.0&InstanceId=i-10a64379&Name=standard-web-server-v1.0&AuthParams
Example Response<CreateImageResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <imageId>ami-4fa54026</imageId></CreateImageResponse>
Related Operations• RunInstances (p. 231)
• DescribeInstances (p. 105)
• TerminateInstances (p. 251)
API Version 2010-08-3139
Amazon Elastic Compute Cloud API ReferenceExamples
CreateKeyPair
DescriptionCreates a new 2048-bit RSA key pair with the specified name. The public key is stored by Amazon EC2and the private key is displayed on the console. The private key is returned as an unencrypted PEMencoded PKCS#8 private key. If a key with the specified name already exists, Amazon EC2 returns anerror.
Tip
The key pair returned to you works only in the Region you're using when you create the key pair.
If you'd like to create a key pair that works in all Regions, see ImportKeyPair (p. 192).
Request Parameters
RequiredDescriptionName
YesA unique name for the key pair.
Type: String
Default: None
Constraints: Accepts alphanumeric characters, spaces,dashes, and underscores.
KeyName
Response Elements
DescriptionName
CreateKeyPairResponseType element.
Type: CreateKeyPairResponseType (p. 579)
Ancestor: None
Children: requestId, keyName, keyFingerprint, andkeyMaterial
CreateKeyPairResponseType
The ID of the request.
Type: xsd:string
Ancestor: CreateKeyPairResponseType
Children: None
requestId
The key pair name provided in the original request.
Type: xsd:string
Ancestor: CreateKeyPairResponseType
Children: None
keyName
A SHA-1 digest of the DER encoded private key.
Type: xsd:string
Ancestor: CreateKeyPairResponseType
Children: None
keyFingerprint
API Version 2010-08-3140
Amazon Elastic Compute Cloud API ReferenceCreateKeyPair
DescriptionName
An unencrypted PEM encoded RSA private key.
Type: xsd:string
Ancestor: CreateKeyPairResponseType
Children: None
keyMaterial
Examples
Example RequestThis example creates a key pair named gsg-keypair.
https://ec2.amazonaws.com/?Action=CreateKeyPair&KeyName=gsg-keypair&AuthParams
Example Response<CreateKeyPairResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <keyName>gsg-keypair</keyName> <keyFinger print>1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f</keyFinger print> <keyMaterial>-----BEGIN RSA PRIVATE KEY-----MIIEoQIBAAKCAQBuLFg5ujHrtm1jnutSuoO8Xe56LlT+HM8v/xkaa39EstM3/aFxTHgElQiJLChpHungXQ29VTc8rc1bW0lkdi23OH5eqkMHGhvEwqa0HWASUMll4o3o/IX+0f2UcPoKCOVUR+jx71Sg5AU52EQfanIn3ZQ8lFW7Edp5a3q4DhjGlUKToHVbicL5E+g45zfB95wIyywWZfeW/UUF3LpGZyq/ebIUlq1qTbHkLbCC2r7RTn8vpQWp47BGVYGtGSBMpTRP5hnbzzuqj3itkiLHjU39S2sJCJ0TrJx5i8BygR4s3mHKBj8l+ePQxG1kGbF6R4yg6sECmXn17MRQVXODNHZbAgMBAAECggEAY1tsiUsIwDl591CXirkYGuVfLyLflXenxfI50mDFms/mumTqloHO7tr0oriHDR5K7wMcY/YY5YkcXNo7mvUVD1pMZNUJs7rw9gZRTrf7LylaJ58kOcyajw8TsC4e4LPbFaHwS1d6K8rXh64o6WgW4SrsB6ICmr1kGQI73wcfgt5ecIu4TZf0OE9IHjn+2eRlsrjBdeORi7KiUNC/pAG23I6MdDOFEQRcCSigCj+4/mciFUSASWS4dMbrpb9FNSIcf9dcLxVM7/6KxgJNfZc9XWzUw77Jg8x92Zd0fVhHOux5IZC+UvSKWB4dyfcItE8C3p9bbU9VGyY5vLCAiIb4qQKBgQDLiO24GXrIkswF32YtBBMuVgLGCwU9h9HlO9mKAc2m8Cm1jUE5IpzRjTedc9I2qiIMUTwtgnw42auSCzbUeYMURPtDqyQ7p6AjMujp9EPemcSVOK9vXYL0PtcoxW9MC0dtV6iPkCN7gOqiZXPRKaFbWADp16p8UAIvS/a5XXk5jwKBgQCKkpHi2EISh1uRkhxljyWCiDCiK6JBRsMvpLbc0v5dKwP5alo1fmdR5PJaV2qvZSj5CYNpMAy1/EDNTY5OSIJU+0KFmQbyhsbmrdLNLDL4+TcnT7c62/aH01ohYaf/VCbRhtLlBfqGoQc7+sAc8vmKkesnF7CqCEKDyF/dhrxYdQKBgC0iZzzNAapayz1+JcVTwwEid6j9JqNXbBc+Z2YwMi+T0Fv/P/hwkX/ypeOXnIUcw0Ih/YtGBVACDQbsz7LcY1HqXiHKYNWNvXgwwO+oiChjxvEkSdsTTIfnK4VSCvU9BxDbQHjdiNDJbL6oar92UN7VrBYvChJZF7LvUH4YmVpHAoGAbZ2X7XvoeEO+uZ58/BGKOIGHByHBDiXtzMhdJr15HTYjxK7OgTZmgK+8zp4L9IbvLGDMJO8vft32XPEWuvI8twCzFH+CsWLQADZMZKSsBasOZ/h1FwhdMgCMcY+Qlzd4JZKjTSu3i7vhvx6RzdSedXEMNTZWN4qlIx3kR5aHcukCgYA9T+Zrvm1F0seQPbLknn7EqhXIjBaTP8TTvW/6bdPi23ExzxZn7KOdrfclYRph1LHMpAONv/x2xALIf91UB+v5ohy1oDoasL0gij1houRe2ERKKdwz0ZL9SWq6VTdhr/5G994CK72fy5WhyERbDjUIdHaK3M849JJuf8cSrvSb4g==-----END RSA PRIVATE KEY-----</keyMaterial></CreateKeyPairResponse>
Related Operations• RunInstances (p. 231)
• DescribeKeyPairs (p. 121)
• DeleteKeyPair (p. 58)
API Version 2010-08-3141
Amazon Elastic Compute Cloud API ReferenceExamples
CreatePlacementGroup
DescriptionCreates a placement group that you launch cluster compute instances into.You must give the group aname unique within the scope of your account. For more information about placement groups and clustercompute instances, go to Cluster Compute Instance Concepts in the Amazon Elastic Compute CloudDeveloper Guide.
Request Parameters
RequiredDescriptionName
YesThe name of the placement group.
Type: string
Default: None
GroupName
YesThe placement group strategy.
Type: string
Valid Values: cluster
Strategy
Response Elements
DescriptionName
CreatePlacementGroupResponse element.
Type: CreatePlacementGroupResponseType
Ancestor: None
Children: requestId, return
CreatePlacementGroupResponse
The ID of the request.
Type: xsd:string
Ancestor: CreatePlacementGroupResponse
Children: None
requestId
Returns true if the placement group is created. Otherwise, returnsan error.
Type: xsd:boolean
Ancestor: CreatePlacementGroupResponse
Children: None
return
Examples
Example RequestThis example creates a placement group named XYZ-cluster.
API Version 2010-08-3142
Amazon Elastic Compute Cloud API ReferenceCreatePlacementGroup
https://ec2.amazonaws.com/?Action=CreatePlacementGroup&GroupName=XYZ-cluster&Strategy=cluster&AuthParams
Example Response<CreatePlacementGroupResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/">
<requestId>d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE</requestId> <return>true</return></CreatePlacementGroupResponse>
Related Operations• DeletePlacementGroup (p. 60)
• DescribePlacementGroups (p. 125)
API Version 2010-08-3143
Amazon Elastic Compute Cloud API ReferenceRelated Operations
CreateSecurityGroup
DescriptionCreates a new security group. Group names must be unique per account.
Every instance is launched in a security group. If no security group is specified during launch, the instancesare launched in the default security group. Instances within the same security group have unrestrictednetwork access to each other. Instances will reject network access attempts from other instances in adifferent security group. As the owner of instances you can grant or revoke specific permissions usingthe AuthorizeSecurityGroupIngress and RevokeSecurityGroupIngress operations.
Request Parameters
RequiredDescriptionName
YesName of the security group.
Type: String
Default: None
Constraints: Accepts alphanumeric characters, spaces,dashes, and underscores.
GroupName
YesDescription of the group. This is informational only. If thedescription contains spaces, you must enclose it in singlequotes (') or URL-encode it.
Type: String
Default: None
Constraints: Accepts alphanumeric characters, spaces,dashes, and underscores.
GroupDescription
Response Elements
DescriptionName
CreateSecurityGroupResponseType element.
Type: CreateSecurityGroupResponseType (p. 580)
Ancestor: None
Children: requestId, return
CreateSecurityGroupResponseType
The ID of the request.
Type: xsd:string
Ancestor: CreateSecurityGroupResponseType
Children: None
requestId
Returns true if creation succeeded. Otherwise, returns an error.
Type: xsd:boolean
Ancestor: CreateSecurityGroupResponseType
Children: None
return
API Version 2010-08-3144
Amazon Elastic Compute Cloud API ReferenceCreateSecurityGroup
Examples
Example RequestThis example creates the websrv security group.
https://ec2.amazonaws.com/?Action=CreateSecurityGroup&GroupName=websrv&GroupDescription='Web Servers'&AuthParams
Example Response<CreateSecurityGroupResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/">
<return>true</return></CreateSecurityGroupResponse>
Related Operations• RunInstances (p. 231)
• DescribeSecurityGroups (p. 141)
• AuthorizeSecurityGroupIngress (p. 22)
• RevokeSecurityGroupIngress (p. 228)
• DeleteSecurityGroup (p. 61)
API Version 2010-08-3145
Amazon Elastic Compute Cloud API ReferenceExamples
CreateSnapshot
DescriptionCreates a snapshot of an Amazon EBS volume and stores it in Amazon S3.You can use snapshots forbackups, to make identical copies of instance devices, and to save data before shutting down an instance.For more information about Amazon EBS, go to the Amazon Elastic Compute Cloud Developer Guide orAmazon Elastic Compute Cloud User Guide.
When taking a snapshot of a file system, we recommend unmounting it first. This ensures the file systemmetadata is in a consistent state, that the 'mounted indicator' is cleared, and that all applications usingthat file system are stopped and in a consistent state. Some file systems, such as xfs, can freeze andunfreeze activity so a snapshot can be made without unmounting.
For Linux/UNIX, enter the following command from the command line.
umount -d /dev/sdh
For Windows, open Disk Management, right-click the volume to unmount, and select Change Drive Letterand Path. Then, select the mount point to remove and click Remove.
Request Parameters
RequiredDescriptionName
YesThe ID of the Amazon EBS volume of which to take asnapshot.
Type: String
Default: None
VolumeId
NoDescription of the Amazon EBS snapshot.
Type: String
Default: None
Constraints: Up to 255 characters
Description
Response Elements
DescriptionName
CreateSnapshotResponseType element.
Type: CreateSnapshotResponseType (p. 581)
Ancestor: None
Children: requestId, snapshotId, volumeId, status,startTime, progress, ownerId, volumeSize, and description
CreateSnapshotResponseType
The ID of the request.
Type: xsd:string
Ancestor: CreateSnapshotResponseType
Children: None
requestId
API Version 2010-08-3146
Amazon Elastic Compute Cloud API ReferenceCreateSnapshot
DescriptionName
The ID of the snapshot.
Type: xsd:string
Ancestor: CreateSnapshotResponseType
Children: None
snapshotId
The ID of the volume.
Type: xsd:string
Ancestor: CreateSnapshotResponseType
Children: None
volumeId
Snapshot state (e.g., pending, completed, or error)
Type: xsd:string
Ancestor: CreateSnapshotResponseType
Children: None
status
Time stamp when the snapshot was initiated.
Type: xsd:dateTime
Ancestor: CreateSnapshotResponseType
Children: None
startTime
The progress of the snapshot, in percentage.
Type: xsd:string
Ancestor: CreateSnapshotResponseType
Children: None
progress
The AWS account ID of the Amazon EBS snapshot owner.
Type: xsd:string
Ancestor: CreateSnapshotResponseType
Children: None
ownerId
The size of the volume, in GiB.
Type: xsd:string
Ancestor: CreateSnapshotResponseType
Children: None
volumeSize
Description of the snapshot.
Type: xsd:string
Ancestor: CreateSnapshotResponseType
Children: None
description
Examples
Example RequestThis example creates a snapshot of volume vol-4d826724.
https://ec2.amazonaws.com/?Action=CreateSnapshot&VolumeId=vol-4d826724
API Version 2010-08-3147
Amazon Elastic Compute Cloud API ReferenceExamples
&Description=Daily+Backup&AuthParams
Example Response<CreateSnapshotResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <snapshotId>snap-78a54011</snapshotId> <volumeId>vol-4d826724</volumeId> <volumeSize>10</volumeSize> <status>pending</status> <startTime>2008-05-07T12:51:50.000Z</startTime> <progress>60%</progress> <ownerId>213457642086</ownerId> <description>Daily Backup</description></CreateSnapshotResponse>
Related Operations• DeleteSnapshot (p. 63)
• DescribeSnapshots (p. 149)
API Version 2010-08-3148
Amazon Elastic Compute Cloud API ReferenceRelated Operations
CreateSpotDatafeedSubscription
DescriptionCreates the data feed for Spot Instances, enabling you to view Spot Instance usage logs.You can createone data feed per account. For conceptual information about Spot Instances, refer to the Amazon ElasticCompute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide.
Request Parameters
RequiredDescriptionName
YesThe Amazon S3 bucket in which to store the Spot Instancedatafeed.
Type: String
Default: None
Constraints: Must be a valid bucket associated with youraccount.
Bucket
NoPrefix that is prepended to datafeed files.
Type: String
Default: None
Prefix
Response Elements
DescriptionName
CreateSpotDatafeedSubscriptionResponseType element.
Type: CreateSpotDatafeedSubscriptionResponseType (p. 583)
Ancestor: None
Children: requestId, spotDatafeedSubscription
CreateSpotDatafeedSubscriptionResponseType
The ID of the request.
Type: xsd:string
Ancestor: CreateSpotDatafeedSubscriptionResponseType
Children: None
requestId
Datafeed subscription.
Type: SpotDatafeedSubscriptionType (p. 698)
Ancestor: CreateSpotDatafeedSubscriptionResponseType
Children: ownerId, bucket, prefix, state, and fault
spotDatafeedSubscription
The AWS account ID of the account.
Type: xsd:string
Ancestor: spotDatafeedSubscription
Children: None
ownerId
API Version 2010-08-3149
Amazon Elastic Compute Cloud API ReferenceCreateSpotDatafeedSubscription
DescriptionName
The Amazon S3 bucket where the Spot Instance datafeed is located.
Type: xsd:string
Ancestor: spotDatafeedSubscription
Children: None
bucket
Prefix that is prepended to datafeed files.
Type: xsd:string
Ancestor: spotDatafeedSubscription
Children: None
prefix
The state of the Spot datafeed subscription.
Type: xsd:string
Valid Values: Active | Inactive
Ancestor: spotDatafeedSubscription
Children: None
state
Fault codes for the Spot Instance request, if any.
Type: SpotInstanceStateFaultType (p. 702)
Ancestor: spotDatafeedSubscription
Children: code, message
fault
Reason code for the Spot Instance state change.
Type: xsd:string
Ancestor: fault
Children: None
code
Message for the Spot Instance state change.
Type: xsd:string
Ancestor: fault
Children: None
message
Examples
Example RequestThis example creates the data feed for the account.
https://ec2.amazonaws.com/?Action=CreateSpotDatafeedSubscription&Bucket=my-bucket&AuthParams
Example Response<CreateSpotDatafeedSubscriptionResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <spotDatafeedSubscription> <ownerId>254933287430</ownerId> <bucket>my-bucket</bucket> <prefix/>
API Version 2010-08-3150
Amazon Elastic Compute Cloud API ReferenceExamples
<state>open</state> </spotDatafeedSubscription></CreateSpotDatafeedSubscriptionResponse>
Related Operations• DeleteSpotDatafeedSubscription (p. 65)
• DescribeSpotDatafeedSubscription (p. 155)
API Version 2010-08-3151
Amazon Elastic Compute Cloud API ReferenceRelated Operations
CreateTags
DescriptionAdds or overwrites one or more tags for the specified resource or resources. Each resource can have amaximum of 10 tags. Each tag consists of a key and optional value.Tag keys must be unique per resource.
For more information about tags, go to Using Tags in the Amazon Elastic Compute Cloud DeveloperGuide.
Request Parameters
RequiredDescriptionName
YesID of a resource to tag. For example, ami-1a2b3c4d.Youcan specify multiple resources to assign the tags to.
Type: String
Default: None
ResourceId.n
YesKey for a tag.
Type: String
Default: None
Constraints: Tag keys are case sensitive and accept amaximum of 128 Unicode characters.
Tag.n.Key
YesValue for a tag. If you don't want the tag to have a value,specify the parameter with no value, and we will set thevalue to an empty string.
Type: String
Default: None
Constraints: Tag values are case sensitive and accept amaximum of 256 Unicode characters.
Tag.n.Value
Response Elements
DescriptionName
CreateTagsResponse element.
Type: CreateTagsResponseType
Ancestor: None
Children: requestId, return
CreateTagsResponse
The ID of the request.
Type: xsd:string
Ancestor: CreateTagsResponse
Children: None
requestId
API Version 2010-08-3152
Amazon Elastic Compute Cloud API ReferenceCreateTags
DescriptionName
Returns true if the request succeeded. Otherwise, returns an error.
Type: xsd:boolean
Ancestor: CreateTagsResponse
Children: None
return
Examples
Example RequestThis example adds (or overwrites) two tags for an AMI and an instance. One of the tags is just a key(webserver), with no value (we set the value to an empty string). The other consists of a key (stack) andvalue (Production).
https://ec2.amazonaws.com/?Action=CreateTags&ResourceId.1=ami-1a2b3c4d&ResourceId.2=i-7f4d3a2b&Tag.1.Key=webserver&Tag.1.Value=&Tag.2.Key=stack&Tag.2.Value=Production&AuthParams
Example Response<CreateTagsResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId> <return>true</return></CreateTagsResponse>
Related Operations• DescribeTags (p. 171)
• DeleteTags (p. 67)
API Version 2010-08-3153
Amazon Elastic Compute Cloud API ReferenceExamples
CreateVolume
DescriptionCreates a new Amazon EBS volume to which any Amazon EC2 instance can attach within the sameAvailability Zone. For more information about Amazon EBS, go to the Amazon Elastic Compute CloudDeveloper Guide or Amazon Elastic Compute Cloud User Guide.
Note
You must specify an Availability Zone when creating a volume. The volume and the instance towhich it attaches must be in the same Availability Zone.
Request Parameters
RequiredDescriptionName
YesThe size of the volume, in GiBs. Required if you are notcreating a volume from a snapshot.
Type: String
Valid Values: 1 -1024
Default: None
Size
NoThe snapshot from which to create the new volume.
Type: String
Default: None
SnapshotId
YesThe Availability Zone in which to create the new volume.
Type: String
Default: None
AvailabilityZone
Response Elements
DescriptionName
CreateVolumeResponseType element.
Type: CreateVolumeResponseType (p. 586)
Ancestor: None
Children: requestId, volumeId, size, snapshotId,availabilityZone, status, and createTime
CreateVolumeResponseType
The ID of the request.
Type: xsd:string
Ancestor: CreateVolumeResponseType
Children: None
requestId
API Version 2010-08-3154
Amazon Elastic Compute Cloud API ReferenceCreateVolume
DescriptionName
The ID of the volume.
Type: xsd:string
Ancestor: CreateVolumeResponseType
Children: None
volumeId
The size of the volume, in GiBs.
Type: xsd:string
Ancestor: CreateVolumeResponseType
Children: None
size
Snapshot from which the volume was created, if applicable.
Type: xsd:string
Ancestor: CreateVolumeResponseType
Children: None
snapshotId
Availability Zone in which the volume was created.
Type: xsd:string
Ancestor: CreateVolumeResponseType
Children: None
availabilityZone
Volume state (e.g., creating, available)
Type: xsd:string
Ancestor: CreateVolumeResponseType
Children: None
status
Time stamp when volume creation was initiated.
Type: xsd:dateTime
Ancestor: CreateVolumeResponseType
Children: None
createTime
Examples
Example RequestThis example creates a new 800 GiB volume in Availability Zone us-east-1a.
https://ec2.amazonaws.com/?Action=CreateVolume&Size=800&AvailabilityZone=us-east-1a&AuthParams
Example Response<CreateVolumeResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <volumeId>vol-4d826724</volumeId> <size>800</size> <status>creating</status> <createTime>2008-05-07T11:51:50.000Z</createTime> <availabilityZone>us-east-1a</availabilityZone>
API Version 2010-08-3155
Amazon Elastic Compute Cloud API ReferenceExamples
<snapshotId></snapshotId></CreateVolumeResponse>
Related Operations• DeleteVolume (p. 70)
• DescribeVolumes (p. 177)
• AttachVolume (p. 19)
• DetachVolume (p. 183)
• DescribeAvailabilityZones (p. 77)
API Version 2010-08-3156
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DeactivateLicenseThis action is for the Microsoft Windows Server License Mobility Pilot for Amazon EC2, which is a pilotprogram offered by Microsoft that allows customers with Microsoft Enterprise Agreements (EA) to migratetheir existing Windows Server licenses to Amazon EC2. If you're interested in the program, go tohttp://aws.amazon.com/ec2/windows-license-mobility-pilot.
API Version 2010-08-3157
Amazon Elastic Compute Cloud API ReferenceDeactivateLicense
DeleteKeyPair
DescriptionDeletes the specified key pair, by removing the public key from Amazon EC2.You must own the key pair.
Request Parameters
RequiredDescriptionName
YesName of the key pair to delete.
Type: String
Default: None
KeyName
Response Elements
DescriptionName
DeleteKeyPairResponseType element.
Type: DeleteKeyPairResponseType (p. 587)
Ancestor: None
Children: requestId, return
DeleteKeyPairResponseType
The ID of the request.
Type: xsd:string
Ancestor: DeleteKeyPairResponseType
Children: None
requestId
Returns true if deletion succeeded. Otherwise, returns an error.
Type: xsd:boolean
Ancestor: DeleteKeyPairResponseType
Children: None
return
Examples
Example RequestThis example deletes the gsg-keypair key pair.
https://ec2.amazonaws.com/?Action=DeleteKeyPair&KeyName=gsg-keypair&AuthParams
Example Response<DeleteKeyPairResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <return>true</return></DeleteKeyPairResponse>
API Version 2010-08-3158
Amazon Elastic Compute Cloud API ReferenceDeleteKeyPair
Related Operations• CreateKeyPair (p. 40)
• DescribeKeyPairs (p. 121)
API Version 2010-08-3159
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DeletePlacementGroup
DescriptionDeletes a placement group from your account.You must terminate all instances in the placement groupbefore deleting it. For more information about placement groups and cluster compute instances, go toCluster Compute Instance Concepts in the Amazon Elastic Compute Cloud Developer Guide.
Request Parameters
RequiredDescriptionName
YesThe name of the placement group to delete.
Type: string
Default: None
GroupName
Examples
Example RequestThis example deletes the placement group named XYZ-cluster.
https://ec2.amazonaws.com/?Action=DeletePlacementGroup&GroupName=XYZ-cluster&AuthParams
Example Response<DeletePlacementGroupResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/">
<requestId>d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE</requestId> <return>true</return></DeletePlacementGroupResponse>
Related Operations• CreatePlacementGroup (p. 42)
• DescribePlacementGroups (p. 125)
API Version 2010-08-3160
Amazon Elastic Compute Cloud API ReferenceDeletePlacementGroup
DeleteSecurityGroup
DescriptionDeletes a security group that you own.
Note
If you attempt to delete a security group that contains instances, a fault is returned.
If you attempt to delete a security group that is referenced by another security group, a fault isreturned. For example, if security group B has a rule that allows access from security group A,security group A cannot be deleted until the allow rule is removed.
Request Parameters
RequiredDescriptionName
YesName of the security group to delete.
Type: String
Default: None
GroupName
Response Elements
DescriptionName
DeleteSecurityGroupResponseType element.
Type: DeleteSecurityGroupResponseType (p. 588)
Ancestor: None
Children: requestId, return
DeleteSecurityGroupResponseType
The ID of the request.
Type: xsd:string
Ancestor: DeleteSecurityGroupResponseType
Children: None
requestId
Returns true if deletion succeeded. Otherwise, returns an error.
Type: xsd:boolean
Ancestor: DeleteSecurityGroupResponseType
Children: None
return
Examples
Example RequestThis example deletes the websrv security group.
API Version 2010-08-3161
Amazon Elastic Compute Cloud API ReferenceDeleteSecurityGroup
https://ec2.amazonaws.com/?Action=DeleteSecurityGroup&GroupName=websrv&AuthParams
Example Response<DeleteSecurityGroupResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/">
<return>true</return></DeleteSecurityGroupResponse>
Related Operations• CreateSecurityGroup (p. 44)
• DescribeSecurityGroups (p. 141)
• AuthorizeSecurityGroupIngress (p. 22)
• RevokeSecurityGroupIngress (p. 228)
API Version 2010-08-3162
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DeleteSnapshot
DescriptionDeletes a snapshot of an Amazon EBS volume that you own. For more information, go to the AmazonElastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide.
Request Parameters
RequiredDescriptionName
YesThe ID of the Amazon EBS snapshot to delete.
Type: String
Default: None
SnapshotId
Response Elements
DescriptionName
DeleteSnapshotResponseType element.
Type: DeleteSnapshotResponseType (p. 589)
Ancestor: None
Children: requestId, return
DeleteSnapshotResponseType
The ID of the request.
Type: xsd:string
Ancestor: DeleteSnapshotResponseType
Children: None
requestId
Returns true if deletion succeeded. Otherwise, returns an error.
Type: xsd:boolean
Ancestor: DeleteSnapshotResponseType
Children: None
return
Examples
Example RequestThis example deletes snapshot snap-78a54011.
https://ec2.amazonaws.com/?Action=DeleteSnapshot&SnapshotId.1=snap-78a54011&AuthParams
API Version 2010-08-3163
Amazon Elastic Compute Cloud API ReferenceDeleteSnapshot
Example Response<DeleteSnapshotResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <return>true</return></DeleteSnapshotResponse>
Related Operations• CreateSnapshot (p. 46)
• DescribeSnapshots (p. 149)
API Version 2010-08-3164
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DeleteSpotDatafeedSubscription
DescriptionDeletes the data feed for Spot Instances. For conceptual information about Spot Instances, refer to theAmazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide.
Request ParametersThe DeleteSpotDatafeedSubscription operation does not have any request parameters.
Response Elements
DescriptionName
DeleteSpotDatafeedSubscriptionResponseType element.
Type: DeleteSpotDatafeedSubscriptionResponseType (p. 590)
Ancestor: None
Children: requestId, return
DeleteSpotDatafeedSubscriptionResponseType
The ID of the request.
Type: xsd:string
Ancestor: DeleteSpotDatafeedSubscriptionResponseType
Children: None
requestId
Returns true if deletion succeeded. Otherwise, returns an error.
Type: xsd:boolean
Ancestor: DeleteSpotDatafeedSubscriptionResponseType
Children: None
return
Examples
Example RequestThis example deletes the data feed for the account.
https://ec2.amazonaws.com/?Action=DeleteSpotDatafeedSubscription&AuthParams
Example Response<DeleteSpotDatafeedSubscriptionResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <return>true</return></DeleteSpotDatafeedSubscriptionResponse>
Related Operations• CreateSpotDatafeedSubscription (p. 49)
API Version 2010-08-3165
Amazon Elastic Compute Cloud API ReferenceDeleteSpotDatafeedSubscription
• DescribeSpotDatafeedSubscription (p. 155)
API Version 2010-08-3166
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DeleteTags
DescriptionDeletes a specific set of tags from a specific set of resources. This call is designed to follow aDescribeTags call.You first determine what tags a resource has, and then you call DeleteTags withthe resource ID and the specific tags you want to delete.
For more information about tags, go to Using Tags in the Amazon Elastic Compute Cloud DeveloperGuide.
Request Parameters
RequiredDescriptionName
YesID of the resource. For example, ami-1a2b3c4d.You canspecify more than one resource ID.
Type: String
Default: None
ResourceId.n
YesThe tag's key.You can specify more than one tag to delete.
Type: String
Default: None
Tag.n.Key
NoThe tag's value.
Type: String
Default: If you omit this parameter, we delete the tagregardless of its value. If you specify this parameter withan empty string as the value, we delete the key only if itsvalue is an empty string.
Tag.n.Value
Response Elements
DescriptionName
DeleteTagsResponse element.
Type: DeleteTagsResponseType
Ancestor: None
Children: requestId, tags
DeleteTagsResponse
The ID of the request.
Type: xsd:string
Ancestor: DeleteTagsResponse
Children: None
requestId
Returns true if deletion succeeded. Otherwise, returns an error.
Type: xsd:boolean
Ancestor: DeleteTagsResponse
Children: None
return
API Version 2010-08-3167
Amazon Elastic Compute Cloud API ReferenceDeleteTags
Examples
Example RequestThis example deletes the tags for the AMI with ID ami-1a2b3c4d.You first get a list of the tags.
https://ec2.amazonaws.com/?Action=DescribeTags&ResourceId.1=ami-1a2b3c4d&AuthParams
Sample response:
<DescribeTagsResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId> <tagSet> <item> <resourceId>ami-1a2b3c4d</resourceId> <resourceType>image</resourceType> <key>webserver</key> <value/> </item> <item> <resourceId>ami-1a2b3c4d</resourceId> <resourceType>image</resourceType> <key>stack</key> <value>Production</value> </item> </tagSet></DescribeTagsResponse>
Then you delete the tags. Specifying the value for the stack tag is optional.
https://ec2.amazonaws.com/?Action=DeleteTags&ResourceId.1=ami-1a2b3c4d&Tag.1.Key=webserver&Tag.2.Key=stack&AuthParams
Sample response:
<DeleteTagsResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId> <return>true</return></DeleteTagsResponse>
Example RequestThis example deletes the stack tag from two particular instances.
https://ec2.amazonaws.com/?Action=DeleteTags&ResourceId.1=i-5f4e3d2a&Tag.1.Key=stack&ResourceId.2=i-12345678&Tag.2.Key=stack&AuthParams
API Version 2010-08-3168
Amazon Elastic Compute Cloud API ReferenceExamples
Example RequestThis example deletes the stack and webserver tags for one particular instance.
https://ec2.amazonaws.com/?Action=DeleteTags&ResourceId.1=i-5f4e3d2a&Tag.1.Key=stack&ResourceId.2=i-5f4e3d2a&Tag.2.Key=webserver&AuthParams
Example RequestYou can specify a tag key without a corresponding tag value if you want to delete the tag regardless ofits value. This example deletes all tags whose key=Purpose, regardless of the tag value.
https://ec2.amazonaws.com/?Action=DeleteTags&ResourceId.1=i-5f4e3d2a&Tag.1.Key=Purpose&AuthParams
Example RequestWhen you create a tag, you can set the tag value to the empty string. Correspondingly, you can deleteonly tags that have a specific key and whose value is the empty string. This example deletes all tags forthe specified instance where key=Purpose and the tag value is the empty string.
https://ec2.amazonaws.com/?Action=DeleteTags&ResourceId.1=i-5f4e3d2a&Tag.1.Key=Purpose&Tag.2.Value=&AuthParams
Related Operations• CreateTags (p. 52)
• DescribeTags (p. 171)
API Version 2010-08-3169
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DeleteVolume
DescriptionDeletes an Amazon EBS volume that you own. The volume must be in the available state (not attachedto an instance). For more information about Amazon EBS, go to the Amazon Elastic Compute CloudDeveloper Guide or Amazon Elastic Compute Cloud User Guide.
Note
The volume remains in the deleting state for several minutes after you enter this command.
Request Parameters
RequiredDescriptionName
YesThe ID of the volume to delete.The volume remains in thedeleting state for several minutes after entering thiscommand.
Type: String
Default: None
VolumeId
Response Elements
DescriptionName
DeleteVolumeResponseType element.
Type: DeleteVolumeResponseType (p. 591)
Ancestor: None
Children: requestId, return
DeleteVolumeResponseType
The ID of the request.
Type: xsd:string
Ancestor: DeleteVolumeResponseType
Children: None
requestId
Returns true if deletion succeeded. Otherwise, returns an error.
Type: xsd:boolean
Ancestor: DeleteVolumeResponseType
Children: None
return
Examples
Example RequestThis example deletes volume vol-4282672b.
API Version 2010-08-3170
Amazon Elastic Compute Cloud API ReferenceDeleteVolume
https://ec2.amazonaws.com/?Action=DeleteVolume&VolumeId=vol-4282672b&AuthParams
Example Response<DeleteVolumeResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <return>true</return></DeleteVolumeResponse>
Related Operations• CreateVolume (p. 54)
• DescribeVolumes (p. 177)
• AttachVolume (p. 19)
• DetachVolume (p. 183)
API Version 2010-08-3171
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DeregisterImage
DescriptionDeregisters the specified AMI. Once deregistered, the AMI cannot be used to launch new instances.
Note
This command does not delete the AMI.
Request Parameters
RequiredDescriptionName
YesUnique ID of the AMI which was assigned duringregistration. To register an AMI, use RegisterImage. Toview the AMI IDs of AMIs that belong to your account. useDescribeImages.
Type: String
Default: None
ImageId
Response Elements
DescriptionName
DeregisterImageResponseType element.
Type: DeregisterImageResponseType (p. 592)
Ancestor: None
Children: requestId, return
DeregisterImageResponseType
The ID of the request.
Type: xsd:string
Ancestor: DeregisterImageResponseType
Children: None
requestId
Returns true if deregistration succeeded. Otherwise, returns an error.
Type: xsd:boolean
Ancestor: DeregisterImageResponseType
Children: None
return
Examples
Example RequestThis example deregisters the ami-4fa54026 AMI.
API Version 2010-08-3172
Amazon Elastic Compute Cloud API ReferenceDeregisterImage
https://ec2.amazonaws.com/?Action=DeregisterImage&ImageId=ami-4fa54026&AuthParams
Example Response<DeregisterImageResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <return>true</return></DeregisterImageResponse>
Related Operations• RegisterImage (p. 208)
• DescribeImages (p. 91)
API Version 2010-08-3173
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DescribeAddresses
DescriptionLists elastic IP addresses assigned to your account or provides information about a specific address.
You can filter the results to return information only about elastic IP addresses that match criteria youspecify. For example, you could get information only about addresses tagged with a certain value.Youcan specify multiple values for a filter. An address must match at least one of the specified values for itto be included in the results.
You can specify multiple filters (e.g., the address is a particular value, and is tagged with a certain value).The result includes information for an address only if it matches all your filters. If there's no match, nospecial message is returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactlyone character.You can escape special characters using a backslash before the character. For example,a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following table shows the available filters.
DescriptionFilter Name
Instance the address is associated with (if any).
Type: String
instance-id
The elastic IP address.
Type: String
public-ip
Request Parameters
RequiredDescriptionName
NoElastic IP address to describe.
Type: String
Default: None
PublicIp.n
NoName of a filter. See the preceding table for a list ofallowed filter names.
Type: String
Default: None
Filter.n.Name
NoA value for the filter. See the preceding table for a list ofallowed values for each filter.
Type: String
Default: None
Filter.n.Value.m
API Version 2010-08-3174
Amazon Elastic Compute Cloud API ReferenceDescribeAddresses
Response Elements
DescriptionName
DescribeAddressesResponse element.
Type: DescribeAddressesResponseType (p. 595)
Ancestor: None
Children: requestId, addressesSet
DescribeAddressesResponse
The ID of the request.
Type: xsd:string
Ancestor: DescribeAddressesResponseType
Children: None
requestId
The set of IP addresses.
Type: DescribeAddressesResponseInfoType (p. 594)
Ancestor: DescribeAddressesResponseType
Children: item
addressesSet
Information about an instance.
Type: DescribeAddressesResponseItemType (p. 594)
Ancestor: addressesSet
Children: publicIp, instanceId
item
The public IP address.
Type: xsd:string
Ancestor: item
Children: None
publicIp
The ID of the instance.
Type: xsd:string
Ancestor: item
Children: None
instanceId
Examples
Example RequestThis example describes elastic IP addresses assigned to the account. Amazon EC2 returns 67.202.55.255,which is assigned to instance i-f15ebb98, and 67.202.55.233, which is not assigned to an instance.
https://ec2.amazonaws.com/?Action=DescribeAddresses&PublicIp.1=67.202.55.255&PublicIp.2=67.202.55.233&AuthParams
Example Response<DescribeAddressesResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <addressesSet> <item>
API Version 2010-08-3175
Amazon Elastic Compute Cloud API ReferenceResponse Elements
<publicIp>67.202.55.255</publicIp> <instanceId>i-f15ebb98</instanceId> </item> <item> <publicIp>67.202.55.233</publicIp> <instanceId/> </item> </addressesSet> </DescribeAddressesResponse>
Related Operations• AllocateAddress (p. 16)
• ReleaseAddress (p. 212)
API Version 2010-08-3176
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DescribeAvailabilityZones
DescriptionDisplays Availability Zones that are currently available to the account. The results include zones only forthe Region you're currently using.
Note
Availability Zones are not the same across accounts.The Availability Zone us-east-1a for accountA is not necessarily the same as us-east-1a for account B. Zone assignments are mappedindependently for each account.
You can filter the results to return information only about zones that match criteria you specify. Forexample, you could filter the results to return only the zones whose state is available.You can specifymultiple filters (e.g., the zone is in a particular Region, and the state is available). The result includesinformation for a particular zone only if it matches all your filters. If there's no match, no special messageis returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactlyone character.You can escape special characters using a backslash before the character. For example,a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following table shows the available filters.
DescriptionFilter Name
Message giving information about the Availability Zone.
Type: String
message
Region the Availablity Zone is in (e.g., us-east-1).
Type: String
region-name
State of the Availability Zone
Type: String
Valid Values: available
state
Name of the zone.
Type: String
zone-name
Request Parameters
RequiredDescriptionName
NoAvailability Zone name.
Type: String
Default: None
ZoneName.n
API Version 2010-08-3177
Amazon Elastic Compute Cloud API ReferenceDescribeAvailabilityZones
RequiredDescriptionName
NoName of a filter. See the preceding table for a list ofallowed filter names.
Type: String
Default: None
Filter.n.Name
NoA value for the filter. See the preceding table for a list ofallowed values for each filter.
Type: String
Default: None
Filter.n.Value.m
Response Elements
DescriptionName
DescribeAvailabilityZonesResponseType element.
Type: DescribeAvailabilityZonesResponseType (p. 596)
Ancestor: None
Children: requestId, availabilityZoneInfo
DescribeAvailabilityZonesResponseType
The ID of the request.
Type: xsd:string
Ancestor: DescribeAvailabilityZonesResponseType
Children: None
requestId
Availability Zone information.
Type: AvailabilityZoneSetType (p. 567)
Ancestor: DescribeAvailabilityZonesResponseType
Children: item
availabilityZoneInfo
Information for one Availability Zone.
Type: AvailabilityZoneItemType (p. 565)
Ancestor: availabilityZoneInfo
Children: zoneName, zoneState, regionName, and messageSet
item
Name of the Availability Zone.
Type: xsd:string
Ancestor: item
Children: None
zoneName
State of the Availability Zone.
Type: xsd:string
Valid Values: available
Ancestor: item
Children: None
zoneState
API Version 2010-08-3178
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Name of the Region.
Type: xsd:string
Ancestor: item
Children: None
regionName
Message set.
Type: AvailabilityZoneMessageSetType (p. 566)
Ancestor: item
Children: item
messageSet
Availability Zone message set.
Type: AvailabilityZoneMessageType (p. 566)
Ancestor: messageSet
Children: message
item
The Availability Zone message.
Type: xsd:string
Ancestor: item
Children: None
message
Examples
Example RequestThis example displays information about Availability Zones that are available to the account. The resultsincludes zones only in the Region (endpoint) you're currently using.
https://ec2.amazonaws.com/?Action=DescribeAvailabilityZones&AuthParams
Example Response<DescribeAvailabilityZonesResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <availabilityZoneInfo> <item> <zoneName>us-east-1a</zoneName> <zoneState>available</zoneState> </item> <item> <zoneName>us-east-1b</zoneName> <zoneState>available</zoneState> </item> <item> <zoneName>us-east-1c</zoneName> <zoneState>available</zoneState> </item> <item> <zoneName>us-east-1d</zoneName> <zoneState>available</zoneState> </item>
API Version 2010-08-3179
Amazon Elastic Compute Cloud API ReferenceExamples
</availabilityZoneInfo></DescribeAvailabilityZonesResponse>
Related Operations• RunInstances (p. 231)
• DescribeRegions (p. 128)
API Version 2010-08-3180
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DescribeBundleTasks
DescriptionDescribes current bundling tasks.
Note
Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in thelist, you can still register an AMI from it. Just use the RegisterImage action with the AmazonS3 bucket name and image manifest name you provided to the bundle task.
You can filter the results to return information only about tasks that match criteria you specify. For example,you could filter the results to return only the tasks whose state is complete.You can specify multiplevalues for a filter. A bundle task must match at least one of the specified values for it to be included inthe results.
You can specify multiple filters (e.g., the bundle is stored in a particular Amazon S3 bucket and the stateis complete).The result includes information for a particular bundle task only if it matches all your filters.If there's no match, no special message is returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactlyone character.You can escape special characters using a backslash before the character. For example,a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following table shows the available filters.
DescriptionFilter Name
ID of the bundle task.
Type: String
bundle-id
If the task failed, the error code returned.
Type: String
error-code
If the task failed, the error message returned.
Type: String
error-message
ID of the instance that was bundled.
Type: String
instance-id
Level of task completion, in percent (e.g., 20%).
Type: String
progress
AWS Access Key ID of the bucket owner.
Type: String
s3-aws-access-key-id
Amazon S3 bucket where the AMI will be stored.
Type: String
s3-bucket
Beginning of the AMI name.
Type: String
s3-prefix
API Version 2010-08-3181
Amazon Elastic Compute Cloud API ReferenceDescribeBundleTasks
DescriptionFilter Name
Time the task started, e.g., 2008-09-15T17:15:20.000Z.
Type: xsd:dateTime
start-time
State of the task.
Type: String
Valid Values: pending | waiting-for-shutdown | bundling | storing| cancelling | complete | failed
state
Time of the most recent update for the task, e.g., 2008-09-15T17:15:20.000Z.
Type: xsd:dateTime
update-time
Request Parameters
RequiredDescriptionName
NoThe ID of the bundle task to describe.You can specifymultiple bundle tasks.
Type: String
Default: If no ID is specified, all bundle tasks are described.
BundleId.n
NoName of a filter. See the preceding table for a list ofallowed filter names.
Type: String
Default: None
Filter.n.Name
NoA value for the filter. See the preceding table for a list ofallowed values for each filter.
Type: String
Default: None
Filter.n.Value.m
Response Elements
DescriptionName
DescribeBundleTasksResponse element.
Type: DescribeBundleTasksResponseType (p. 599)
Ancestor: None
Children: requestId, bundleInstanceTasksSet
DescribeBundleTasksResponse
The ID of the request.
Type: xsd:string
Ancestor: DescribeBundleTasksResponseType
Children: None
requestId
API Version 2010-08-3182
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
DescriptionName
Bundle task set.
Type: BundleInstanceTasksSetType (p. 571)
Ancestor: DescribeBundleTasksResponseType
Children: item
bundleInstanceTasksSet
Bundle task.
Type: BundleInstanceTaskType (p. 572)
Ancestor: bundleInstanceTasksSet
Children: instanceId, bundleId, state, startTime,updateTime, storage, progress, and error
item
Instance associated with this bundle task.
Type: xsd:string
Ancestor: item
Children: None
instanceId
Identifier for this task.
Type: xsd:string
Ancestor: item
Children: None
bundleId
The state of the task.
Type: xsd:string
Valid Values: pending | waiting-for-shutdown | bundling |storing | cancelling | complete | failed
Ancestor: item
Children: None
state
The time this task started.
Type: xsd:dateTime
Ancestor: item
Children: None
startTime
The time of the most recent update for the task.
Type: xsd:dateTime
Ancestor: item
Children: None
updateTime
Amazon S3 storage locations.
Type: BundleInstanceTaskStorageType (p. 571)
Ancestor: item
Children: S3
storage
Amazon S3 storage location.
Type: BundleInstanceS3StorageType (p. 569)
Ancestor: storage
Children:bucket, prefix, awsAccessKeyId, uploadPolicy, anduploadPolicySignature
S3
API Version 2010-08-3183
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
The bucket in which to store the AMI.You can specify a bucket thatyou already own or a new bucket that Amazon EC2 creates on yourbehalf. If you specify a bucket that belongs to someone else, AmazonEC2 returns an error.
Type: xsd:string
Ancestor: S3
Children: None
bucket
Specifies the beginning of the file name of the AMI.
Type: xsd:string
Ancestor: S3
Children: None
prefix
The Access Key ID of the owner of the Amazon S3 bucket.
Type: xsd:string
Ancestor: S3
Children: None
awsAccessKeyId
A Base64-encoded Amazon S3 upload policy that gives AmazonEC2 permission to upload items into Amazon S3 on the user's behalf.
Type: xsd:string
Ancestor: S3
Children: None
uploadPolicy
The signature of the Base64 encoded JSON document.
Type: xsd:string
Ancestor: S3
Children: None
uploadPolicySignature
The level of task completion, in percent (e.g., 20%).
Type: xsd:string
Ancestor: item
Children: None
progress
If the task fails, a description of the error.
Type: BundleInstanceTaskErrorType (p. 570)
Ancestor: item
Children: code, message
error
Error code.
Type: xsd:string
Ancestor: error
Children: None
code
Error message.
Type: xsd:string
Ancestor: error
Children: None
message
API Version 2010-08-3184
Amazon Elastic Compute Cloud API ReferenceResponse Elements
Examples
Example RequestThis example describes the status of the bun-57a5403e bundle task.
https://ec2.amazonaws.com/?Action=DescribeBundleTasks&bundleId.1=bun-c1a540a8&AuthParams
Example Response<DescribeBundleTasksResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/">
<bundleInstanceTasksSet> <item> <instanceId>i-12345678</instanceId> <bundleId>bun-c1a540a8</bundleId> <state>canceling</state> <startTime>2008-10-07T11:41:50.000Z</startTime> <updateTime>2008-10-07T11:51:50.000Z</updateTime> <progress>20%</progress> <storage> <S3> <bucket>mybucket</bucket> <prefix>winami</prefix> </S3> </storage> </item> <bundleInstanceTasksSet></DescribeBundleTasksResponse>
Example RequestThis example filters the results to display only bundle tasks whose state is either complete or failed,and in addition are targeted for the Amazon S3 bucket called mybucket.
https://ec2.amazonaws.com/?Action=DescribeBundleTasks&Filter.1.Name=s3-bucket&Filter.1.Value.1=mybucket&Filter.2.Name=state&Filter.2.Name.1=complete&Filter.2.Name.2=failed&AuthParams
Related Operations• BundleInstance (p. 25)
• CancelBundleTask (p. 30)
API Version 2010-08-3185
Amazon Elastic Compute Cloud API ReferenceExamples
DescribeImageAttribute
DescriptionReturns information about an attribute of an AMI.You can get information about only one attribute percall.
Request Parameters
RequiredDescriptionName
YesThe ID of the AMI for which an attribute will be described.
Type: String
Default: None
ImageId
NoReturns the description of the AMI that was provided duringimage creation.
Type: String
Default: None
Attribute=description
NoReturns the ID of the kernel associated with the AMI.
Type: String
Default: None
Attribute=kernel
NoReturns the ID of the RAM disk associated with the AMI.
Type: String
Default: None
Attribute=ramdisk
NoReturns the launch permissions of the AMI.
Type: String
Default: None
Attribute=launchPermission
NoReturns the product code associated with the AMI.
Type: String
Default: None
Attribute=productCodes
NoReturns the block device mapping of the AMI.
Type: String
Default: None
Attribute=blockDeviceMapping
API Version 2010-08-3186
Amazon Elastic Compute Cloud API ReferenceDescribeImageAttribute
Response Elements
DescriptionName
DescribeImageAttributeResponseType element.
Type: DescribeImageAttributeResponseType (p. 600)
Ancestor: None
Children: requestId, imageId, launchPermission,productCodes, kernel, ramdisk, description, andblockDeviceMapping
DescribeImageAttributeResponseType
The ID of the request.
Type: xsd:string
Ancestor: DescribeImageAttributeResponseType
Children: None
requestId
The ID of the AMI.
Type: xsd:string
Ancestor: DescribeImageAttributeResponseType
Children: None
imageId
Launch permissions set.
Type: LaunchPermissionListType (p. 660)
Ancestor: DescribeImageAttributeResponseType
Children: item
launchPermission
Information for launch permissions.
Type: LaunchPermissionItemType (p. 659)
Ancestor: launchPermission
Children: userId, group
item
AWS account ID.
Type: xsd:string
Ancestor: item
Children: None
userId
Name of the group. Currently supports "all."
Type: xsd:string
Ancestor: item
Children: None
group
Product codes set.
Type: ProductCodeListType (p. 673)
Ancestor: DescribeImageAttributeResponseType
Children: item
productCodes
Information for one product code.
Type: ProductCodeItemType (p. 672)
Ancestor: productCodes
Children: productCode
item
API Version 2010-08-3187
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Product code.
Type: xsd:string
Ancestor: item
Children: None
productCode
Kernel set.
Type: NullableAttributeValueType (p. 670)
Ancestor: DescribeImageAttributeResponseType
Children:
kernel
RAM disk set.
Type: NullableAttributeValueType (p. 670)
Ancestor: DescribeImageAttributeResponseType
Children:
ramdisk
User-created description of the AMI.
Type: NullableAttributeValueType (p. 670)
Ancestor: DescribeImageAttributeResponseType
Children:
description
Block device mapping set.
Type: BlockDeviceMappingType (p. 568)
Ancestor: DescribeImageAttributeResponseType
Children: item
blockDeviceMapping
Information for one block device mapping.
Type: BlockDeviceMappingItemType (p. 567)
Ancestor: blockDeviceMapping
Children: deviceName, virtualName, ebs, and noDevice
item
The device name (e.g., /dev/sdh).
Type: xsd:string
Ancestor: item
Children: None
deviceName
The virtual device name.
Type: xsd:string
Ancestor: item
Children: None
virtualName
Specifies parameters used to automatically set up Amazon EBSvolumes when the instance is launched.
Type: EbsBlockDeviceType (p. 643)
Ancestor: item
Children:snapshotId, volumeSize, and deleteOnTermination
ebs
API Version 2010-08-3188
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
The ID of the snapshot.
Type: xsd:string
Ancestor: ebs
Children: None
snapshotId
The size of the volume, in GiBs.
Type: xsd:int
Ancestor: ebs
Children: None
volumeSize
Specifies whether the Amazon EBS volume is deleted on instancetermination.
Type: xsd:boolean
Ancestor: ebs
Children: None
deleteOnTermination
Specifies the device name to suppress during instance launch.
Type: EmptyElementType (p. 644)
Ancestor: item
Children:
noDevice
Examples
Example RequestThis example lists the launch permissions for the ami-61a54008 AMI
https://ec2.amazonaws.com/?Action=DescribeImageAttribute&ImageId=ami-2bb65342&Attribute=launchPermission&AuthParams
Example Response<DescribeImageAttributeResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <imageId>ami-61a54008</imageId> <launchPermission> <item> <group>all</group> </item> <item> <userId>495219933132</userId> </item> </launchPermission></DescribeImageAttributeResponse>
Example RequestThis example lists the product code for the ami-2bb65342 AMI.
API Version 2010-08-3189
Amazon Elastic Compute Cloud API ReferenceExamples
https://ec2.amazonaws.com/?Action=DescribeImageAttribute&ImageId=ami-2bb65342&Attribute=productCodes&AuthParams
Example Response<DescribeImageAttributeResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <imageId>ami-2bb65342</imageId> <productCodes> <item> <productCode>774F4FF8</productCode> </item> </productCodes> </DescribeImageAttributeResponse>
Related Operations• DescribeImages (p. 91)
• ModifyImageAttribute (p. 195)
• ResetImageAttribute (p. 222)
API Version 2010-08-3190
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DescribeImages
DescriptionReturns information about AMIs, AKIs, and ARIs. Images available to you include public images, privateimages that you own, and private images owned by other AWS accounts but for which you have explicitlaunch permissions.
Launch permissions fall into three categories:
DescriptionLaunchPermission
The owner of the AMI granted launch permissions for the AMI to the all group.All AWS accounts have launch permissions for these AMIs.
public
The owner of the AMI granted launch permissions to a specific AWS account.explicit
An AWS account has implicit launch permissions for all the AMIs it owns.implicit
The list of AMIs returned can be modified by specifying AMI IDs, AMI owners, or AWS accounts withlaunch permissions. If no options are specified, Amazon EC2 returns all AMIs for which you have launchpermissions.
If you specify one or more AMI IDs, only AMIs that have the specified IDs are returned. If you specify aninvalid AMI ID, a fault is returned. If you specify an AMI ID for which you do not have access, it will notbe included in the returned results.
If you specify one or more AMI owners, only AMIs from the specified owners and for which you haveaccess are returned. The results can include the account IDs of the specified owners, amazon for AMIsowned by Amazon, or self for AMIs that you own.
If you specify a list of executable users, only AMIs with launch permissions for those users are returned.You can specify account IDs (if you own the AMI(s)), self for AMIs for which you own or have explicitpermissions, or all for public AMIs.
Note
Deregistered images are included in the returned results for an unspecified interval afterderegistration.
You can filter the results to return information only about images that match criteria you specify. Forexample, you could get information only about images that use a certain kernel.You can specify multiplevalues for a filter (e.g., the image uses either kernel aki-1a2b3c4d or kernel aki-9b8c7d6f). An imagemust match at least one of the specified values for it to be included in the results.
You can specify multiple filters (e.g., the image uses a certain kernel, and uses an Amazon EBS volumeas the root device). The result includes information for a particular image only if it matches all your filters.If there's no match, no special message is returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactlyone character.You can escape special characters using a backslash before the character. For example,a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following table shows the available filters.
API Version 2010-08-3191
Amazon Elastic Compute Cloud API ReferenceDescribeImages
DescriptionFilter Name
Image architecture.
Type: String
Valid Values: i386 | x86_64
architecture
Whether the Amazon EBS volume is deleted oninstance termination.
Type: Boolean
block-device-mapping.delete-on-termination
Device name (e.g., /dev/sdh) for an Amazon EBSvolume mapped to the image.
Type: String
block-device-mapping.device-name
Snapshot ID for an Amazon EBS volume mappedto the image.
Type: String
block-device-mapping.snapshot-id
Volume size for an Amazon EBS volume mappedto the image.
Type: Integer
block-device-mapping.volume-size
Description of the AMI (provided during imagecreation).
Type: String
description
ID of the image.
Type: String
image-id
Type of image.
Type: String
Valid Values: machine | kernel | ramdisk
image-type
Whether the image is public.
Type: Boolean
is-public
Kernel ID.
Type: String
kernel-id
Location of the image manifest.
Type: String
manifest-location
Name of the AMI (provided during image creation).
Type: String
name
AWS account alias (e.g., amazon or self) or AWSaccount ID that owns the AMI.
Type: String
owner-alias
AWS account ID of the image owner.
Type: String
owner-id
API Version 2010-08-3192
Amazon Elastic Compute Cloud API ReferenceDescription
DescriptionFilter Name
Use windows if you have Windows based AMIs;otherwise leave blank.
Type: String
Valid Value: windows
platform
Product code associated with the AMI.
Type: String
product-code
RAM disk ID.
Type: String
ramdisk-id
Root device name of the AMI (e.g., /dev/sda1).
Type: String
root-device-name
Root device type the AMI uses.
Type: String
Valid Values: ebs | instance-store
root-device-type
State of the image.
Type: String
Valid Values: available | pending | failed
state
Reason code for the state change.
Type: String
state-reason-code
Message for the state change.
Type: String
state-reason-message
Key of a tag assigned to the resource. This filter isindependent of the tag-value filter. For example,if you use both the filter tag-key=Purpose andthe filter tag-value=X, you get any resourcesassigned both the tag key Purpose (regardless ofwhat the tag's value is), and the tag value X(regardless of what the tag's key is). If you want tolist only resources where Purpose=X, see thetag:key filter later in this table.
For more information about tags, go to Using Tagsin the Amazon Elastic Compute Cloud DeveloperGuide.
Type: String
tag-key
Value of a tag assigned to the resource. This filteris independent of the tag-key filter.
Type: String
tag-value
API Version 2010-08-3193
Amazon Elastic Compute Cloud API ReferenceDescription
DescriptionFilter Name
Filters the results based on a specific tag/valuecombination.
Example: To list just the resources assigned tagPurpose=X, then specify:
Filter.1.Name=tag:Purpose
Filter.1.Value.1=X
Example: To list just resources assigned tagPurpose=X OR Purpose=Y, then specify:
Filter.1.Name=tag:Purpose
Filter.1.Value.1=X
Filter.1.Value.2=Y
tag:key
Virtualization type of the image.
Type: String
Valid Values: paravirtual | hvm
virtualization-type
Request Parameters
RequiredDescriptionName
NoReturns AMIs for which the specified user ID has explicitlaunch permissions. The user ID can be an AWS accountID, self to return AMIs for which the sender of the requesthas explicit launch permissions, or all to return AMIs withpublic launch permissions.
Type: String
Default: None
ExecutableBy.n
NoAMI IDs to describe.
Type: String
Default: Returns all AMIs, or only those otherwisespecified.
ImageId.n
NoReturns AMIs owned by the specified owner. Multipleowner values can be specified.The IDs amazon and selfcan be used to include AMIs owned by Amazon or AMIsowned by you, respectively
Type: String
Default: None
Owner.n
NoName of a filter. See the preceding table for a list ofallowed filter names.
Type: String
Default: None
Filter.n.Name
NoA value for the filter. See the preceding table for a list ofallowed values for each filter.
Type: String
Default: None
Filter.n.Value.m
API Version 2010-08-3194
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
Response Elements
DescriptionName
DescribeImagesResponse element.
Type: DescribeImagesResponseType (p. 607)
Ancestor: None
Children: requestId, imagesSet
DescribeImagesResponse
The ID of the request.
Type: xsd:string
Ancestor: DescribeImagesResponseType
Children: None
requestId
Image set.
Type: DescribeImagesResponseInfoType (p. 605)
Ancestor: DescribeImagesResponseType
Children: item
imagesSet
Information for one image.
Type: DescribeImagesResponseItemType (p. 605)
Ancestor: imagesSet
Children:imageId, imageLocation, imageState, imageOwnerId,isPublic, productCodes, architecture, imageType,kernelId, ramdiskId, platform, stateReason,imageOwnerAlias, name, description, rootDeviceType,rootDeviceName, blockDeviceMapping, virtualizationType,tags
item
The ID of the AMI.
Type: xsd:string
Ancestor: item
Children: None
imageId
The location of the AMI.
Type: xsd:string
Ancestor: item
Children: None
imageLocation
Current state of the AMI. If the operation returns available, theimage is successfully registered and available for launching.
Type: xsd:string
available | pending | failed
Ancestor: item
Children: None
imageState
AWS account ID of the image owner.
Type: xsd:string
Ancestor: item
Children: None
imageOwnerId
API Version 2010-08-3195
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Returns true if this image has public launch permissions. Returnsfalse if it only has implicit and explicit launch permissions.
Type: xsd:boolean
Ancestor: item
Children: None
isPublic
Product codes of the AMI.
Type: ProductCodesSetType (p. 674)
Ancestor: item
Children: item
productCodes
Information for one product code.
Type: ProductCodesSetItemType (p. 674)
Ancestor: productCodes
Children: productCode
item
Product code.
Type: xsd:string
Ancestor: item
Children: None
productCode
The architecture of the image.
Type: xsd:string
Valid Values: i386 | x86_64
Ancestor: item
Children: None
architecture
The type of image (machine, kernel, or ramdisk).
Type: xsd:string
Ancestor: item
Children: None
imageType
The kernel associated with the image, if any. Only applicable formachine images.
Type: xsd:string
Ancestor: item
Children: None
kernelId
The RAM disk associated with the image, if any. Only applicable formachine images.
Type: xsd:string
Ancestor: item
Children: None
ramdiskId
Value is Windows for Windows AMIs; otherwise blank.
Type: xsd:string
Valid Value: Windows
Ancestor: item
Children: None
platform
API Version 2010-08-3196
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
The reason for the state change. See StateReasonType (p. 704) fora listing of supported state change codes.
Type: StateReasonType (p. 704)
Ancestor: item
Children: code, message
stateReason
Reason code for the state change.
Type: xsd:string
Ancestor: stateReason
Children: None
code
Message for the state change.
Type: xsd:string
Ancestor: stateReason
Children: None
message
The AWS account alias (e.g., "amazon", "redhat", "self", etc.) or AWSaccount ID that owns the AMI.
Type: xsd:string
Ancestor: item
Children: None
imageOwnerAlias
The name of the AMI that was provided during image creation.
Type: xsd:string
Ancestor: item
Children: None
name
The description of the AMI that was provided during image creation.
Type: xsd:string
Ancestor: item
Children: None
description
The root device type used by the AMI. The AMI can use an AmazonEBS or instance store root device.
Type: xsd:string
Valid Values: ebs | instance-store
Ancestor: item
Children: None
rootDeviceType
The root device name (e.g., /dev/sda1).
Type: xsd:string
Ancestor: item
Children: None
rootDeviceName
Specifies how block devices are exposed to the instance.
Type: BlockDeviceMappingType (p. 568)
Ancestor: item
Children: item
blockDeviceMapping
API Version 2010-08-3197
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Information for one block device mapping.
Type: BlockDeviceMappingItemType (p. 567)
Ancestor: blockDeviceMapping
Children: deviceName, virtualName, ebs, and noDevice
item
The device name (e.g., /dev/sdh).
Type: xsd:string
Ancestor: item
Children: None
deviceName
The virtual device name.
Type: xsd:string
Ancestor: item
Children: None
virtualName
Specifies parameters used to automatically setup Amazon EBSvolumes when the instance is launched.
Type: EbsBlockDeviceType (p. 643)
Ancestor: item
Children:snapshotId, volumeSize, and deleteOnTermination
ebs
The ID of the snapshot.
Type: xsd:string
Ancestor: ebs
Children: None
snapshotId
The size of the volume, in GiBs. Required if you are not creating avolume from a snapshot.
Type: xsd:int
Ancestor: ebs
Children: None
volumeSize
Specifies whether the Amazon EBS volume is deleted on instancetermination.
Type: xsd:boolean
Ancestor: ebs
Children: None
deleteOnTermination
Specifies the device name to suppress during instance launch.
Type: EmptyElementType (p. 644)
Ancestor: item
Children:
noDevice
Specifies the type of virtualization in which your instance is running.Valid values are (paravirtual or hvm)
Type: xsd:string
Ancestor: None
Children: None
virtualizationType
API Version 2010-08-3198
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Tags assigned to the resource.
Type: ResourceTagSetType
Ancestor: item
Children: item
tagSet
Information about one tag.
Type: ResourceTagSetItemType
Ancestor: tagSet
Children: key, value
item
Tag key.
Type: xsd:string
Ancestor: item
Children: None
key
Tag value.
Type: xsd:string
Ancestor: item
Children: None
value
Examples
Example RequestThis example describes the ami-be3adfd7 AMI.
https://ec2.amazonaws.com/?Action=DescribeImages&ImageId.1=ami-be3adfd7&AuthParams
Example Response<DescribeImagesResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <imagesSet> <item> <imageId>ami-be3adfd7</imageId> <imageLocation>amazon/getting-started</imageLocation> <imageState>available</imageState> <imageOwnerId>206029621532</imageOwnerId> <isPublic>true</isPublic> <architecture>i386</architecture> <imageType>machine</imageType> <kernelId>aki-d3376696</kernelId> <ramdiskId>ari-e73766a2</ramdiskId> <imageOwnerAlias>amazon</imageOwnerAlias> <name>getting-started</name> <description>Fedora 8 v1.11 i386 lvm-rootVG-rootFS ext3 ec2pnp enabled</de scription> <rootDeviceType>ebs</rootDeviceType> <rootDeviceName>/dev/sda</rootDeviceName> <blockDeviceMapping>
API Version 2010-08-3199
Amazon Elastic Compute Cloud API ReferenceExamples
<item> <deviceName>/dev/sda</deviceName> <ebs> <snapshotId>snap-32885f5a</snapshotId> <volumeSize>15</volumeSize> <deleteOnTermination>false</deleteOnTermination> </ebs> </item> </blockDeviceMapping> <virtualizationType>paravirtual</virtualizationType> <tagSet/> </item> </imagesSet></DescribeImagesResponse>
Example RequestThis example filters the results to display only the public Windows images with an x86_64 architecture.
https://ec2.amazonaws.com/?Action=DescribeImages&Filter.1.Name=is-public&Filter.1.Value.1=true&Filter.2.Name=architecture&Filter.2.Value.1=x86_64&Filter.3.Name=platform&Filter.3.Value.1=windows&AuthParams
Example Response<DescribeImagesResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <imagesSet> <item> <imageId>ami-dd20c3b4</imageId> <imageLocation>ec2-public-windows-images/Server2003r2-x86_64-Win-v1.07.manifest.xml</imageLocation> <imageState>available</imageState> <imageOwnerId>206029621532</imageOwnerId> <isPublic>true</isPublic> <architecture>x86_64</architecture> <imageType>machine</imageType> <platform>windows</platform> <imageOwnerAlias>amazon</imageOwnerAlias> <rootDeviceType>instance-store</rootDeviceType> <blockDeviceMapping/> <virtualizationType>hvm</virtualizationType> <tagSet/> </item> ... </imagesSet></DescribeImagesResponse>
Related Operations• DescribeInstances (p. 105)
• DescribeImageAttribute (p. 86)
API Version 2010-08-31100
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DescribeInstanceAttribute
DescriptionReturns information about an attribute of an instance.You can get information about only one attributeper call.
Request Parameters
RequiredDescriptionName
YesThe instance ID.
Type: String
Default: Describes all instances.
InstanceId
NoThe instance type of the instance.
Type: String
Default: None
Attribute=instanceType
NoReturns the ID of the kernel associated with the AMI.
Type: String
Default: None
Attribute=kernel
NoReturns the ID of the RAM disk associated with the AMI.
Type: String
Default: None
Attribute=ramdisk
NoReturns the MIME, Base64-encoded user data for theinstance.
Type: String
Default: None
Attribute=userData
NoReturns the value for the disableApiTerminationattribute, which specifies whether the instance can beterminated using the APIs. The default value for thisattribute is true.
Default: None
Attribute=disableApiTermination
NoReturns the value for theinstanceInitiatedShutdownBehavior attribute, whichcontrols whether the instance stops or terminates whenan instance shutdown is initiated The default value for theattribute is stop.
Type: String
Default: None
Attribute=instanceInitiatedShutdownBehavior
NoReturns the instance's root device name (e.g., /dev/sda1).
Type: String
Default: None
Attribute=rootDeviceName
API Version 2010-08-31101
Amazon Elastic Compute Cloud API ReferenceDescribeInstanceAttribute
RequiredDescriptionName
NoReturns the instance's block device mapping information.
Type: String
Default: None
Attribute=blockDeviceMapping
Response Elements
DescriptionName
DescribeInstanceAttributeResponseType element.
Type: DescribeInstanceAttributeResponseType (p. 608)
Ancestor: None
Children: requestId, instanceId, instanceType, kernel,ramdisk, userData, disableApiTermination,instanceInitiatedShutdownBehavior, rootDeviceName, andblockDeviceMapping
DescribeInstanceAttributeResponseType
The ID of the request.
Type: xsd:string
Ancestor: DescribeInstanceAttributeResponseType
Children: None
requestId
The ID of the instance.
Type: xsd:string
Ancestor: DescribeInstanceAttributeResponseType
Children: None
instanceId
The instance type (e.g., m1.small, c1.medium, m2.2xlarge, and soon).
Type: NullableAttributeValueType (p. 670)
Ancestor: DescribeInstanceAttributeResponseType
Children:
instanceType
The kernel ID.
Type: NullableAttributeValueType (p. 670)
Ancestor: DescribeInstanceAttributeResponseType
Children:
kernel
The RAM disk ID.
Type: NullableAttributeValueType (p. 670)
Ancestor: DescribeInstanceAttributeResponseType
Children:
ramdisk
MIME, Base64-encoded user data.
Type: NullableAttributeValueType (p. 670)
Ancestor: DescribeInstanceAttributeResponseType
Children:
userData
API Version 2010-08-31102
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Specifies whether the instance can be terminated.You must modifythis attribute before you can terminate any "locked" instances.
Type: NullableAttributeBooleanValueType (p. 670)
Ancestor: DescribeInstanceAttributeResponseType
Children:
disableApiTermination
If an instance shutdown is initiated, this determines whether theinstance stops or terminates.
Type: NullableAttributeValueType (p. 670)
Ancestor: DescribeInstanceAttributeResponseType
Children:
instanceInitiatedShutdownBehavior
The root device name (e.g., /dev/sda1).
Type: NullableAttributeValueType (p. 670)
Ancestor: DescribeInstanceAttributeResponseType
Children:
rootDeviceName
Specifies how block devices are exposed to the instance. Eachmapping is made up of a virtualName and a deviceName.
Type: InstanceBlockDeviceMappingResponseType (p. 650)
Ancestor: DescribeInstanceAttributeResponseType
Children: item
blockDeviceMapping
The item element.
Type: InstanceBlockDeviceMappingResponseItemType (p. 650)
Ancestor: blockDeviceMapping
Children: deviceName, ebs
item
Specifies how the device is exposed to the instance (e.g., /dev/sdh).
Type: xsd:string
Ancestor: item
Children: None
deviceName
Specifies parameters used to automatically set up Amazon EBSvolumes when the instance is launched.
Type: EbsInstanceBlockDeviceMappingResponseType (p. 644)
Ancestor: item
Children: volumeId, status, attachTime, anddeleteOnTermination
ebs
The ID of the Amazon EBS volume.
Type: xsd:string
Ancestor: ebs
Children: None
volumeId
API Version 2010-08-31103
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Attachment state.
Type: xsd:string
Valid Values: attaching | attached | detaching | detached
Ancestor: ebs
Children: None
status
Time stamp when the attachment initiated.
Type: xsd:dateTime
Ancestor: ebs
Children: None
attachTime
Specifies whether the Amazon EBS volume is deleted on instancetermination.
Type: xsd:boolean
Ancestor: ebs
Children: None
deleteOnTermination
Examples
Example RequestThis example lists the kernel ID of the i-10a64379 instance.
https://ec2.amazonaws.com/?Action=DescribeInstanceAttribute&InstanceId=i-10a64379&Attribute=kernel&AuthParams
Example Response<DescribeInstanceAttributeResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <instanceId>i-10a64379</instanceId> <kernel> <value>aki-f70657b2</value> </kernel></DescribeInstanceAttributeResponse>
Related Operations• DescribeInstances (p. 105)
• ModifyInstanceAttribute (p. 198)
• ResetInstanceAttribute (p. 224)
API Version 2010-08-31104
Amazon Elastic Compute Cloud API ReferenceExamples
DescribeInstances
DescriptionReturns information about instances that you own.
If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you donot specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify aninvalid instance ID, a fault is returned. If you specify an instance that you do not own, it will not be includedin the returned results.
Recently terminated instances might appear in the returned results.This interval is usually less than onehour.
You can filter the results to return information only about instances that match criteria you specify. Forexample, you could get information about only instances launched with a certain key pair.You can specifymultiple values for a filter (e.g., the instance was launched with either key pair A or key pair B). An instancemust match at least one of the specified values for it to be included in the results.
You can specify multiple filters (e.g., the instance was launched with a certain key pair and uses anAmazon EBS volume as the root device). An instance must match all the filters for it to be included in theresults. If there's no match, no special message is returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactlyone character.You can escape special characters using a backslash before the character. For example,a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following table shows the available filters.
DescriptionFilter Name
Instance architecture.
Type: String
Valid Values: i386 | x86_64
architecture
Instance's Availability Zone.
Type: String
availability-zone
Attach time for an Amazon EBS volume mappedto the instance, e.g., 2010-09-15T17:15:20.000Z
Type: xsd:dateTime
block-device-mapping.attach-time
Whether the Amazon EBS volume is deleted oninstance termination.
Type: Boolean
block-device-mapping.delete-on-termination
Device name (e.g., /dev/sdh) for an Amazon EBSvolume mapped to the instance.
Type: String
block-device-mapping.device-name
Status for an Amazon EBS volume mapped to theinstance.
Type: String
Valid Values:attaching | attached | detaching| detached
block-device-mapping.status
API Version 2010-08-31105
Amazon Elastic Compute Cloud API ReferenceDescribeInstances
DescriptionFilter Name
ID for an Amazon EBS volume mapped to theinstance.
Type: String
block-device-mapping.volume-id
Idempotency token you provided when youlaunched the instance.
Type: String
client-token
Public DNS name of the instance.
Type: String
dns-name
A security group the instance is in.
Type: String
group-id
ID of the image used to launch the instance.
Type: String
image-id
ID of the instance.
Type: String
instance-id
Whether this is a Spot Instance.
Type: String
Valid Values: spot
instance-lifecycle
Code identifying the instance's state. A 16-bitunsigned integer. The high byte is an opaqueinternal value and should be ignored.The low byteis set based on the state represented
Type: String
Valid Values: 0 (pending) | 16 (running) | 32(shutting-down) | 48 (terminated) | 64 (stopping) |80 (stopped)
instance-state-code
Instance's state.
Type: String
Valid Values: pending | running |shutting-down | terminated | stopping |stopped
instance-state-name
Type of instance (e.g., m1.small).
Type: String
instance-type
Public IP address of the instance.
Type: String
ip-address
Kernel ID.
Type: String
kernel-id
Name of the key pair used when the instance waslaunched.
Type: String
key-name
API Version 2010-08-31106
Amazon Elastic Compute Cloud API ReferenceDescription
DescriptionFilter Name
When launching multiple instances at once, this isthe index for the instance in the launch group (e.g.,0, 1, 2, etc.).
Type: String
launch-index
Time instance was launched, e.g.,2010-08-07T11:54:42.000Z.
Type: xsd:dateTime
launch-time
Whether monitoring is enabled for the instance.
Type: String
Valid Values: disabled | enabled
monitoring-state
AWS account ID of the instance owner.
Type: String
owner-id
Name of the placement group the instance is in.
Type: String
placement-group-name
Use windows if you have Windows basedinstances; otherwise, leave blank.
Type: String
Valid Value: windows
platform
Private DNS name of the instance.
Type: String
private-dns-name
Private IP address of the instance.
Type: String
private-ip-address
Product code associated with the AMI used tolaunch the instance.
Type: String
product-code
RAM disk ID.
Type: String
ramdisk-id
Reason for the instance's current state (e.g., shows"User Initiated [date]" when you stop or terminatethe instance). Similar to the state-reason-code filter.
Type: String
reason
ID of the entity that launched the instance on yourbehalf (e.g., AWS Management Console, AutoScaling, etc.)
Type: String
requester-id
ID of the instance's reservation.
Type: String
reservation-id
Root device name of the instance (e.g., /dev/sda1).
Type: String
root-device-name
API Version 2010-08-31107
Amazon Elastic Compute Cloud API ReferenceDescription
DescriptionFilter Name
Root device type the instance uses.
Type: String
Valid Values: ebs | instance-store
root-device-type
ID of the Spot Instance request.
Type: String
spot-instance-request-id
Reason code for the state change.
Type: String
state-reason-code
Message for the state change.
Type: String
state-reason-message
ID of the subnet the instance is in (if using AmazonVirtual Private Cloud).
Type: String
subnet-id
Key of a tag assigned to the resource. This filter isindependent of the tag-value filter. For example,if you use both the filter tag-key=Purpose andthe filter tag-value=X, you get any resourcesassigned both the tag key Purpose (regardless ofwhat the tag's value is), and the tag value X(regardless of what the tag's key is). If you want tolist only resources where Purpose=X, see thetag:key filter later in this table.
For more information about tags, go to Using Tagsin the Amazon Elastic Compute Cloud DeveloperGuide.
Type: String
tag-key
Value of a tag assigned to the resource. This filteris independent of the tag-key filter.
Type: String
tag-value
Filters the results based on a specific tag/valuecombination.
Example: To list just the resources assigned tagPurpose=X, then specify:
Filter.1.Name=tag:Purpose
Filter.1.Value.1=X
Example: To list just resources assigned tagPurpose=X OR Purpose=Y, then specify:
Filter.1.Name=tag:Purpose
Filter.1.Value.1=X
Filter.1.Value.2=Y
tag:key
Virtualization type of the instance.
Type: String
Valid Values: paravirtual | hvm
virtualization-type
API Version 2010-08-31108
Amazon Elastic Compute Cloud API ReferenceDescription
DescriptionFilter Name
ID of the VPC the instance is in (if using AmazonVirtual Private Cloud).
Type: String
vpc-id
Request Parameters
RequiredDescriptionName
NoInstance IDs to describe.
Type: String
Default: Returns all instances.
InstanceId.n
NoName of a filter. See the preceding table for a list ofallowed filter names.
Type: String
Default: None
Filter.n.Name
NoA value for the filter. See the preceding table for a list ofallowed values for each filter.
Type: String
Default: None
Filter.n.Value.m
Response Elements
DescriptionName
DescribeInstancesResponse element.
Type: DescribeInstancesResponseType (p. 612)
Ancestor: None
Children: requestId, reservationSet
DescribeInstancesResponse
The ID of the request.
Type: xsd:string
Ancestor: DescribeInstancesResponseType
Children: None
requestId
Reservation set.
Type: ReservationSetType (p. 685)
Ancestor: DescribeInstancesResponseType
Children: item
reservationSet
Information for a reservation.
Type: ReservationInfoType (p. 685)
Ancestor: reservationSet
Children: reservationId, ownerId, groupSet, instancesSet,and requesterId
item
API Version 2010-08-31109
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
DescriptionName
Unique ID of the reservation.
Type: xsd:string
Ancestor: item
Children: None
reservationId
AWS account ID of the user who owns the reservation.
Type: xsd:string
Ancestor: item
Children: None
ownerId
Group set.
Type: GroupSetType (p. 648)
Ancestor: item
Children: item
groupSet
Group set item.
Type: GroupItemType (p. 648)
Ancestor: groupSet
Children: groupId
item
Name of the security group.
Type: xsd:string
Ancestor: item
Children: None
groupId
Instance set.
Type: RunningInstancesSetType (p. 696)
Ancestor: item
Children: item
instancesSet
Running instance set item.
Type: RunningInstancesItemType (p. 694)
Ancestor: instancesSet
Children: instanceId, imageId, instanceState,privateDnsName, dnsName, reason, keyName, amiLaunchIndex,productCodes, instanceType, launchTime, placement,kernelId, ramdiskId, platform, monitoring, subnetId,vpcId, privateIpAddress, ipAddress, stateReason,architecture, rootDeviceType, rootDeviceName,blockDeviceMapping, instanceLifecycle,spotInstanceRequestId, virtualizationType, clientToken,tagSet
item
Unique ID of the instance launched.
Type: xsd:string
Ancestor: item
Children: None
instanceId
API Version 2010-08-31110
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Image ID of the AMI used to launch the instance.
Type: xsd:string
Ancestor: item
Children: None
imageId
The current state of the instance.
Type: InstanceStateType (p. 655)
Ancestor: item
Children: code, name
instanceState
A 16-bit unsigned integer. The high byte is an opaque internal valueand should be ignored. The low byte is set based on the staterepresented:
Type: xsd:int
Valid Values: 0 (pending) | 16 (running) | 32(shutting-down) | 48 (terminated) | 64 (stopping) | 80(stopped)
Ancestor: instanceState
Children: None
code
The current state of the instance.
Type: xsd:string
Valid Values: pending | running | shutting-down | terminated| stopping | stopped
Ancestor: instanceState
Children: None
name
The private DNS name assigned to the instance. This DNS namecan only be used inside the Amazon EC2 network. This elementremains empty until the instance enters a running state.
Type: xsd:string
Ancestor: item
Children: None
privateDnsName
The public DNS name assigned to the instance. This DNS name iscontactable from outside the Amazon EC2 network. This elementremains empty until the instance enters a running state.
Type: xsd:string
Ancestor: item
Children: None
dnsName
Reason for the most recent state transition. This might be an emptystring.
Type: xsd:string
Ancestor: item
Children: None
reason
API Version 2010-08-31111
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
If this instance was launched with an associated key pair, this displaysthe key pair name.
Type: xsd:string
Ancestor: item
Children: None
keyName
The AMI launch index, which can be used to find this instance withinthe launch group.
Type: xsd:string
Ancestor: item
Children: None
amiLaunchIndex
Amazon DevPay product codes attached to this instance.
Type: ProductCodesSetType (p. 674)
Ancestor: item
Children: item
productCodes
Information for one product code.
Type: ProductCodesSetItemType (p. 674)
Ancestor: productCodes
Children: productCode
item
The Amazon DevPay product code associated with the instance.
Type: xsd:string
Ancestor: item
Children: None
productCode
The instance type.
Type: xsd:string
Ancestor: item
Children: None
instanceType
The time the instance launched.
Type: xsd:dateTime
Ancestor: item
Children: None
launchTime
The location where the instance launched.
Type: PlacementResponseType (p. 672)
Ancestor: item
Children: availabilityZone
placement
Returns the Availability Zone of the instance.
Type: xsd:string
Ancestor: placement
Children: None
availabilityZone
API Version 2010-08-31112
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
The ID of the placement group the instance is in (for cluster computeinstances).
Type: xsd:string
Default: None
Ancestor: placement
Children: None
groupName
The name of the placement group the instance is in (for clustercompute instances).
Type: xsd:string
Default: None
Ancestor: placement
Children: None
groupName
Kernel associated with this instance.
Type: xsd:string
Ancestor: item
Children: None
kernelId
RAM disk associated with this instance.
Type: xsd:string
Ancestor: item
Children: None
ramdiskId
Platform of the instance (e.g. Windows).
Type: xsd:string
Ancestor: item
Children: None
platform
Indicates whether monitoring is enabled for the instance.
Type: InstanceMonitoringStateType (p. 653)
Ancestor: item
Children: state
monitoring
State of monitoring for the instance.
Type: xsd:string
Valid Values: monitoring-enabled (enabled) |monitoring-pending (pending) | monitoring-disabling(disabling) | monitoring-disabled (disabled)
Ancestor: monitoring
Children: None
state
Specifies the Amazon VPC subnet ID in which the instance is running.
Type: xsd:string
Ancestor: item
Children: None
subnetId
API Version 2010-08-31113
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Specifies the Amazon VPC in which the instance is running.
Type: xsd:string
Ancestor: item
Children: None
vpcId
Specifies the private IP address that is assigned to the instance.
Type: xsd:string
Ancestor: item
Children: None
privateIpAddress
Specifies the IP address of the instance.
Type: xsd:string
Ancestor: item
Children: None
ipAddress
The reason for the most recent state transition. SeeStateReasonType (p. 704) for a listing of supported state changecodes.
Type: StateReasonType (p. 704)
Ancestor: item
Children: code, message
stateReason
Reason code for the state change.
Type: xsd:string
Ancestor: stateReason
Children: None
code
Message for the state change.
Type: xsd:string
Ancestor: stateReason
Children: None
message
The architecture of the image.
Type: xsd:string
Valid Values: i386 | x86_64
Ancestor: item
Children: None
architecture
The root device type used by the AMI. The AMI can use an AmazonEBS or instance store root device.
Type: xsd:string
Valid Values: ebs | instance-store
Ancestor: item
Children: None
rootDeviceType
The root device name (e.g., /dev/sda1).
Type: xsd:string
Ancestor: item
Children: None
rootDeviceName
API Version 2010-08-31114
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Block device mapping set.
Type: InstanceBlockDeviceMappingResponseType (p. 650)
Ancestor: item
Children: item
blockDeviceMapping
The item element.
Type: InstanceBlockDeviceMappingResponseItemType (p. 650)
Ancestor: blockDeviceMapping
Children: deviceName, ebs
item
Specifies how the device is exposed to the instance (e.g., /dev/sdh).
Type: xsd:string
Ancestor: item
Children: None
deviceName
Specifies parameters used to automatically setup Amazon EBSvolumes when the instance is launched.
Type: EbsInstanceBlockDeviceMappingResponseType (p. 644)
Ancestor: item
Children: volumeId, status, attachTime, anddeleteOnTermination
ebs
The ID of the Amazon EBS volume.
Type: xsd:string
Ancestor: ebs
Children: None
volumeId
Attachment state.
Type: xsd:string
Valid Values: attaching | attached | detaching | detached
Ancestor: ebs
Children: None
status
Time stamp when the attachment initiated.
Type: xsd:dateTime
Ancestor: ebs
Children: None
attachTime
Specifies whether the Amazon EBS volume is deleted on instancetermination.
Type: xsd:boolean
Ancestor: ebs
Children: None
deleteOnTermination
Indicates the life cycle of the instance.
Type: xsd:string
Valid Values: spot | blank (no value)
Ancestor: item
Children: None
instanceLifecycle
API Version 2010-08-31115
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
The ID of the Spot Instance request.
Type: xsd:string
Ancestor: item
Children: None
spotInstanceRequestId
Specifies the instance's virtualization type.
Type: xsd:string
Valid Values: paravirtual | hvm
Ancestor: item
Children: None
virtualizationType
Idempotency token you provided when you launched the instance.
Type: xsd:string
Ancestor: item
Children: None
clientToken
Tags assigned to the resource.
Type: ResourceTagSetType
Ancestor: item
Children: item
tagSet
Information about one tag.
Type: ResourceTagSetItemType
Ancestor: tagSet
Children: key, value
item
Tag key.
Type: xsd:string
Ancestor: item
Children: None
key
Tag value.
Type: xsd:string
Ancestor: item
Children: None
value
ID of the requester.
Type: xsd:string
Ancestor: item
Children: None
requesterId
Examples
Example RequestThis example describes the current state of the instances owned by your AWS account.
API Version 2010-08-31116
Amazon Elastic Compute Cloud API ReferenceExamples
https://ec2.amazonaws.com/?Action=DescribeInstances&AuthParams
Example Response<DescribeInstancesResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <requestId>98e3c9a4-848c-4d6d-8e8a-b1bd857abf00</requestId> <reservationSet> <item> <reservationId>r-b27e30d9</reservationId> <ownerId>999988887777</ownerId> <groupSet> <item> <groupId>default</groupId> </item> </groupSet> <instancesSet> <item> <instanceId>i-c5cd56af</instanceId> <imageId>ami-1a2b3c4d</imageId> <instanceState> <code>16</code> <name>running</name> </instanceState> <privateDnsName>domU-12-31-39-10-56-34.compute-1.internal</privateDns Name> <dnsName>ec2-174-129-165-232.compute-1.amazonaws.com</dnsName> <reason/> <keyName>GSG_Keypair</keyName> <amiLaunchIndex>0</amiLaunchIndex> <productCodes/> <instanceType>m1.small</instanceType> <launchTime>2010-08-17T01:15:18.000Z</launchTime> <placement> <availabilityZone>us-east-1b</availabilityZone> <groupName/> </placement> <kernelId>aki-94c527fd</kernelId> <ramdiskId>ari-96c527ff</ramdiskId> <monitoring> <state>disabled</state> </monitoring> <privateIpAddress>10.198.85.190</privateIpAddress> <ipAddress>174.129.165.232</ipAddress> <architecture>i386</architecture> <rootDeviceType>ebs</rootDeviceType> <rootDeviceName>/dev/sda1</rootDeviceName> <blockDeviceMapping> <item> <deviceName>/dev/sda1</deviceName> <ebs> <volumeId>vol-a082c1c9</volumeId> <status>attached</status> <attachTime>2010-08-17T01:15:21.000Z</attachTime> <deleteOnTermination>false</deleteOnTermination> </ebs> </item> </blockDeviceMapping>
API Version 2010-08-31117
Amazon Elastic Compute Cloud API ReferenceExamples
<instanceLifecycle>spot</instanceLifecycle> <spotInstanceRequestId>sir-7a688402</spotInstanceRequestId> <virtualizationType>paravirtual</virtualizationType> <clientToken/> <tagSet/> </item> </instancesSet> <requesterId>854251627541</requesterId> </item> <item> <reservationId>r-b67e30dd</reservationId> <ownerId>999988887777</ownerId> <groupSet> <item> <groupId>default</groupId> </item> </groupSet> <instancesSet> <item> <instanceId>i-d9cd56b3</instanceId> <imageId>ami-1a2b3c4d</imageId> <instanceState> <code>16</code> <name>running</name> </instanceState> <privateDnsName>domU-12-31-39-10-54-E5.compute-1.internal</privateDns Name> <dnsName>ec2-184-73-58-78.compute-1.amazonaws.com</dnsName> <reason/> <keyName>GSG_Keypair</keyName> <amiLaunchIndex>0</amiLaunchIndex> <productCodes/> <instanceType>m1.large</instanceType> <launchTime>2010-08-17T01:15:19.000Z</launchTime> <placement> <availabilityZone>us-east-1b</availabilityZone> <groupName/> </placement> <kernelId>aki-94c527fd</kernelId> <ramdiskId>ari-96c527ff</ramdiskId> <monitoring> <state>disabled</state> </monitoring> <privateIpAddress>10.198.87.19</privateIpAddress> <ipAddress>184.73.58.78</ipAddress> <architecture>i386</architecture> <rootDeviceType>ebs</rootDeviceType> <rootDeviceName>/dev/sda1</rootDeviceName> <blockDeviceMapping> <item> <deviceName>/dev/sda1</deviceName> <ebs> <volumeId>vol-a282c1cb</volumeId> <status>attached</status> <attachTime>2010-08-17T01:15:23.000Z</attachTime> <deleteOnTermination>false</deleteOnTermination> </ebs> </item> </blockDeviceMapping>
API Version 2010-08-31118
Amazon Elastic Compute Cloud API ReferenceExamples
<instanceLifecycle>spot</instanceLifecycle> <spotInstanceRequestId>sir-55a3aa02</spotInstanceRequestId> <virtualizationType>paravirtual</virtualizationType> <clientToken/> <tagSet/> </item> </instancesSet> <requesterId>854251627541</requesterId> </item> </reservationSet></DescribeInstancesResponse>
Example RequestThis example filters the results to display only the m1.small or m1.large instances that have an AmazonEBS volume that is both attached and set to delete on termination.
https://ec2.amazonaws.com/?Action=DescribeInstances&Filter.1.Name=instance-type&Filter.1.Value.1=m1.small&Filter.1.Value.2=m1.large&Filter.2.Name=block-device-mapping.status&Filter.2.Value.1=attached&Filter.3.Name=block-device-mapping.delete-on-termination&Filter.3.Value.1=true&AuthParams
Example Response<DescribeInstancesResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <reservationSet> <item> <reservationId>r-bc7e30d7</reservationId> <ownerId>999988887777</ownerId> <groupSet> <item> <groupId>default</groupId> </item> </groupSet> <instancesSet> <item> <instanceId>i-c7cd56ad</instanceId> <imageId>ami-b232d0db</imageId> <instanceState> <code>16</code> <name>running</name> </instanceState> <privateDnsName>domU-12-31-39-01-76-06.compute-1.internal</privateDns Name> <dnsName>ec2-72-44-52-124.compute-1.amazonaws.com</dnsName> <keyName>GSG_Keypair</keyName> <amiLaunchIndex>0</amiLaunchIndex> <productCodes/> <instanceType>m1.small</instanceType> <launchTime>2010-08-17T01:15:16.000Z</launchTime> <placement> <availabilityZone>us-east-1b</availabilityZone> </placement>
API Version 2010-08-31119
Amazon Elastic Compute Cloud API ReferenceExamples
<kernelId>aki-94c527fd</kernelId> <ramdiskId>ari-96c527ff</ramdiskId> <monitoring> <state>disabled</state> </monitoring> <privateIpAddress>10.255.121.240</privateIpAddress> <ipAddress>72.44.52.124</ipAddress> <architecture>i386</architecture> <rootDeviceType>ebs</rootDeviceType> <rootDeviceName>/dev/sda1</rootDeviceName> <blockDeviceMapping> <item> <deviceName>/dev/sda1</deviceName> <ebs> <volumeId>vol-a482c1cd</volumeId> <status>attached</status> <attachTime>2010-08-17T01:15:26.000Z</attachTime> <deleteOnTermination>true</deleteOnTermination> </ebs> </item> </blockDeviceMapping/> <virtualizationType>paravirtual</virtualizationType> <clientToken/> <tagSet/> </item> </instancesSet> </item> </reservationSet></DescribeInstancesResponse>
Related Operations• RunInstances (p. 231)
• StopInstances (p. 247)
• StartInstances (p. 244)
• TerminateInstances (p. 251)
API Version 2010-08-31120
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DescribeKeyPairs
DescriptionReturns information about key pairs available to you. If you specify key pairs, information about thosekey pairs is returned. Otherwise, information for all registered key pairs is returned.
You can filter the results to return information only about key pairs that match criteria you specify. Forexample, you could filter the results to return only the key pairs whose names include the string Dave.You can specify multiple values for a filter. A key pair must match at least one of the specified values forit to be included in the results.
You can specify multiple filters (e.g., the key pair name includes the string Dave, and the fingerprint equalsa certain value). The result includes information for a particular key pair only if it matches all your filters.If there's no match, no special message is returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactlyone character.You can escape special characters using a backslash before the character. For example,a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following table shows the available filters.
DescriptionFilter Name
Fingerprint of the key pair.
Type: String
fingerprint
Name of the key pair.
Type: String
key-name
Request Parameters
RequiredDescriptionName
NoName of the key pair to describe.
Type: String
Default: Describes all key pairs you own, or only thoseotherwise specified.
KeyName.n
NoName of a filter. See the preceding table for a list ofallowed filter names.
Type: String
Default: None
Filter.n.Name
NoA value for the filter. See the preceding table for a list ofallowed values for each filter.
Type: String
Default: None
Filter.n.Value.m
API Version 2010-08-31121
Amazon Elastic Compute Cloud API ReferenceDescribeKeyPairs
Response Elements
DescriptionName
DescribeKeyPairsResponse element.
Type: DescribeKeyPairsResponseType (p. 615)
Ancestor: None
Children: requestId, keySet
DescribeKeyPairsResponse
The ID of the request.
Type: xsd:string
Ancestor: DescribeKeyPairsResponseType
Children: None
requestId
Information for a key pair.
Type: DescribeKeyPairsResponseInfoType (p. 614)
Ancestor: DescribeKeyPairsResponseType
Children: item
keySet
Information for a key pair.
Type: DescribeKeyPairsResponseItemType (p. 614)
Ancestor: keySet
Children: keyName, keyFingerprint
item
Name of the key pair.
Type: xsd:string
Ancestor: item
Children: None
keyName
A SHA-1 digest of the DER encoded private key.
Type: xsd:string
Ancestor: item
Children: None
keyFingerprint
Examples
Example RequestThis example describes the keypair with name gsg-keypair.
https://ec2.amazonaws.com/?Action=DescribeKeyPairs&KeyName.1=gsg-keypair&AuthParams
Example Response<DescribeKeyPairsResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <keySet> <item> <keyName>gsg-keypair</keyName> <keyFinger
API Version 2010-08-31122
Amazon Elastic Compute Cloud API ReferenceResponse Elements
print>1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f</keyFinger print> </item> </keySet></DescribeKeyPairsResponse>
Example RequestThis example filters the results to display only key pairs whose names include the string Dave.
https://ec2.amazonaws.com/?Action=DescribeKeyPairs&Filter.1.Name=key-name&Filter.1.Value.1=*Dave*&AuthParams
Related Operations• DescribeAvailabilityZones (p. 77)
• RunInstances (p. 231)
API Version 2010-08-31123
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DescribeLicensesThis action is for the Microsoft Windows Server License Mobility Pilot for Amazon EC2, which is a pilotprogram offered by Microsoft that allows customers with Microsoft Enterprise Agreements (EA) to migratetheir existing Windows Server licenses to Amazon EC2. If you're interested in the program, go tohttp://aws.amazon.com/ec2/windows-license-mobility-pilot.
API Version 2010-08-31124
Amazon Elastic Compute Cloud API ReferenceDescribeLicenses
DescribePlacementGroups
DescriptionReturns information about one or more placement groups in your account. For more information aboutplacement groups and cluster compute instances, go to Cluster Compute Instance Concepts in theAmazon Elastic Compute Cloud Developer Guide.
You can filter the results to return information only about placement groups that match criteria you specify.For example, you could filter the results to return only the groups whose state is deleted.You can specifymultiple values for a filter. A placement group must match at least one of the specified values for it to beincluded in the results.
You can specify multiple filters (e.g., the group's state is deleted and the name includes the stringProject). The result includes information for a particular group only if it matches all your filters. If there'sno match, no special message is returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactlyone character.You can escape special characters using a backslash before the character. For example,a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following table shows the available filters.
DescriptionFilter Name
Name of the placement group.
Type: String
group-name
Placement group's state.
Type: String
Valid Values: pending | available | deleting | deleted
state
Placement group's strategy.
Type: String
Valid Value: cluster
strategy
Request Parameters
RequiredDescriptionName
NoThe name of the placement group.
Type: string
Default: Describes all your placement groups, or only thoseotherwise specified.
GroupName.n
NoName of a filter. See the preceding table for a list ofallowed filter names.
Type: String
Default: None
Filter.n.Name
API Version 2010-08-31125
Amazon Elastic Compute Cloud API ReferenceDescribePlacementGroups
RequiredDescriptionName
NoA value for the filter. See the preceding table for a list ofallowed values for each filter.
Type: String
Default: None
Filter.n.Value.m
Response Elements
DescriptionName
DescribePlacementGroupsResponseType element.
Type:
Ancestor: None
Children: requestId, placementGroupSet
DescribePlacementGroupsResponse
The ID of the request.
Type: xsd:string
Ancestor: DescribePlacementGroupsResponse
Children: None
requestId
Placement group set element.
Type: PlacementGroupsSetType
Ancestor: DescribePlacementGroupsResponse
Children: item
placementGroupSet
Information about one placement group.
Type: PlacementGroupType
Ancestor: placementGroupSet
Children: groupName, strategy, state
item
Name of the placement group.
Type: xsd:string
Ancestor: item
Children: None
groupName
The placement strategy.
Type: xsd:string
Valid Values: cluster
Ancestor: item
Children: None
strategy
Status of the placement group.
Type: xsd:string
Valid Values: pending | available | deleting | deleted
Ancestor: item
Children: None
state
API Version 2010-08-31126
Amazon Elastic Compute Cloud API ReferenceResponse Elements
Examples
Example RequestThis example describes the placement group named XYZ-cluster.
https://ec2.amazonaws.com/?Action=DescribePlacementGroups&GroupName.1=XYZ-cluster&AuthParams
Example Response<DescribePlacementGroupsResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <requestID>d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE</requestID> <placementGroupSet> <item> <groupName>XYZ-cluster</groupName> <strategy>cluster</strategy> <state>available</state> </item> </placementGroupSet></DescribePlacementGroupsResponse>
Example RequestThis example filters the results to display only placement groups that include the string Project in thename.
https://ec2.amazonaws.com/?Action=DescribePlacementGroups&Filter.1.Name=group-name&Filter.1.Value=*Project*&AuthParams
Related Operations• CreatePlacementGroup (p. 42)
• DeletePlacementGroup (p. 60)
API Version 2010-08-31127
Amazon Elastic Compute Cloud API ReferenceExamples
DescribeRegions
DescriptionDescribes Regions that are currently available to the account.
You can use filters with this call just as you can with other "describe" calls.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactlyone character.You can escape special characters using a backslash before the character. For example,a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following table shows the available filters.
DescriptionFilter Name
Region's endpoint (e.g., ec2.us-east-1.amazonaws.com).
Type: String
endpoint
Name of the Region.
Type: String
region-name
Request Parameters
RequiredDescriptionName
NoName of a Region.
Type: String
Default: Describes all Regions available to the account.
RegionName.n
NoName of a filter. See the preceding table for a list ofallowed filter names.
Type: String
Default: None
Filter.n.Name
NoA value for the filter. See the preceding table for a list ofallowed values for each filter.
Type: String
Default: None
Filter.n.Value.m
Response Elements
DescriptionName
DescribeRegionsResponseType element.
Type: DescribeRegionsResponseType (p. 616)
Ancestor: None
Children: requestId, regionInfo
DescribeRegionsResponseType
API Version 2010-08-31128
Amazon Elastic Compute Cloud API ReferenceDescribeRegions
DescriptionName
The ID of the request.
Type: xsd:string
Ancestor: DescribeRegionsResponseType
Children: None
requestId
Region set.
Type: RegionSetType (p. 680)
Ancestor: DescribeRegionsResponseType
Children: item
regionInfo
Information for a Region.
Type: RegionItemType (p. 679)
Ancestor: regionInfo
Children: regionName, regionEndpoint
item
Name of the Region.
Type: xsd:string
Ancestor: item
Children: None
regionName
Region service endpoint.
Type: xsd:string
Ancestor: item
Children: None
regionEndpoint
Examples
Example RequestThis example displays information about all Regions.
https://ec2.amazonaws.com/?Action=DescribeRegions&AuthParams
Example RequestThis example displays information about just the specified Regions.
https://ec2.amazonaws.com/?Action=DescribeRegions&RegionName.1=us-east-1&RegionName.2=eu-west-1&AuthParams
Example Response<DescribeRegionsResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <regionInfo> <item> <regionName>us-east-1</regionName> <regionEndpoint>ec2.us-east-1.amazonaws.com</regionEndpoint>
API Version 2010-08-31129
Amazon Elastic Compute Cloud API ReferenceExamples
</item> <item> <regionName>eu-west-1</regionName> <regionEndpoint>ec2.eu-west-1.amazonaws.com</regionEndpoint> </item> </regionInfo></DescribeRegionsResponse>
Example RequestThis example displays information about all Regions that have the string ap in the endpoint.
https://ec2.amazonaws.com/?Action=DescribeRegions&Filter.1.Name=endpoint&Filter.1.Value.1=*ap*&AuthParams
Example Response<DescribeRegionsResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <regionInfo> <item> <regionName>ap-southeast-1</regionName> <regionEndpoint>ec2.ap-southeast-1.amazonaws.com</regionEndpoint> </item> </regionInfo></DescribeRegionsResponse>
Related Operations• DescribeAvailabilityZones (p. 77)
• RunInstances (p. 231)
API Version 2010-08-31130
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DescribeReservedInstances
DescriptionDescribes Reserved Instances that you purchased. For more information about Reserved Instances, goto the Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide.
You can filter the results to return information only about Reserved Instances that match criteria youspecify. For example, you could get information about only Reserved Instances in a particular AvailabilityZone.You can specify multiple values for a filter. A Reserved Instance must match at least one of thespecified values for it to be included in the results.
You can specify multiple filters (e.g., the instance is in a particular Availability Zone and is tagged with aparticular value). The result includes information for a particular instance only if it matches all your filters.If there's no match, no special message is returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactlyone character.You can escape special characters using a backslash before the character. For example,a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following table shows the available filters.
DescriptionFilter Name
Availability Zone where the Reserved Instance can be used.
Type: String
availability-zone
Duration of the Reserved Instance (e.g., one year or three years), inseconds.
Type: xs:long
Valid Values: 31536000 | 94608000
duration
Purchase price of the Reserved Instance (e.g., 9800.0)
Type: xs:double
fixed-price
Instance type on which the Reserved Instance can be used.
Type: String
instance-type
Reserved Instance description.
Type: String
Valid Values: Linux/UNIX | Linux/UNIX (Amazon VPC) |Windows | Windows (Amazon VPC)
product-description
Reserved Instance's ID.
Type: String
reserved-instances-id
Time the Reserved Instance purchase request was placed, e.g.,2010-08-07T11:54:42.000Z.
Type: xsd:dateTime
start
State of the Reserved Instance.
Type: String
Valid Values: pending-payment | active | payment-failed |retired
state
API Version 2010-08-31131
Amazon Elastic Compute Cloud API ReferenceDescribeReservedInstances
DescriptionFilter Name
Key of a tag assigned to the resource. This filter is independent ofthe tag-value filter. For example, if you use both the filtertag-key=Purpose and the filter tag-value=X, you get anyresources assigned both the tag key Purpose (regardless of whatthe tag's value is), and the tag value X (regardless of what the tag'skey is). If you want to list only resources where Purpose=X, see thetag:key filter later in this table.
For more information about tags, go to Using Tags in the AmazonElastic Compute Cloud Developer Guide.
Type: String
tag-key
Value of a tag assigned to the resource. This filter is independent ofthe tag-key filter.
Type: String
tag-value
Filters the results based on a specific tag/value combination.
Example: To list just the resources assigned tag Purpose=X, thenspecify:
Filter.1.Name=tag:Purpose
Filter.1.Value.1=X
Example: To list just resources assigned tag Purpose=X ORPurpose=Y, then specify:
Filter.1.Name=tag:Purpose
Filter.1.Value.1=X
Filter.1.Value.2=Y
tag:key
Usage price of the Reserved Instance, per hour (e.g., 0.84)
Type: xs:double
usage-price
Request Parameters
RequiredDescriptionName
NoIDs of the Reserved Instance to describe.
Type: String
Default: Describes all your Reserved Instances, or onlythose otherwise specified.
ReservedInstancesId.n
NoName of a filter. See the preceding table for a list ofallowed filter names.
Type: String
Default: None
Filter.n.Name
NoA value for the filter. See the preceding table for a list ofallowed values for each filter.
Type: String
Default: None
Filter.n.Value.m
API Version 2010-08-31132
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
Response Elements
DescriptionName
DescribeReservedInstancesResponseType element.
Type: DescribeReservedInstancesResponseType (p. 623)
Ancestor: None
Children: requestId, reservedInstancesSet
DescribeReservedInstancesResponseType
The ID of the request.
Type: xsd:string
Ancestor: DescribeReservedInstancesResponseType
Children: None
requestId
Reserved Instances set.
Type: DescribeReservedInstancesResponseSetType (p. 623)
Ancestor: DescribeReservedInstancesResponseType
Children: item
reservedInstancesSet
Reserved Instance set.
Type: DescribeReservedInstancesResponseSetItemType (p. 622)
Ancestor: reservedInstancesSet
Children: reservedInstancesId, instanceType,availabilityZone, start, duration, fixedPrice,usagePrice, instanceCount, productDescription, state,tagSet
item
The ID of the Reserved Instance.
Type: xsd:string
Ancestor: item
Children: None
reservedInstancesId
The instance type on which the Reserved Instance can be used.
Type: xsd:string
Ancestor: item
Children: None
instanceType
The Availability Zone in which the Reserved Instance can be used.
Type: xsd:string
Ancestor: item
Children: None
availabilityZone
The date and time the Reserved Instance started.
Type: xsd:dateTime
Ancestor: item
Children: None
start
The duration of the Reserved Instance, in seconds.
Type: xs:long
Ancestor: item
Children: None
duration
API Version 2010-08-31133
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
The purchase price of the Reserved Instance.
Type: xs:double
Ancestor: item
Children: None
fixedPrice
The usage price of the Reserved Instance, per hour.
Type: xs:double
Ancestor: item
Children: None
usagePrice
The number of Reserved Instances purchased.
Type: xs:integer
Ancestor: item
Children: None
instanceCount
The Reserved Instance description.
Type: xsd:string
Valid Values: Linux/UNIX | Linux/UNIX (Amazon VPC) |Windows | Windows (Amazon VPC)
Ancestor: item
Children: None
productDescription
The state of the Reserved Instance purchase.
Type: xsd:string
Valid Values: pending-payment | active | payment-failed |retired
Ancestor: item
Children: None
state
Tags assigned to the resource.
Type: ResourceTagSetType
Ancestor: item
Children: item
tagSet
Information about one tag.
Type: ResourceTagSetItemType
Ancestor: tagSet
Children: key, value
item
Tag key.
Type: xsd:string
Ancestor: item
Children: None
key
Tag value.
Type: xsd:string
Ancestor: item
Children: None
value
API Version 2010-08-31134
Amazon Elastic Compute Cloud API ReferenceResponse Elements
Examples
Example RequestThis example describes Reserved Instances owned by your account.
https://ec2.amazonaws.com/?Action=DescribeReservedInstances&AuthParams
Example Response<DescribeReservedInstancesResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <reservedInstancesSet> <item> <reservedInstancesId>4b2293b4-5813-4cc8-9ce3-1957fc1dcfc8</reservedIn stancesId> <instanceType>m1.xlarge</instanceType> <availabilityZone>us-east-1a</availabilityZone> <duration>31536000</duration> <usagePrice>0.24</usagePrice> <fixedPrice>1820.0</fixedPrice> <instanceCount>3</instanceCount> <productDescription>Linux/UNIX</productDescription> <state>Active</state> <tagSet/> </item> </reservedInstancesSet> </DescribeReservedInstancesResponse>
Example RequestThis example filters the results to display only one-year, m1.small Linux/UNIX Reserved Instances. If youwant Linux/UNIX Reserved Instances specifically for use with Amazon VPC, set the product descriptonto Linux/UNIX (Amazon VPC).
https://ec2.amazonaws.com/?Action=DescribeReservedInstances&Filter.1.Name=duration&Filter.1.Value.1=31536000&Filter.2.Name=instance-type&Filter.2.Value.1=m1.small&Filter.3.Name=product-description&Filter.3.Value.1=Linux/UNIX&AuthParams
Related Operations• PurchaseReservedInstancesOffering (p. 204)
• DescribeReservedInstancesOfferings (p. 136)
API Version 2010-08-31135
Amazon Elastic Compute Cloud API ReferenceExamples
DescribeReservedInstancesOfferings
DescriptionDescribes Reserved Instance offerings that are available for purchase. With Amazon EC2 ReservedInstances, you purchase the right to launch Amazon EC2 instances for a period of time (without gettinginsufficient capacity errors) and pay a lower usage rate for the actual time used. For more informationabout Reserved Instances, go to the Amazon Elastic Compute Cloud Developer Guide or Amazon ElasticCompute Cloud User Guide.
Note
Our policy is to provide filters for all describe calls so you can limit the results to your specifiedcriteria. Therefore, you can use filters to limit the results when describing Reserved Instancesofferings, even though you can use the regular request parameters to do something similar.
For example, you could use the regular request parameters or a filter to get the offerings for a particularinstance type.You can specify multiple request parameters or multiple filters (e.g., limit the results to them2.xlarge instance type, and only for Windows instances).The result includes information for a particularoffering only if it matches all your request parameters or filters. If there's no match, no special messageis returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactlyone character.You can escape special characters using a backslash before the character. For example,a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following table shows the available filters.
DescriptionFilter Name
Availability Zone where the Reserved Instance canbe used.
Type: String
availability-zone
Duration of the Reserved Instance (e.g., one yearor three years), in seconds.
Type: xs:long
Valid Values: 31536000 | 94608000
duration
Purchase price of the Reserved Instance (e.g.,9800.0)
Type: xs:double
fixed-price
Instance type on which the Reserved Instance canbe used.
Type: String
instance-type
Reserved Instance description.
Type: String
Valid Values: Linux/UNIX | Linux/UNIX(Amazon VPC) | Windows | Windows (AmazonVPC)
product-description
API Version 2010-08-31136
Amazon Elastic Compute Cloud API ReferenceDescribeReservedInstancesOfferings
DescriptionFilter Name
Reserved Instances offering ID.
Type: String
reserved-instances-offering-id
Usage price of the Reserved Instance, per hour(e.g., 0.84)
Type: xs:double
usage-price
Request Parameters
RequiredDescriptionName
NoID of the Reserved Instances to describe.
Type: String
Default: None
ReservedInstancesOfferingId.n
NoThe instance type on which the Reserved Instance can beused.
Type: String
Default: None
InstanceType
NoThe Availability Zone in which the Reserved Instance canbe used.
Type: String
Default: None
AvailabilityZone
NoThe Reserved Instance description. Instances that include(Amazon VPC) in the description are for use with AmazonVPC.
Type: String
Valid Values: Linux/UNIX | Linux/UNIX (AmazonVPC) | Windows | Windows (Amazon VPC)
Default: None
ProductDescription
NoName of a filter. See the preceding table for a list ofallowed filter names.
Type: String
Default: None
Filter.n.Name
NoA value for the filter. See the preceding table for a list ofallowed values for each filter.
Type: String
Default: None
Filter.n.Value.m
API Version 2010-08-31137
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
Response Elements
DescriptionName
DescribeReservedInstancesOfferingsResponseType element.
Type: DescribeReservedInstancesOfferingsResponseType (p. 620)
Ancestor: None
Children: requestId, reservedInstancesOfferingsSet
DescribeReservedInstancesOfferingsResponseType
The ID of the request.
Type: xsd:string
Ancestor:DescribeReservedInstancesOfferingsResponseType
Children: None
requestId
Reserved Instances offerings set.
Type:DescribeReservedInstancesOfferingsResponseSetType (p.619)
Ancestor:DescribeReservedInstancesOfferingsResponseType
Children: item
reservedInstancesOfferingsSet
Reserved Instance offerings set.
Type:DescribeReservedInstancesOfferingsResponseSetItemType (p. 618)
Ancestor: reservedInstancesOfferingsSet
Children: reservedInstancesOfferingId, instanceType,availabilityZone, duration, fixedPrice, usagePrice, andproductDescription
item
The ID of the Reserved Instance offering.
Type: xsd:string
Ancestor: item
Children: None
reservedInstancesOfferingId
The instance type on which the Reserved Instance can be used.
Type: xsd:string
Ancestor: item
Children: None
instanceType
The Availability Zone in which the Reserved Instance can be used.
Type: xsd:string
Ancestor: item
Children: None
availabilityZone
The duration of the Reserved Instance, in seconds.
Type: xs:long
Ancestor: item
Children: None
duration
API Version 2010-08-31138
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
The purchase price of the Reserved Instance.
Type: xs:double
Ancestor: item
Children: None
fixedPrice
The usage price of the Reserved Instance, per hour.
Type: xs:double
Ancestor: item
Children: None
usagePrice
The Reserved Instance description.
Type: xsd:string
Valid Values: Linux/UNIX | Linux/UNIX (Amazon VPC) |Windows | Windows (Amazon VPC)
Ancestor: item
Children: None
productDescription
Examples
Example RequestThis example describes available Reserved Instance offerings.
https://ec2.amazonaws.com/?Action=DescribeReservedInstancesOfferings&AuthParams
Example Response<DescribeReservedInstancesOfferingsResponse xmlns="http://ec2.amazon aws.com/doc/2010-08-31/"> <reservedInstancesOfferingsSet> <item> <reservedInstancesOfferingId>4b2293b4-b01c-4392-98d7-ea2629b4ad558</reservedInstancesOfferingId> <instanceType>m1.small</instanceType> <availabilityZone>us-east-1b</availabilityZone> <duration>94608000</duration> <fixedPrice>350.0</fixedPrice> <usagePrice>0.03</usagePrice> <productDescription>Linux/UNIX</productDescription> </item> ... </reservedInstancesOfferingsSet> </DescribeReservedInstancesOfferingsResponse>
Example RequestThis example uses filters to return one-year offerings for Linux/UNIX m1.small or m1.large instances.
https://ec2.amazonaws.com/?Action=DescribeReservedInstancesOfferings&Filter.1.Name=duration
API Version 2010-08-31139
Amazon Elastic Compute Cloud API ReferenceExamples
&Filter.1.Value.1=31536000&Filter.2.Name=instance-type&Filter.2.Value.1=m1.small&Filter.2.Value.2=m1.large&Filter.3.Name=product-description&Filter.3.Value.1=Linux/UNIX&AuthParams
Related Operations• PurchaseReservedInstancesOffering (p. 204)
• DescribeReservedInstances (p. 131)
API Version 2010-08-31140
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DescribeSecurityGroups
DescriptionReturns information about security groups that you own.
You can filter the results to return information only about security groups that match criteria you specify.For example, you could get information about groups whose name contains a particular string.You canspecify multiple values for a filter. A security group must match at least one of the specified values for itto be included in the results.
You can specify multiple filters (e.g., the group's name contains a particular string, and the group givespermission to another security group with a different string in its name). The result includes informationfor a particular group only if it matches all your filters. If there's no match, no special message is returned;the response is simply empty.
Important
Filters are based on literal strings only. This is important to remember when you want to usefilters to return only security groups with access allowed on a specific port number or numbers.For example, let's say you want to get all groups that have access on port 22. And let's sayGroupA gives access on a range of ports using fromPort=20 and toPort=30. If you filter withip-permission.from-port=22 or ip-permission.to-port=22 (or both), GroupA will notbe returned in the results. It will only be returned in the results if you specifyip-permission.from-port=20 or ip-permission.to-port=30 (or both).
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactlyone character.You can escape special characters using a backslash before the character. For example,a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following table shows the available filters.
DescriptionFilter Name
Description of the security group.
Type: String
description
Name of the security group.
Type: String
group-name
CIDR range that has been granted the permission.
Type: String
ip-permission.cidr
Start of port range for the TCP and UDP protocols,or an ICMP type number. An ICMP type numberof -1 indicates a wildcard (i.e., any ICMP typenumber).
Type: String
ip-permission.from-port
Name of security group that has been granted thepermission.
Type: String
ip-permission.group-name
API Version 2010-08-31141
Amazon Elastic Compute Cloud API ReferenceDescribeSecurityGroups
DescriptionFilter Name
IP protocol for the permission.
Type: String
Valid Values: tcp | udp | icmp
ip-permission.protocol
End of port range for the TCP and UDP protocols,or an ICMP code. An ICMP type number of -1indicates a wildcard (i.e., any ICMP type number).
Type: String
ip-permission.to-port
ID of AWS account that has been granted thepermission.
Type: String
ip-permission.user-id
AWS account ID of the owner of the security group.
Type: String
owner-id
Request Parameters
RequiredDescriptionName
NoName of the security group.
Type: String
Default: Describes all groups you own, or only thoseotherwise specified.
GroupName.n
NoName of a filter. See the preceding table for a list ofallowed filter names.
Type: String
Default: None
Filter.n.Name
NoA value for the filter. See the preceding table for a list ofallowed values for each filter.
Type: String
Default: None
Filter.n.Value.m
Response Elements
DescriptionName
DescribeSecurityGroupsResponse element.
Type: DescribeSecurityGroupsResponseType (p. 625)
Ancestor: None
Children: requestId, securityGroupInfo
DescribeSecurityGroupsResponse
API Version 2010-08-31142
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
DescriptionName
The ID of the request.
Type: xsd:string
Ancestor: DescribeSecurityGroupsResponseType
Children: None
requestId
Security group set.
Type: SecurityGroupSetType (p. 697)
Ancestor: DescribeSecurityGroupsResponseType
Children: item
securityGroupInfo
Information for a security group.
Type: SecurityGroupItemType (p. 697)
Ancestor: securityGroupInfo
Children: ownerId, groupName, groupDescription,ipPermissions
item
AWS account ID of the owner of the security group.
Type: xsd:string
Ancestor: item
Children: None
ownerId
Name of the security group.
Type: xsd:string
Ancestor: item
Children: None
groupName
Description of the security group.
Type: xsd:string
Ancestor: item
Children: None
groupDescription
Set of IP permissions associated with the security group.
Type: IpPermissionSetType (p. 657)
Ancestor: item
Children: item
ipPermissions
Set of IP permissions.
Type: IpPermissionType (p. 657)
Ancestor: ipPermissions
Children:ipProtocol, fromPort, toPort, groups, and ipRanges
item
IP protocol.
Type: xsd:string
Valid Values: tcp | udp | icmp
Ancestor: item
Children: None
ipProtocol
API Version 2010-08-31143
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Start of port range for the TCP and UDP protocols, or an ICMP typenumber. An ICMP type number of -1 indicates a wildcard (i.e., anyICMP type number).
Type: xsd:int
Ancestor: item
Children: None
fromPort
End of port range for the TCP and UDP protocols, or an ICMP code.An ICMP code of -1 indicates a wildcard (i.e., any ICMP code).
Type: xsd:int
Ancestor: item
Children: None
toPort
List of security group and user ID pairs.
Type: UserIdGroupPairSetType (p. 708)
Ancestor: item
Children: item
groups
Information for one security group.
Type: UserIdGroupPairType (p. 709)
Ancestor: groups
Children: userId, groupName
item
AWS account ID. Cannot be used when specifying a CIDR IPaddress.
Type: xsd:string
Ancestor: item
Children: None
userId
Name of the security group. Cannot be used when specifying a CIDRIP address.
Type: xsd:string
Ancestor: item
Children: None
groupName
IP ranges.
Type: IpRangeSetType (p. 659)
Ancestor: item
Children: item
ipRanges
Information for one IP range.
Type: IpRangeItemType (p. 658)
Ancestor: ipRanges
Children: cidrIp
item
CIDR range.
Type: xsd:string
Ancestor: item
Children: None
cidrIp
API Version 2010-08-31144
Amazon Elastic Compute Cloud API ReferenceResponse Elements
Examples
Example RequestThis example returns information about two security groups that are configured for the account.
https://ec2.amazonaws.com/?Action=DescribeSecurityGroups&GroupName.1=WebServers&GroupName.2=RangedPortsBySource&AuthParams
Example Response<DescribeSecurityGroupsResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <securityGroupInfo> <item> <ownerId>UYY3TLBUXIEON5NQVUUX6OMPWBZIQNFM</ownerId> <groupName>WebServers</groupName> <groupDescription>Web Servers</groupDescription> <ipPermissions> <item> <ipProtocol>tcp</ipProtocol> <fromPort>80</fromPort> <toPort>80</toPort> <groups/> <ipRanges> <item> <cidrIp>0.0.0.0/0</cidrIp> </item> </ipRanges> </item> </ipPermissions> </item> <item> <ownerId>UYY3TLBUXIEON5NQVUUX6OMPWBZIQNFM</ownerId> <groupName>RangedPortsBySource</groupName> <groupDescription>Group A</groupDescription> <ipPermissions> <item> <ipProtocol>tcp</ipProtocol> <fromPort>6000</fromPort> <toPort>7000</toPort> <groups/> <ipRanges/> </item> </ipPermissions> </item> </securityGroupInfo></DescribeSecurityGroupsResponse>
Example RequestThis example returns information about all security groups that grant access over TCP specifically onport 22 from instances in either the app_server_group or database_group.
API Version 2010-08-31145
Amazon Elastic Compute Cloud API ReferenceExamples
https://ec2.amazonaws.com/?Action=DescribeSecurityGroups&Filter.1.Name=ip-permission.protocol&Filter.1.Value.1=tcp&Filter.2.Name=ip-permission.from-port&Filter.2.Value.1=22&Filter.3.Name=ip-permission.to-port&Filter.3.Value.1=22&Filter.4.Name=ip-permission.group-name&Filter.4.Value.1=app_server_group&Filter.4.Value.2=database_group&AuthParams
Related Operations• CreateSecurityGroup (p. 44)
• AuthorizeSecurityGroupIngress (p. 22)
• RevokeSecurityGroupIngress (p. 228)
• DeleteSecurityGroup (p. 61)
API Version 2010-08-31146
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DescribeSnapshotAttribute
DescriptionReturns information about an attribute of a snapshot.You can get information about only one attributeper call.
Request Parameters
RequiredDescriptionName
YesThe ID of the Amazon EBS snapshot.
Type: String
Default: None
SnapshotId.n
YesReturns the create volume permissions of the snapshot.
Type: String
Default: None
Attribute=createVolumePermission
Response Elements
DescriptionName
DescribeSnapshotAttributeResponseType element.
Type: DescribeSnapshotAttributeResponseType (p. 627)
Ancestor: None
Children: requestId, snapshotId, andcreateVolumePermission
DescribeSnapshotAttributeResponseType
The ID of the request.
Type: xsd:string
Ancestor: DescribeSnapshotAttributeResponseType
Children: None
requestId
The ID of the Amazon EBS snapshot.
Type: xsd:string
Ancestor: DescribeSnapshotAttributeResponseType
Children: None
snapshotId
Create volume permission element.
Type: CreateVolumePermissionListType (p. 585)
Ancestor: DescribeSnapshotAttributeResponseType
Children: item
createVolumePermission
Volume permission item.
Type: CreateVolumePermissionItemType (p. 584)
Ancestor: createVolumePermission
Children: userId, group
item
API Version 2010-08-31147
Amazon Elastic Compute Cloud API ReferenceDescribeSnapshotAttribute
DescriptionName
ID of an AWS account that can create volumes from the snapshot.
Type: xsd:string
Ancestor: item
Children: None
userId
Group that is allowed to create volumes from the snapshot (currentlysupports "all").
Type: xsd:string
Ancestor: item
Children: None
group
Examples
Example RequestThis example describes permissions for the snap-78a54011 snapshot.
https://ec2.amazonaws.com/?Action=DescribeSnapshotAttribute&SnapshotId=snap-78a54011&Attribute=createVolumePermission&AuthParams
Example Response<DescribeSnapshotAttributeResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <snapshotId>snap-78a54011</snapshotId> <createVolumePermission> <item> <group>all</group> </item> </createVolumePermission></DescribeSnapshotAttributeResponse>
Related Operations• ModifySnapshotAttribute (p. 200)
• DescribeSnapshots (p. 149)
• ResetSnapshotAttribute (p. 226)
• CreateSnapshot (p. 46)
API Version 2010-08-31148
Amazon Elastic Compute Cloud API ReferenceExamples
DescribeSnapshots
DescriptionReturns information about Amazon EBS snapshots available to you. Snapshots available to you includepublic snapshots available for any AWS account to launch, private snapshots you own, and privatesnapshots owned by another AWS account but for which you've been given explicit create volumepermissions.
The create volume permissions fall into 3 categories:
DescriptionPermission
The owner of the snapshot granted create volume permissions for the snapshotto the all group. All AWS accounts have create volume permissions for thesesnapshots.
public
The owner of the snapshot granted create volume permissions to a specific AWSaccount.
explicit
An AWS account has implicit create volume permissions for all snapshots it owns.implicit
The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWSaccounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshotsfor which you have create volume permissions.
If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If youspecify an invalid snapshot ID, a fault is returned. If you specify a snapshot ID for which you do not haveaccess, it will not be included in the returned results.
If you specify one or more snapshot owners, only snapshots from the specified owners and for which youhave access are returned.The results can include the AWS account IDs of the specified owners, amazonfor snapshots owned by Amazon, or self for snapshots that you own.
If you specify a list of restorable users, only snapshots with create snapshot permissions for those usersare returned.You can specify AWS account IDs (if you own the snapshot(s)), self for snapshots forwhich you own or have explicit permissions, or all for public snapshots.
You can filter the results to return information only about snapshots that match criteria you specify. Forexample, you could get information about snapshots whose status is pending.You can specify multiplevalues for a filter (e.g., the snapshot's status is either pending or completed). A snapshot must matchat least one of the specified values for it to be included in the results.
You can specify multiple filters (e.g., the snapshot's status is pending, and it is tagged with a particularvalue). The result includes information for a particular snapshot only if it matches all your filters. If there'sno match, no special message is returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactlyone character.You can escape special characters using a backslash before the character. For example,a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following table shows the available filters.
API Version 2010-08-31149
Amazon Elastic Compute Cloud API ReferenceDescribeSnapshots
DescriptionFilter Name
Description of the snapshot.
Type: String
description
The AWS account alias (e.g., amazon) that owns the snapshot.
Type: String
owner-alias
ID of the AWS account that owns the snapshot.
Type: String
owner-id
The progress of the snapshot, in percentage (e.g., 80%).
Type: String
progress
Snapshot ID.
Type: String
snapshot-id
Time stamp when the snapshot was initiated.
Type: xsd:dateTime
start-time
Status of the snapshot.
Type: String
Valid Values: pending | completed | error
status
Key of a tag assigned to the resource. This filter is independent of thetag-value filter. For example, if you use both the filter tag-key=Purposeand the filter tag-value=X, you get any resources assigned both the tagkey Purpose (regardless of what the tag's value is), and the tag value X(regardless of what the tag's key is). If you want to list only resources wherePurpose=X, see the tag:key filter later in this table.
For more information about tags, go to Using Tags in the Amazon ElasticCompute Cloud Developer Guide.
Type: String
tag-key
Value of a tag assigned to the resource. This filter is independent of thetag-key filter.
Type: String
tag-value
Filters the results based on a specific tag/value combination.
Example: To list just the resources assigned tag Purpose=X, then specify:
Filter.1.Name=tag:Purpose
Filter.1.Value.1=X
Example: To list just resources assigned tag Purpose=X OR Purpose=Y,then specify:
Filter.1.Name=tag:Purpose
Filter.1.Value.1=X
Filter.1.Value.2=Y
tag:key
ID of the volume the snapshot is for.
Type: String
volume-id
The size of the volume, in GiB (e.g., 20).
Type: String
volume-size
API Version 2010-08-31150
Amazon Elastic Compute Cloud API ReferenceDescription
Request Parameters
RequiredDescriptionName
NoThe ID of the Amazon EBS snapshot.
Type: String
Default: Describes snapshots for which you have launchpermissions.
SnapshotId.n
NoReturns snapshots owned by the specified owner. Multipleowners can be specified.
Type: String
Valid Values: self | amazon | AWS Account ID
Default: None
Owner.n
NoID of an AWS account that can create volumes from thesnapshot.
Type: String
Default: None
RestorableBy.n
NoName of a filter. See the preceding table for a list ofallowed filter names.
Type: String
Default: None
Filter.n.Name
NoA value for the filter. See the preceding table for a list ofallowed values for each filter.
Type: String
Default: None
Filter.n.Value.m
Response Elements
DescriptionName
DescribeSnapshotsResponse element.
Type: DescribeSnapshotsResponseType (p. 630)
Ancestor: None
Children: requestId, snapshotSet
DescribeSnapshotsResponse
The ID of the request.
Type: xsd:string
Ancestor: DescribeSnapshotsResponseType
Children: None
requestId
Snapshot set.
Type: DescribeSnapshotsSetResponseType (p. 633)
Ancestor: DescribeSnapshotsResponseType
Children: item
snapshotSet
API Version 2010-08-31151
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
DescriptionName
Information for a snapshot.
Type: DescribeSnapshotsSetItemResponseType (p. 631)
Ancestor: snapshotSet
Children:snapshotId, volumeId, status, startTime, progress,ownerId, volumeSize, description ownerAlias, tagSet
item
The ID of the snapshot.
Type: xsd:string
Ancestor: item
Children: None
snapshotId
The ID of the volume.
Type: xsd:string
Ancestor: item
Children: None
volumeId
Snapshot state (e.g., pending, completed, or error)
Type: xsd:string
Valid Values: pending | completed | error
Ancestor: item
Children: None
status
Time stamp when the snapshot was initiated.
Type: xsd:dateTime
Ancestor: item
Children: None
startTime
The progress of the snapshot, in percentage.
Type: xsd:string
Ancestor: item
Children: None
progress
ID of the AWS account that owns the snapshot.
Type: xsd:string
Ancestor: item
Children: None
ownerId
The size of the volume, in GiB.
Type: xsd:string
Ancestor: item
Children: None
volumeSize
Description of the snapshot.
Type: xsd:string
Ancestor: item
Children: None
description
API Version 2010-08-31152
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
The AWS account alias (e.g., amazon, self, etc.) or AWS accountID that owns the AMI.
Type: xsd:string
Ancestor: item
Children: None
ownerAlias
Tags assigned to the resource.
Type: ResourceTagSetType
Ancestor: item
Children: item
tagSet
Information about one tag.
Type: ResourceTagSetItemType
Ancestor: tagSet
Children: key, value
item
Tag key.
Type: xsd:string
Ancestor: item
Children: None
key
Tag value.
Type: xsd:string
Ancestor: item
Children: None
value
Examples
Example RequestThis example describes snapshot snap-78a54011.
https://ec2.amazonaws.com/?Action=DescribeSnapshots&SnapshotId=snap-78a54011&AuthParams
Example Response<DescribeSnapshotsResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <snapshotSet> <item> <snapshotId>snap-78a54011</snapshotId> <volumeId>vol-4d826724</volumeId> <status>pending</status> <startTime>2008-05-07T12:51:50.000Z</startTime> <progress>80%</progress> <ownerId>999988887777</ownerId> <volumeSize>10</volumeSize> <description>Daily Backup</description> <tagSet/>
API Version 2010-08-31153
Amazon Elastic Compute Cloud API ReferenceExamples
</item> </snapshotSet></DescribeSnapshotsResponse>
Example RequestThis example filters the results to display only snapshots with the pending status, and that are alsotagged with a value that includes the string db_.
https://ec2.amazonaws.com/?Action=DescribeSnapshots&Filter.1.Name=status&Filter.1.Value.1=pending&Filter.2.Name=tag-value&Filter.2.Value.1=*db_*&AuthParams
Example Response<DescribeSnapshotsResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <snapshotSet> <item> <snapshotId>snap-1a2b3c4d</snapshotId> <volumeId>vol-8875daef</volumeId> <status>pending</status> <startTime>2010-07-29T04:12:01.000Z</startTime> <progress>30%</progress> <ownerId>999988887777</ownerId> <volumeSize>15</volumeSize> <description>Daily Backup</description> <tagSet> <item> <key>Purpose</key> <value>demo_db_14_backup</value> </item> </tagSet> </item> </snapshotSet></DescribeSnapshotsResponse>
Related Operations• CreateSnapshot (p. 46)
• DeleteSnapshot (p. 63)
API Version 2010-08-31154
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DescribeSpotDatafeedSubscription
DescriptionDescribes the data feed for Spot Instances. For conceptual information about Spot Instances, refer tothe Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide.
Request ParametersThe DescribeSpotDatafeedSubscription operation does not have any request parameters.
Response Elements
DescriptionName
DescribeSpotDatafeedSubscriptionResponse element.
Type: DescribeSpotDatafeedSubscriptionResponseType (p. 634)
Ancestor: None
Children: requestId, spotDatafeedSubscription
DescribeSpotDatafeedSubscriptionResponse
The ID of the request.
Type: xsd:string
Ancestor:DescribeSpotDatafeedSubscriptionResponseType
Children: None
requestId
The Spot Instance datafeed subscription.
Type: SpotDatafeedSubscriptionType (p. 698)
Ancestor:DescribeSpotDatafeedSubscriptionResponseType
Children: ownerId, bucket, prefix, state, and fault
spotDatafeedSubscription
The AWS account ID of the account.
Type: xsd:string
Ancestor: spotDatafeedSubscription
Children: None
ownerId
The Amazon S3 bucket where the Spot Instance datafeed is located.
Type: xsd:string
Ancestor: spotDatafeedSubscription
Children: None
bucket
Prefix for the datafeed files.
Type: xsd:string
Ancestor: spotDatafeedSubscription
Children: None
prefix
API Version 2010-08-31155
Amazon Elastic Compute Cloud API ReferenceDescribeSpotDatafeedSubscription
DescriptionName
The state of the Spot Instance datafeed subscription.
Type: xsd:string
Valid Values: Active | Inactive
Ancestor: spotDatafeedSubscription
Children: None
state
Fault codes for the Spot Instance request, if any.
Type: SpotInstanceStateFaultType (p. 702)
Ancestor: spotDatafeedSubscription
Children: code, message
fault
Reason code for the Spot Instance state change.
Type: xsd:string
Ancestor: fault
Children: None
code
Message for the Spot Instance state change.
Type: xsd:string
Ancestor: fault
Children: None
message
Examples
Example RequestThis example describes the data feed for the account.
https://ec2.amazonaws.com/?Action=DescribeSpotDatafeedSubscription&AuthParams
Example Response<DescribeSpotDatafeedSubscriptionResponse xmlns="http://ec2.amazon aws.com/doc/2010-08-31/"> <spotDatafeedSubscription> <ownerId>999988887777</ownerId> <bucket>mybucket</bucket> <prefix>spotdata</prefix> <state>Active</state> </spotDatafeedSubscription></DescribeSpotDatafeedSubscriptionResponse>
Related Operations• CreateSpotDatafeedSubscription (p. 49)
• DeleteSpotDatafeedSubscription (p. 65)
API Version 2010-08-31156
Amazon Elastic Compute Cloud API ReferenceExamples
DescribeSpotInstanceRequests
DescriptionDescribes Spot Instance requests. Spot Instances are instances that Amazon EC2 starts on your behalfwhen the maximum price that you specify exceeds the current Spot Price. Amazon EC2 periodically setsthe Spot Price based on available Spot Instance capacity and current spot instance requests. Forconceptual information about Spot Instances, refer to the Amazon Elastic Compute Cloud DeveloperGuide or Amazon Elastic Compute Cloud User Guide.
You can filter the results to return information only about Spot Instance requests that match criteria youspecify. For example, you could get information about requests where the Spot Price you specified is acertain value (you can't use greater than or less than comparison, but you can use * and ? wildcards).You can specify multiple values for a filter. A Spot Instance request must match at least one of the specifiedvalues for it to be included in the results.
You can specify multiple filters (e.g., the Spot Price is equal to a particular value, and the instance typeis m1.small). The result includes information for a particular request only if it matches all your filters. Ifthere's no match, no special message is returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactlyone character.You can escape special characters using a backslash before the character. For example,a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following table shows the available filters.
DescriptionFilter Name
Availability Zone group. If you specify the sameAvailability Zone group for all Spot Instancerequests, all Spot Instances are launched in thesame Availability Zone.
Type: String
availability-zone-group
Time stamp when the Spot Instance request wascreated.
Type: String
create-time
Fault code related to the request.
Type: String
fault-code
Fault message related to the request.
Type: String
fault-message
ID of the instance that fulfilled the request.
Type: String
instance-id
Spot Instance launch group. Launch groups areSpot Instances that launch together and terminatetogether.
Type: String
launch-group
Whether an Amazon EBS volume mapped to theinstance is deleted on instance termination.
Type: Boolean
launch.block-device-mapping.delete-on-termination
API Version 2010-08-31157
Amazon Elastic Compute Cloud API ReferenceDescribeSpotInstanceRequests
DescriptionFilter Name
Device name (e.g., /dev/sdh) for an Amazon EBSvolume mapped to the instance.
Type: String
launch.block-device-mapping.device-name
ID for a snapshot mapped to the instance.
Type: String
launch.block-device-mapping.snapshot-id
Size of an Amazon EBS volume mapped to theinstance (in GiB).
Type: String
launch.block-device-mapping.volume-size
A security group the instance is in.
Type: String
launch.group-id
The AMI ID.
Type: String
launch.image-id
Type of instance (e.g., m1.small).
Type: String
launch.instance-type
Kernel ID.
Type: String
launch.kernel-id
Name of the key pair the instance launched with.
Type: String
launch.key-name
Whether monitoring is enabled for the SpotInstance.
Type: Boolean
launch.monitoring-enabled
RAM disk ID.
Type: String
launch.ramdisk-id
Product description associated with the instance.
Type: String
Valid Values: Linux/UNIX | Windows
product-description
Spot Instance request ID.
Type: String
spot-instance-request-id
Maximum hourly price for any Spot Instancelaunched to fulfill the request.
Type: String
spot-price
State of the Spot Instance request.
Type: String
Valid Values: active | cancelled | open |closed | failed
state
API Version 2010-08-31158
Amazon Elastic Compute Cloud API ReferenceDescription
DescriptionFilter Name
Key of a tag assigned to the resource. This filter isindependent of the tag-value filter. For example,if you use both the filter tag-key=Purpose andthe filter tag-value=X, you get any resourcesassigned both the tag key Purpose (regardless ofwhat the tag's value is), and the tag value X(regardless of what the tag's key is). If you want tolist only resources where Purpose=X, see thetag:key filter later in this table.
For more information about tags, go to Using Tagsin the Amazon Elastic Compute Cloud DeveloperGuide.
Type: String
tag-key
Value of a tag assigned to the resource. This filteris independent of the tag-key filter.
Type: String
tag-value
Filters the results based on a specific tag/valuecombination.
Example: To list just the resources assigned tagPurpose=X, then specify:
Filter.1.Name=tag:Purpose
Filter.1.Value.1=X
Example: To list just resources assigned tagPurpose=X OR Purpose=Y, then specify:
Filter.1.Name=tag:Purpose
Filter.1.Value.1=X
Filter.1.Value.2=Y
tag:key
Type of Spot Instance request.
Type: String
Valid Values: one-time | persistent
type
Start date of the request.
Type: xsd:dateTime
valid-from
End date of the request.
Type: xsd:dateTime
valid-until
Request Parameters
RequiredDescriptionName
NoSpecifies the ID of the Spot Instance request.
Type: String
Default: None
SpotInstanceRequestId.n
API Version 2010-08-31159
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
RequiredDescriptionName
NoName of a filter. See the preceding table for a list ofallowed filter names.
Type: String
Default: None
Filter.n.Name
NoA value for the filter. See the preceding table for a list ofallowed values for each filter.
Type: String
Default: None
Filter.n.Value.m
Response Elements
DescriptionName
DescribeSpotInstanceRequestsResponse element.
Type: DescribeSpotInstanceRequestsResponseType (p. 635)
Ancestor: None
Children: requestId, spotInstanceRequestSet
DescribeSpotInstanceRequestsResponse
The ID of the request.
Type: xsd:string
Ancestor: DescribeSpotInstanceRequestsResponseType
Children: None
requestId
Spot Instance request set.
Type: SpotInstanceRequestSetType (p. 701)
Ancestor: DescribeSpotInstanceRequestsResponseType
Children: item
spotInstanceRequestSet
Spot Instance request set.
Type: SpotInstanceRequestSetItemType (p. 700)
Ancestor: spotInstanceRequestSet
Children: spotInstanceRequestId, spotPrice, type, state,fault, validFrom, validUntil, launchGroup,availabilityZoneGroup, launchSpecification, instanceId,createTime, productDescription, tagSet
item
Specifies the ID of the Spot Instance request.
Type: xsd:string
Ancestor: item
Children: None
spotInstanceRequestId
Specifies the maximum hourly price for any Spot Instance launchedto fulfill the request.
Type: xsd:string
Ancestor: item
Children: None
spotPrice
API Version 2010-08-31160
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Specifies the Spot Instance request type.
Type: xsd:string
Valid Values: one-time | persistent
Ancestor: item
Children: None
type
The state of the Spot Instance request.
Type: xsd:string
Valid Values: open | closed | cancelled | failed
Ancestor: item
Children: None
state
Fault codes for the Spot Instance request, if any.
Type: SpotInstanceStateFaultType (p. 702)
Ancestor: item
Children: code, message
fault
Reason code for the Spot Instance state change.
Type: xsd:string
Ancestor: fault
Children: None
code
Message for the Spot Instance state change.
Type: xsd:string
Ancestor: fault
Children: None
message
Start date of the request. If this is a one-time request, the requestbecomes active at this date and time and remains active until allinstances launch, the request expires, or the request is canceled. Ifthe request is persistent, the request becomes active at this date andtime and remains active until it expires or is canceled.
Type: xsd:dateTime
Ancestor: item
Children: None
validFrom
End date of the request. If this is a one-time request, the requestremains active until all instances launch, the request is canceled, orthis date is reached. If the request is persistent, it remains active untilit is canceled or this date and time is reached.
Type: xsd:dateTime
Ancestor: item
Children: None
validUntil
Specifies the instance launch group. Launch groups are SpotInstances that launch together and terminate together.
Type: xsd:string
Ancestor: item
Children: None
launchGroup
API Version 2010-08-31161
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Specifies the Availability Zone group. If you specify the sameAvailability Zone group for all Spot Instance requests, all SpotInstances are launched in the same Availability Zone.
Type: xsd:string
Ancestor: item
Children: None
availabilityZoneGroup
Specifies additional launch instance information.
Type: LaunchSpecificationType (p. 661)
Ancestor: item
Children: imageId, keyName, groupSet, addressingType,instanceType, placement, kernelId, ramdiskId,blockDeviceMapping, monitoring, and subnetId
launchSpecification
The AMI ID.
Type: xsd:string
Ancestor: launchSpecification
Children: None
imageId
The name of the key pair.
Type: xsd:string
Ancestor: launchSpecification
Children: None
keyName
Group set.
Type: GroupSetType (p. 648)
Ancestor: launchSpecification
Children: item
groupSet
Group set item.
Type: GroupItemType (p. 648)
Ancestor: groupSet
Children: groupId
item
Name of the security group.
Type: xsd:string
Ancestor: item
Children: None
groupId
Deprecated.
Type: xsd:string
Ancestor: launchSpecification
Children: None
addressingType
API Version 2010-08-31162
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Specifies the instance type.
Type: xsd:string
Valid Values: m1.small | m1.large | m1.xlarge | c1.medium |c1.xlarge | m2.xlarge | m2.2xlarge | m2.4xlarge | t1.micro
Ancestor: launchSpecification
Children: None
instanceType
Placement item.
Type: PlacementRequestType (p. 671)
Ancestor: launchSpecification
Children: availabilityZone
placement
Specifies the placement constraints (Availability Zones) for launchingthe instances.
Type: xsd:string
Ancestor: placement
Children: None
availabilityZone
The ID of the kernel to select.
Type: xsd:string
Ancestor: launchSpecification
Children: None
kernelId
The ID of the RAM disk to select. Some kernels require additionaldrivers at launch. Check the kernel requirements for information onwhether you need to specify a RAM disk and search for the kernelID.
Type: xsd:string
Ancestor: launchSpecification
Children: None
ramdiskId
Specifies how block devices are exposed to the instance. Eachmapping is made up of a virtualName and a deviceName.
Type: BlockDeviceMappingType (p. 568)
Ancestor: launchSpecification
Children: item
blockDeviceMapping
Information for one block device mapping.
Type: BlockDeviceMappingItemType (p. 567)
Ancestor: blockDeviceMapping
Children: deviceName, virtualName, ebs, and noDevice
item
The device name (e.g., /dev/sdh).
Type: xsd:string
Ancestor: item
Children: None
deviceName
API Version 2010-08-31163
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
The virtual device name.
Type: xsd:string
Ancestor: item
Children: None
virtualName
Specifies parameters used to automatically set up Amazon EBSvolumes when the instance is launched.
Type: EbsBlockDeviceType (p. 643)
Ancestor: item
Children:snapshotId, volumeSize, and deleteOnTermination
ebs
The ID of the snapshot.
Type: xsd:string
Ancestor: ebs
Children: None
snapshotId
The size of the volume, in GiBs. Required if you are not creating avolume from a snapshot.
Type: xsd:int
Ancestor: ebs
Children: None
volumeSize
Specifies whether the Amazon EBS volume is deleted on instancetermination.
Type: xsd:boolean
Ancestor: ebs
Children: None
deleteOnTermination
Specifies the device name to suppress during instance launch.
Type: EmptyElementType (p. 644)
Ancestor: item
Children: none
noDevice
This element contains no options.
Type: xsd:string
Ancestor: noDevice
Children: None
none
Specifies whether to enable monitoring for the instance.
Type: MonitoringInstanceType (p. 666)
Ancestor: launchSpecification
Children: enabled
monitoring
Enables monitoring for the instance.
Type: xsd:boolean
Ancestor: monitoring
Children: None
enabled
API Version 2010-08-31164
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Specifies the Amazon VPC subnet ID within which to launch theinstance(s) for Amazon Virtual Private Cloud.
Type: xsd:string
Ancestor: launchSpecification
Children: None
subnetId
Specifies the instance ID.
Type: xsd:string
Ancestor: item
Children: None
instanceId
Time stamp when the Spot Instance request was created.
Type: xsd:dateTime
Ancestor: item
Children: None
createTime
The product description associated with the Spot Instance.
Type: xsd:dateTime
Ancestor: item
Children: None
productDescription
Tags assigned to the resource.
Type: ResourceTagSetType
Ancestor: item
Children: item
tagSet
Information about one tag.
Type: ResourceTagSetItemType
Ancestor: tagSet
Children: key, value
item
Tag key.
Type: xsd:string
Ancestor: item
Children: None
key
Tag value.
Type: xsd:string
Ancestor: item
Children: None
value
Examples
Example RequestThis example returns information about current Spot Instance requests.
API Version 2010-08-31165
Amazon Elastic Compute Cloud API ReferenceExamples
https://ec2.amazonaws.com/?Action=DescribeSpotInstanceRequests&AuthParams
Example Response<DescribeSpotInstanceRequestsResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <spotInstanceRequestSet> <item> <spotInstanceRequestId>sir-e95fae02</spotInstanceRequestId> <spotPrice>0.01</spotPrice> <type>one-time</type> <state>open</state> <launchSpecification> <imageId>ami-235fba4a</imageId> <keyName>MyKey</keyName> <groupSet> <item> <groupId>default</groupId> </item> </groupSet> <instanceType>m1.small</instanceType> <blockDeviceMapping/> <monitoring> <enabled>false</enabled> </monitoring> </launchSpecification> <instanceId>i-2fd4ca67</instanceId> <createTime>2009-12-04T22:51:14.000Z</createTime> <productDescription>Linux/UNIX</productDescription> <tagSet/> </item> </spotInstanceRequestSet></DescribeSpotInstanceRequestsResponse>
Example RequestThis example describes all persistent Spot Instance requests that have resulted in the launch of at leastone m1.small instance that also has monitoring enabled.
https://ec2.amazonaws.com/?Action=DescribeSpotInstanceRequests&Filter.1.Name=type&Filter.1.Value.1=persistent&Filter.2.Name=instance-type&Filter.2.Value.1=m1.small&Filter.3.Name=monitoring-enabled&Filter.3.Value.1=true&AuthParams
Related Operations• RequestSpotInstances (p. 214)
• CancelSpotInstanceRequests (p. 34)
• DescribeSpotPriceHistory (p. 167)
API Version 2010-08-31166
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DescribeSpotPriceHistory
DescriptionDescribes Spot Price history. Spot Instances are instances that Amazon EC2 starts on your behalf whenthe maximum price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets theSpot Price based on available Spot Instance capacity and current spot instance requests. For conceptualinformation about Spot Instances, refer to the Amazon Elastic Compute Cloud Developer Guide or AmazonElastic Compute Cloud User Guide.
Note
Although you can specify an Availability Zone or Availability Zone group when placing a SpotInstances request, the Spot Price does not vary by Availability Zone.
Note
Our policy is to provide filters for all "describe" calls so you can limit the results to your specifiedcriteria. Therefore, you can use filters to limit the results when describing Spot Price histories,even though you can use the regular request parameters to do something similar.
For example, you could use the regular request parameters or a filter to get the history for a particularinstance type.You can specify multiple request parameters or multiple filters (e.g., limit the results to them2.xlarge instance type, and only for Windows instances).The result includes information for a particularprice history only if it matches all your request parameters or filters. If there's no match, no special messageis returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactlyone character.You can escape special characters using a backslash before the character. For example,a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following table shows the available filters.
DescriptionFilter Name
Type of instance (e.g., m1.small).
Type: String
instance-type
Product description for the Spot Price.
Type: String
Valid Values: Linux/UNIX | Windows
product-description
Spot Price. The value must match exactly (or use wildcards; greater than orless than comparison is not supported).
Type: String
spot-price
Timestamp of the Spot Price history, e.g., 2010-08-16T05:06:11.000Z.Youcan use wildcards (* and ?). Greater than or less than comparison is notsupported.
Type: xsd:dateTime
timestamp
API Version 2010-08-31167
Amazon Elastic Compute Cloud API ReferenceDescribeSpotPriceHistory
Request Parameters
RequiredDescriptionName
NoStart date and time of the Spot Instance price history data.
Type: DateTime
Default: None
StartTime
NoEnd date and time of the Spot Instance price history data.
Type: DateTime
Default: None
EndTime
NoSpecifies the instance type to return.
Type: String
Valid Values: m1.small | m1.large | m1.xlarge |c1.medium | c1.xlarge | m2.xlarge | m2.2xlarge |m2.4xlarge | t1.micro
Default: None
InstanceType.n
NoFilters the results by Linux/UNIX vs. Windows.
Type: String
Valid Values: Linux/UNIX | Windows
Default: Returns both Linux/UNIX and Windows information
ProductDescription.n
NoName of a filter. See the preceding table for a list ofallowed filter names.
Type: String
Default: None
Filter.n.Name
NoA value for the filter. See the preceding table for a list ofallowed values for each filter.
Type: String
Default: None
Filter.n.Value.m
Response Elements
DescriptionName
DescribeSpotPriceHistoryResponse element.
Type: DescribeSpotPriceHistoryResponseType (p. 636)
Ancestor: None
Children: requestId, spotPriceHistorySet
DescribeSpotPriceHistoryResponse
The ID of the request.
Type: xsd:string
Ancestor: DescribeSpotPriceHistoryResponseType
Children: None
requestId
API Version 2010-08-31168
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
DescriptionName
Spot Price history set.
Type: SpotPriceHistorySetType (p. 703)
Ancestor: DescribeSpotPriceHistoryResponseType
Children: item
spotPriceHistorySet
Spot Price history set.
Type: SpotPriceHistorySetItemType (p. 702)
Ancestor: spotPriceHistorySet
Children:instanceType, productDescription, spotPrice, andtimestamp
item
The instance type.
Type: xsd:string
Ancestor: item
Children: None
instanceType
The description of the AMI.
Type: xsd:string
Valid Values: Linux/UNIX | Windows
Ancestor: item
Children: None
productDescription
Specifies the maximum price you will pay to launch one or more SpotInstances.
Type: xsd:string
Ancestor: item
Children: None
spotPrice
Specifies the date and time the request was created.
Type: xsd:dateTime
Ancestor: item
Children: None
timestamp
Examples
Example RequestThis example returns Spot Price history for a particular day in December 2009.
https://ec2.amazonaws.com/?Action=DescribeSpotPriceHistory&StartTime=2009-12-04T00:00:00.000Z&EndTime=2009-12-04T23:59:59.000Z&AuthParams
This request uses filters instead of regular request parameters to achieve the same results.
https://ec2.amazonaws.com/?Action=DescribeSpotPriceHistory&Filter.1.Name=timestamp&Filter.1.Value.1=2009-12-04*&AuthParams
API Version 2010-08-31169
Amazon Elastic Compute Cloud API ReferenceExamples
Example Response<DescribeSpotPriceHistoryResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <spotPriceHistorySet> <item> <instanceType>m1.small</instanceType> <productDescription>Linux/UNIX</productDescription> <spotPrice>0.287</spotPrice> <timestamp>2009-12-04T20:56:05.000Z</timestamp> </item> <item> <instanceType>m1.small</instanceType> <productDescription>Windows</productDescription> <spotPrice>0.033</spotPrice> <timestamp>2009-12-04T22:33:47.000Z</timestamp> </item> </ spotPriceHistorySet></DescribeSpotPriceHistoryResponse>
Related Operations• DescribeSpotInstanceRequests (p. 157)
• RequestSpotInstances (p. 214)
• CancelSpotInstanceRequests (p. 34)
API Version 2010-08-31170
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DescribeTags
DescriptionLists your tags. For more information about tags, go to Using Tags in the Amazon Elastic Compute CloudDeveloper Guide.
You can use filters to limit the results when describing tags. For example, you could get only the tags fora particular resource type.You can specify multiple values for a filter. A tag must match at least one ofthe specified values for it to be included in the results.
You can specify multiple filters (e.g., limit the results to a specific resource type, and get only tags withvalues that contain the string database). The result includes information for a particular tag only if itmatches all your filters. If there's no match, no special message is returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactlyone character.You can escape special characters using a backslash before the character. For example,a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following table shows the available filters.
DescriptionFilter Name
Tag key.
Type: String
key
Resource ID.
Type: String
resource-id
Resource type.
Type: String
Valid Values: customer-gateway | dhcp-options | image | instance |snapshot | spot-instances-request | subnet | volume | vpc |vpn-connection | vpn-gateway
resource-type
Tag value.
Type: String
value
Request Parameters
RequiredDescriptionName
NoName of a filter. See the preceding table for a list ofallowed filter names.
Type: String
Default: None
Filter.n.Name
NoA value for the filter. See the preceding table for a list ofallowed values for each filter.
Type: String
Default: None
Filter.n.Value.m
API Version 2010-08-31171
Amazon Elastic Compute Cloud API ReferenceDescribeTags
Response Elements
DescriptionName
DescribeTagsResponse element.
Type: DescribeTagsResponseType
Ancestor: None
Children: requestId, tagSet
DescribeTagsResponse
The ID of the request.
Type: xsd:string
Ancestor: DescribeTagsResponse
Children: None
requestId
Information about the tags.
Type: TagSetType
Ancestor: DescribeTagsResponse
Children: item
tagSet
Information about one tag.
Type: TagSetItemType
Ancestor: tagSet
Children: resourceId, resourceType, key, value
item
The resource's ID. For example, ami-1a2b3c4d.
Type: String
resourceId
Type of resource.
Type: String
Valid Values: customer-gateway | dhcp-options | image |instance | snapshot | spot-instances-request | subnet |volume | vpc | vpn-connection | vpn-gateway
resourceType
The tag's key.
Type: String
key
The tag's value.
Type: String
value
Examples
Example RequestThis example describes all the tags in your account.
https://ec2.amazonaws.com/?Action=DescribeTags&AuthParams
Sample response:
API Version 2010-08-31172
Amazon Elastic Compute Cloud API ReferenceResponse Elements
<DescribeTagsResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId> <tagSet> <item> <resourceId>ami-1a2b3c4d</resourceId> <resourceType>image</resourceType> <key>webserver</key> <value/> </item> <item> <resourceId>ami-1a2b3c4d</resourceId> <resourceType>image</resourceType> <key>stack</key> <value>Production</value> </item> <item> <resourceId>i-5f4e3d2a</resourceId> <resourceType>instance</resourceType> <key>webserver</key> <value/> </item> <item> <resourceId>i-5f4e3d2a</resourceId> <resourceType>instance</resourceType> <key>stack</key> <value>Production</value> </item> <item> <resourceId>i-12345678</resourceId> <resourceType>instance</resourceType> <key>database_server</key> <value/> </item> <item> <resourceId>i-12345678</resourceId> <resourceType>instance</resourceType> <key>stack</key> <value>Test</value> </item> </tagSet></DescribeTagsResponse>
Example RequestThis example describes only the tags for the AMI with ID ami-1a2b3c4d.
https://ec2.amazonaws.com/?Action=DescribeTags&Filter.1.Name=resource-id&Filter.1.Value.1=ami-1a2b3c4d&AuthParams
Sample response:
<DescribeTagsResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId> <tagSet> <item> <resourceId>ami-1a2b3c4d</resourceId> <resourceType>image</resourceType>
API Version 2010-08-31173
Amazon Elastic Compute Cloud API ReferenceExamples
<key>webserver</key> <value/> </item> <item> <resourceId>ami-1a2b3c4d</resourceId> <resourceType>image</resourceType> <key>stack</key> <value>Production</value> </item> </tagSet></DescribeTagsResponse>
Example RequestThis example describes the tags for all your instances.
https://ec2.amazonaws.com/?Action=DescribeTags&Filter.1.Name=resource-type&Filter.1.Value.1=instance&AuthParams
Sample response:
<DescribeTagsResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId> <tagSet> <item> <resourceId>i-5f4e3d2a</resourceId> <resourceType>instance</resourceType> <key>webserver</key> <value/> </item> <item> <resourceId>i-5f4e3d2a</resourceId> <resourceType>instance</resourceType> <key>stack</key> <value>Production</value> </item> <item> <resourceId>i-12345678</resourceId> <resourceType>instance</resourceType> <key>database_server</key> <value/> </item> <item> <resourceId>i-12345678</resourceId> <resourceType>instance</resourceType> <key>stack</key> <value>Test</value> </item> </tagSet></DescribeTagsResponse>
Example RequestThis example describes the tags for all your instances tagged with the key webserver. Note that you canuse wildcards with filters. So you could specify the value as ?ebserver to find tags with the key webserveror Webserver.
API Version 2010-08-31174
Amazon Elastic Compute Cloud API ReferenceExamples
https://ec2.amazonaws.com/?Action=DescribeTags&Filter.1.Name=key&Filter.1.Value.1=webserver&AuthParams
Sample response:
<DescribeTagsResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId> <tagSet> <item> <resourceId>i-5f4e3d2a</resourceId> <resourceType>instance</resourceType> <key>webserver</key> <value/> </item> </tagSet></DescribeTagsResponse>
Example RequestThis example describes the tags for all your instances tagged with either stack=Test or stack=Production.
https://ec2.amazonaws.com/?Action=DescribeTags&Filter.1.Name=resource-type&Filter.1.Value.1=instance&Filter.2.Name=key&Filter.2.Value.1=stack&Filter.3.Name=value&Filter.3.Value.1=Test&Filter.3.Value.2=Production&AuthParams
Sample response:
<DescribeTagsResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId> <tagSet> <item> <resourceId>i-5f4e3d2a</resourceId> <resourceType>instance</resourceType> <key>stack</key> <value>Production</value> </item> <item> <resourceId>i-12345678</resourceId> <resourceType>instance</resourceType> <key>stack</key> <value>Test</value> </item> </tagSet></DescribeTagsResponse>
Example RequestThis example describes the tags for all your instances tagged with Purpose=[empty string].
https://ec2.amazonaws.com/?Action=DescribeTags&Filter.1.Name=resource-type
API Version 2010-08-31175
Amazon Elastic Compute Cloud API ReferenceExamples
&Filter.1.Value.1=instance&Filter.2.Name=key&Filter.2.Value.1=Purpose&Filter.3.Name=value&Filter.3.Value.1=&AuthParams
Related Operations• CreateTags (p. 52)
• DeleteTags (p. 67)
API Version 2010-08-31176
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DescribeVolumes
DescriptionDescribes your Amazon EBS volumes. For more information about Amazon EBS, go to the AmazonElastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide.
You can filter the results to return information only about volumes that match criteria you specify. Forexample, you could get information about volumes whose status is available.You can specify multiplevalues for a filter (e.g., the volume's status is either available or in-use). A volume must match atleast one of the specified values for it to be included in the results.
You can specify multiple filters (e.g., the volume's status is available, and it is tagged with a particularvalue). The result includes information for a particular volume only if it matches all your filters. If there'sno match, no special message is returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactlyone character.You can escape special characters using a backslash before the character. For example,a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following table shows the available filters.
DescriptionFilter Name
Time stamp when the attachment initiated.
Type: xsd:dateTime
attachement.attach-time
Whether the volume will be deleted on instancetermination.
Type: Boolean
attachment.delete-on-termination
How the volume is exposed to the instance (e.g.,/dev/sda1).
Type: String
attachement.device
ID of the instance the volume is attached to.
Type: String
attachment.instance-id
Attachment state.
Type: String
Valid Values:attaching | attached | detaching| detached
attachment.status
Availability Zone in which the volume was created.
Type: String
availability-zone
Time stamp when the volume was created.
Type: xsd:dateTime
create-time
Size of the volume, in GiB (e.g., 20).
Type: String
size
Snapshot from which the volume was created.
Type: String
snapshot-id
API Version 2010-08-31177
Amazon Elastic Compute Cloud API ReferenceDescribeVolumes
DescriptionFilter Name
Status of the volume.
Type: String
Valid Values: creating | available | in-use |deleting | deleted | error
status
Key of a tag assigned to the resource. This filter isindependent of the tag-value filter. For example,if you use both the filter tag-key=Purpose andthe filter tag-value=X, you get any resourcesassigned both the tag key Purpose (regardless ofwhat the tag's value is), and the tag value X(regardless of what the tag's key is). If you want tolist only resources where Purpose=X, see thetag:key filter later in this table.
For more information about tags, go to Using Tagsin the Amazon Elastic Compute Cloud DeveloperGuide.
Type: String
tag-key
Value of a tag assigned to the resource. This filteris independent of the tag-key filter.
Type: String
tag-value
Filters the results based on a specific tag/valuecombination.
Example: To list just the resources assigned tagPurpose=X, then specify:
Filter.1.Name=tag:Purpose
Filter.1.Value.1=X
Example: To list just resources assigned tagPurpose=X OR Purpose=Y, then specify:
Filter.1.Name=tag:Purpose
Filter.1.Value.1=X
Filter.1.Value.2=Y
tag:key
Volume ID.
Type: String
volume-id
Request Parameters
RequiredDescriptionName
NoThe ID of the volume to list.
Type: String
Default: Describes all volumes that you own, or only thoseotherwise specified.
VolumeId.n
API Version 2010-08-31178
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
RequiredDescriptionName
NoName of a filter. See the preceding table for a list ofallowed filter names.
Type: String
Default: None
Filter.n.Name
NoA value for the filter. See the preceding table for a list ofallowed values for each filter.
Type: String
Default: None
Filter.n.Value.m
Response Elements
DescriptionName
DescribeVolumesResponse element.
Type: DescribeVolumesResponseType (p. 637)
Ancestor: None
Children: requestId, volumeSet
DescribeVolumesResponse
The ID of the request.
Type: xsd:string
Ancestor: DescribeVolumesResponseType
Children: None
requestId
Volume set.
Type: DescribeVolumesSetResponseType (p. 639)
Ancestor: DescribeVolumesResponseType
Children: item
volumeSet
Information for a volume.
Type: DescribeVolumesSetItemResponseType (p. 637)
Ancestor: volumeSet
Children: volumeId, size, snapshotId, availabilityZone,status, createTime, attachmentSet, tagSet
item
The ID of the volume.
Type: xsd:string
Ancestor: item
Children: None
volumeId
The size of the volume, in GiBs.
Type: xsd:string
Ancestor: item
Children: None
size
API Version 2010-08-31179
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Snapshot from which the volume was created (optional).
Type: xsd:string
Ancestor: item
Children: None
snapshotId
Availability Zone in which the volume was created.
Type: xsd:string
Ancestor: item
Children: None
availabilityZone
Volume state.
Type: xsd:string
Valid Values: creating | available | in-use | deleting |deleted | error
Ancestor: item
Children: None
status
Time stamp when volume creation was initiated.
Type: xsd:dateTime
Ancestor: item
Children: None
createTime
Attachment set.
Type: AttachmentSetResponseType (p. 561)
Ancestor: item
Children: item
attachmentSet
Information for a attachment set.
Type: AttachmentSetItemResponseType (p. 560)
Ancestor: attachmentSet
Children:volumeId, instanceId, device, status, attachTime,and deleteOnTermination
item
The ID of the volume.
Type: xsd:string
Ancestor: item
Children: None
volumeId
The ID of the instance.
Type: xsd:string
Ancestor: item
Children: None
instanceId
Specifies how the device is exposed to the instance (e.g., /dev/sdh).
Type: xsd:string
Ancestor: item
Children: None
device
API Version 2010-08-31180
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Attachment state.
Type: xsd:string
Valid Values: attaching | attached | detaching | detached
Ancestor: item
Children: None
status
Time stamp when the attachment initiated.
Type: xsd:dateTime
Ancestor: item
Children: None
attachTime
Specifies whether the Amazon EBS volume is deleted on instancetermination.
Type: xsd:boolean
Ancestor: item
Children: None
deleteOnTermination
Tags assigned to the resource.
Type: ResourceTagSetType
Ancestor: item
Children: item
tagSet
Information about one tag.
Type: ResourceTagSetItemType
Ancestor: tagSet
Children: key, value
item
Tag key.
Type: xsd:string
Ancestor: item
Children: None
key
Tag value.
Type: xsd:string
Ancestor: item
Children: None
value
Examples
Example RequestThis example describes all volumes associated with your account.
https://ec2.amazonaws.com/?Action=DescribeVolumes&AuthParams
API Version 2010-08-31181
Amazon Elastic Compute Cloud API ReferenceExamples
Example Response<DescribeVolumesResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <volumeSet> <item> <volumeId>vol-4282672b</volumeId> <size>80</size> <snapshotId/> <availabilityZone>us-east-1a</availabilityZone> <status>in-use</status> <createTime>2008-05-07T11:51:50.000Z</createTime> <attachmentSet> <item> <volumeId>vol-4282672b</volumeId> <instanceId>i-6058a509</instanceId> <device>/dev/sdh</device> <status>attached</status> <attachTime>2008-05-07T12:51:50.000Z</attachTime> <deleteOnTermination>false</deleteOnTermination> </item> </attachmentSet> <tagSet/> </item> </volumeSet></DescribeVolumesResponse>
Example RequestThis example describes all volumes that are both attached to instance i-1a2b3c4d and also set to deletewhen the instance terminates.
https://ec2.amazonaws.com/?Action=DescribeVolumes&Filter.1.Name=attachment.instance-id&Filter.1.Value.1=i-1a2b3c4d&Filter.2.Name=attachment.delete-on-termination&Filter.2.Value.1=true&AuthParams
Related Operations• CreateVolume (p. 54)
• DeleteVolume (p. 70)
• AttachVolume (p. 19)
• DetachVolume (p. 183)
API Version 2010-08-31182
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DetachVolume
DescriptionDetaches an Amazon EBS volume from an instance. For more information about Amazon EBS, go to theAmazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide.
Important
Make sure to unmount any file systems on the device within your operating system beforedetaching the volume. Failure to unmount file systems, or otherwise properly release the devicefrom use, can result in lost data and will corrupt the file system.
Note
If an Amazon EBS volume is the root device of an instance, it cannot be detached while theinstance is in the ‘running’ state. To detach the root volume, stop the instance first.
Request Parameters
RequiredDescriptionName
YesThe ID of the volume.
Type: String
Default: None
VolumeId
NoThe ID of the instance.
Type: String
Default: None
InstanceId
NoThe device name.
Type: String
Default: None
Device
NoForces detachment if the previous detachment attempt didnot occur cleanly (logging into an instance, unmountingthe volume, and detaching normally).This option can leadto data loss or a corrupted file system. Use this option onlyas a last resort to detach a volume from a failed instance.The instance will not have an opportunity to flush filesystem caches nor file system meta data. If you use thisoption, you must perform file system check and repairprocedures.
Type: Boolean
Default: None
Force
API Version 2010-08-31183
Amazon Elastic Compute Cloud API ReferenceDetachVolume
Response Elements
DescriptionName
DetachVolumeResponseType element.
Type: DetachVolumeResponseType (p. 640)
Ancestor: None
Children: requestId, volumeId, instanceId, device, status,and attachTime
DetachVolumeResponseType
The ID of the request.
Type: xsd:string
Ancestor: DetachVolumeResponseType
Children: None
requestId
The ID of the volume.
Type: xsd:string
Ancestor: DetachVolumeResponseType
Children: None
volumeId
The ID of the instance.
Type: xsd:string
Ancestor: DetachVolumeResponseType
Children: None
instanceId
The device as it is exposed to the instance.
Type: xsd:string
Ancestor: DetachVolumeResponseType
Children: None
device
Attachment state.
Type: xsd:string
Valid Values: attaching | attached | detaching | detached
Ancestor: DetachVolumeResponseType
Children: None
status
Time stamp when the attachment initiated.
Type: xsd:dateTime
Ancestor: DetachVolumeResponseType
Children: None
attachTime
Examples
Example RequestThis example detaches volume vol-4d826724.
https://ec2.amazonaws.com/?Action=DetachVolume&VolumeId=vol-4d826724
API Version 2010-08-31184
Amazon Elastic Compute Cloud API ReferenceResponse Elements
&InstanceId=i-6058a509&AuthParams
Example Response<DetachVolumeResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <volumeId>vol-4d826724</volumeId> <instanceId>i-6058a509</instanceId> <device>/dev/sdh</device> <status>detaching</status> <attachTime>2008-05-08T11:51:50.000Z</attachTime></DetachVolumeResponse>
Related Operations• CreateVolume (p. 54)
• DeleteVolume (p. 70)
• DescribeVolumes (p. 177)
• AttachVolume (p. 19)
API Version 2010-08-31185
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DisassociateAddress
DescriptionDisassociates the specified elastic IP address from the instance to which it is assigned. This is anidempotent operation. If you enter it more than once, Amazon EC2 does not return an error.
Request Parameters
RequiredDescriptionName
YesIP address that you are disassociating from the instance.
Type: String
Default: None
PublicIp
Response Elements
DescriptionName
DisassociateAddressResponseType element.
Type: DisassociateAddressResponseType (p. 642)
Ancestor: None
Children: requestId, return
DisassociateAddressResponseType
The ID of the request.
Type: xsd:string
Ancestor: DisassociateAddressResponseType
Children: None
requestId
Returns true if the IP address is disassociated from the instance.Otherwise, returns an error.
Type: xsd:boolean
Ancestor: DisassociateAddressResponseType
Children: None
return
Examples
Example RequestThis example disassociates the 67.202.55.255 IP address from the instance to which it is assigned.
https://ec2.amazonaws.com/?Action=DisassociateAddress&PublicIp=67.202.55.255&AuthParams
API Version 2010-08-31186
Amazon Elastic Compute Cloud API ReferenceDisassociateAddress
Example Response<DisassociateAddressResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/">
<return>true</return></DisassociateAddressResponse>
Related Operations• AllocateAddress (p. 16)
• DescribeAddresses (p. 74)
• ReleaseAddress (p. 212)
• AssociateAddress (p. 17)
API Version 2010-08-31187
Amazon Elastic Compute Cloud API ReferenceRelated Operations
GetConsoleOutput
DescriptionRetrieves console output for the specified instance.
Instance console output is buffered and posted shortly after instance boot, reboot, and termination.Amazon EC2 preserves the most recent 64 KB output which will be available for at least one hour afterthe most recent post.
Request Parameters
RequiredDescriptionName
YesID of the instance for which you want console output.
Type: String
Default: None
InstanceId
Response Elements
DescriptionName
GetConsoleOutputResponseType element.
Type: GetConsoleOutputResponseType (p. 646)
Ancestor: None
Children: requestId, instanceId, timestamp, and output
GetConsoleOutputResponseType
The ID of the request.
Type: xsd:string
Ancestor: GetConsoleOutputResponseType
Children: None
requestId
The instance ID.
Type: xsd:string
Ancestor: GetConsoleOutputResponseType
Children: None
instanceId
The time the output was last updated.
Type: xsd:dateTime
Ancestor: GetConsoleOutputResponseType
Children: None
timestamp
The console output, Base64 encoded.
Type: xsd:string
Ancestor: GetConsoleOutputResponseType
Children: None
output
API Version 2010-08-31188
Amazon Elastic Compute Cloud API ReferenceGetConsoleOutput
Examples
Example RequestThis example retrieves the console output for the i-10a64379 Linux and UNIX instance.
https://ec2.amazonaws.com/?Action=GetConsoleOutput&InstanceId=i-10a64379&AuthParams
Example Response<GetConsoleOutputResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <instanceId>i-28a64341</instanceId> <timestamp>2007-01-03 15:00:00</timestamp> <output>TGludXggdmVyc2lvbiAyLjYuMTYteGVuVSAoYnVpbGRlckBwYXRjaGJhdC5hb WF6b25zYSkgKGdjYyB2ZXJzaW9uIDQuMC4xIDIwMDUwNzI3IChSZWQgSGF0IDQuMC4xLTUpKSAjMSBTTVAgVGh1IE9jdCAyNiAwODo0MToyNiBTQVNUIDIwMDYKQklPUy1wcm92aWRlZCBwaHlzaWNhbCBSQU0gbWFwOgpYZW46IDAwMDAwMDAwMDAwMDAwMDAgLSAwMDAwMDAwMDZhNDAwMDAwICh1c2FibGUpCjk4ME1CIEhJR0hNRU0gYXZhaWxhYmxlLgo3MjdNQiBMT1dNRU0gYXZhaWxhYmxlLgpOWCAoRXhlY3V0ZSBEaXNhYmxlKSBwcm90ZWN0aW9uOiBhY3RpdmUKSVJRIGxvY2t1cCBkZXRlY3Rpb24gZGlzYWJsZWQKQnVpbHQgMSB6b25lbGlzdHMKS2VybmVsIGNvbW1hbmQgbGluZTogcm9vdD0vZGV2L3NkYTEgcm8gNApFbmFibGluZyBmYXN0IEZQVSBzYXZlIGFuZCByZXN0b3JlLi4uIGRvbmUuCg==</output></GetConsoleOutputResponse>
Related Operations• RunInstances (p. 231)
API Version 2010-08-31189
Amazon Elastic Compute Cloud API ReferenceExamples
GetPasswordData
DescriptionRetrieves the encrypted administrator password for the instances running Windows.
Note
The Windows password is only generated the first time an AMI is launched. It is not generatedfor rebundled AMIs or after the password is changed on an instance.
The password is encrypted using the key pair that you provided.
Request Parameters
RequiredDescriptionName
YesThe ID of the instance for which to get the password.
Type: String
Default: None
InstanceId
Response Elements
DescriptionName
GetPasswordDataResponseType element.
Type: GetPasswordDataResponseType (p. 647)
Ancestor: None
Children: requestId, instanceId, timestamp, andpasswordData
GetPasswordDataResponseType
The ID of the request.
Type: xsd:string
Ancestor: GetPasswordDataResponseType
Children: None
requestId
The ID of the instance.
Type: xsd:string
Ancestor: GetPasswordDataResponseType
Children: None
instanceId
The time the data was last updated.
Type: xsd:dateTime
Ancestor: GetPasswordDataResponseType
Children: None
timestamp
API Version 2010-08-31190
Amazon Elastic Compute Cloud API ReferenceGetPasswordData
DescriptionName
The password of the instance.
Type: xsd:string
Ancestor: GetPasswordDataResponseType
Children: None
passwordData
Examples
Example RequestThis example returns the encrypted version of the administrator password for the i-2574e22a instance.
https://ec2.amazonaws.com/?Action=GetPasswordData&InstanceId=i-10a64379&AuthParams
Example Response<GetPasswordDataResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <instanceId>i-2574e22a</instanceId> <timestamp>2009-10-24 15:00:00</timestamp> <passwordData>TGludXggdmVyc2lvbiAyLjYuMTYteGVuVSAoYnVpbGRlckBwYXRjaGJhdC5hb WF6b25zYSkgKGdj</passwordData></GetPasswordDataResponse>
Related Operations• RunInstances (p. 231)
API Version 2010-08-31191
Amazon Elastic Compute Cloud API ReferenceExamples
ImportKeyPair
DescriptionImports the public key from an RSA key pair that you created with a third-party tool. Compare this withCreateKeyPair, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy ofthe public key). With ImportKeyPair, you create the key pair and give AWS just the public key. Theprivate key is never transferred between you and AWS.
You can easily create an RSA key pair on Windows and Linux using the ssh-keygen command line tool(provided with the standard OpenSSH installation). Standard library support for RSA key pair creation isalso available in Java, Ruby, Python, and many other programming languages.
Supported formats:
• OpenSSH public key format (e.g., the format in ~/.ssh/authorized_keys)
• Base64 encoded DER format
• SSH public key file format as specified in RFC4716
DSA keys are not supported. Make sure your key generator is set up to create RSA keys.
Supported lengths: 1024, 2048, and 4096.
Request Parameters
RequiredDescriptionName
YesA unique name for the key pair.
Type: String
Default: None
Constraints: Accepts alphanumeric characters, spaces,dashes, and underscores.
KeyName
YesThe public key.You must base64 encode the public keymaterial before sending it to AWS.
Type: String
Default: None
PublicKeyMaterial
Response Elements
DescriptionName
ImportKeyPairResponse element.
Type: ImportKeyPairResponse
Ancestor: None
Children: requestId, keyName, keyFingerprint
ImportKeyPairResponse
API Version 2010-08-31192
Amazon Elastic Compute Cloud API ReferenceImportKeyPair
DescriptionName
The ID of the request.
Type: xsd:string
Ancestor: ImportKeyPairResponse
Children: None
requestId
The key pair name you provided.
Type: xsd:string
Ancestor: ImportKeyPairResponse
Children: None
keyName
MD5 public key fingerprint as specified in section 4 of RFC4716.
Type: xsd:string
Ancestor: ImportKeyPairResponse
Children: None
keyFingerprint
Examples
Example RequestThis example uploads the public key for a key pair you name gsg-keypair.
https://ec2.amazonaws.com/?Action=ImportKeyPair&KeyName=gsg-keypair&PublicKeyMaterial=LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tDQpNSUlDZHp DQ0FlQ2dBd0lCQWdJR0FQalRyR3pQTUEwR0NTcUdTSWIzRFFFQkJRVUFNRk14Q3pBSkJnTlZCQVlUDQpBbFZUTVJNd0VRWURWUVFLRXdwQmJXRjZiMjR1WTI5dE1Rd3dDZ1lEVlFRTEV3TkJWMU14SVRBZkJnTlZCQU1UDQpHRUZYVXlCTWFXMXBkR1ZrTFVGemMzVnlZVzVqWlNCRFFUQWVGdzB3T1RBM016RXlNVFEzTXpWYUZ3MHhNREEzDQpNekV5TVRRM016VmFNRkl4Q3pBSkJnTlZCQVlUQWxWVE1STXdFUVlEVlFRS0V3cEJiV0Y2YjI0dVkyOXRNUmN3DQpGUVlEVlFRTEV3NUJWMU10UkdWMlpXeHZjR1Z5Y3pFVk1CTUdBMVVFQXhNTWJUSnViRGhxZW00MWVHUjFNSUdmDQpNQTBHQ1NxR1NJYjNEUUVCQVFVQUE0R05BRENCaVFLQmdRQ1dOazBoQytrcExBRnp2YkFQc3U1TDU5bFMwUnI0DQprZEpaM0RFak1pL0IwV2ZDSzhpS2hWYWt1WitHSnJtNDdMUHZCaFVKWk9IeHVUU0VXakFDNmlybDJzKzlSWXVjDQpFZXg0TjI4ZlpCZGpORlAzdEgwZ2NuWjdIbXZ4aFBrTEtoRTdpZmViNmNGWUhRdHpHRnRPQ0ZQTmdUSE92VDE5DQoyR3lZb1VyU3BDVGFCUUlEQVFBQm8xY3dWVEFPQmdOVkhROEJBZjhFQkFNQ0JhQXdGZ1lEVlIwbEFRSC9CQXd3DQpDZ1lJS3dZQkJRVUhBd0l3REFZRFZSMFRBUUgvQkFJd0FEQWRCZ05WSFE0RUZnUVU1RVNuTUZZUzdyTDNXTUdLDQpqejMxVXZ5TThnMHdEUVlKS29aSWh2Y05BUUVGQlFBRGdZRUFnWjdDZ1lJWHR1WFM1NHVqbU5jOTR0NWRNc3krDQpCM0Z3WVVNdUd4WUI2eGQvSUVWMTFLRVEyZ0hpZUdMU21jUWg4c2JXTTdtKzcrYm9UNmc2U2hLbU1jblkzWkRTDQpWRVFZZ25qcEt1aEZRd2pmaVpTUEc1UG5SVENhdkVqS3lTTUpDVGxpdTdTTjMrR2J3cFU5Uzg3K21GM2tsMGRmDQpZNlIrbEl5SWcrU3ROOTg9DQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tEXAMPLE&AuthParams
Example Response<ImportKeyPairResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId> <keyName>gsg-keypair</keyName> <keyFingerprint> 1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f </keyFingerprint></ImportKeyPairResponse>
API Version 2010-08-31193
Amazon Elastic Compute Cloud API ReferenceExamples
Related Operations• CreateKeyPair (p. 40)
• DescribeKeyPairs (p. 121)
• DeleteKeyPair (p. 58)
API Version 2010-08-31194
Amazon Elastic Compute Cloud API ReferenceRelated Operations
ModifyImageAttribute
DescriptionModifies an attribute of an AMI.
Request Parameters
RequiredDescriptionName
YesThe AMI ID.
Type: String
Default: None
ImageId
YesID of the AWS account you want to give permission to.
Type: String
Default: None
UserId.n
YesName of the group to give permission to. Use this if youwant to make an AMI public or private.The only valid valueis all.
Type: String
Valid Value: all (for all EC2 users)
Default: None
Group.n
NoProduct code. Once you add a product code to an AMI, itcan't be removed.
Type: String
Default: None
ProductCode.n
Specifies the attribute to modify.
Type: String
Valid Values: launchPermission | productCodes
Default: None
Attribute
Specifies the operation to perform on the attribute.
Type: String
Valid Values: add | remove
Default: None
OperationType
Response Elements
DescriptionName
ModifyImageAttributeResponseType element.
Type: ModifyImageAttributeResponseType (p. 662)
Ancestor: None
Children: requestId, return
ModifyImageAttributeResponseType
API Version 2010-08-31195
Amazon Elastic Compute Cloud API ReferenceModifyImageAttribute
DescriptionName
The ID of the request.
Type: xsd:string
Ancestor: ModifyImageAttributeResponseType
Children: None
requestId
Returns true if successful. Otherwise, returns an error.
Type: xsd:boolean
Ancestor: ModifyImageAttributeResponseType
Children: None
return
Examples
Example RequestThis example makes the AMI public (i.e., so any AWS account can launch it).
https://ec2.amazonaws.com/?Action=ModifyImageAttribute&ImageId=ami-61a54008&Attribute=launchPermission&OperationType=add&Group.1=all&AuthParams
Example RequestThis example makes the AMI private (i.e., so only you as the owner can launch it).
https://ec2.amazonaws.com/?Action=ModifyImageAttribute&ImageId=ami-61a54008&Attribute=launchPermission&OperationType=remove&Group.1=all&AuthParams
Example RequestThis example grants launch permission to the AWS account with ID 111122223333.
https://ec2.amazonaws.com/?Action=ModifyImageAttribute&ImageId=ami-61a54008&Attribute=launchPermission&OperationType=add&UserId.1=111122223333&AuthParams
Example RequestThis example removes launch permission from the AWS account with ID 111122223333.
https://ec2.amazonaws.com/?Action=ModifyImageAttribute&ImageId=ami-61a54008&Attribute=launchPermission
API Version 2010-08-31196
Amazon Elastic Compute Cloud API ReferenceExamples
&OperationType=remove&UserId.1=111122223333&AuthParams
Example RequestThis example adds the 774F4FF8 product code to the ami-61a54008 AMI.
https://ec2.amazonaws.com/?Action=ModifyImageAttribute?Action=ModifyImageAttrib ute&ImageId=ami-61a54008&Attribute=productCodes&ProductCode.1=774F4FF8&AuthParams
Example Response<ModifyImageAttributeResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/">
<return>true</return></ModifyImageAttributeResponse>
Related Operations• ResetImageAttribute (p. 222)
• DescribeImageAttribute (p. 86)
API Version 2010-08-31197
Amazon Elastic Compute Cloud API ReferenceRelated Operations
ModifyInstanceAttribute
DescriptionModifies an attribute of an instance.
Request Parameters
RequiredDescriptionName
YesThe ID of the instance.
Type: String
Default: None
InstanceId
NoSpecifies the attribute to modify.
Type: String
Default: None
Valid values: instanceType | kernel | ramdisk | userData |disableApiTermination | instanceInitiatedShutdownBehavior| rootDevice | blockDeviceMapping
Attribute
NoThe value of the attribute being modified.
Type: String
Default: None
Value
Response Elements
DescriptionName
ModifyInstanceAttributeResponseType element.
Type: ModifyInstanceAttributeResponseType (p. 663)
Ancestor: None
Children: requestId, return
ModifyInstanceAttributeResponseType
The ID of the request.
Type: xsd:string
Ancestor: ModifyInstanceAttributeResponseType
Children: None
requestId
Returns true if successful. Otherwise, returns an error.
Type: xsd:boolean
Ancestor: ModifyInstanceAttributeResponseType
Children: None
return
API Version 2010-08-31198
Amazon Elastic Compute Cloud API ReferenceModifyInstanceAttribute
Examples
Example RequestThis example changed the kernel for the instance.
https://ec2.amazonaws.com/?Action=ModifyInstanceAttribute&InstanceId=i-10a64379&Attribute=kernel&Value=aki-f70657b2&AuthParams
Example Response<ModifyInstanceAttributeResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <return>true</return></ModifyInstanceAttributeResponse>
Related Operations• ResetInstanceAttribute (p. 224)
• DescribeInstanceAttribute (p. 101)
API Version 2010-08-31199
Amazon Elastic Compute Cloud API ReferenceExamples
ModifySnapshotAttribute
DescriptionAdds or remove permission settings for the specified snapshot.
Request Parameters
RequiredDescriptionName
YesThe ID of the snapshot.
Type: String
Default: None
SnapshotId
YesModifies the create volume permissions of the snapshot.
Type: String
Default: None
Attribute=createVolumePermission
NoID of an AWS account that can create volumes from thesnapshot.
Type: String
Default: None
UserId
NoGroup that is allowed to create volumes from the snapshot(currently supports "all").
Type: String
Default: None
UserGroup
YesSpecifies the operation to perform on the attribute.
Type: String
Valid Values: add | remove
Default: None
OperationType
Response Elements
DescriptionName
ModifySnapshotAttributeResponseType element.
Type: ModifySnapshotAttributeResponseType (p. 665)
Ancestor: None
Children: requestId, return
ModifySnapshotAttributeResponseType
The ID of the request.
Type: xsd:string
Ancestor: ModifySnapshotAttributeResponseType
Children: None
requestId
API Version 2010-08-31200
Amazon Elastic Compute Cloud API ReferenceModifySnapshotAttribute
DescriptionName
Returns true if successful. Otherwise, returns an error.
Type: xsd:boolean
Ancestor: ModifySnapshotAttributeResponseType
Children: None
return
Examples
Example RequestThis example makes the snap-78a54011 snapshot public.
https://ec2.amazonaws.com/?Action=ModifySnapshotAttribute&snapshotId=snap-78a54011&Attribute=createVolumePermission&OperationType=add&Group.1=all&UserId.1=495219933132&AuthParams
Example Response<ModifySnapshotAttributeResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <return>true</return></ModifySnapshotAttributeResponse>
Related Operations• DescribeSnapshotAttribute (p. 147)
• DescribeSnapshots (p. 149)
• ResetSnapshotAttribute (p. 226)
• CreateSnapshot (p. 46)
API Version 2010-08-31201
Amazon Elastic Compute Cloud API ReferenceExamples
MonitorInstances
DescriptionEnables monitoring for a running instance. For more information, refer to the Amazon CloudWatchDeveloper Guide.
Request Parameters
RequiredDescriptionName
YesInstance ID.
Type: String
Default: None
InstanceId.n
Response Elements
DescriptionName
MonitorInstancesResponseType element.
Type: MonitorInstancesResponseType (p. 668)
Ancestor: None
Children: requestId, instancesSet
MonitorInstancesResponseType
The ID of the request.
Type: xsd:string
Ancestor: MonitorInstancesResponseType
Children: None
requestId
Monitor instance response set.
Type: MonitorInstancesResponseSetType (p. 667)
Ancestor: MonitorInstancesResponseType
Children: item
instancesSet
Instance Item.
Type: MonitorInstancesResponseSetItemType (p. 666)
Ancestor: instancesSet
Children: instanceId, monitoring
item
Instance ID.
Type: xsd:string
Ancestor: item
Children: None
instanceId
Monitoring information.
Type: InstanceMonitoringStateType (p. 653)
Ancestor: item
Children: state
monitoring
API Version 2010-08-31202
Amazon Elastic Compute Cloud API ReferenceMonitorInstances
DescriptionName
State of monitoring for the instance.
Type: xsd:string
Valid Values: monitoring-enabled (enabled) |monitoring-pending (pending) | monitoring-disabling(disabling) | monitoring-disabled (disabled)
Ancestor: monitoring
Children: None
state
Examples
Example RequestThis example enables monitoring for i-43a4412a and i-23a3397d.
https://ec2.amazonaws.com/?Action=MonitorInstances&InstanceId.1=i-43a4412a&InstanceId.2=i-23a3397d&AuthParams
Example Response<MonitorInstancesResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <instancesSet> <item> <instanceId>i-43a4412a</instanceId> <monitoring> <state>pending</state> </monitoring> </item> <item> <instanceId>i-23a3397d</instanceId> <monitoring> <state>pending</state> </monitoring> </item> </instancesSet></MonitorInstancesResponse>
Related Operations• UnmonitorInstances (p. 254)
• RunInstances (p. 231)
API Version 2010-08-31203
Amazon Elastic Compute Cloud API ReferenceExamples
PurchaseReservedInstancesOffering
DescriptionPurchases a Reserved Instance for use with your account. With Amazon EC2 Reserved Instances, youpurchase the right to launch Amazon EC2 instances for a period of time (without getting insufficientcapacity errors) and pay a lower usage rate for the actual time used. For more information about ReservedInstances, go to the Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute CloudUser Guide.
Request Parameters
RequiredDescriptionName
YesThe offering ID of the Reserved Instance to purchase.
Type: String
Default: None
ReservedInstancesOfferingId.n
NoThe number of Reserved Instances to purchase.
Type: Integer
Default: 1
InstanceCount.n
Response Elements
DescriptionName
PurchaseReservedInstancesOfferingResponseType element.
Type: PurchaseReservedInstancesOfferingResponseType (p. 676)
Ancestor: None
Children: requestId, reservedInstancesId
PurchaseReservedInstancesOfferingResponseType
The ID of the request.
Type: xsd:string
Ancestor:PurchaseReservedInstancesOfferingResponseType
Children: None
requestId
The IDs of the purchased Reserved Instances.
Type: xsd:string
Ancestor:PurchaseReservedInstancesOfferingResponseType
Children: None
reservedInstancesId
Examples
Example RequestThis example purchases Reserved Instances.
API Version 2010-08-31204
Amazon Elastic Compute Cloud API ReferencePurchaseReservedInstancesOffering
https://ec2.amazonaws.com/?Action=PurchaseReservedInstancesOffering&ReservedInstancesOfferingId.1=4b2293b4-5813-4cc8-9ce3-1957fc1dcfc8&InstanceCount.1=2&AuthParams
Example Response<PurchaseReservedInstancesOfferingResponse xmlns="http://ec2.amazon aws.com/doc/2010-08-31/"> <reservedInstancesId>reservation-1001001</reservedInstancesId> </PurchaseReservedInstancesOfferingResponse>
Related Operations• DescribeReservedInstancesOfferings (p. 136)
• DescribeReservedInstances (p. 131)
API Version 2010-08-31205
Amazon Elastic Compute Cloud API ReferenceRelated Operations
RebootInstances
DescriptionRequests a reboot of one or more instances. This operation is asynchronous; it only queues a requestto reboot the specified instance(s). The operation will succeed if the instances are valid and belong toyou. Requests to reboot terminated instances are ignored.
Note
If a Linux/UNIX instance does not cleanly shut down within four minutes, Amazon EC2 will performa hard reboot.
Request Parameters
RequiredDescriptionName
YesOne or more instance IDs.
Type: String
Default: None
InstanceId.n
Response Elements
DescriptionName
RebootInstancesResponseType element.
Type: RebootInstancesResponseType (p. 678)
Ancestor: None
Children: requestId, return
RebootInstancesResponseType
The ID of the request.
Type: xsd:string
Ancestor: RebootInstancesResponseType
Children: None
requestId
Returns true if successful. Otherwise, returns an error.
Type: xsd:boolean
Ancestor: RebootInstancesResponseType
Children: None
return
Examples
Example RequestThis example reboots an instance.
API Version 2010-08-31206
Amazon Elastic Compute Cloud API ReferenceRebootInstances
https://ec2.amazonaws.com/?Action=RebootInstances&AuthParams
Example Response<RebootInstancesResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <return>true</return></RebootInstancesResponse>
Related Operations• RunInstances (p. 231)
API Version 2010-08-31207
Amazon Elastic Compute Cloud API ReferenceRelated Operations
RegisterImage
DescriptionRegisters an AMI with Amazon EC2. Images must be registered before they can be launched. To launchinstances, use the RunInstances operation.
Each AMI is associated with an unique ID which is provided by the Amazon EC2 service through thisoperation. If needed, you can deregister an AMI at any time.
Note
For EBS-backed instances, the CreateImage operation enables you to create and register animage in a single request.You can use the RegisterImage operation to register a snapshot ofan instance backed by Amazon EBS.
Amazon EBS snapshots are not guaranteed to be bootable. For information on creating AMIsbacked by Amazon EBS, go to the Amazon Elastic Compute Cloud Developer Guide or AmazonElastic Compute Cloud User Guide.
Any modifications to an AMI backed by Amazon S3 invalidates this registration. If you makechanges to an image, deregister the previous image and register the new image.
Request Parameters
RequiredDescriptionName
NoFull path to your AMI manifest in Amazon S3 storage.
Type: String
Default: None
ImageLocation
NoA name for your AMI.
Type: String
Default: None
Constraints: 3-128 alphanumeric characters, parenthesis(()), commas (,), slashes (/), dashes (-), or underscores(_)
Name
NoThe description of the AMI.
Type: String
Default: None
Constraints: Up to 255 characters.
Description
NoThe architecture of the image.
Type: String
Valid Values: i386 | x86_64
Default: None
Architecture
NoThe ID of the kernel to select.
Type: String
Default: None
KernelId
API Version 2010-08-31208
Amazon Elastic Compute Cloud API ReferenceRegisterImage
RequiredDescriptionName
NoThe ID of the RAM disk to select. Some kernels requireadditional drivers at launch. Check the kernel requirementsfor information on whether you need to specify a RAMdisk. To find kernel requirements, refer to the ResourceCenter and search for the kernel ID.
Type: String
Default: None
RamdiskId
NoThe root device name (e.g., /dev/sda1).
Type: String
Default: None
RootDeviceName
NoThe device name (e.g., /dev/sdh).
Type: String
Default: None
BlockDeviceMapping.n.DeviceName
NoThe virtual device name.
Type: String
Default: None
BlockDeviceMapping.n.VirtualName
NoThe ID of the snapshot.
Type: String
Default: None
BlockDeviceMapping.n.Ebs.SnapshotId
NoThe size of the volume, in GiBs. Required if you are notcreating a volume from a snapshot.
Type: Integer
Default: None
BlockDeviceMapping.n.Ebs.VolumeSize
NoSpecifies that no device should be mapped.
Type: Boolean
Default: true
BlockDeviceMapping.n.Ebs.NoDevice
NoSpecifies whether the Amazon EBS volume is deleted oninstance termination.
Type: Boolean
Default: true
BlockDeviceMapping.n.Ebs.DeleteOnTermination
Response Elements
DescriptionName
RegisterImageResponseType element.
Type: RegisterImageResponseType (p. 680)
Ancestor: None
Children: requestId, imageId
RegisterImageResponseType
API Version 2010-08-31209
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
The ID of the request.
Type: xsd:string
Ancestor: RegisterImageResponseType
Children: None
requestId
Unique ID of the newly registered machine image.
Type: xsd:string
Ancestor: RegisterImageResponseType
Children: None
imageId
Examples
Example RequestThis example registers the AMI specified in the image.manifest.xml manifest file.
https://ec2.amazonaws.com/?Action=RegisterImage&ImageLocation=mybucket-myimage.manifest.xml&AuthParams
Example Response<RegisterImageResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <imageId>ami-61a54008</imageId></RegisterImageResponse>
Example RequestThis example registers an Amazon EBS snapshot to create an AMI backed by Amazon EBS.
https://ec2.amazonaws.com/?Action=RegisterImage&RootDeviceName=/dev/sda1 &BlockDeviceMapping.1.DeviceName=/dev/sda1 &BlockDeviceMapping.1.Ebs.SnapshotId=snap-6eba6e06 &Name=MyImage&AuthParams
Example Response<RegisterImageResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <imageId>ami-78a54023</imageId></RegisterImageResponse>
Example RequestThis example registers the AMI with an Amazon EBS snapshot as the root device, a separate snapshotas a secondary device, and an empty 100 GiB Amazon EBS volume as a storage device.
https://ec2.amazonaws.com/?Action=RegisterImage&RootDeviceName=/dev/sda1&BlockDeviceMapping.1.DeviceName=/dev/sda1
API Version 2010-08-31210
Amazon Elastic Compute Cloud API ReferenceExamples
&BlockDeviceMapping.1.Ebs.SnapshotId=snap-6eba6e06&BlockDeviceMapping.2.DeviceName=/dev/sdb&BlockDeviceMapping.2.Ebs.SnapshotId=snap-823ea6df&BlockDeviceMapping.3.DeviceName=/dev/sdc&BlockDeviceMapping.3.Ebs.VolumeSize=100&Name=MyImage&AuthParams
Example Response<RegisterImageResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <imageId>ami-78a54043</imageId></RegisterImageResponse>
Related Operations• DescribeImages (p. 91)
• DeregisterImage (p. 72)
API Version 2010-08-31211
Amazon Elastic Compute Cloud API ReferenceRelated Operations
ReleaseAddress
DescriptionReleases an elastic IP address associated with your account.
If you run this operation on an elastic IP address that is already released, the address might be assignedto another account which will cause Amazon EC2 to return an error.
Note
Releasing an IP address automatically disassociates it from any instance with which it isassociated.To disassociate an IP address without releasing it, use the DisassociateAddressoperation.
Important
After releasing an elastic IP address, it is released to the IP address pool and might no longerbe available to your account. Make sure to update your DNS records and any servers or devicesthat communicate with the address.
Request Parameters
RequiredDescriptionName
YesThe IP address that you are releasing from your account.
Type: String
Default: None
PublicIp
Response Elements
DescriptionName
ReleaseAddressResponseType element.
Type: ReleaseAddressResponseType (p. 682)
Ancestor: None
Children: requestId, return
ReleaseAddressResponseType
The ID of the request.
Type: xsd:string
Ancestor: ReleaseAddressResponseType
Children: None
requestId
Returns true if successful. Otherwise, returns an error.
Type: xsd:boolean
Ancestor: ReleaseAddressResponseType
Children: None
return
API Version 2010-08-31212
Amazon Elastic Compute Cloud API ReferenceReleaseAddress
Examples
Example RequestThis example releases an elastic IP address associated with the account.
https://ec2.amazonaws.com/?Action=ReleaseAddress&PublicIp=67.202.55.255&AuthParams
Example Response<ReleaseAddressResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <return>true</return></ReleaseAddressResponse>
Related Operations• AllocateAddress (p. 16)
• DescribeAddresses (p. 74)
• AssociateAddress (p. 17)
• DisassociateAddress (p. 186)
API Version 2010-08-31213
Amazon Elastic Compute Cloud API ReferenceExamples
RequestSpotInstances
DescriptionCreates a Spot Instance request. Spot Instances are instances that Amazon EC2 starts on your behalfwhen the maximum price that you specify exceeds the current Spot Price. Amazon EC2 periodically setsthe Spot Price based on available Spot Instance capacity and current spot instance requests. Forconceptual information about Spot Instances, refer to the Amazon Elastic Compute Cloud DeveloperGuide or Amazon Elastic Compute Cloud User Guide.
Request Parameters
RequiredDescriptionName
YesSpecifies the maximum hourly price for any Spot Instancelaunched to fulfill the request.
Type: String
Default: None
SpotPrice
NoThe maximum number of Spot Instances to launch.
Type: xs:integer
Default: 1
InstanceCount
NoSpecifies the Spot Instance request type.
Type: String
Valid Values: one-time | persistent
Default: one-time
Type
NoStart date of the request. If this is a one-time request, therequest becomes active at this date and time and remainsactive until all instances launch, the request expires, orthe request is canceled. If the request is persistent, therequest becomes active at this date and time and remainsactive until it expires or is canceled.
Type: DateTime
Default: Request is effective independently
ValidFrom
NoEnd date of the request. If this is a one-time request, therequest remains active until all instances launch, therequest is canceled, or this date is reached. If the requestis persistent, it remains active until it is canceled or thisdate and time is reached.
Type: DateTime
Default: Request is effective indefinitely
ValidUntil
NoSpecifies the instance launch group. Launch groups areSpot Instances that launch together and terminate together.
Type: String
Default: Instances are launched and terminated individually
LaunchGroup
API Version 2010-08-31214
Amazon Elastic Compute Cloud API ReferenceRequestSpotInstances
RequiredDescriptionName
NoSpecifies the Availability Zone group. If you specify thesame Availability Zone group for all Spot Instance requests,all Spot Instances are launched in the same AvailabilityZone.
Type: String
Default: Instances are launched in any available AvailabilityZone.
AvailabilityZoneGroup
YesThe AMI ID.
Type: String
Default: None
LaunchSpecification.ImageId
NoThe name of the key pair.
Type: String
Default: None
LaunchSpecificationKeyName
NoName of the security group.
Type: String
Default: None
LaunchSpecification.SecurityGroup.n
NoMIME, Base64-encoded user data.
Type: String
Default: None
LaunchSpecification.UserData
NoDeprecated.
Type: String
Default: None
LaunchSpecification.AddressingType
NoSpecifies the instance type.
Type: String
Valid Values: m1.small | m1.large | m1.xlarge |c1.medium | c1.xlarge | m2.xlarge | m2.2xlarge |m2.4xlarge | t1.micro
Default: m1.small
LaunchSpecification.InstanceType
NoThe ID of the kernel to select.
Type: String
Default: None
LaunchSpecification.KernelId
NoThe ID of the RAM disk to select. Some kernels requireadditional drivers at launch. Check the kernel requirementsfor information on whether you need to specify a RAM diskand search for the kernel ID.
Type: String
Default: None
LaunchSpecification.RamdiskId
NoSpecifies the Amazon VPC subnet ID within which tolaunch the instance(s) for Amazon Virtual Private Cloud.
Type: String
Default: None
LaunchSpecification.SubnetId
API Version 2010-08-31215
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
RequiredDescriptionName
NoSpecifies the placement constraints (Availability Zones)for launching the instances.
Type: String
Default: Amazon EC2 selects an Availability Zone.
LaunchSpecification.Placement.AvailabilityZone
NoDescribes the mapping that defines native device namesto use when exposing virtual devices.
Type: String
Default: None
LaunchSpecification.blockDeviceMapping.n.DeviceName
NoEnables monitoring for the instance.
Type: String
Default: Disabled
LaunchSpecification.Monitoring.Enabled
Response Elements
DescriptionName
RequestSpotInstancesResponseType element.
Type: RequestSpotInstancesResponseType (p. 683)
Ancestor: None
Children: requestId, spotInstanceRequestSet
RequestSpotInstancesResponseType
The ID of the request.
Type: xsd:string
Ancestor: RequestSpotInstancesResponseType
Children: None
requestId
Spot Instance request set.
Type: SpotInstanceRequestSetType (p. 701)
Ancestor: RequestSpotInstancesResponseType
Children: item
spotInstanceRequestSet
Spot Instance request set.
Type: SpotInstanceRequestSetItemType (p. 700)
Ancestor: spotInstanceRequestSet
Children: spotInstanceRequestId, spotPrice, type, state,fault, validFrom, validUntil, launchGroup,availabilityZoneGroup, launchSpecification, instanceId,createTime, and productDescription
item
Specifies the ID of the Spot Instance request.
Type: xsd:string
Ancestor: item
Children: None
spotInstanceRequestId
API Version 2010-08-31216
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Specifies the maximum hourly price for any Spot Instance launchedto fulfill the request.
Type: xsd:string
Ancestor: item
Children: None
spotPrice
Specifies the Spot Instance request type.
Type: xsd:string
Valid Values: one-time | persistent
Ancestor: item
Children: None
type
The state of the Spot Instance request.
Type: xsd:string
Valid Values: active | open | closed | cancelled | failed
Ancestor: item
Children: None
state
Fault codes for the Spot Instance request, if any.
Type: SpotInstanceStateFaultType (p. 702)
Ancestor: item
Children: code, message
fault
Reason code for the Spot Instance state change.
Type: xsd:string
Ancestor: fault
Children: None
code
Message for the Spot Instance state change.
Type: xsd:string
Ancestor: fault
Children: None
message
Start date of the request. If this is a one-time request, the requestbecomes active at this date and time and remains active until allinstances launch, the request expires, or the request is canceled. Ifthe request is persistent, the request becomes active at this date andtime and remains active until it expires or is canceled.
Type: xsd:dateTime
Ancestor: item
Children: None
validFrom
End date of the request. If this is a one-time request, the requestremains active until all instances launch, the request is canceled, orthis date is reached. If the request is persistent, it remains active untilit is canceled or this date and time is reached.
Type: xsd:dateTime
Ancestor: item
Children: None
validUntil
API Version 2010-08-31217
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Specifies the instance launch group. Launch groups are SpotInstances that launch together and terminate together.
Type: xsd:string
Ancestor: item
Children: None
launchGroup
Specifies the Availability Zone group. If you specify the sameAvailability Zone group for all Spot Instance requests, all SpotInstances are launched in the same Availability Zone.
Type: xsd:string
Ancestor: item
Children: None
availabilityZoneGroup
Specifies additional launch instance information.
Type: LaunchSpecificationType (p. 661)
Ancestor: item
Children: imageId, keyName, groupSet, userData,addressingType, instanceType, placement, kernelId,ramdiskId, and subnetId
launchSpecification
The AMI ID.
Type: xsd:string
Ancestor: launchSpecification
Children: None
imageId
The name of the key pair.
Type: xsd:string
Ancestor: launchSpecification
Children: None
keyName
Group set.
Type: GroupSetType (p. 648)
Ancestor: launchSpecification
Children: item
groupSet
Group set item.
Type: GroupItemType (p. 648)
Ancestor: groupSet
Children: groupId
item
Name of the security group.
Type: xsd:string
Ancestor: item
Children: None
groupId
MIME, Base64-encoded user data.
Type: UserDataType (p. 708)
Ancestor: launchSpecification
Children: data
userData
API Version 2010-08-31218
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
MIME, Base64-encoded user data.
Type: xsd:string
Ancestor: userData
Children: None
data
Deprecated.
Type: xsd:string
Ancestor: launchSpecification
Children: None
addressingType
Specifies the instance type.
Type: xsd:string
Valid Values: m1.small | m1.large | m1.xlarge | c1.medium |c1.xlarge | m2.xlarge | m2.2xlarge | m2.4xlarge | t1.micro
Ancestor: launchSpecification
Children: None
instanceType
Placement item.
Type: PlacementRequestType (p. 671)
Ancestor: launchSpecification
Children:
placement
The ID of the kernel to select.
Type: xsd:string
Ancestor: launchSpecification
Children: None
kernelId
The ID of the RAM disk to select. Some kernels require additionaldrivers at launch. Check the kernel requirements for information onwhether you need to specify a RAM disk and search for the kernelID.
Type: xsd:string
Ancestor: launchSpecification
Children: None
ramdiskId
Specifies the Amazon VPC subnet ID within which to launch theinstance(s) for Amazon Virtual Private Cloud.
Type: xsd:string
Ancestor: launchSpecification
Children: None
subnetId
Specifies the instance ID.
Type: xsd:string
Ancestor: item
Children: None
instanceId
API Version 2010-08-31219
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Time stamp when the Spot Instance request was fulfilled.
Type: xsd:dateTime
Ancestor: item
Children: None
createTime
The product description associated with the Spot Instance.
Type: xsd:dateTime
Ancestor: item
Children: None
productDescription
Examples
Example RequestThis example creates a Spot Instances request for ten m1.small instances.
https://ec2.amazonaws.com/?Action=RequestSpotInstances&SpotPrice.1=0.50&InstanceCount.1=10&Type.1=one-time&AvailabilityZoneGroup.1=MyAzGroup&LaunchSpecification.ImageId.1=i-43a4412a&LaunchSpecification.KeyName.1=MyKeypair&LaunchSpecification.GroupSet.1=websrv&LaunchSpecification.InstanceType.1=m1.small&AuthParams
Example Response<RequestSpotInstancesResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/">
<spotInstanceRequestSet> <item> <spotInstanceRequestId>sir-f102a405</spotInstanceRequestId> <spotPrice>0.50</spotPrice> <type>one-time</type> <state>open</state> <fault/> <validFrom/> <validUntil/> <launchGroup/> <availabilityZoneGroup>MyAzGroup</availabilityZoneGroup> <launchSpecification> <imageId> i-43a4412a</imageId> <keyName>MyKeypair</keyName> <groupSet>websrv</groupSet> <instanceType>m1.small</instanceType> </launchSpecification> <instanceId>i-123345678</instanceId> <createTime>2009-10-19T00:00:00+0000</createTime> <productDescription/> </item>
API Version 2010-08-31220
Amazon Elastic Compute Cloud API ReferenceExamples
</spotInstanceRequestSet> </RequestSpotInstancesResponse>
Related Operations• DescribeSpotInstanceRequests (p. 157)
• CancelSpotInstanceRequests (p. 34)
• DescribeSpotPriceHistory (p. 167)
API Version 2010-08-31221
Amazon Elastic Compute Cloud API ReferenceRelated Operations
ResetImageAttribute
DescriptionResets an attribute of an AMI to its default value.
Note
The productCodes attribute cannot be reset.
Request Parameters
RequiredDescriptionName
YesID of the AMI on which the attribute will be reset.
Type: String
Default: None
ImageId
NoDescribes the launch permissions of the AMI.
Type: String
Default: None
Attribute=launchPermission
Response Elements
DescriptionName
ResetImageAttributeResponseType element.
Type: ResetImageAttributeResponseType (p. 686)
Ancestor: None
Children: requestId, return
ResetImageAttributeResponseType
The ID of the request.
Type: xsd:string
Ancestor: ResetImageAttributeResponseType
Children: None
requestId
Indicates whether the attribute successfully reset.
Type: xsd:boolean
Ancestor: ResetImageAttributeResponseType
Children: None
return
Examples
Example RequestThis example resets the launchPermission attribute.
API Version 2010-08-31222
Amazon Elastic Compute Cloud API ReferenceResetImageAttribute
https://ec2.amazonaws.com/?Action=ResetImageAttribute&ImageId=ami-61a54008&Attribute=launchPermission&AuthParams
Example Response<ResetImageAttributeResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/">
<return>true</return></ResetImageAttributeResponse>
Related Operations• ModifyImageAttribute (p. 195)
• DescribeImageAttribute (p. 86)
API Version 2010-08-31223
Amazon Elastic Compute Cloud API ReferenceRelated Operations
ResetInstanceAttribute
DescriptionResets an attribute of an instance to its default value.
Request Parameters
RequiredDescriptionName
YesID of the instance on which the attribute will be reset.
Type: String
Default: None
InstanceId
NoResets the ID of the kernel.
Type: String
Default: None
Attribute=kernel
NoResets the ID of the RAM disk.
Type: String
Default: None
Attribute=ramdisk
Response Elements
DescriptionName
ResetInstanceAttributeResponseType element.
Type: ResetInstanceAttributeResponseType (p. 687)
Ancestor: None
Children: requestId, return
ResetInstanceAttributeResponseType
The ID of the request.
Type: xsd:string
Ancestor: ResetInstanceAttributeResponseType
Children: None
requestId
Indicates whether the attribute successfully reset.
Type: xsd:boolean
Ancestor: ResetInstanceAttributeResponseType
Children: None
return
Examples
Example RequestThis example resets the kernel attribute.
API Version 2010-08-31224
Amazon Elastic Compute Cloud API ReferenceResetInstanceAttribute
https://ec2.amazonaws.com/?Action=ResetInstanceAttribute&InstanceId=i-10a64379&Attribute=kernel&AuthParams
Example Response<ResetInstanceAttributeResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <return>true</return></ResetInstanceAttributeResponse>
Related Operations• ModifyInstanceAttribute (p. 198)
• DescribeInstanceAttribute (p. 101)
API Version 2010-08-31225
Amazon Elastic Compute Cloud API ReferenceRelated Operations
ResetSnapshotAttribute
DescriptionResets permission settings for the specified snapshot.
Request Parameters
RequiredDescriptionName
NoThe ID of the snapshot.
Type: String
Default: None
SnapshotId
YesResets the create volume permissions of the snapshot.
Type: String
Default: None
Attribute=createVolumePermission
Response Elements
DescriptionName
ResetSnapshotAttributeResponseType element.
Type: ResetSnapshotAttributeResponseType (p. 689)
Ancestor: None
Children: requestId, return
ResetSnapshotAttributeResponseType
The ID of the request.
Type: xsd:string
Ancestor: ResetSnapshotAttributeResponseType
Children: None
requestId
Specifies whether the snapshot permissions were reset.
Type: xsd:boolean
Ancestor: ResetSnapshotAttributeResponseType
Children: None
return
Examples
Example RequestThis example resets the permissions for snap-78a54011, making it a private snapshot that can only beused by the account that created it.
https://ec2.amazonaws.com/?Action=ResetSnapshotAttribute&SnapshotId.1=snap-78a54011&Attribute=createVolumePermission&AuthParams
API Version 2010-08-31226
Amazon Elastic Compute Cloud API ReferenceResetSnapshotAttribute
Example Response<ResetSnapshotAttributeResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <return>true</return></ResetSnapshotAttributeResponse>
Related Operations• ModifySnapshotAttribute (p. 200)
• DescribeSnapshotAttribute (p. 147)
• DescribeSnapshots (p. 149)
• CreateSnapshot (p. 46)
API Version 2010-08-31227
Amazon Elastic Compute Cloud API ReferenceRelated Operations
RevokeSecurityGroupIngress
DescriptionRevokes permissions from a security group. The permissions used to revoke must be specified using thesame values used to grant the permissions.
The permission is comprised of the IP protocol (TCP, UDP or ICMP) and the CIDR range or source group.For TCP and UDP, you also specify the source and destination port ranges; for ICMP, you also specifythe ICMP types.You can use -1 as a wildcard for the ICMP type.
Permission changes are quickly propagated to instances within the security group. However, dependingon the number of instances in the group, a small delay might occur.
Request Parameters
RequiredDescriptionName
NoDeprecatedUserId
YesName of the group to modify. The name must be valid,and the group must belong to your account.
Type: String
Default: None
GroupName
YesIP protocol.
Type: String
Valid Values: tcp | udp | icmp
Default: None
IpPermissions.n.IpProtocol
YesStart of port range for the TCP and UDP protocols, or anICMP type number. An ICMP type number of -1 indicatesa wildcard (i.e., any ICMP type number).
Type: Integer
Default: None
IpPermissions.n.FromPort
YesEnd of port range for the TCP and UDP protocols, or anICMP code. An ICMP code of -1 indicates a wildcard (i.e.,any ICMP code).
Type: Integer
Default: None
IpPermissions.n.ToPort
ConditionalAWS account ID that owns the source security group.Cannot be used when specifying a CIDR IP address.
Type: String
Default: None
Condition: Required if giving access to one or more sourcesecurity groups.
IpPermissions.n.Groups.m.UserId
API Version 2010-08-31228
Amazon Elastic Compute Cloud API ReferenceRevokeSecurityGroupIngress
RequiredDescriptionName
ConditionalName of the source security group. Cannot be used whenspecifying a CIDR IP address.
Type: String
Default: None
Condition: Required if giving access to one or more sourcesecurity groups.
IpPermissions.n.Groups.m.GroupName
ConditionalCIDR range. Cannot be used when specifying a sourcesecurity group.
Type: String
Default: None
Constraints: Valid CIDR IP address range.
Condition: Required if giving access to one or more IPaddress ranges.
IpPermissions.n.IpRanges.m.CidrIp
Response Elements
DescriptionName
RevokeSecurityGroupIngressResponseType element.
Type: RevokeSecurityGroupIngressResponseType (p. 690)
Ancestor: None
Children: requestId, return
RevokeSecurityGroupIngressResponseType
The ID of the request.
Type: xsd:string
Ancestor: RevokeSecurityGroupIngressResponseType
Children: None
requestId
Returns true if the request is successful. Otherwise, returns an error.
Type: xsd:boolean
Ancestor: RevokeSecurityGroupIngressResponseType
Children: None
return
Examples
Example RequestThis example revokes TCP port 80 access from the 205.192.0.0/16 address range for the websrv securitygroup.
https://ec2.amazonaws.com/?Action=RevokeSecurityGroupIngress&IpProtocol=tcp&FromPort=80&ToPort=80&CidrIp=205.192.0.0/16&AuthParams
API Version 2010-08-31229
Amazon Elastic Compute Cloud API ReferenceResponse Elements
Example Response<RevokeSecurityGroupIngressResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <return>true</return></RevokeSecurityGroupIngressResponse>
Related Operations• CreateSecurityGroup (p. 44)
• DescribeSecurityGroups (p. 141)
• AuthorizeSecurityGroupIngress (p. 22)
• DeleteSecurityGroup (p. 61)
API Version 2010-08-31230
Amazon Elastic Compute Cloud API ReferenceRelated Operations
RunInstances
DescriptionLaunches a specified number of instances of an AMI for which you have permissions.
If Amazon EC2 cannot launch the minimum number of instances you request, no instances will belaunched. If there is insufficient capacity to launch the maximum number of instances you request, AmazonEC2 launches the minimum number specified and allocates the remaining available instances using roundrobin.
Note
Every instance is launched in a security group (created using the CreateSecurityGroupoperation). If no security group is specified in the RunInstances request, the "default" securitygroup will be used.
For Linux instances, you can provide an optional key pair ID in the launch request (created using theCreateKeyPair operation). The instances will have access to the public key at boot.You can use thiskey to provide secure access to an instance of an image on a per-instance basis. Amazon EC2 publicimages use this feature to provide secure access without passwords.
Important
Launching public images without a key pair ID will leave them inaccessible.
The public key material is made available to the instance at boot time by placing it in the openssh_id.pubfile on a logical device that is exposed to the instance as /dev/sda2 (the instance store). The format ofthis file is suitable for use as an entry within ~/.ssh/authorized_keys (the OpenSSH format). Thiscan be done at boot (e.g., as part of rc.local) allowing for secure access without passwords.
Optional user data can be provided in the launch request. All instances that collectively comprise thelaunch request have access to this data. For more information, go to the Amazon Elastic Compute CloudDeveloper Guide or Amazon Elastic Compute Cloud User Guide.
Note
If any of the AMIs have a product code attached for which the user has not subscribed, theRunInstances call will fail.
Request Parameters
RequiredDescriptionName
YesUnique ID of a machine image, returned by a call toDescribeImages.
Type: String
Default: None
ImageId
API Version 2010-08-31231
Amazon Elastic Compute Cloud API ReferenceRunInstances
RequiredDescriptionName
YesMinimum number of instances to launch. If the value ismore than Amazon EC2 can launch, no instances arelaunched at all.
Type: Integer
Default: None
Constraints: Between 1 and the maximum number allowedfor your account (default: 20).
MinCount
YesMaximum number of instances to launch. If the value ismore than Amazon EC2 can launch, the largest possiblenumber above minCount will be launched instead.
Type: Integer
Default: None
Constraints: Between 1 and the maximum number allowedfor your account (default: 20).
MaxCount
NoThe name of the key pair.
Type: String
Default: None
KeyName
NoName of the security group.
Type: String
Default: None
SecurityGroup.n
NoThis parameter is deprecated.
Type: String
Default: None
AddressingType
NoSpecifies the instance type.
Type: String
Valid Values: m1.small | m1.large | m1.xlarge |c1.medium | c1.xlarge | m2.xlarge | m2.2xlarge |m2.4xlarge | cc1.4xlarge | t1.micro
Default: m1.small
InstanceType
NoThe ID of the kernel with which to launch the instance.
Type: String
Default: None
KernelId
NoThe ID of the RAM disk to select. Some kernels requireadditional drivers at launch. Check the kernel requirementsfor information on whether you need to specify a RAMdisk. To find kernel requirements, refer to the ResourceCenter and search for the kernel ID.
Type: String
Default: None
RamdiskId
NoThe device name (e.g., /dev/sdh).
Type: String
Default: None
BlockDeviceMapping.n.DeviceName
API Version 2010-08-31232
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
RequiredDescriptionName
NoThe virtual device name.
Type: String
Default: None
BlockDeviceMapping.n.VirtualName
NoThe ID of the snapshot.
Type: String
Default: None
BlockDeviceMapping.n.Ebs.SnapshotId
NoThe size of the volume, in GiBs. Required if you are notcreating a volume from a snapshot.
Type: Integer
Default: None
BlockDeviceMapping.n.Ebs.VolumeSize
NoSpecifies that no device should be mapped.
Type: Boolean
Default: true
BlockDeviceMapping.n.Ebs.NoDevice
NoSpecifies whether the Amazon EBS volume is deleted oninstance termination.
Type: Boolean
Default: true
BlockDeviceMapping.n.Ebs.DeleteOnTermination
NoEnables monitoring for the instance.
Type: Boolean
Default: Disabled
Monitoring.Enabled
NoIf you're using Amazon Virtual Private Cloud, this specifiesthe ID of the subnet you want to launch the instance into.
Type: String
Default: None
SubnetId
NoIf you're using Amazon Virtual Private Cloud, you canoptionally use this parameter to assign the instance aspecific available IP address from the subnet (e.g.,10.0.0.25).
Type: String
Default: Amazon VPC selects an IP address from thesubnet for the instance
PrivateIpAddress
NoSpecifies whether the instance can be terminated usingthe APIs.You must modify this attribute using theec2-modify-instance command before you can terminateany "locked" instances via the APIs.
Type: Boolean
Default: true
DisableApiTermination
NoDetermines whether the instance stops or terminates oninstance-initiated shutdown.
Type: String
Valid Values: stop | terminate
Default: stop
InstanceInitiatedShutdownBehavior
API Version 2010-08-31233
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
RequiredDescriptionName
NoSpecifies the name of an existing placement group youwant to launch the instance into (for cluster computeinstances).
Type: xsd:string
Default: None
Placement.GroupName
NoUnique, case-sensitive identifier you provide to ensureidempotency of the request. For more information, go toHow to Ensure Idempotency in the Amazon ElasticCompute Cloud Developer Guide.
Type: String
Default: None
Constraints: Maximum 64 ASCII characters
ClientToken
Response Elements
DescriptionName
RunInstancesResponse element.
Type: RunInstancesResponseType (p. 692)
Ancestor: None
Children: requestId, reservationId, ownerId, groupSet,instancesSet, and requesterId
RunInstancesResponse
The ID of the request.
Type: xsd:string
Ancestor: RunInstancesResponseType
Children: None
requestId
Unique ID of the reservation.
Type: xsd:string
Ancestor: RunInstancesResponseType
Children: None
reservationId
ID of the AWS account that owns the reservation.
Type: xsd:string
Ancestor: RunInstancesResponseType
Children: None
ownerId
Security group set.
Type: GroupSetType (p. 648)
Ancestor: RunInstancesResponseType
Children: item
groupSet
Group set item.
Type: GroupItemType (p. 648)
Ancestor: groupSet
Children: groupId
item
API Version 2010-08-31234
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Name of the security group.
Type: xsd:string
Ancestor: item
Children: None
groupId
Instance set.
Type: RunningInstancesSetType (p. 696)
Ancestor: item
Children: item
instancesSet
Running instance set item.
Type: RunningInstancesItemType (p. 694)
Ancestor: instancesSet
Children: instanceId, imageId, instanceState,privateDnsName, dnsName, reason, keyName, amiLaunchIndex,productCodes, instanceType, launchTime, placement,kernelId, ramdiskId, platform, monitoring, subnetId,vpcId, privateIpAddress, ipAddress, stateReason,architecture, rootDeviceType, rootDeviceName,blockDeviceMapping, instanceLifecycle,spotInstanceRequestId, virtualizationType, clientToken,tagSet
item
Unique ID of the instance launched.
Type: xsd:string
Ancestor: item
Children: None
instanceId
Image ID of the AMI used to launch the instance.
Type: xsd:string
Ancestor: item
Children: None
imageId
The current state of the instance.
Type: InstanceStateType (p. 655)
Ancestor: item
Children: code, name
instanceState
A 16-bit unsigned integer. The high byte is an opaque internal valueand should be ignored. The low byte is set based on the staterepresented:
Type: xsd:int
Valid Values: 0 (pending) | 16 (running) | 32(shutting-down) | 48 (terminated) | 64 (stopping) | 80(stopped)
Ancestor: instanceState
Children: None
code
API Version 2010-08-31235
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
The current state of the instance.
Type: xsd:string
Valid Values: pending | running | shutting-down | terminated| stopping | stopped
Ancestor: instanceState
Children: None
name
The private DNS name assigned to the instance. This DNS namecan only be used inside the Amazon EC2 network. This elementremains empty until the instance enters a running state.
Type: xsd:string
Ancestor: item
Children: None
privateDnsName
The public DNS name assigned to the instance. This DNS name iscontactable from outside the Amazon EC2 network. This elementremains empty until the instance enters a running state.
Type: xsd:string
Ancestor: item
Children: None
dnsName
Reason for the most recent state transition. This might be an emptystring.
Type: xsd:string
Ancestor: item
Children: None
reason
If this instance was launched with an associated key pair, this displaysthe key pair name.
Type: xsd:string
Ancestor: item
Children: None
keyName
The AMI launch index, which can be used to find this instance withinthe launch group.
Type: xsd:string
Ancestor: item
Children: None
amiLaunchIndex
Amazon DevPay product codes attached to this instance.
Type: ProductCodesSetType (p. 674)
Ancestor: item
Children: item
productCodes
Information for one product code.
Type: ProductCodesSetItemType (p. 674)
Ancestor: productCodes
Children: productCode
item
API Version 2010-08-31236
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
The Amazon DevPay product code associated with the instance.
Type: xsd:string
Ancestor: item
Children: None
productCode
The instance type.
Type: xsd:string
Ancestor: item
Children: None
instanceType
The time the instance launched.
Type: xsd:dateTime
Ancestor: item
Children: None
launchTime
The location where the instance launched.
Type: PlacementResponseType (p. 672)
Ancestor: item
Children: availabilityZone
placement
Returns the Availability Zone of the instance.
Type: xsd:string
Ancestor: placement
Children: None
availabilityZone
The ID of the placement group the instance is in (for cluster computeinstances).
Type: xsd:string
Default: None
Ancestor: placement
Children: None
groupName
The name of the placement group the instance is in (for clustercompute instances).
Type: xsd:string
Default: None
Ancestor: placement
Children: None
groupName
Kernel associated with this instance.
Type: xsd:string
Ancestor: item
Children: None
kernelId
RAM disk associated with this instance.
Type: xsd:string
Ancestor: item
Children: None
ramdiskId
API Version 2010-08-31237
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Platform of the instance (e.g. Windows).
Type: xsd:string
Ancestor: item
Children: None
platform
Indicates whether monitoring is enabled for the instance.
Type: InstanceMonitoringStateType (p. 653)
Ancestor: item
Children: state
monitoring
State of monitoring for the instance.
Type: xsd:string
Valid Values: monitoring-enabled (enabled) |monitoring-pending (pending) | monitoring-disabling(disabling) | monitoring-disabled (disabled)
Ancestor: monitoring
Children: None
state
Specifies the Amazon VPC subnet ID in which the instance is running.
Type: xsd:string
Ancestor: item
Children: None
subnetId
Specifies the Amazon VPC in which the instance is running.
Type: xsd:string
Ancestor: item
Children: None
vpcId
Specifies the private IP address that is assigned to the instance.
Type: xsd:string
Ancestor: item
Children: None
privateIpAddress
Specifies the IP address of the instance.
Type: xsd:string
Ancestor: item
Children: None
ipAddress
The reason for the most recent state transition. SeeStateReasonType (p. 704) for a listing of supported state changecodes.
Type: StateReasonType (p. 704)
Ancestor: item
Children: code, message
stateReason
Reason code for the state change.
Type: xsd:string
Ancestor: stateReason
Children: None
code
API Version 2010-08-31238
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Message for the state change.
Type: xsd:string
Ancestor: stateReason
Children: None
message
The architecture of the image.
Type: xsd:string
Valid Values: i386 | x86_64
Ancestor: item
Children: None
architecture
The root device type used by the AMI. The AMI can use an AmazonEBS or instance store root device.
Type: xsd:string
Valid Values: ebs | instance-store
Ancestor: item
Children: None
rootDeviceType
The root device name (e.g., /dev/sda1).
Type: xsd:string
Ancestor: item
Children: None
rootDeviceName
Block device mapping set.
Type: InstanceBlockDeviceMappingResponseType (p. 650)
Ancestor: item
Children: item
blockDeviceMapping
The item element.
Type: InstanceBlockDeviceMappingResponseItemType (p. 650)
Ancestor: blockDeviceMapping
Children: deviceName, ebs
item
Specifies how the device is exposed to the instance (e.g., /dev/sdh).
Type: xsd:string
Ancestor: item
Children: None
deviceName
Specifies parameters used to automatically setup Amazon EBSvolumes when the instance is launched.
Type: EbsInstanceBlockDeviceMappingResponseType (p. 644)
Ancestor: item
Children: volumeId, status, attachTime, anddeleteOnTermination
ebs
The ID of the Amazon EBS volume.
Type: xsd:string
Ancestor: ebs
Children: None
volumeId
API Version 2010-08-31239
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Attachment state.
Type: xsd:string
Valid Values: attaching | attached | detaching | detached
Ancestor: ebs
Children: None
status
Time stamp when the attachment initiated.
Type: xsd:dateTime
Ancestor: ebs
Children: None
attachTime
Specifies whether the Amazon EBS volume is deleted on instancetermination.
Type: xsd:boolean
Ancestor: ebs
Children: None
deleteOnTermination
Indicates the life cycle of the instance.
Type: xsd:string
Valid Values: spot | blank (no value)
Ancestor: item
Children: None
instanceLifecycle
The ID of the Spot Instance request.
Type: xsd:string
Ancestor: item
Children: None
spotInstanceRequestId
Specifies the instance's virtualization type.
Type: xsd:string
Valid Values: paravirtual | hvm
Ancestor: item
Children: None
virtualizationType
Idempotency token you provided when you launched the instance.
Type: xsd:string
Ancestor: item
Children: None
clientToken
Tags assigned to the resource.
Type: ResourceTagSetType
Ancestor: item
Children: item
tagSet
Information about one tag.
Type: ResourceTagSetItemType
Ancestor: tagSet
Children: key, value
item
API Version 2010-08-31240
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Tag key.
Type: xsd:string
Ancestor: item
Children: None
key
Tag value.
Type: xsd:string
Ancestor: item
Children: None
value
ID of the requester that launched the instances on your behalf (e.g.,AWS Management Console, Auto Scaling).
Type: xsd:string
Ancestor: RunInstancesResponseType
Children: None
requesterId
Examples
Example RequestThis example launches three instances of the ami-60a54009 AMI.
https://ec2.amazonaws.com/?Action=RunInstances&ImageId=ami-60a54009&MaxCount=3&MinCount=1&Placement.AvailabilityZone=us-east-1b&Monitoring.Enabled=true&AuthParams
Example Response<RunInstancesResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <reservationId>r-47a5402e</reservationId> <ownerId>999988887777</ownerId> <groupSet> <item> <groupId>default</groupId> </item> </groupSet> <instancesSet> <item> <instanceId>i-2ba64342</instanceId> <imageId>ami-60a54009</imageId> <instanceState> <code>0</code> <name>pending</name> </instanceState> <privateDnsName></privateDnsName> <dnsName></dnsName> <keyName>example-key-name</keyName> <amiLaunchIndex>0</amiLaunchIndex>
API Version 2010-08-31241
Amazon Elastic Compute Cloud API ReferenceExamples
<instanceType>m1.small</instanceType> <launchTime>2007-08-07T11:51:50.000Z</launchTime> <placement> <availabilityZone>us-east-1b</availabilityZone> </placement> <monitoring> <enabled>true</enabled> </monitoring> <virtualizationType>paravirtual</virtualizationType> </item> <item> <instanceId>i-2bc64242</instanceId> <imageId>ami-60a54009</imageId> <instanceState> <code>0</code> <name>pending</name> </instanceState> <privateDnsName></privateDnsName> <dnsName></dnsName> <keyName>example-key-name</keyName> <amiLaunchIndex>1</amiLaunchIndex> <instanceType>m1.small</instanceType> <launchTime>2007-08-07T11:51:50.000Z</launchTime> <placement> <availabilityZone>us-east-1b</availabilityZone> </placement> <monitoring> <enabled>true</enabled> </monitoring> <virtualizationType>paravirtual</virtualizationType> <item> <instanceId>i-2be64332</instanceId> <imageId>ami-60a54009</imageId> <instanceState> <code>0</code> <name>pending</name> </instanceState> <privateDnsName></privateDnsName> <dnsName></dnsName> <keyName>example-key-name</keyName> <amiLaunchIndex>2</amiLaunchIndex> <instanceType>m1.small</instanceType> <launchTime>2007-08-07T11:51:50.000Z</launchTime> <placement> <availabilityZone>us-east-1b</availabilityZone> </placement> <monitoring> <enabled>true</enabled> </monitoring> <virtualizationType>paravirtual</virtualizationType> </item> </instancesSet></RunInstancesResponse>
Related Operations• DescribeInstances (p. 105)
• StopInstances (p. 247)
API Version 2010-08-31242
Amazon Elastic Compute Cloud API ReferenceRelated Operations
• StartInstances (p. 244)
• TerminateInstances (p. 251)
• AuthorizeSecurityGroupIngress (p. 22)
• RevokeSecurityGroupIngress (p. 228)
• DescribeSecurityGroups (p. 141)
• CreateSecurityGroup (p. 44)
• CreateKeyPair (p. 40)
API Version 2010-08-31243
Amazon Elastic Compute Cloud API ReferenceRelated Operations
StartInstances
DescriptionStarts an instance that uses an Amazon EBS volume as its root device.
Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started.Whenan instance is stopped, the compute resources are released and you are not billed for hourly instanceusage. However, your root partition Amazon EBS volume remains, continues to persist your data, andyou are charged for Amazon EBS volume usage.You can restart your instance at any time.
Note
Before stopping an instance, make sure it is in a state from which it can be restarted. Stoppingan instance does not preserve data stored in RAM.
Performing this operation on an instance that uses an instance store as its root device returnsan error.
Request Parameters
RequiredDescriptionName
YesThe instance ID.
Type: String
Default: None
InstanceId
Response Elements
DescriptionName
StartInstancesResponseType element.
Type: StartInstancesResponseType (p. 703)
Ancestor: None
Children: requestId, instancesSet
StartInstancesResponseType
The ID of the request.
Type: xsd:string
Ancestor: StartInstancesResponseType
Children: None
requestId
Instances set.
Type: InstanceStateChangeSetType (p. 654)
Ancestor: StartInstancesResponseType
Children: item
instancesSet
The item element.
Type: InstanceStateChangeType (p. 654)
Ancestor: instancesSet
Children: instanceId, currentState, and previousState
item
API Version 2010-08-31244
Amazon Elastic Compute Cloud API ReferenceStartInstances
DescriptionName
The instance ID.
Type: xsd:string
Ancestor: item
Children: None
instanceId
The current state of the instance.
Type: InstanceStateType (p. 655)
Ancestor: item
Children: code, name
currentState
A 16-bit unsigned integer. The high byte is an opaque internal valueand should be ignored. The low byte is set based on the staterepresented:
Type: xsd:int
Valid Values: 0 (pending) | 16 (running) | 32(shutting-down) | 48 (terminated) | 64 (stopping) | 80(stopped)
Ancestor: currentState
Children: None
code
The current state of the instance.
Type: xsd:string
Valid Values: pending | running | shutting-down | terminated| stopping | stopped
Ancestor: currentState
Children: None
name
The previous state of the instance.
Type: InstanceStateType (p. 655)
Ancestor: item
Children: code, name
previousState
A 16-bit unsigned integer. The high byte is an opaque internal valueand should be ignored. The low byte is set based on the staterepresented:
Type: xsd:int
Valid Values: 0 (pending) | 16 (running) | 32(shutting-down) | 48 (terminated) | 64 (stopping) | 80(stopped)
Ancestor: previousState
Children: None
code
The current state of the instance.
Type: xsd:string
Valid Values: pending | running | shutting-down | terminated| stopping | stopped
Ancestor: previousState
Children: None
name
API Version 2010-08-31245
Amazon Elastic Compute Cloud API ReferenceResponse Elements
Examples
Example RequestThis example starts the i-10a64379 instance.
https://ec2.amazonaws.com/?Action=StartInstances&InstanceId.1=i-10a64379&AuthParams
Example Response<StartInstancesResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <instancesSet> <item> <instanceId>i-10a64379</instanceId> <currentState> <code>0</code> <name>pending</name> </currentState> <previousState> <code>80</code> <name>stopped</name> </previousState> </item> </instancesSet> </StartInstancesResponse>
Related Operations• StopInstances (p. 247)
• RunInstances (p. 231)
• DescribeInstances (p. 105)
• TerminateInstances (p. 251)
API Version 2010-08-31246
Amazon Elastic Compute Cloud API ReferenceExamples
StopInstances
DescriptionStops an instance that uses an Amazon EBS volume as its root device.
Important
Although Spot Instances can use Amazon EBS-backed AMIs, they don't support Stop/Start. Inother words, you can't stop and start Spot Instances launched from an AMI with an Amazon EBSroot device.
Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started.Whenan instance is stopped, the compute resources are released and you are not billed for hourly instanceusage. However, your root partition Amazon EBS volume remains, continues to persist your data, andyou are charged for Amazon EBS volume usage.You can restart your instance at any time.
Note
Before stopping an instance, make sure it is in a state from which it can be restarted. Stoppingan instance does not preserve data stored in RAM.
Performing this operation on an instance that uses an instance store as its root device returnsan error.
Request Parameters
RequiredDescriptionName
YesThe instance ID.You can stop multiple instances in asingle request.
Type: String
Default: None
InstanceId.n
NoForces the instance to stop. The instance will not have anopportunity to flush file system caches nor file system metadata. If you use this option, you must perform file systemcheck and repair procedures. This option is notrecommended for Windows instances.
Type: Boolean
Default: None
Force
Response Elements
DescriptionName
StopInstancesResponseType element.
Type: StopInstancesResponseType (p. 706)
Ancestor: None
Children: requestId, instancesSet
StopInstancesResponseType
API Version 2010-08-31247
Amazon Elastic Compute Cloud API ReferenceStopInstances
DescriptionName
The ID of the request.
Type: xsd:string
Ancestor: StopInstancesResponseType
Children: None
requestId
Instances set.
Type: InstanceStateChangeSetType (p. 654)
Ancestor: StopInstancesResponseType
Children: item
instancesSet
The item element.
Type: InstanceStateChangeType (p. 654)
Ancestor: instancesSet
Children: instanceId, currentState, and previousState
item
The instance ID.
Type: xsd:string
Ancestor: item
Children: None
instanceId
The current state of the instance.
Type: InstanceStateType (p. 655)
Ancestor: item
Children: code, name
currentState
A 16-bit unsigned integer. The high byte is an opaque internal valueand should be ignored. The low byte is set based on the staterepresented:
Type: xsd:int
Valid Values: 0 (pending) | 16 (running) | 32(shutting-down) | 48 (terminated) | 64 (stopping) | 80(stopped)
Ancestor: currentState
Children: None
code
The current state of the instance.
Type: xsd:string
Valid Values: pending | running | shutting-down | terminated| stopping | stopped
Ancestor: currentState
Children: None
name
The previous state of the instance.
Type: InstanceStateType (p. 655)
Ancestor: item
Children: code, name
previousState
API Version 2010-08-31248
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
A 16-bit unsigned integer. The high byte is an opaque internal valueand should be ignored. The low byte is set based on the staterepresented:
Type: xsd:int
Valid Values: 0 (pending) | 16 (running) | 32(shutting-down) | 48 (terminated) | 64 (stopping) | 80(stopped)
Ancestor: previousState
Children: None
code
The current state of the instance.
Type: xsd:string
Valid Values: pending | running | shutting-down | terminated| stopping | stopped
Ancestor: previousState
Children: None
name
Examples
Example RequestThis example stops the i-10a64379 instance.
https://ec2.amazonaws.com/?Action=StopInstances&InstanceId.1=i-10a64379&Force=false&AuthParams
Example Response<StopInstancesResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <instancesSet> <item> <instanceId>i-10a64379</instanceId> <currentState> <code>64</code> <name>stopping</name> </currentState> <previousState> <code>16</code> <name>running</name> </previousState> </instancesSet> </StopInstancesResponse>
Related Operations• StartInstances (p. 244)
• RunInstances (p. 231)
• DescribeInstances (p. 105)
API Version 2010-08-31249
Amazon Elastic Compute Cloud API ReferenceExamples
• TerminateInstances (p. 251)
API Version 2010-08-31250
Amazon Elastic Compute Cloud API ReferenceRelated Operations
TerminateInstances
DescriptionShuts down one or more instances. This operation is idempotent; if you terminate an instance more thanonce, each call will succeed.
Terminated instances will remain visible after termination (approximately one hour).
Note
By default, Amazon EC2 deletes all Amazon EBS volumes that were attached when the instancelaunched. Amazon EBS volumes attached after instance launch continue running.
Request Parameters
RequiredDescriptionName
YesThe instance ID.
Type: String
Default: None
InstanceId
Response Elements
DescriptionName
TerminateInstancesResponseType element.
Type: TerminateInstancesResponseType (p. 707)
Ancestor: None
Children: requestId, instancesSet
TerminateInstancesResponseType
The ID of the request.
Type: xsd:string
Ancestor: TerminateInstancesResponseType
Children: None
requestId
Instances set.
Type: InstanceStateChangeSetType (p. 654)
Ancestor: TerminateInstancesResponseType
Children: item
instancesSet
The item element.
Type: InstanceStateChangeType (p. 654)
Ancestor: instancesSet
Children: instanceId, currentState, and previousState
item
API Version 2010-08-31251
Amazon Elastic Compute Cloud API ReferenceTerminateInstances
DescriptionName
The instance ID.
Type: xsd:string
Ancestor: item
Children: None
instanceId
The current state of the instance.
Type: InstanceStateType (p. 655)
Ancestor: item
Children: code, name
currentState
A 16-bit unsigned integer. The high byte is an opaque internal valueand should be ignored. The low byte is set based on the staterepresented:
Type: xsd:int
Valid Values: 0 (pending) | 16 (running) | 32(shutting-down) | 48 (terminated) | 64 (stopping) | 80(stopped)
Ancestor: currentState
Children: None
code
The current state of the instance.
Type: xsd:string
Valid Values: pending | running | shutting-down | terminated| stopping | stopped
Ancestor: currentState
Children: None
name
The previous state of the instance.
Type: InstanceStateType (p. 655)
Ancestor: item
Children: code, name
previousState
A 16-bit unsigned integer. The high byte is an opaque internal valueand should be ignored. The low byte is set based on the staterepresented:
Type: xsd:int
Valid Values: 0 (pending) | 16 (running) | 32(shutting-down) | 48 (terminated) | 64 (stopping) | 80(stopped)
Ancestor: previousState
Children: None
code
The current state of the instance.
Type: xsd:string
Valid Values: pending | running | shutting-down | terminated| stopping | stopped
Ancestor: previousState
Children: None
name
API Version 2010-08-31252
Amazon Elastic Compute Cloud API ReferenceResponse Elements
Examples
Example RequestThis example terminates the i-3ea74257 instance.
https://ec2.amazonaws.com/?Action=TerminateInstances&InstanceId.1=i-3ea74257&AuthParams
Example Response<TerminateInstancesResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <instancesSet> <item> <instanceId>i-3ea74257</instanceId> <currentState> <code>32</code> <name>shutting-down</name> </currentState> <previousState> <code>16</code> <name>running</name> </previousState> </item> </instancesSet></TerminateInstancesResponse>
Related Operations• DescribeInstances (p. 105)
• RunInstances (p. 231)
API Version 2010-08-31253
Amazon Elastic Compute Cloud API ReferenceExamples
UnmonitorInstances
DescriptionDisables monitoring for a running instance. For more information, refer to the Amazon CloudWatchDeveloper Guide.
Request Parameters
RequiredDescriptionName
YesInstance ID.
Type: String
Default: None
InstanceId.n
Response Elements
DescriptionName
MonitorInstancesResponseType element.
Type: MonitorInstancesResponseType (p. 668)
Ancestor: None
Children: requestId, instancesSet
MonitorInstancesResponseType
The ID of the request.
Type: xsd:string
Ancestor: MonitorInstancesResponseType
Children: None
requestId
Monitor instance response set.
Type: MonitorInstancesResponseSetType (p. 667)
Ancestor: MonitorInstancesResponseType
Children: item
instancesSet
Instance Item.
Type: MonitorInstancesResponseSetItemType (p. 666)
Ancestor: instancesSet
Children: instanceId, monitoring
item
Instance ID.
Type: xsd:string
Ancestor: item
Children: None
instanceId
Monitoring information.
Type: InstanceMonitoringStateType (p. 653)
Ancestor: item
Children: state
monitoring
API Version 2010-08-31254
Amazon Elastic Compute Cloud API ReferenceUnmonitorInstances
DescriptionName
State of monitoring for the instance.
Type: xsd:string
Valid Values: monitoring-enabled (enabled) |monitoring-pending (pending) | monitoring-disabling(disabling) | monitoring-disabled (disabled)
Ancestor: monitoring
Children: None
state
Examples
Example RequestThis example disables monitoring for i-43a4412a and i-23a3397d.
https://ec2.amazonaws.com/?Action=UnmonitorInstances&InstanceId.1=i-43a4412a&InstanceId.2=i-23a3397d&AuthParams
Example Response<UnmonitorInstancesResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <instancesSet> <item> <instanceId> i-43a4412a</instanceId> <monitoring> <state>pending</state> </monitoring> </item> <item> <instanceId>i-23a3397d</instanceId> <monitoring> <state>pending</state> </monitoring> </item> </instancesSet></UnmonitorInstancesResponse>
Related Operations• MonitorInstances (p. 202)
• RunInstances (p. 231)
API Version 2010-08-31255
Amazon Elastic Compute Cloud API ReferenceExamples
Amazon EC2 SOAP API
Topics
• List of SOAP Operations by Function (p. 258)
• ActivateLicense (p. 261)
• AllocateAddress (p. 262)
• AssociateAddress (p. 264)
• AttachVolume (p. 266)
• AuthorizeSecurityGroupIngress (p. 269)
• BundleInstance (p. 274)
• CancelBundleTask (p. 280)
• CancelSpotInstanceRequests (p. 284)
• ConfirmProductInstance (p. 287)
• CreateImage (p. 289)
• CreateKeyPair (p. 292)
• CreatePlacementGroup (p. 295)
• CreateSecurityGroup (p. 297)
• CreateSnapshot (p. 299)
• CreateSpotDatafeedSubscription (p. 302)
• CreateTags (p. 305)
• CreateVolume (p. 308)
• DeactivateLicense (p. 311)
• DeleteKeyPair (p. 312)
• DeletePlacementGroup (p. 314)
• DeleteSecurityGroup (p. 315)
• DeleteSnapshot (p. 317)
• DeleteSpotDatafeedSubscription (p. 319)
• DeleteTags (p. 321)
• DeleteVolume (p. 325)
• DeregisterImage (p. 327)
• DescribeAddresses (p. 329)
• DescribeAvailabilityZones (p. 333)
• DescribeBundleTasks (p. 337)
API Version 2010-08-31256
Amazon Elastic Compute Cloud API Reference
• DescribeImageAttribute (p. 344)
• DescribeImages (p. 350)
• DescribeInstanceAttribute (p. 362)
• DescribeInstances (p. 367)
• DescribeKeyPairs (p. 384)
• DescribeLicenses (p. 388)
• DescribePlacementGroups (p. 389)
• DescribeRegions (p. 393)
• DescribeReservedInstances (p. 397)
• DescribeReservedInstancesOfferings (p. 404)
• DescribeSecurityGroups (p. 410)
• DescribeSnapshotAttribute (p. 417)
• DescribeSnapshots (p. 420)
• DescribeSpotDatafeedSubscription (p. 428)
• DescribeSpotInstanceRequests (p. 430)
• DescribeSpotPriceHistory (p. 442)
• DescribeTags (p. 447)
• DescribeVolumes (p. 455)
• DetachVolume (p. 462)
• DisassociateAddress (p. 465)
• GetConsoleOutput (p. 467)
• GetPasswordData (p. 469)
• ImportKeyPair (p. 471)
• ModifyImageAttribute (p. 474)
• ModifyInstanceAttribute (p. 479)
• ModifySnapshotAttribute (p. 483)
• MonitorInstances (p. 486)
• PurchaseReservedInstancesOffering (p. 489)
• RebootInstances (p. 491)
• RegisterImage (p. 493)
• ReleaseAddress (p. 498)
• RequestSpotInstances (p. 500)
• ResetImageAttribute (p. 512)
• ResetInstanceAttribute (p. 514)
• ResetSnapshotAttribute (p. 516)
• RevokeSecurityGroupIngress (p. 518)
• RunInstances (p. 522)
• StartInstances (p. 538)
• StopInstances (p. 542)
• TerminateInstances (p. 546)
• UnmonitorInstances (p. 550)
API Version 2010-08-31257
Amazon Elastic Compute Cloud API Reference
List of SOAP Operations by FunctionAmazon DevPay
• ConfirmProductInstance (p. 287)
AMIs
• CreateImage (p. 289)
• DeregisterImage (p. 327)
• DescribeImageAttribute (p. 344)
• DescribeImages (p. 350)
• ModifyImageAttribute (p. 474)
Availability Zones and Regions
• DescribeAvailabilityZones (p. 333)
• DescribeRegions (p. 393)
Elastic Block Store
• AttachVolume (p. 266)
• CreateSnapshot (p. 299)
• CreateVolume (p. 308)
• DeleteSnapshot (p. 317)
• DeleteVolume (p. 325)
• DescribeSnapshotAttribute (p. 417)
• DescribeSnapshots (p. 420)
• DescribeVolumes (p. 455)
• DetachVolume (p. 462)
• ModifySnapshotAttribute (p. 483)
• ResetSnapshotAttribute (p. 516)
Elastic IP Addresses
• AllocateAddress (p. 262)
• AssociateAddress (p. 264)
• DescribeAddresses (p. 329)
• DisassociateAddress (p. 465)
• ReleaseAddress (p. 498)
General
• GetConsoleOutput (p. 467)
API Version 2010-08-31258
Amazon Elastic Compute Cloud API ReferenceList of SOAP Operations by Function
Images
• RegisterImage (p. 493)
• ResetImageAttribute (p. 512)
Instances
• DescribeInstanceAttribute (p. 362)
• DescribeInstances (p. 367)
• ModifyInstanceAttribute (p. 479)
• RebootInstances (p. 491)
• ResetInstanceAttribute (p. 514)
• RunInstances (p. 522)
• StartInstances (p. 538)
• StopInstances (p. 542)
• TerminateInstances (p. 546)
Key Pairs
• CreateKeyPair (p. 292)
• DeleteKeyPair (p. 312)
• DescribeKeyPairs (p. 384)
• ImportKeyPair (p. 471)
Monitoring
• MonitorInstances (p. 486)
• UnmonitorInstances (p. 550)
Placement Groups
• CreatePlacementGroup (p. 295)
• DeletePlacementGroup (p. 314)
• DescribePlacementGroups (p. 389)
Reserved Instances
• DescribeReservedInstances (p. 397)
• DescribeReservedInstancesOfferings (p. 404)
• PurchaseReservedInstancesOffering (p. 489)
Security Groups
• AuthorizeSecurityGroupIngress (p. 269)
• CreateSecurityGroup (p. 297)
API Version 2010-08-31259
Amazon Elastic Compute Cloud API ReferenceList of SOAP Operations by Function
• DeleteSecurityGroup (p. 315)
• DescribeSecurityGroups (p. 410)
• RevokeSecurityGroupIngress (p. 518)
Spot Instances
• CancelSpotInstanceRequests (p. 284)
• CreateSpotDatafeedSubscription (p. 302)
• DeleteSpotDatafeedSubscription (p. 319)
• DescribeSpotDatafeedSubscription (p. 428)
• DescribeSpotInstanceRequests (p. 430)
• DescribeSpotPriceHistory (p. 442)
• RequestSpotInstances (p. 500)
Tags
• CreateTags (p. 305)
• DeleteTags (p. 321)
• DescribeTags (p. 447)
Windows
• BundleInstance (p. 274)
• CancelBundleTask (p. 280)
• DescribeBundleTasks (p. 337)
• GetPasswordData (p. 469)
API Version 2010-08-31260
Amazon Elastic Compute Cloud API ReferenceList of SOAP Operations by Function
ActivateLicenseThis action is for the Microsoft Windows Server License Mobility Pilot for Amazon EC2, which is a pilotprogram offered by Microsoft that allows customers with Microsoft Enterprise Agreements (EA) to migratetheir existing Windows Server licenses to Amazon EC2. If you're interested in the program, go tohttp://aws.amazon.com/ec2/windows-license-mobility-pilot.
API Version 2010-08-31261
Amazon Elastic Compute Cloud API ReferenceActivateLicense
AllocateAddress
DescriptionAcquires an elastic IP address for use with your account.
Request ParametersThe AllocateAddress operation does not have any request parameters.
Response Elements
DescriptionName
AllocateAddressResponseType element.
Type: AllocateAddressResponseType (p. 559)
Ancestor: None
Children: requestId, publicIp
AllocateAddressResponseType
The ID of the request.
Type: xsd:string
Ancestor: AllocateAddressResponseType
Children: None
requestId
IP address for use with your account.
Type: xsd:string
Ancestor: AllocateAddressResponseType
Children: None
publicIp
Examples
Example RequestThis example returns an elastic IP address for use with the account.
<AllocateAddress xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"></AllocateAddress>
Example Response<AllocateAddressResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <publicIp>67.202.55.255</publicIp></AllocateAddressResponse>
Related Operations• DescribeAddresses (p. 329)
• ReleaseAddress (p. 498)
• AssociateAddress (p. 264)
API Version 2010-08-31262
Amazon Elastic Compute Cloud API ReferenceAllocateAddress
• DisassociateAddress (p. 465)
API Version 2010-08-31263
Amazon Elastic Compute Cloud API ReferenceRelated Operations
AssociateAddress
DescriptionAssociates an elastic IP address with an instance. If the IP address is currently assigned to anotherinstance, the IP address is assigned to the new instance. This is an idempotent operation. If you enter itmore than once, Amazon EC2 does not return an error.
Request Parameters
RequiredDescriptionName
AssociateAddressType element.
Type: AssociateAddressType (p. 560)
Ancestor: None
Children: publicIp, instanceId
AssociateAddressType
YesIP address that you are assigning to the instance.
Type: xsd:string
Default: None
Ancestor: AssociateAddressType
Children: None
publicIp
YesThe instance to associate with the IP address.
Type: xsd:string
Default: None
Ancestor: AssociateAddressType
Children: None
instanceId
Response Elements
DescriptionName
AssociateAddressResponseType element.
Type: AssociateAddressResponseType (p. 559)
Ancestor: None
Children: requestId, return
AssociateAddressResponseType
The ID of the request.
Type: xsd:string
Ancestor: AssociateAddressResponseType
Children: None
requestId
Returns true if instance and IP address successfully associated.Otherwise, returns an error.
Type: xsd:boolean
Ancestor: AssociateAddressResponseType
Children: None
return
API Version 2010-08-31264
Amazon Elastic Compute Cloud API ReferenceAssociateAddress
Examples
Example RequestThis example associates an IP address with an instance.
<AssociateAddress xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <instanceId>i-28a64341</instanceId> <publicIp>67.202.55.255</publicIp></AssociateAddress>
Example Response<AssociateAddressResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <return>true</return></AssociateAddressResponse>
Related Operations• AllocateAddress (p. 262)
• DescribeAddresses (p. 329)
• ReleaseAddress (p. 498)
• DisassociateAddress (p. 465)
API Version 2010-08-31265
Amazon Elastic Compute Cloud API ReferenceExamples
AttachVolume
DescriptionAttaches an Amazon EBS volume to a running instance and exposes it as the specified device.
Note
Windows instances currently support devices xvda through xvdp. Devices xvda and xvdb arereserved by the operating system, xvdc is assigned to drive C:\, and, depending on the instancetype, devices xvdd through xvde might be reserved by the instance stores. Any device that is notreserved can be attached to an Amazon EBS volume. For a list of devices that are reserved bythe instance stores, go to the Amazon Elastic Compute Cloud Developer Guide or Amazon ElasticCompute Cloud User Guide.
Request Parameters
RequiredDescriptionName
AttachVolumeType element.
Type: AttachVolumeType (p. 562)
Ancestor: None
Children: volumeId, instanceId, and device
AttachVolumeType
YesThe ID of the Amazon EBS volume. The volume andinstance must be within the same Availability Zone andthe instance must be running.
Type: xsd:string
Default: None
Ancestor: AttachVolumeType
Children: None
volumeId
YesThe ID of the instance to which the volume attaches. Thevolume and instance must be within the same AvailabilityZone and the instance must be running.
Type: xsd:string
Default: None
Ancestor: AttachVolumeType
Children: None
instanceId
YesSpecifies how the device is exposed to the instance (e.g.,/dev/sdh).
Type: xsd:string
Default: None
Ancestor: AttachVolumeType
Children: None
device
API Version 2010-08-31266
Amazon Elastic Compute Cloud API ReferenceAttachVolume
Response Elements
DescriptionName
AttachVolumeResponseType element.
Type: AttachVolumeResponseType (p. 562)
Ancestor: None
Children: requestId, volumeId, instanceId, device, status,and attachTime
AttachVolumeResponseType
The ID of the request.
Type: xsd:string
Ancestor: AttachVolumeResponseType
Children: None
requestId
The ID of the volume.
Type: xsd:string
Ancestor: AttachVolumeResponseType
Children: None
volumeId
The ID of the instance.
Type: xsd:string
Ancestor: AttachVolumeResponseType
Children: None
instanceId
The device as it is exposed to the instance.
Type: xsd:string
Ancestor: AttachVolumeResponseType
Children: None
device
Volume state.
Type: xsd:string
Valid Values: attaching | attached | detaching | detached
Ancestor: AttachVolumeResponseType
Children: None
status
Time stamp when the attachment initiated.
Type: xsd:dateTime
Ancestor: AttachVolumeResponseType
Children: None
attachTime
Examples
Example RequestThis example attaches volume vol-4d826724 to instance i-6058a509 and exposes it as /dev/sdh.For information on standard storage locations, go to the Amazon Elastic Compute Cloud Developer Guideor Amazon Elastic Compute Cloud User Guide.
API Version 2010-08-31267
Amazon Elastic Compute Cloud API ReferenceResponse Elements
<AttachVolume xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <volumeId>vol-4d826724</volumeId> <instanceId>i-6058a509</instanceId> <device>/dev/sdh</device></AttachVolume>
Example Response<AttachVolumeResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <volumeId>vol-4d826724</volumeId> <instanceId>i-6058a509</instanceId> <device>/dev/sdh</device> <status>attaching</status> <attachTime>2008-05-07T11:51:50.000Z</attachTime></AttachVolumeResponse>
Related Operations• CreateVolume (p. 308)
• DeleteVolume (p. 325)
• DescribeVolumes (p. 455)
• DetachVolume (p. 462)
API Version 2010-08-31268
Amazon Elastic Compute Cloud API ReferenceRelated Operations
AuthorizeSecurityGroupIngress
DescriptionAdds a rule to a security group. Specifically, this either gives one or more CIDR IP address rangespermission to access a security group in your account, or gives one or more security groups (called thesource groups) permission to access a security group in your account. A source group can be in yourown AWS account, or another.
The permission is comprised of the IP protocol (TCP, UDP or ICMP) and the CIDR range or source group.For TCP and UDP, you also specify the source and destination port ranges; for ICMP, you also specifythe ICMP types.You can use -1 as a wildcard for the ICMP type.
Permission changes are propagated to instances within the security group as quickly as possible. However,depending on the number of instances, a small delay might occur.
Caution
Adding hundreds of rules to a security group might cause problems when you access the instance.We recommend you condense your rules as much as possible.
Request Parameters
RequiredDescriptionName
AuthorizeSecurityGroupIngressType element.
Type: AuthorizeSecurityGroupIngressType (p. 565)
Ancestor: None
Children: userId, groupName, and ipPermissions
AuthorizeSecurityGroupIngressType
NoDeprecateduserId
YesName of the group to modify. The name must be valid,and the group must belong to your account.
Type: xsd:string
Default: None
Ancestor: AuthorizeSecurityGroupIngressType
Children: None
groupName
YesSet of permissions.
Type: IpPermissionSetType (p. 657)
Ancestor: AuthorizeSecurityGroupIngressType
Children: item
ipPermissions
YesSet of IP permissions.
Type: IpPermissionType (p. 657)
Ancestor: ipPermissions
Children:ipProtocol, fromPort, toPort, groups, andipRanges
item
API Version 2010-08-31269
Amazon Elastic Compute Cloud API ReferenceAuthorizeSecurityGroupIngress
RequiredDescriptionName
YesIP protocol.
Type: xsd:string
Valid Values: tcp | udp | icmp
Default: None
Ancestor: item
Children: None
ipProtocol
YesStart of port range for the TCP and UDP protocols, or anICMP type number. An ICMP type number of -1 indicatesa wildcard (i.e., any ICMP type number).
Type: xsd:int
Default: None
Ancestor: item
Children: None
fromPort
YesEnd of port range for the TCP and UDP protocols, or anICMP code. An ICMP code of -1 indicates a wildcard (i.e.,any ICMP code).
Type: xsd:int
Default: None
Ancestor: item
Children: None
toPort
ConditionalList of source security group and user ID (i.e., AWSaccount ID) pairs.
Type: UserIdGroupPairSetType (p. 708)
Condition: Required if giving access to one or more sourcesecurity groups.
Ancestor: item
Children: item
groups
ConditionalInformation for one security group.
Type: UserIdGroupPairType (p. 709)
Condition: Required if giving access to one or more sourcesecurity groups.
Ancestor: groups
Children: userId, groupName
item
ConditionalAWS account ID that owns the source security group.Cannot be used when specifying a CIDR IP address.
Type: xsd:string
Default: None
Condition: Required if giving access to one or more sourcesecurity groups.
Ancestor: item
Children: None
userId
API Version 2010-08-31270
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
RequiredDescriptionName
ConditionalName of the source security group. Cannot be used whenspecifying a CIDR IP address.
Type: xsd:string
Default: None
Condition: Required if giving access to one or more sourcesecurity groups.
Ancestor: item
Children: None
groupName
ConditionalIP ranges.
Type: IpRangeSetType (p. 659)
Condition: Required if giving access to one or more IPaddress ranges.
Ancestor: item
Children: item
ipRanges
ConditionalInformation for one IP range.
Type: IpRangeItemType (p. 658)
Condition: Required if giving access to one or more IPaddress ranges.
Ancestor: ipRanges
Children: cidrIp
item
ConditionalCIDR range. Cannot be used when specifying a sourcesecurity group.
Type: xsd:string
Default: None
Constraints: Valid CIDR IP address range.
Condition: Required if giving access to one or more IPaddress ranges.
Ancestor: item
Children: None
cidrIp
Response Elements
DescriptionName
AuthorizeSecurityGroupIngressResponseType element.
Type: AuthorizeSecurityGroupIngressResponseType (p. 564)
Ancestor: None
Children: requestId, return
AuthorizeSecurityGroupIngressResponseType
The ID of the request.
Type: xsd:string
Ancestor: AuthorizeSecurityGroupIngressResponseType
Children: None
requestId
API Version 2010-08-31271
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Returns true if request is successful. Otherwise, returns an error.
Type: xsd:boolean
Ancestor: AuthorizeSecurityGroupIngressResponseType
Children: None
return
Examples
Example RequestThis example grants the 205.192.0.0/16 and 205.159.0.0/16 address ranges access to your websrvsecurity group on TCP port 80.
<AuthorizeSecurityGroupIngress xmlns="http://ec2.amazonaws.com/doc/2010-08-31/">
<userId/> <groupName>websrv</groupName> <ipPermissions> <item> <ipProtocol>tcp</ipProtocol> <fromPort>80</fromPort> <toPort>80</toPort> <groups/> <ipRanges> <item> <cidrIp>205.192.0.0/16</cidrIp> </item> <item> <cidrIp>205.159.0.0/16</cidrIp> </item> </ipRanges> </item> </ipPermissions></AuthorizeSecurityGroupIngress>
Example RequestThis example grants TCP port 80 access from the source group called OtherAccountGroup (in AWSaccount 999988887777) to your websrv security group.
<AuthorizeSecurityGroupIngress xmlns="http://ec2.amazonaws.com/doc/2010-08-31/">
<userId/> <groupName>websrv</groupName> <ipPermissions> <item> <ipProtocol>tcp</ipProtocol> <fromPort>80</fromPort> <toPort>80</toPort> <groups> <item> <userId>999988887777</userId> <groupName>OtherAccountGroup</groupName> </item>
API Version 2010-08-31272
Amazon Elastic Compute Cloud API ReferenceExamples
</groups> <ipRanges/> </item> </ipPermissions></AuthorizeSecurityGroupIngress>
Example Response<AuthorizeSecurityGroupIngressResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <return>true</return></AuthorizeSecurityGroupIngressResponse>
Related Operations• CreateSecurityGroup (p. 297)
• DescribeSecurityGroups (p. 410)
• RevokeSecurityGroupIngress (p. 518)
• DeleteSecurityGroup (p. 315)
API Version 2010-08-31273
Amazon Elastic Compute Cloud API ReferenceRelated Operations
BundleInstance
DescriptionBundles an Amazon S3-backed Windows instance.
Note
During bundling, only the root store (C:\) is bundled. Data on other instance stores is not preserved.
This procedure is not applicable for Linux and UNIX instances or Windows instances that useAmazon EBS volumes as their root devices.
Request Parameters
RequiredDescriptionName
BundleInstanceType element.
Type: BundleInstanceType (p. 573)
Ancestor: None
Children: instanceId, storage
BundleInstanceType
YesThe ID of the instance to bundle.
Type: xsd:string
Default: None
Ancestor: BundleInstanceType
Children: None
instanceId
YesAmazon S3 storage locations.
Type: BundleInstanceTaskStorageType (p. 571)
Ancestor: BundleInstanceType
Children: S3
storage
YesAmazon S3 storage location.
Type: BundleInstanceS3StorageType (p. 569)
Ancestor: storage
Children: bucket, prefix, awsAccessKeyId,uploadPolicy, and uploadPolicySignature
S3
YesThe bucket in which to store the AMI.You can specify abucket that you already own or a new bucket that AmazonEC2 creates on your behalf. If you specify a bucket thatbelongs to someone else, Amazon EC2 returns an error.
Type: xsd:string
Default: None
Ancestor: S3
Children: None
bucket
API Version 2010-08-31274
Amazon Elastic Compute Cloud API ReferenceBundleInstance
RequiredDescriptionName
YesSpecifies the beginning of the file name of the AMI.
Type: xsd:string
Default: None
Ancestor: S3
Children: None
prefix
YesThe Access Key ID of the owner of the Amazon S3 bucket.
Type: xsd:string
Default: None
Ancestor: S3
Children: None
awsAccessKeyId
YesA Base64-encoded Amazon S3 upload policy that givesAmazon EC2 permission to upload items into Amazon S3on the user's behalf.
Type: xsd:string
Default: None
Ancestor: S3
Children: None
uploadPolicy
YesThe signature of the Base64 encoded JSON document.
Type: xsd:string
Default: None
Ancestor: S3
Children: None
uploadPolicySignature
JSON ParametersThe upload policy gives Amazon EC2 limited permission to upload items into your Amazon S3 bucket.The following table describes the required parameters for the upload policy JSON document. Parameternames are case sensitive. For more information about upload policies and how to sign them, go to thesections about policy construction and signatures in the Amazon Simple Storage Service DeveloperGuide.
RequiredDescriptionName
YesThe expiration of the policy. We recommend 12 hoursor longer.
expiration
YesA list of restrictions on what can be uploaded toAmazon S3. Must contain the bucket and ACLconditions in this table.
conditions
YesThe bucket to store the AMI.bucket
YesThis must be set to ec2-bundle-read.acl
API Version 2010-08-31275
Amazon Elastic Compute Cloud API ReferenceJSON Parameters
Response Elements
DescriptionName
BundleInstanceResponseType element.
Type: BundleInstanceResponseType (p. 569)
Ancestor: None
Children: requestId, bundleInstanceTask
BundleInstanceResponseType
The ID of the request.
Type: xsd:string
Ancestor: BundleInstanceResponseType
Children: None
requestId
Bundle task.
Type: BundleInstanceTaskType (p. 572)
Ancestor: BundleInstanceResponseType
Children: instanceId, bundleId, state, startTime,updateTime, storage, progress, and error
bundleInstanceTask
Instance associated with this bundle task.
Type: xsd:string
Ancestor: bundleInstanceTask
Children: None
instanceId
Identifier for this task.
Type: xsd:string
Ancestor: bundleInstanceTask
Children: None
bundleId
The state of the task.
Type: xsd:string
Valid Values: pending | waiting-for-shutdown | storing |canceling | complete | failed
Ancestor: bundleInstanceTask
Children: None
state
The time this task started.
Type: xsd:dateTime
Ancestor: bundleInstanceTask
Children: None
startTime
The time of the most recent update for the task.
Type: xsd:dateTime
Ancestor: bundleInstanceTask
Children: None
updateTime
Amazon S3 storage locations.
Type: BundleInstanceTaskStorageType (p. 571)
Ancestor: bundleInstanceTask
Children: S3
storage
API Version 2010-08-31276
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Amazon S3 storage location.
Type: BundleInstanceS3StorageType (p. 569)
Ancestor: storage
Children:bucket, prefix, awsAccessKeyId, uploadPolicy, anduploadPolicySignature
S3
The bucket in which to store the AMI.You can specify a bucket thatyou already own or a new bucket that Amazon EC2 creates on yourbehalf. If you specify a bucket that belongs to someone else, AmazonEC2 returns an error.
Type: xsd:string
Ancestor: S3
Children: None
bucket
Specifies the beginning of the file name of the AMI.
Type: xsd:string
Ancestor: S3
Children: None
prefix
The Access Key ID of the owner of the Amazon S3 bucket.
Type: xsd:string
Ancestor: S3
Children: None
awsAccessKeyId
A Base64-encoded Amazon S3 upload policy that gives AmazonEC2 permission to upload items into Amazon S3 on the user's behalf.
Type: xsd:string
Ancestor: S3
Children: None
uploadPolicy
The signature of the Base64 encoded JSON document.
Type: xsd:string
Ancestor: S3
Children: None
uploadPolicySignature
The level of task completion, in percent (e.g., 20%).
Type: xsd:string
Ancestor: bundleInstanceTask
Children: None
progress
If the task fails, a description of the error.
Type: BundleInstanceTaskErrorType (p. 570)
Ancestor: bundleInstanceTask
Children: code, message
error
Error code.
Type: xsd:string
Ancestor: error
Children: None
code
API Version 2010-08-31277
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Error message.
Type: xsd:string
Ancestor: error
Children: None
message
Examples
Example RequestThis example bundles the i-e468cd8d instance.
<BundleInstance xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <instanceId>i-e468cd8d</instanceId> <storage> <S3> <bucket>my-bucket</bucket> <prefix>winami</prefix> <awsAccessKeyId>10QMXFEV71ZS32XQFTR2</awsAccessKeyId> <uploadPolicy>eyJleHBpcmF0aW9uIjogIjIwMDgtMDgtMzBUMDg6NDk6MDlaIi wiY29uZGl0aW9ucyI6IFt7Im J1Y2tldCI6ICJteS1idWNrZXQifSxbInN0YXJ0cy13aXRoIiwgIiRrZXkiLCAibXktbmV3LWltY WdlIl1dfQ==</uploadPolicy> <uploadPolicySignature>w6BZu2oxGsiiLZnoBmQSErotuMA=</uploadPolicySignature>
</S3> </storage></BundleInstance>
Example Response<BundleInstanceResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <requestId>bun-c1a540a8</requestId> <bundleInstanceTask> <instanceId>i-12345678</instanceId> <bundleId>bun-c1a540a8</bundleId> <state>bundling</state> <startTime>2008-10-07T11:41:50.000Z</startTime> <updateTime>2008-10-07T11:51:50.000Z</updateTime> <progress>70%</progress> <storage> <S3> <bucket>my-bucket</bucket> <prefix>winami</prefix> </S3> </storage> </bundleInstanceTask></BundleInstanceResponse>
Related Operations• CancelBundleTask (p. 280)
• DescribeBundleTasks (p. 337)
API Version 2010-08-31278
Amazon Elastic Compute Cloud API ReferenceExamples
• CreateImage (p. 289)
API Version 2010-08-31279
Amazon Elastic Compute Cloud API ReferenceRelated Operations
CancelBundleTask
DescriptionCancels an Amazon EC2 bundling operation.
Request Parameters
RequiredDescriptionName
CancelBundleTaskType element.
Type: CancelBundleTaskType (p. 574)
Ancestor: None
Children: bundleId
CancelBundleTaskType
YesThe ID of the bundle task to cancel.
Type: xsd:string
Default: None
Ancestor: CancelBundleTaskType
Children: None
bundleId
Response Elements
DescriptionName
CancelBundleTaskResponseType element.
Type: CancelBundleTaskResponseType (p. 574)
Ancestor: None
Children: requestId, bundleInstanceTask
CancelBundleTaskResponseType
The ID of the request.
Type: xsd:string
Ancestor: CancelBundleTaskResponseType
Children: None
requestId
Bundle task to cancel.
Type: BundleInstanceTaskType (p. 572)
Ancestor: CancelBundleTaskResponseType
Children: instanceId, bundleId, state, startTime,updateTime, storage, progress, and error
bundleInstanceTask
Instance associated with this bundle task.
Type: xsd:string
Ancestor: bundleInstanceTask
Children: None
instanceId
API Version 2010-08-31280
Amazon Elastic Compute Cloud API ReferenceCancelBundleTask
DescriptionName
Identifier for this task.
Type: xsd:string
Ancestor: bundleInstanceTask
Children: None
bundleId
The state of the task.
Type: xsd:string
Valid Values: pending | waiting-for-shutdown | storing |canceling | complete | failed
Ancestor: bundleInstanceTask
Children: None
state
The time this task started.
Type: xsd:dateTime
Ancestor: bundleInstanceTask
Children: None
startTime
The time of the most recent update for the task.
Type: xsd:dateTime
Ancestor: bundleInstanceTask
Children: None
updateTime
Amazon S3 storage locations.
Type: BundleInstanceTaskStorageType (p. 571)
Ancestor: bundleInstanceTask
Children: S3
storage
Amazon S3 storage location.
Type: BundleInstanceS3StorageType (p. 569)
Ancestor: storage
Children:bucket, prefix, awsAccessKeyId, uploadPolicy, anduploadPolicySignature
S3
The bucket in which to store the AMI.You can specify a bucket thatyou already own or a new bucket that Amazon EC2 creates on yourbehalf. If you specify a bucket that belongs to someone else, AmazonEC2 returns an error.
Type: xsd:string
Ancestor: S3
Children: None
bucket
Specifies the beginning of the file name of the AMI.
Type: xsd:string
Ancestor: S3
Children: None
prefix
API Version 2010-08-31281
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
The Access Key ID of the owner of the Amazon S3 bucket.
Type: xsd:string
Ancestor: S3
Children: None
awsAccessKeyId
A Base64-encoded Amazon S3 upload policy that gives AmazonEC2 permission to upload items into Amazon S3 on the user's behalf.
Type: xsd:string
Ancestor: S3
Children: None
uploadPolicy
The signature of the Base64 encoded JSON document.
Type: xsd:string
Ancestor: S3
Children: None
uploadPolicySignature
The level of task completion, in percent (e.g., 20%).
Type: xsd:string
Ancestor: bundleInstanceTask
Children: None
progress
If the task fails, a description of the error.
Type: BundleInstanceTaskErrorType (p. 570)
Ancestor: bundleInstanceTask
Children: code, message
error
Error code.
Type: xsd:string
Ancestor: error
Children: None
code
Error message.
Type: xsd:string
Ancestor: error
Children: None
message
Examples
Example RequestThis example cancels the bun-cla322b9 bundle task.
<CancelBundleTask xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <bundleId>bun-cla322b9</bundleId></CancelBundleTask>
API Version 2010-08-31282
Amazon Elastic Compute Cloud API ReferenceExamples
Example Response<CancelBundleTaskResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <bundleInstanceTask> <instanceId>i-12345678</instanceId> <bundleId>bun-cla322b9</bundleId> <state>canceling</state> <startTime>2008-10-07T11:41:50.000Z</startTime> <updateTime>2008-10-07T11:51:50.000Z</updateTime> <progress>20%</progress> <storage> <S3> <bucket>my-bucket</bucket> <prefix>my-new-image</prefix> </S3> </storage> </bundleInstanceTask></CancelBundleTaskResponse>
Related Operations• BundleInstance (p. 274)
• DescribeBundleTasks (p. 337)
API Version 2010-08-31283
Amazon Elastic Compute Cloud API ReferenceRelated Operations
CancelSpotInstanceRequests
DescriptionCancels one or more Spot Instance requests. Spot Instances are instances that Amazon EC2 starts onyour behalf when the maximum price that you specify exceeds the current Spot Price. Amazon EC2periodically sets the Spot Price based on available Spot Instance capacity and current spot instancerequests. For conceptual information about Spot Instances, refer to the Amazon Elastic Compute CloudDeveloper Guide or Amazon Elastic Compute Cloud User Guide.
Important
Canceling a Spot Instance request does not terminate running Spot Instances associated withthe request.
Request Parameters
RequiredDescriptionName
CancelSpotInstanceRequestsType element.
Type: CancelSpotInstanceRequestsType (p. 576)
Ancestor: None
Children: spotInstanceRequestIdSet
CancelSpotInstanceRequestsType
YesSpot Instance requests set.
Type: SpotInstanceRequestIdSetType (p. 699)
Ancestor: CancelSpotInstanceRequestsType
Children: item
spotInstanceRequestIdSet
YesSpot Instance request ID set.
Type: SpotInstanceRequestIdSetItemType (p. 699)
Ancestor: spotInstanceRequestIdSet
Children: spotInstanceRequestId
item
YesSpecifies the ID of the Spot Instance request.
Type: xsd:string
Default: None
Ancestor: item
Children: None
spotInstanceRequestId
Response Elements
DescriptionName
CancelSpotInstanceRequestsResponseType element.
Type: CancelSpotInstanceRequestsResponseType (p. 576)
Ancestor: None
Children: requestId, spotInstanceRequestSet
CancelSpotInstanceRequestsResponseType
API Version 2010-08-31284
Amazon Elastic Compute Cloud API ReferenceCancelSpotInstanceRequests
DescriptionName
The ID of the request.
Type: xsd:string
Ancestor: CancelSpotInstanceRequestsResponseType
Children: None
requestId
Spot Instance requests set.
Type: CancelSpotInstanceRequestsResponseSetType (p. 575)
Ancestor: CancelSpotInstanceRequestsResponseType
Children: item
spotInstanceRequestSet
Cancel Spot Instance requests item.
Type: CancelSpotInstanceRequestsResponseSetItemType (p. 575)
Ancestor: spotInstanceRequestSet
Children: spotInstanceRequestId, state
item
Specifies the ID of the Spot Instance request.
Type: xsd:string
Ancestor: item
Children: None
spotInstanceRequestId
The state of the Spot Instance request.
Type: xsd:string
Valid Values: active | open | closed | cancelled | failed
Ancestor: item
Children: None
state
Examples
Example RequestThis example cancels a Spot Instance request.
<CancelSpotInstanceRequests xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <spotInstanceRequestIdSet> <item> <spotInstanceRequestId>sir-e95fae02</spotInstanceRequestId> </item> </spotInstanceRequestIdSet></CancelSpotInstanceRequests>
Example Response<CancelSpotInstanceRequestsResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <requestId>59dbff89-35bd-4eac-99ed-be587ed81825</requestId> <spotInstanceRequestSet> <item> <spotInstanceRequestId>sir-e95fae02</spotInstanceRequestId> <state>cancelled</state>
API Version 2010-08-31285
Amazon Elastic Compute Cloud API ReferenceExamples
</item> </spotInstanceRequestSet></CancelSpotInstanceRequestsResponse>
Related Operations• DescribeSpotInstanceRequests (p. 430)
• RequestSpotInstances (p. 500)
• DescribeSpotPriceHistory (p. 442)
API Version 2010-08-31286
Amazon Elastic Compute Cloud API ReferenceRelated Operations
ConfirmProductInstance
DescriptionVerifies whether a Amazon DevPay product code is associated with an instance.This can only be executedby the owner of the AMI and is useful when an AMI owner wants to verify whether a user's instance iseligible for support.
Request Parameters
RequiredDescriptionName
ConfirmProductInstanceType element.
Type: ConfirmProductInstanceType (p. 577)
Ancestor: None
Children: productCode, instanceId
ConfirmProductInstanceType
YesThe product code to confirm.
Type: xsd:string
Default: None
Ancestor: ConfirmProductInstanceType
Children: None
productCode
YesThe instance to confirm.
Type: xsd:string
Default: None
Ancestor: ConfirmProductInstanceType
Children: None
instanceId
Response Elements
DescriptionName
ConfirmProductInstanceResponseType element.
Type: ConfirmProductInstanceResponseType (p. 577)
Ancestor: None
Children: requestId, return, and ownerId
ConfirmProductInstanceResponseType
The ID of the request.
Type: xsd:string
Ancestor: ConfirmProductInstanceResponseType
Children: None
requestId
Returns true if the product code is attached to the instance.Otherwise, returns an error.
Type: xsd:boolean
Ancestor: ConfirmProductInstanceResponseType
Children: None
return
API Version 2010-08-31287
Amazon Elastic Compute Cloud API ReferenceConfirmProductInstance
DescriptionName
The instance owner's account ID. Only present if the product codeis attached to the instance.
Type: xsd:string
Ancestor: ConfirmProductInstanceResponseType
Children: None
ownerId
Examples
Example RequestThis example describes the confirms the product code is associated with the instance.
<ConfirmProductInstance xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <productCode>774F4FF8</productCode> <instanceId>i-10a64379</instanceId></ConfirmProductInstance>
Example Response<ConfirmProductInstanceResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <return>true</return> <ownerId>254933287430</ownerId></ConfirmProductInstanceResponse>
Related Operations• DescribeInstances (p. 367)
• RunInstances (p. 522)
API Version 2010-08-31288
Amazon Elastic Compute Cloud API ReferenceExamples
CreateImage
DescriptionCreates an AMI that uses an Amazon EBS root device from a "running" or "stopped" instance.
AMIs that use an Amazon EBS root device boot faster than AMIs that use instance stores. They can beup to 1 TiB in size, use storage that persists on instance failure, and can be stopped and started.
Request Parameters
RequiredDescriptionName
CreateImageType element.
Type: CreateImageType (p. 578)
Ancestor: None
Children: instanceId, name, description, andnoReboot
CreateImageType
YesThe ID of the instance.
Type: xsd:string
Default: None
Ancestor: CreateImageType
Children: None
instanceId
YesThe name of the AMI that was provided during imagecreation.
Type: xsd:string
Default: None
Constraints: 3-128 alphanumeric characters, parenthesis(()), commas (,), slashes (/), dashes (-), or underscores(_)
Ancestor: CreateImageType
Children: None
name
NoThe description of the AMI that was provided during imagecreation.
Type: xsd:string
Default: None
Constraints: Up to 255 characters
Ancestor: CreateImageType
Children: None
description
API Version 2010-08-31289
Amazon Elastic Compute Cloud API ReferenceCreateImage
RequiredDescriptionName
NoBy default this property is set to false, which meansAmazon EC2 attempts to cleanly shut down the instancebefore image creation and reboots the instance afterwards.When set to true, Amazon EC2 does not shut down theinstance before creating the image. When this option isused, file system integrity on the created image cannot beguaranteed.
Type: xsd:boolean
Default: false
Ancestor: CreateImageType
Children: None
noReboot
Response Elements
DescriptionName
CreateImageResponseType element.
Type: CreateImageResponseType (p. 578)
Ancestor: None
Children: requestId, imageId
CreateImageResponseType
The ID of the request.
Type: xsd:string
Ancestor: CreateImageResponseType
Children: None
requestId
The ID of the AMI.
Type: xsd:string
Ancestor: CreateImageResponseType
Children: None
imageId
Examples
Example RequestThis example creates an AMI from the i-10a64379 instance.
<CreateImage xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <instanceId>i-10a64379</instanceId> <name>fedora-v11.01</name> <description>Fedora_v11</description> <noReboot>false</noReboot></CreateImage>
API Version 2010-08-31290
Amazon Elastic Compute Cloud API ReferenceResponse Elements
Example Response<CreateImageResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <ImageId>ami-4fa54026</ImageId></CreateImageResponse>
Related Operations• RunInstances (p. 522)
• DescribeInstances (p. 367)
• TerminateInstances (p. 546)
API Version 2010-08-31291
Amazon Elastic Compute Cloud API ReferenceRelated Operations
CreateKeyPair
DescriptionCreates a new 2048-bit RSA key pair with the specified name. The public key is stored by Amazon EC2and the private key is displayed on the console. The private key is returned as an unencrypted PEMencoded PKCS#8 private key. If a key with the specified name already exists, Amazon EC2 returns anerror.
Tip
The key pair returned to you works only in the Region you're using when you create the key pair.
If you'd like to create a key pair that works in all Regions, see ImportKeyPair (p. 471).
Request Parameters
RequiredDescriptionName
CreateKeyPairType element.
Type: CreateKeyPairType (p. 580)
Ancestor: None
Children: keyName
CreateKeyPairType
YesA unique name for the key pair.
Type: xsd:string
Default: None
Constraints: Accepts alphanumeric characters, spaces,dashes, and underscores.
Ancestor: CreateKeyPairType
Children: None
keyName
Response Elements
DescriptionName
CreateKeyPairResponseType element.
Type: CreateKeyPairResponseType (p. 579)
Ancestor: None
Children: requestId, keyName, keyFingerprint, andkeyMaterial
CreateKeyPairResponseType
The ID of the request.
Type: xsd:string
Ancestor: CreateKeyPairResponseType
Children: None
requestId
API Version 2010-08-31292
Amazon Elastic Compute Cloud API ReferenceCreateKeyPair
DescriptionName
The key pair name provided in the original request.
Type: xsd:string
Ancestor: CreateKeyPairResponseType
Children: None
keyName
A SHA-1 digest of the DER encoded private key.
Type: xsd:string
Ancestor: CreateKeyPairResponseType
Children: None
keyFingerprint
An unencrypted PEM encoded RSA private key.
Type: xsd:string
Ancestor: CreateKeyPairResponseType
Children: None
keyMaterial
Examples
Example RequestThis example creates a key pair named gsg-keypair.
<CreateKeyPair xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <keyName>gsg-keypair</keyName></CreateKeyPair>
Example Response<CreateKeyPairResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <keyName>gsg-keypair</keyName> <keyFinger print>1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f</keyFinger print> <keyMaterial>-----BEGIN RSA PRIVATE KEY-----MIIEoQIBAAKCAQBuLFg5ujHrtm1jnutSuoO8Xe56LlT+HM8v/xkaa39EstM3/aFxTHgElQiJLChpHungXQ29VTc8rc1bW0lkdi23OH5eqkMHGhvEwqa0HWASUMll4o3o/IX+0f2UcPoKCOVUR+jx71Sg5AU52EQfanIn3ZQ8lFW7Edp5a3q4DhjGlUKToHVbicL5E+g45zfB95wIyywWZfeW/UUF3LpGZyq/ebIUlq1qTbHkLbCC2r7RTn8vpQWp47BGVYGtGSBMpTRP5hnbzzuqj3itkiLHjU39S2sJCJ0TrJx5i8BygR4s3mHKBj8l+ePQxG1kGbF6R4yg6sECmXn17MRQVXODNHZbAgMBAAECggEAY1tsiUsIwDl591CXirkYGuVfLyLflXenxfI50mDFms/mumTqloHO7tr0oriHDR5K7wMcY/YY5YkcXNo7mvUVD1pMZNUJs7rw9gZRTrf7LylaJ58kOcyajw8TsC4e4LPbFaHwS1d6K8rXh64o6WgW4SrsB6ICmr1kGQI73wcfgt5ecIu4TZf0OE9IHjn+2eRlsrjBdeORi7KiUNC/pAG23I6MdDOFEQRcCSigCj+4/mciFUSASWS4dMbrpb9FNSIcf9dcLxVM7/6KxgJNfZc9XWzUw77Jg8x92Zd0fVhHOux5IZC+UvSKWB4dyfcItE8C3p9bbU9VGyY5vLCAiIb4qQKBgQDLiO24GXrIkswF32YtBBMuVgLGCwU9h9HlO9mKAc2m8Cm1jUE5IpzRjTedc9I2qiIMUTwtgnw42auSCzbUeYMURPtDqyQ7p6AjMujp9EPemcSVOK9vXYL0PtcoxW9MC0dtV6iPkCN7gOqiZXPRKaFbWADp16p8UAIvS/a5XXk5jwKBgQCKkpHi2EISh1uRkhxljyWCiDCiK6JBRsMvpLbc0v5dKwP5alo1fmdR5PJaV2qvZSj5CYNpMAy1/EDNTY5OSIJU+0KFmQbyhsbmrdLNLDL4+TcnT7c62/aH01ohYaf/VCbRhtLlBfqGoQc7+sAc8vmKkesnF7CqCEKDyF/dhrxYdQKBgC0iZzzNAapayz1+JcVTwwEid6j9JqNXbBc+Z2YwMi+T0Fv/P/hwkX/ypeOXnIUcw0Ih/YtGBVACDQbsz7LcY1HqXiHKYNWNvXgwwO+oiChjxvEkSdsTTIfnK4VSCvU9BxDbQHjdiNDJbL6oar92UN7VrBYvChJZF7LvUH4YmVpHAoGAbZ2X7XvoeEO+uZ58/BGKOIGHByHBDiXtzMhdJr15HTYjxK7OgTZmgK+8zp4L9IbvLGDMJO8vft32XPEWuvI8twCzFH+CsWLQADZMZKSsBasOZ/h1FwhdMgCMcY+Qlzd4JZKjTSu3i7vhvx6RzdSedXEMNTZWN4qlIx3kR5aHcukCgYA9T+Zrvm1F0seQPbLknn7EqhXIjBaT
API Version 2010-08-31293
Amazon Elastic Compute Cloud API ReferenceExamples
P8TTvW/6bdPi23ExzxZn7KOdrfclYRph1LHMpAONv/x2xALIf91UB+v5ohy1oDoasL0gij1houRe2ERKKdwz0ZL9SWq6VTdhr/5G994CK72fy5WhyERbDjUIdHaK3M849JJuf8cSrvSb4g==-----END RSA PRIVATE KEY-----</keyMaterial></CreateKeyPairResponse>
Related Operations• RunInstances (p. 522)
• DescribeKeyPairs (p. 384)
• DeleteKeyPair (p. 312)
API Version 2010-08-31294
Amazon Elastic Compute Cloud API ReferenceRelated Operations
CreatePlacementGroup
DescriptionCreates a placement group that you launch cluster compute instances into.You must give the group aname unique within the scope of your account. For more information about placement groups and clustercompute instances, go to Cluster Compute Instance Concepts in the Amazon Elastic Compute CloudUser Guide.
Request Parameters
RequiredDescriptionName
CreatePlacementGroup element.
Type: CreatePlacementGroupType
Ancestor: None
Children: groupName, strategy
CreatePlacementGroup
YesName of the placement group.
Type: xsd:string
Default: None
Ancestor: CreatePlacementGroup
Children: None
groupName
YesThe placement group strategy.
Type: xsd:string
Valid Values: cluster
Default: None
Ancestor:CreatePlacementGroup
Children: None
strategy
Response Elements
DescriptionName
CreatePlacementGroupResponse element.
Type: CreatePlacementGroupResponseType
Ancestor: None
Children: requestId, return
CreatePlacementGroupResponse
The ID of the request.
Type: xsd:string
Ancestor: CreatePlacementGroupResponse
Children: None
requestId
API Version 2010-08-31295
Amazon Elastic Compute Cloud API ReferenceCreatePlacementGroup
DescriptionName
Returns true if the placement group is created. Otherwise, returnsan error.
Type: xsd:boolean
Ancestor: CreatePlacementGroupResponse
Children: None
return
Examples
Example RequestThis example creates a placement group named XYZ-cluster.
<CreatePlacementGroup xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <groupName>XYZ-cluster</groupName> <strategy>cluster</strategy></CreatePlacementGroup>
Example Response<CreatePlacementGroupResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/">
<requestID>d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE</requestID> <return>true</return></CreatePlacementGroupResponse>
Related Operations• DeletePlacementGroup (p. 314)
• DescribePlacementGroups (p. 389)
API Version 2010-08-31296
Amazon Elastic Compute Cloud API ReferenceExamples
CreateSecurityGroup
DescriptionCreates a new security group. Group names must be unique per account.
Every instance is launched in a security group. If no security group is specified during launch, the instancesare launched in the default security group. Instances within the same security group have unrestrictednetwork access to each other. Instances will reject network access attempts from other instances in adifferent security group. As the owner of instances you can grant or revoke specific permissions usingthe AuthorizeSecurityGroupIngress and RevokeSecurityGroupIngress operations.
Request Parameters
RequiredDescriptionName
CreateSecurityGroupType element.
Type: CreateSecurityGroupType (p. 581)
Ancestor: None
Children: groupName, groupDescription
CreateSecurityGroupType
YesName of the security group.
Type: xsd:string
Default: None
Constraints: Accepts alphanumeric characters, spaces,dashes, and underscores.
Ancestor: CreateSecurityGroupType
Children: None
groupName
YesDescription of the group. This is informational only. If thedescription contains spaces, you must enclose it in singlequotes (') or URL-encode it.
Type: xsd:string
Default: None
Constraints: Accepts alphanumeric characters, spaces,dashes, and underscores.
Ancestor: CreateSecurityGroupType
Children: None
groupDescription
Response Elements
DescriptionName
CreateSecurityGroupResponseType element.
Type: CreateSecurityGroupResponseType (p. 580)
Ancestor: None
Children: requestId, return
CreateSecurityGroupResponseType
API Version 2010-08-31297
Amazon Elastic Compute Cloud API ReferenceCreateSecurityGroup
DescriptionName
The ID of the request.
Type: xsd:string
Ancestor: CreateSecurityGroupResponseType
Children: None
requestId
Returns true if creation succeeded. Otherwise, returns an error.
Type: xsd:boolean
Ancestor: CreateSecurityGroupResponseType
Children: None
return
Examples
Example RequestThis example creates the websrv security group.
<CreateSecurityGroup xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <groupName>websrv</groupName> <groupDescription>Web Servers</groupDescription></CreateSecurityGroup>
Example Response<CreateSecurityGroupResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/">
<return>true</return></CreateSecurityGroupResponse>
Related Operations• RunInstances (p. 522)
• DescribeSecurityGroups (p. 410)
• AuthorizeSecurityGroupIngress (p. 269)
• RevokeSecurityGroupIngress (p. 518)
• DeleteSecurityGroup (p. 315)
API Version 2010-08-31298
Amazon Elastic Compute Cloud API ReferenceExamples
CreateSnapshot
DescriptionCreates a snapshot of an Amazon EBS volume and stores it in Amazon S3.You can use snapshots forbackups, to make identical copies of instance devices, and to save data before shutting down an instance.For more information about Amazon EBS, go to the Amazon Elastic Compute Cloud Developer Guide orAmazon Elastic Compute Cloud User Guide.
When taking a snapshot of a file system, we recommend unmounting it first. This ensures the file systemmetadata is in a consistent state, that the 'mounted indicator' is cleared, and that all applications usingthat file system are stopped and in a consistent state. Some file systems, such as xfs, can freeze andunfreeze activity so a snapshot can be made without unmounting.
For Linux/UNIX, enter the following command from the command line.
umount -d /dev/sdh
For Windows, open Disk Management, right-click the volume to unmount, and select Change Drive Letterand Path. Then, select the mount point to remove and click Remove.
Request Parameters
RequiredDescriptionName
CreateSnapshotType element.
Type: CreateSnapshotType (p. 582)
Ancestor: None
Children: volumeId, description
CreateSnapshotType
YesThe ID of the Amazon EBS volume of which to take asnapshot.
Type: xsd:string
Default: None
Ancestor: CreateSnapshotType
Children: None
volumeId
NoDescription of the Amazon EBS snapshot.
Type: xsd:string
Default: None
Constraints: Up to 255 characters
Ancestor: CreateSnapshotType
Children: None
description
API Version 2010-08-31299
Amazon Elastic Compute Cloud API ReferenceCreateSnapshot
Response Elements
DescriptionName
CreateSnapshotResponseType element.
Type: CreateSnapshotResponseType (p. 581)
Ancestor: None
Children: requestId, snapshotId, volumeId, status,startTime, progress, ownerId, volumeSize, and description
CreateSnapshotResponseType
The ID of the request.
Type: xsd:string
Ancestor: CreateSnapshotResponseType
Children: None
requestId
The ID of the snapshot.
Type: xsd:string
Ancestor: CreateSnapshotResponseType
Children: None
snapshotId
The ID of the volume.
Type: xsd:string
Ancestor: CreateSnapshotResponseType
Children: None
volumeId
Snapshot state (e.g., pending, completed, or error)
Type: xsd:string
Ancestor: CreateSnapshotResponseType
Children: None
status
Time stamp when the snapshot was initiated.
Type: xsd:dateTime
Ancestor: CreateSnapshotResponseType
Children: None
startTime
The progress of the snapshot, in percentage.
Type: xsd:string
Ancestor: CreateSnapshotResponseType
Children: None
progress
The AWS account ID of the Amazon EBS snapshot owner.
Type: xsd:string
Ancestor: CreateSnapshotResponseType
Children: None
ownerId
The size of the volume, in GiB.
Type: xsd:string
Ancestor: CreateSnapshotResponseType
Children: None
volumeSize
API Version 2010-08-31300
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Description of the snapshot.
Type: xsd:string
Ancestor: CreateSnapshotResponseType
Children: None
description
Examples
Example RequestThis example creates a snapshot of volume vol-4d826724.
<CreateSnapshot xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <volumeId>vol-4d826724</volumeId> <description>Daily Backup</description></CreateSnapshot>
Example Response<CreateSnapshotResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <snapshotId>snap-78a54011</snapshotId> <volumeId>vol-4d826724</volumeId> <volumeSize>10</volumeSize> <status>pending</status> <startTime>2008-05-07T12:51:50.000Z</startTime> <progress>60%</progress> <ownerId>213457642086</ownerId> <description>Daily Backup</description></CreateSnapshotResponse>
Related Operations• DeleteSnapshot (p. 317)
• DescribeSnapshots (p. 420)
API Version 2010-08-31301
Amazon Elastic Compute Cloud API ReferenceExamples
CreateSpotDatafeedSubscription
DescriptionCreates the data feed for Spot Instances, enabling you to view Spot Instance usage logs.You can createone data feed per account. For conceptual information about Spot Instances, refer to the Amazon ElasticCompute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide.
Request Parameters
RequiredDescriptionName
CreateSpotDatafeedSubscriptionType element.
Type: CreateSpotDatafeedSubscriptionType (p. 583)
Ancestor: None
Children: bucket, prefix
CreateSpotDatafeedSubscriptionType
YesThe Amazon S3 bucket in which to store the Spot Instancedatafeed.
Type: xsd:string
Default: None
Constraints: Must be a valid bucket associated with youraccount.
Ancestor: CreateSpotDatafeedSubscriptionType
Children: None
bucket
NoPrefix that is prepended to datafeed files.
Type: xsd:string
Default: None
Ancestor: CreateSpotDatafeedSubscriptionType
Children: None
prefix
Response Elements
DescriptionName
CreateSpotDatafeedSubscriptionResponseType element.
Type: CreateSpotDatafeedSubscriptionResponseType (p. 583)
Ancestor: None
Children: requestId, spotDatafeedSubscription
CreateSpotDatafeedSubscriptionResponseType
The ID of the request.
Type: xsd:string
Ancestor: CreateSpotDatafeedSubscriptionResponseType
Children: None
requestId
API Version 2010-08-31302
Amazon Elastic Compute Cloud API ReferenceCreateSpotDatafeedSubscription
DescriptionName
Datafeed subscription.
Type: SpotDatafeedSubscriptionType (p. 698)
Ancestor: CreateSpotDatafeedSubscriptionResponseType
Children: ownerId, bucket, prefix, state, and fault
spotDatafeedSubscription
The AWS account ID of the account.
Type: xsd:string
Ancestor: spotDatafeedSubscription
Children: None
ownerId
The Amazon S3 bucket where the Spot Instance datafeed is located.
Type: xsd:string
Ancestor: spotDatafeedSubscription
Children: None
bucket
Prefix that is prepended to datafeed files.
Type: xsd:string
Ancestor: spotDatafeedSubscription
Children: None
prefix
The state of the Spot datafeed subscription.
Type: xsd:string
Valid Values: Active | Inactive
Ancestor: spotDatafeedSubscription
Children: None
state
Fault codes for the Spot Instance request, if any.
Type: SpotInstanceStateFaultType (p. 702)
Ancestor: spotDatafeedSubscription
Children: code, message
fault
Reason code for the Spot Instance state change.
Type: xsd:string
Ancestor: fault
Children: None
code
Message for the Spot Instance state change.
Type: xsd:string
Ancestor: fault
Children: None
message
Examples
Example RequestThis example creates the data feed for the account.
API Version 2010-08-31303
Amazon Elastic Compute Cloud API ReferenceExamples
<CreateSpotDatafeedSubscription xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <bucket>myBucket</bucket></CreateSpotDatafeedSubscription>
Example Response<CreateSpotDatafeedSubscriptionResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <spotDatafeedSubscription> <ownerId>254933287430</ownerId> <bucket>my-bucket</bucket> <prefix/> <state>open</state> </spotDatafeedSubscription></CreateSpotDatafeedSubscriptionResponse>
Related Operations• DeleteSpotDatafeedSubscription (p. 319)
• DescribeSpotDatafeedSubscription (p. 428)
API Version 2010-08-31304
Amazon Elastic Compute Cloud API ReferenceRelated Operations
CreateTags
DescriptionAdds or overwrites one or more tags for the specified resource or resources. Each resource can have amaximum of 10 tags. Each tag consists of a key and optional value.Tag keys must be unique per resource.
For more information about tags, go to Using Tags in the Amazon Elastic Compute Cloud DeveloperGuide.
Request Parameters
RequiredDescriptionName
CreateTags element.
Type: CreateTags
Ancestor: None
Children: resourcesSet, tagSet
CreateTags
YesInformation about the resources you want to tag.
Type: ResourceIdSetType
Ancestor: CreateTags
Children: item
resourcesSet
YesInformation about one resource.
Type: ResourceIdSetItemType
Ancestor: resourcesSet
Children: resourceId
item
YesThe resource's ID. For example, ami-1a2b3c4d.
Type: String
resourceId
YesInformation about the tags.
Type: ResourceTagSetType
Ancestor: CreateTags
Children: item
tagSet
YesInformation about one tag.
Type: ResourceTagSetItemType
Ancestor: tagSet
Children: key, value
item
YesThe tag's key.
Type: String
Constraints: Tag keys are case sensitive and accept amaximum of 128 Unicode characters.
key
API Version 2010-08-31305
Amazon Elastic Compute Cloud API ReferenceCreateTags
RequiredDescriptionName
YesThe tag's value. If you leave this empty, we set the tag'svalue to an empty string.
Type: String
Constraints: Tag values are case sensitive and accept amaximum of 256 Unicode characters.
value
Response Elements
DescriptionName
CreateTagsResponse element.
Type: CreateTagsResponseType
Ancestor: None
Children: requestId, return
CreateTagsResponse
The ID of the request.
Type: xsd:string
Ancestor: CreateTagsResponse
Children: None
requestId
Returns true if the request succeeded. Otherwise, returns an error.
Type: xsd:boolean
Ancestor: CreateTagsResponse
Children: None
return
Examples
Example RequestThis example adds (or overwrites) two tags for two resources: an AMI and an instance. One of the tagsis just a key (webserver), with no value (the value here is an empty string). The other consists of a key(stack) and value (Production).
<CreateTags xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <resourceSet> <item> <resourceId>ami-1a2b3c4d</resourceId> </item> <item> <resourceId>i-7f4d3a2b</resourceId> </item> </resourceSet> <tagSet> <item> <key>webserver</key> <value/> </item> <item> <key>stack</key>
API Version 2010-08-31306
Amazon Elastic Compute Cloud API ReferenceResponse Elements
<value>Production</value> </item> </tagSet></CreateTags>
Example Response<CreateTagsResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId> <return>true</return></CreateTagsResponse>
Related Operations• DescribeTags (p. 447)
• DeleteTags (p. 321)
API Version 2010-08-31307
Amazon Elastic Compute Cloud API ReferenceExamples
CreateVolume
DescriptionCreates a new Amazon EBS volume to which any Amazon EC2 instance can attach within the sameAvailability Zone. For more information about Amazon EBS, go to the Amazon Elastic Compute CloudDeveloper Guide or Amazon Elastic Compute Cloud User Guide.
Note
You must specify an Availability Zone when creating a volume. The volume and the instance towhich it attaches must be in the same Availability Zone.
Request Parameters
RequiredDescriptionName
CreateVolumeType element.
Type: CreateVolumeType (p. 586)
Ancestor: None
Children: size, snapshotId, and availabilityZone
CreateVolumeType
YesThe size of the volume, in GiBs. Required if you are notcreating a volume from a snapshot.
Type: xsd:string
Valid Values: 1 -1024
Default: None
Ancestor: CreateVolumeType
Children: None
size
NoThe snapshot from which to create the new volume.
Type: xsd:string
Default: None
Ancestor: CreateVolumeType
Children: None
snapshotId
YesThe Availability Zone in which to create the new volume.
Type: xsd:string
Default: None
Ancestor: CreateVolumeType
Children: None
availabilityZone
API Version 2010-08-31308
Amazon Elastic Compute Cloud API ReferenceCreateVolume
Response Elements
DescriptionName
CreateVolumeResponseType element.
Type: CreateVolumeResponseType (p. 586)
Ancestor: None
Children: requestId, volumeId, size, snapshotId,availabilityZone, status, and createTime
CreateVolumeResponseType
The ID of the request.
Type: xsd:string
Ancestor: CreateVolumeResponseType
Children: None
requestId
The ID of the volume.
Type: xsd:string
Ancestor: CreateVolumeResponseType
Children: None
volumeId
The size of the volume, in GiBs.
Type: xsd:string
Ancestor: CreateVolumeResponseType
Children: None
size
Snapshot from which the volume was created, if applicable.
Type: xsd:string
Ancestor: CreateVolumeResponseType
Children: None
snapshotId
Availability Zone in which the volume was created.
Type: xsd:string
Ancestor: CreateVolumeResponseType
Children: None
availabilityZone
Volume state (e.g., creating, available)
Type: xsd:string
Ancestor: CreateVolumeResponseType
Children: None
status
Time stamp when volume creation was initiated.
Type: xsd:dateTime
Ancestor: CreateVolumeResponseType
Children: None
createTime
API Version 2010-08-31309
Amazon Elastic Compute Cloud API ReferenceResponse Elements
Examples
Example RequestThis example creates a new 800 GiB volume in Availability Zone us-east-1a.
<CreateVolume xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <size>800</size> <availabilityZone>us-east-1a</availabilityZone></CreateVolume>
Example Response<CreateVolumeResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <volumeId>vol-4d826724</volumeId> <size>800</size> <status>creating</status> <createTime>2008-05-07T11:51:50.000Z</createTime> <availabilityZone>us-east-1a</availabilityZone> <snapshotId></snapshotId></CreateVolumeResponse>
Related Operations• DeleteVolume (p. 325)
• DescribeVolumes (p. 455)
• AttachVolume (p. 266)
• DetachVolume (p. 462)
• DescribeAvailabilityZones (p. 333)
API Version 2010-08-31310
Amazon Elastic Compute Cloud API ReferenceExamples
DeactivateLicenseThis action is for the Microsoft Windows Server License Mobility Pilot for Amazon EC2, which is a pilotprogram offered by Microsoft that allows customers with Microsoft Enterprise Agreements (EA) to migratetheir existing Windows Server licenses to Amazon EC2. If you're interested in the program, go tohttp://aws.amazon.com/ec2/windows-license-mobility-pilot.
API Version 2010-08-31311
Amazon Elastic Compute Cloud API ReferenceDeactivateLicense
DeleteKeyPair
DescriptionDeletes the specified key pair, by removing the public key from Amazon EC2.You must own the key pair.
Request Parameters
RequiredDescriptionName
DeleteKeyPairType element.
Type: DeleteKeyPairType (p. 588)
Ancestor: None
Children: keyName
DeleteKeyPairType
YesName of the key pair to delete.
Type: xsd:string
Default: None
Ancestor: DeleteKeyPairType
Children: None
keyName
Response Elements
DescriptionName
DeleteKeyPairResponseType element.
Type: DeleteKeyPairResponseType (p. 587)
Ancestor: None
Children: requestId, return
DeleteKeyPairResponseType
The ID of the request.
Type: xsd:string
Ancestor: DeleteKeyPairResponseType
Children: None
requestId
Returns true if deletion succeeded. Otherwise, returns an error.
Type: xsd:boolean
Ancestor: DeleteKeyPairResponseType
Children: None
return
Examples
Example RequestThis example deletes the gsg-keypair key pair.
API Version 2010-08-31312
Amazon Elastic Compute Cloud API ReferenceDeleteKeyPair
<DeleteKeyPair xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <keyName>gsg-keypair</keyName></DeleteKeyPair>
Example Response<DeleteKeyPairResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <return>true</return></DeleteKeyPairResponse>
Related Operations• CreateKeyPair (p. 292)
• DescribeKeyPairs (p. 384)
API Version 2010-08-31313
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DeletePlacementGroup
DescriptionDeletes a placement group from your account.You must terminate all instances in the placement groupbefore deleting it. For more information about placement groups and cluster compute instances, go toCluster Compute Instance Concepts in the Amazon Elastic Compute Cloud Developer Guide.
Request Parameters
RequiredDescriptionName
DeletePlacementGroup element.
Type: DeletePlacementGroupType
Ancestor: None
Children: groupName
DeletePlacementGroup
YesThe name of the placement group to delete.
Type: xsd:string
Default: None
Ancestor: DeletePlacementGroup
Children: None
groupName
Examples
Example RequestThis example deletes the placement group named XYZ-cluster.
<DeletePlacementGroup xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <groupName>XYZ-cluster</groupName></DeletePlacementGroup>
Example Response<DeletePlacementGroupResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/">
<requestID>d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE</requestID> <return>true</return></DeletePlacementGroupResponse>
Related Operations• CreatePlacementGroup (p. 295)
• DescribePlacementGroups (p. 389)
API Version 2010-08-31314
Amazon Elastic Compute Cloud API ReferenceDeletePlacementGroup
DeleteSecurityGroup
DescriptionDeletes a security group that you own.
Note
If you attempt to delete a security group that contains instances, a fault is returned.
If you attempt to delete a security group that is referenced by another security group, a fault isreturned. For example, if security group B has a rule that allows access from security group A,security group A cannot be deleted until the allow rule is removed.
Request Parameters
RequiredDescriptionName
DeleteSecurityGroupType element.
Type: DeleteSecurityGroupType (p. 589)
Ancestor: None
Children: groupName
DeleteSecurityGroupType
YesName of the security group to delete.
Type: xsd:string
Default: None
Ancestor: DeleteSecurityGroupType
Children: None
groupName
Response Elements
DescriptionName
DeleteSecurityGroupResponseType element.
Type: DeleteSecurityGroupResponseType (p. 588)
Ancestor: None
Children: requestId, return
DeleteSecurityGroupResponseType
The ID of the request.
Type: xsd:string
Ancestor: DeleteSecurityGroupResponseType
Children: None
requestId
Returns true if deletion succeeded. Otherwise, returns an error.
Type: xsd:boolean
Ancestor: DeleteSecurityGroupResponseType
Children: None
return
API Version 2010-08-31315
Amazon Elastic Compute Cloud API ReferenceDeleteSecurityGroup
Examples
Example RequestThis example deletes the websrv security group.
<DeleteSecurityGroup xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <groupName>websrv</groupName></DeleteSecurityGroup>
Example Response<DeleteSecurityGroupResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/">
<return>true</return></DeleteSecurityGroupResponse>
Related Operations• CreateSecurityGroup (p. 297)
• DescribeSecurityGroups (p. 410)
• AuthorizeSecurityGroupIngress (p. 269)
• RevokeSecurityGroupIngress (p. 518)
API Version 2010-08-31316
Amazon Elastic Compute Cloud API ReferenceExamples
DeleteSnapshot
DescriptionDeletes a snapshot of an Amazon EBS volume that you own. For more information, go to the AmazonElastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide.
Request Parameters
RequiredDescriptionName
DeleteSnapshotType element.
Type: DeleteSnapshotType (p. 590)
Ancestor: None
Children: snapshotId
DeleteSnapshotType
YesThe ID of the Amazon EBS snapshot to delete.
Type: xsd:string
Default: None
Ancestor: DeleteSnapshotType
Children: None
snapshotId
Response Elements
DescriptionName
DeleteSnapshotResponseType element.
Type: DeleteSnapshotResponseType (p. 589)
Ancestor: None
Children: requestId, return
DeleteSnapshotResponseType
The ID of the request.
Type: xsd:string
Ancestor: DeleteSnapshotResponseType
Children: None
requestId
Returns true if deletion succeeded. Otherwise, returns an error.
Type: xsd:boolean
Ancestor: DeleteSnapshotResponseType
Children: None
return
Examples
Example RequestThis example deletes snapshot snap-78a54011.
API Version 2010-08-31317
Amazon Elastic Compute Cloud API ReferenceDeleteSnapshot
<DeleteSnapshot xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <snapshotId>snap-78a54011</snapshotId></DeleteSnapshot>
Example Response<DeleteSnapshotResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <return>true</return></DeleteSnapshotResponse>
Related Operations• CreateSnapshot (p. 299)
• DescribeSnapshots (p. 420)
API Version 2010-08-31318
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DeleteSpotDatafeedSubscription
DescriptionDeletes the data feed for Spot Instances. For conceptual information about Spot Instances, refer to theAmazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide.
Request ParametersThe DeleteSpotDatafeedSubscription operation does not have any request parameters.
Response Elements
DescriptionName
DeleteSpotDatafeedSubscriptionResponseType element.
Type: DeleteSpotDatafeedSubscriptionResponseType (p. 590)
Ancestor: None
Children: requestId, return
DeleteSpotDatafeedSubscriptionResponseType
The ID of the request.
Type: xsd:string
Ancestor: DeleteSpotDatafeedSubscriptionResponseType
Children: None
requestId
Returns true if deletion succeeded. Otherwise, returns an error.
Type: xsd:boolean
Ancestor: DeleteSpotDatafeedSubscriptionResponseType
Children: None
return
Examples
Example RequestThis example deletes the data feed for the account.
<DeleteSpotDatafeedSubscription xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"></DeleteSpotDatafeedSubscription>
Example Response<DeleteSpotDatafeedSubscriptionResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <return>true</return></DeleteSpotDatafeedSubscriptionResponse>
API Version 2010-08-31319
Amazon Elastic Compute Cloud API ReferenceDeleteSpotDatafeedSubscription
Related Operations• CreateSpotDatafeedSubscription (p. 302)
• DescribeSpotDatafeedSubscription (p. 428)
API Version 2010-08-31320
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DeleteTags
DescriptionDeletes a specific set of tags from a specific set of resources. This call is designed to follow aDescribeTags call.You first determine what tags a resource has, and then you call DeleteTags withthe resource ID and the specific tags you want to delete.
For more information about tags, go to Using Tags in the Amazon Elastic Compute Cloud DeveloperGuide.
Request Parameters
RequiredDescriptionName
DeleteTags element.
Type: DeleteTagsType
Ancestor: None
Children: resourcesSet, tagSet
DeleteTags
YesInformation about the resources you want to remove thetags from.
Type: ResourceIdSetType
Ancestor: DeleteTags
Children: item
resourcesSet
YesInformation about one resource.
Type: ResourceIdSetItemType
Ancestor: resourcesSet
Children: resourceId
item
YesThe resource's ID. For example, ami-1a2b3c4d.
Type: String
resourceId
YesInformation about the tags.
Type: DeleteTagsSetType
Ancestor: DeleteTags
Children: item
tagSet
YesInformation about one tag.
Type: DeleteTagsSetItemType
Ancestor: tagSet
Children: key, value
item
YesThe tag's key.
Type: String
key
API Version 2010-08-31321
Amazon Elastic Compute Cloud API ReferenceDeleteTags
RequiredDescriptionName
NoThe tag's value. If you omit the element entirely, weinterpret that as a request to delete the tag regardless ofthe value. If you include the element but leave it empty(<value/>, we interpret that as a request to delete thetag only if its value is an empty string.
Type: String
value
Response Elements
DescriptionName
DeleteTagsResponse element.
Type: DeleteTagsResponseType
Ancestor: None
Children: requestId, tags
DeleteTagsResponse
The ID of the request.
Type: xsd:string
Ancestor: DeleteTagsResponse
Children: None
requestId
Returns true if deletion succeeded. Otherwise, returns an error.
Type: xsd:boolean
Ancestor: DeleteTagsResponse
Children: None
return
Examples
Example RequestThis example deletes the tags for the AMI with ID ami-1a2b3c4d.
You first get a list of the tags.
<DescribeTags xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <filterSet> <item> <name>resource-id</name> <valueSet> <item> <value>ami-1a2b3c4d</value> </item> </valueSet> </item> </filterSet></DescribeTags>
Sample response:
API Version 2010-08-31322
Amazon Elastic Compute Cloud API ReferenceResponse Elements
<DescribeTagsResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId> <tagSet> <item> <resourceId>ami-1a2b3c4d</resourceId> <resourceType>image</resourceType> <key>webserver</key> <value/> </item> <item> <resourceId>ami-1a2b3c4d</resourceId> <resourceType>image</resourceType> <key>stack</key> <value>Production</value> </item> </tagSet></DescribeTagsResponse>
Then you delete the tags. Specifying the value for the stack tag is optional.
<DeleteTags xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <resourcesSet> <item> <resourceId>ami-1a2b3c4d</resourceId> </item> </resourcesSet> <tagSet> <item> <key>webserver</key> </item> <item> <key>stack</key> </item> </tagSet></DeleteTags>
Sample response:
<DeleteTagsResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId> <return>true</return></DeleteTagsResponse>
Example RequestThis example deletes the stack tag from two particular instances.
<DeleteTags xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <resourcesSet> <item> <resourceId>i-5f4e3d2a</resourceId> </item> <item> <resourceId>i-12345678</resourceId> </item> </resourcesSet> <tagSet> <item> <key>stack</key>
API Version 2010-08-31323
Amazon Elastic Compute Cloud API ReferenceExamples
</item> </tagSet></DeleteTags>
Example RequestYou can specify a tag key without a corresponding tag value if you want to delete the tag regardless ofits value. This example deletes all tags whose key=Purpose, regardless of the tag value.
<DeleteTags xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <resourcesSet> <item> <resourceId>i-5f4e3d2a</resourceId> </item> <item> <resourceId>i-3189d4fa</resourceId> </item> <item> <resourceId>i-b83d2264</resourceId> </item> </resourcesSet> <tagSet> <item> <key>Purpose</key> </item> </tagSet></DeleteTags>
Example RequestThis example specifies the empty string as the value for the tag to delete.
<DeleteTags xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <resourcesSet> <item> <resourceId>i-5f4e3d2a</resourceId> </item> </resourcesSet> <tagSet> <item> <key>Purpose</key> <value/> </item> </tagSet></DeleteTags>
Related Operations• CreateTags (p. 305)
• DescribeTags (p. 447)
API Version 2010-08-31324
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DeleteVolume
DescriptionDeletes an Amazon EBS volume that you own. The volume must be in the available state (not attachedto an instance). For more information about Amazon EBS, go to the Amazon Elastic Compute CloudDeveloper Guide or Amazon Elastic Compute Cloud User Guide.
Note
The volume remains in the deleting state for several minutes after you enter this command.
Request Parameters
RequiredDescriptionName
DeleteVolumeType element.
Type: DeleteVolumeType (p. 591)
Ancestor: None
Children: volumeId
DeleteVolumeType
YesThe ID of the volume to delete.The volume remains in thedeleting state for several minutes after entering thiscommand.
Type: xsd:string
Default: None
Ancestor: DeleteVolumeType
Children: None
volumeId
Response Elements
DescriptionName
DeleteVolumeResponseType element.
Type: DeleteVolumeResponseType (p. 591)
Ancestor: None
Children: requestId, return
DeleteVolumeResponseType
The ID of the request.
Type: xsd:string
Ancestor: DeleteVolumeResponseType
Children: None
requestId
Returns true if deletion succeeded. Otherwise, returns an error.
Type: xsd:boolean
Ancestor: DeleteVolumeResponseType
Children: None
return
API Version 2010-08-31325
Amazon Elastic Compute Cloud API ReferenceDeleteVolume
Examples
Example RequestThis example deletes volume vol-4282672b.
<DeleteVolume xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <volumeId>vol-4282672b</volumeId></DeleteVolume>
Example Response<DeleteVolumeResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <return>true</return></DeleteVolumeResponse>
Related Operations• CreateVolume (p. 308)
• DescribeVolumes (p. 455)
• AttachVolume (p. 266)
• DetachVolume (p. 462)
API Version 2010-08-31326
Amazon Elastic Compute Cloud API ReferenceExamples
DeregisterImage
DescriptionDeregisters the specified AMI. Once deregistered, the AMI cannot be used to launch new instances.
Note
This command does not delete the AMI.
Request Parameters
RequiredDescriptionName
DeregisterImageType element.
Type: DeregisterImageType (p. 592)
Ancestor: None
Children: imageId
DeregisterImageType
YesUnique ID of the AMI which was assigned duringregistration. To register an AMI, use RegisterImage. Toview the AMI IDs of AMIs that belong to your account. useDescribeImages.
Type: xsd:string
Default: None
Ancestor: DeregisterImageType
Children: None
imageId
Response Elements
DescriptionName
DeregisterImageResponseType element.
Type: DeregisterImageResponseType (p. 592)
Ancestor: None
Children: requestId, return
DeregisterImageResponseType
The ID of the request.
Type: xsd:string
Ancestor: DeregisterImageResponseType
Children: None
requestId
Returns true if deregistration succeeded. Otherwise, returns an error.
Type: xsd:boolean
Ancestor: DeregisterImageResponseType
Children: None
return
API Version 2010-08-31327
Amazon Elastic Compute Cloud API ReferenceDeregisterImage
Examples
Example RequestThis example deregisters the ami-4fa54026 AMI.
<DeregisterImage xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <imageId>ami-4fa54026</imageId></DeregisterImage>
Example Response<DeregisterImageResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <return>true</return></DeregisterImageResponse>
Related Operations• RegisterImage (p. 493)
• DescribeImages (p. 350)
API Version 2010-08-31328
Amazon Elastic Compute Cloud API ReferenceExamples
DescribeAddresses
DescriptionLists elastic IP addresses assigned to your account or provides information about a specific address.
You can filter the results to return information only about elastic IP addresses that match criteria youspecify. For example, you could get information only about addresses tagged with a certain value.Youcan specify multiple values for a filter. An address must match at least one of the specified values for itto be included in the results.
You can specify multiple filters (e.g., the address is a particular value, and is tagged with a certain value).The result includes information for an address only if it matches all your filters. If there's no match, nospecial message is returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactlyone character.You can escape special characters using a backslash before the character. For example,a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following table shows the available filters.
DescriptionFilter Name
Instance the address is associated with (if any).
Type: String
instance-id
The elastic IP address.
Type: String
public-ip
Request Parameters
RequiredDescriptionName
DescribeAddressesType element.
Type: DescribeAddressesType (p. 595)
Ancestor: None
Children: publicIpsSet
DescribeAddressesType
YesSet of elastic IP addresses. It must be present, but can beempty.
Type: DescribeAddressesInfoType (p. 593)
Ancestor: DescribeAddressesType
Children: item
publicIpsSet
Information for one elastic IP address.
Type: DescribeAddressesItemType (p. 593)
Ancestor: publicIpsSet
Children: publicIp
item
API Version 2010-08-31329
Amazon Elastic Compute Cloud API ReferenceDescribeAddresses
RequiredDescriptionName
NoElastic IP address to describe.
Type: xsd:string
Default: None
Ancestor: item
Children: None
publicIp
YesSet of filters. It must be present, but can be empty.
Type: FilterSetType
Children: item
filterSet
NoInformation for one filter.
Type: FilterType
Ancestor: filterSet
Children: name, valueSet
item
NoName of a filter.
Type: xsd:string
Ancestor: item
Children: None
name
NoOne or more values.
Type: ValueSetType
Ancestor: item
Children: item
valueSet
NoAn item in the set.
Type: ValueType
Ancestor: valueSet
Children: value
item
NoAn individual value.
Type: xsd:string
Ancestor: item
Children: None
value
Response Elements
DescriptionName
DescribeAddressesResponse element.
Type: DescribeAddressesResponseType (p. 595)
Ancestor: None
Children: requestId, addressesSet
DescribeAddressesResponse
API Version 2010-08-31330
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
The ID of the request.
Type: xsd:string
Ancestor: DescribeAddressesResponseType
Children: None
requestId
The set of IP addresses.
Type: DescribeAddressesResponseInfoType (p. 594)
Ancestor: DescribeAddressesResponseType
Children: item
addressesSet
Information about an instance.
Type: DescribeAddressesResponseItemType (p. 594)
Ancestor: addressesSet
Children: publicIp, instanceId
item
The public IP address.
Type: xsd:string
Ancestor: item
Children: None
publicIp
The ID of the instance.
Type: xsd:string
Ancestor: item
Children: None
instanceId
Examples
Example RequestThis example describes elastic IP addresses assigned to the account. Amazon EC2 returns 67.202.55.255,which is assigned to instance i-f15ebb98 and 67.202.55.233, which is not assigned to an instance.
<DescribeAddresses xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <publicIpsSet> <item> <publicIp>67.202.55.255</publicIp> </item> <item> <publicIp>67.202.55.233</publicIp> </item> </publicIpsSet></DescribeAddresses>
Example Response<DescribeAddressesResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <addressesSet> <item> <publicIp>67.202.55.255</publicIp> <instanceId>i-f15ebb98</instanceId>
API Version 2010-08-31331
Amazon Elastic Compute Cloud API ReferenceExamples
</item> <item> <publicIp>67.202.55.233</publicIp> <instanceId/> </item> </addressesSet> </DescribeAddressesResponse>
Related Operations• AllocateAddress (p. 262)
• ReleaseAddress (p. 498)
API Version 2010-08-31332
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DescribeAvailabilityZones
DescriptionDisplays Availability Zones that are currently available to the account. The results include zones only forthe Region you're currently using.
Note
Availability Zones are not the same across accounts.The Availability Zone us-east-1a for accountA is not necessarily the same as us-east-1a for account B. Zone assignments are mappedindependently for each account.
You can filter the results to return information only about zones that match criteria you specify. Forexample, you could filter the results to return only the zones whose state is available.You can specifymultiple filters (e.g., the zone is in a particular Region, and the state is available). The result includesinformation for a particular zone only if it matches all your filters. If there's no match, no special messageis returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactlyone character.You can escape special characters using a backslash before the character. For example,a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following table shows the available filters.
DescriptionFilter Name
Message giving information about the Availability Zone.
Type: String
message
Region the Availablity Zone is in (e.g., us-east-1).
Type: String
region-name
State of the Availability Zone
Type: String
Valid Values: available
state
Name of the zone.
Type: String
zone-name
Request Parameters
RequiredDescriptionName
DescribeAvailabilityZonesType element.
Type: DescribeAvailabilityZonesType (p. 597)
Ancestor: None
Children: availabilityZoneSet
DescribeAvailabilityZonesType
API Version 2010-08-31333
Amazon Elastic Compute Cloud API ReferenceDescribeAvailabilityZones
RequiredDescriptionName
YesSet of Availability Zones. It must be present, but can beempty.
Type: DescribeAvailabilityZonesSetType (p. 597)
Ancestor: DescribeAvailabilityZonesType
Children: item
availabilityZoneSet
Information for one Availability Zone.
Type: DescribeAvailabilityZonesSetItemType (p. 596)
Ancestor: availabilityZoneSet
Children: zoneName
item
NoAvailability Zone name.
Type: xsd:string
Default: None
Ancestor: item
Children: None
zoneName
YesSet of filters. It must be present, but can be empty.
Type: FilterSetType
Children: item
filterSet
NoInformation for one filter.
Type: FilterType
Ancestor: filterSet
Children: name, valueSet
item
NoName of a filter.
Type: xsd:string
Ancestor: item
Children: None
name
NoOne or more values.
Type: ValueSetType
Ancestor: item
Children: item
valueSet
NoAn item in the set.
Type: ValueType
Ancestor: valueSet
Children: value
item
NoAn individual value.
Type: xsd:string
Ancestor: item
Children: None
value
API Version 2010-08-31334
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
Response Elements
DescriptionName
DescribeAvailabilityZonesResponseType element.
Type: DescribeAvailabilityZonesResponseType (p. 596)
Ancestor: None
Children: requestId, availabilityZoneInfo
DescribeAvailabilityZonesResponseType
The ID of the request.
Type: xsd:string
Ancestor: DescribeAvailabilityZonesResponseType
Children: None
requestId
Availability Zone information.
Type: AvailabilityZoneSetType (p. 567)
Ancestor: DescribeAvailabilityZonesResponseType
Children: item
availabilityZoneInfo
Information for one Availability Zone.
Type: AvailabilityZoneItemType (p. 565)
Ancestor: availabilityZoneInfo
Children: zoneName, zoneState, regionName, and messageSet
item
Name of the Availability Zone.
Type: xsd:string
Ancestor: item
Children: None
zoneName
State of the Availability Zone.
Type: xsd:string
Valid Values: available
Ancestor: item
Children: None
zoneState
Name of the Region.
Type: xsd:string
Ancestor: item
Children: None
regionName
Message set.
Type: AvailabilityZoneMessageSetType (p. 566)
Ancestor: item
Children: item
messageSet
Availability Zone message set.
Type: AvailabilityZoneMessageType (p. 566)
Ancestor: messageSet
Children: message
item
API Version 2010-08-31335
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
The Availability Zone message.
Type: xsd:string
Ancestor: item
Children: None
message
Examples
Example RequestThis example displays information about Availability Zones that are available to the account. The resultsincludes zones only in the Region (endpoint) you're currently using.
<DescribeAvailabilityZones xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <availabilityZoneSet/></DescribeAvailabilityZones>
Example Response<DescribeAvailabilityZonesResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <availabilityZoneInfo> <item> <zoneName>us-east-1a</zoneName> <zoneState>available</zoneState> </item> <item> <zoneName>us-east-1b</zoneName> <zoneState>available</zoneState> </item> <item> <zoneName>us-east-1c</zoneName> <zoneState>available</zoneState> </item> <item> <zoneName>us-east-1d</zoneName> <zoneState>available</zoneState> </item> </availabilityZoneInfo></DescribeAvailabilityZonesResponse>
Related Operations• RunInstances (p. 522)
• DescribeRegions (p. 393)
API Version 2010-08-31336
Amazon Elastic Compute Cloud API ReferenceExamples
DescribeBundleTasks
DescriptionDescribes current bundling tasks.
Note
Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in thelist, you can still register an AMI from it. Just use the RegisterImage action with the AmazonS3 bucket name and image manifest name you provided to the bundle task.
You can filter the results to return information only about tasks that match criteria you specify. For example,you could filter the results to return only the tasks whose state is complete.You can specify multiplevalues for a filter. A bundle task must match at least one of the specified values for it to be included inthe results.
You can specify multiple filters (e.g., the bundle is stored in a particular Amazon S3 bucket and the stateis complete).The result includes information for a particular bundle task only if it matches all your filters.If there's no match, no special message is returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactlyone character.You can escape special characters using a backslash before the character. For example,a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following table shows the available filters.
DescriptionFilter Name
ID of the bundle task.
Type: String
bundle-id
If the task failed, the error code returned.
Type: String
error-code
If the task failed, the error message returned.
Type: String
error-message
ID of the instance that was bundled.
Type: String
instance-id
Level of task completion, in percent (e.g., 20%).
Type: String
progress
AWS Access Key ID of the bucket owner.
Type: String
s3-aws-access-key-id
Amazon S3 bucket where the AMI will be stored.
Type: String
s3-bucket
Beginning of the AMI name.
Type: String
s3-prefix
API Version 2010-08-31337
Amazon Elastic Compute Cloud API ReferenceDescribeBundleTasks
DescriptionFilter Name
Time the task started, e.g., 2008-09-15T17:15:20.000Z.
Type: xsd:dateTime
start-time
State of the task.
Type: String
Valid Values: pending | waiting-for-shutdown | bundling | storing| cancelling | complete | failed
state
Time of the most recent update for the task, e.g., 2008-09-15T17:15:20.000Z.
Type: xsd:dateTime
update-time
Request Parameters
RequiredDescriptionName
DescribeBundleTasksType element.
Type: DescribeBundleTasksType (p. 599)
Ancestor: None
Children: bundlesSet
DescribeBundleTasksType
YesSet of bundle tasks. It must be present, but can be empty.
Type: DescribeBundleTasksInfoType (p. 598)
Ancestor: DescribeBundleTasksType
Children: item
bundlesSet
NoInformation for one bundle task.
Type: DescribeBundleTasksItemType (p. 598)
Ancestor: bundlesSet
Children: bundleId
item
NoThe ID of the bundle task to describe.
Type: xsd:string
Default: Describes all bundle tasks, or only those otherwisespecified.
Ancestor: item
Children: None
bundleId
YesSet of filters. It must be present, but can be empty.
Type: FilterSetType
Children: item
filterSet
NoInformation for one filter.
Type: FilterType
Ancestor: filterSet
Children: name, valueSet
item
API Version 2010-08-31338
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
RequiredDescriptionName
NoName of a filter.
Type: xsd:string
Ancestor: item
Children: None
name
NoOne or more values.
Type: ValueSetType
Ancestor: item
Children: item
valueSet
NoAn item in the set.
Type: ValueType
Ancestor: valueSet
Children: value
item
NoAn individual value.
Type: xsd:string
Ancestor: item
Children: None
value
Response Elements
DescriptionName
DescribeBundleTasksResponse element.
Type: DescribeBundleTasksResponseType (p. 599)
Ancestor: None
Children: requestId, bundleInstanceTasksSet
DescribeBundleTasksResponse
The ID of the request.
Type: xsd:string
Ancestor: DescribeBundleTasksResponseType
Children: None
requestId
Bundle task set.
Type: BundleInstanceTasksSetType (p. 571)
Ancestor: DescribeBundleTasksResponseType
Children: item
bundleInstanceTasksSet
Bundle task.
Type: BundleInstanceTaskType (p. 572)
Ancestor: bundleInstanceTasksSet
Children: instanceId, bundleId, state, startTime,updateTime, storage, progress, and error
item
API Version 2010-08-31339
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Instance associated with this bundle task.
Type: xsd:string
Ancestor: item
Children: None
instanceId
Identifier for this task.
Type: xsd:string
Ancestor: item
Children: None
bundleId
The state of the task.
Type: xsd:string
Valid Values: pending | waiting-for-shutdown | bundling |storing | cancelling | complete | failed
Ancestor: item
Children: None
state
The time this task started.
Type: xsd:dateTime
Ancestor: item
Children: None
startTime
The time of the most recent update for the task.
Type: xsd:dateTime
Ancestor: item
Children: None
updateTime
Amazon S3 storage locations.
Type: BundleInstanceTaskStorageType (p. 571)
Ancestor: item
Children: S3
storage
Amazon S3 storage location.
Type: BundleInstanceS3StorageType (p. 569)
Ancestor: storage
Children:bucket, prefix, awsAccessKeyId, uploadPolicy, anduploadPolicySignature
S3
The bucket in which to store the AMI.You can specify a bucket thatyou already own or a new bucket that Amazon EC2 creates on yourbehalf. If you specify a bucket that belongs to someone else, AmazonEC2 returns an error.
Type: xsd:string
Ancestor: S3
Children: None
bucket
API Version 2010-08-31340
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Specifies the beginning of the file name of the AMI.
Type: xsd:string
Ancestor: S3
Children: None
prefix
The Access Key ID of the owner of the Amazon S3 bucket.
Type: xsd:string
Ancestor: S3
Children: None
awsAccessKeyId
A Base64-encoded Amazon S3 upload policy that gives AmazonEC2 permission to upload items into Amazon S3 on the user's behalf.
Type: xsd:string
Ancestor: S3
Children: None
uploadPolicy
The signature of the Base64 encoded JSON document.
Type: xsd:string
Ancestor: S3
Children: None
uploadPolicySignature
The level of task completion, in percent (e.g., 20%).
Type: xsd:string
Ancestor: item
Children: None
progress
If the task fails, a description of the error.
Type: BundleInstanceTaskErrorType (p. 570)
Ancestor: item
Children: code, message
error
Error code.
Type: xsd:string
Ancestor: error
Children: None
code
Error message.
Type: xsd:string
Ancestor: error
Children: None
message
Examples
Example RequestThis example describes the status of the bun-57a5403e bundle task.
API Version 2010-08-31341
Amazon Elastic Compute Cloud API ReferenceExamples
<DescribeBundleTasks xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <bundlesSet> <item> <bundleId>bun-57a5403e</bundleId> </item> </bundlesSet></DescribeBundleTasks>
Example Response<DescribeBundleTasksResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/">
<bundleInstanceTasksSet> <item> <instanceId>i-12345678</instanceId> <bundleId>bun-c1a540a8</bundleId> <state>canceling</state> <startTime>2008-10-07T11:41:50.000Z</startTime> <updateTime>2008-10-07T11:51:50.000Z</updateTime> <progress>20%</progress> <storage> <S3> <bucket>mybucket</bucket> <prefix>winami</prefix> </S3> </storage> </item> <bundleInstanceTasksSet></DescribeBundleTasksResponse>
Example RequestThis example filters the results to display only bundle tasks whose state is either complete or failed,and in addition are targeted for the Amazon S3 bucket called mybucket.
<DescribeBundleTasks xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <bundlesSet/> <filterSet> <item> <name>s3-bucket</name> <valueSet> <item> <value>mybucket</value> </item> </valueSet> </item> <item> <name>state</name> <valueSet> <item> <value>complete</value> </item> <item> <value>failed</value> </item> </valueSet> </item>
API Version 2010-08-31342
Amazon Elastic Compute Cloud API ReferenceExamples
</filterSet></DescribeBundleTasks>
Related Operations• BundleInstance (p. 274)
• CancelBundleTask (p. 280)
API Version 2010-08-31343
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DescribeImageAttribute
DescriptionReturns information about an attribute of an AMI.You can get information about only one attribute percall.
Request Parameters
RequiredDescriptionName
DescribeImageAttribute element.
Type: DescribeImageAttributeType (p. 601)
Ancestor: None
Children:imageId, DescribeImageAttributesGroup,filterSet
DescribeImageAttribute
YesThe ID of the AMI for which an attribute will be described.
Type: xsd:string
Default: None
Ancestor: DescribeImageAttribute
Children: None
imageId
The image attributes group.
Type: DescribeImageAttributesGroup (p. 601)
Ancestor: DescribeImageAttribute
Children:launchPermission, productCodes, kernel,ramdisk, blockDeviceMapping, description
DescribeImageAttributesGroup
NoReturns the launch permissions associated with the AMI.
Type: EmptyElementType (p. 644)
Ancestor: DescribeImageAttributesGroup
Children: None
launchPermission
NoReturns the product code associated with the AMI.
Type: EmptyElementType (p. 644)
Ancestor: DescribeImageAttributesGroup
Children: None
productCodes
NoReturns the ID of the kernel associated with the AMI.
Type: EmptyElementType (p. 644)
Ancestor: DescribeImageAttributesGroup
Children: None
kernel
NoReturns the ID of the RAM disk associated with the AMI.
Type: EmptyElementType (p. 644)
Ancestor: DescribeImageAttributesGroup
Children: None
ramdisk
API Version 2010-08-31344
Amazon Elastic Compute Cloud API ReferenceDescribeImageAttribute
RequiredDescriptionName
NoReturns the block device mapping of the AMI.
Type: EmptyElementType (p. 644)
Ancestor: DescribeImageAttributesGroup
Children: None
blockDeviceMapping
NoReturns the description of the AMI that was provided duringimage creation.
Type: EmptyElementType (p. 644)
Ancestor: DescribeImageAttributesGroup
Children: None
description
Response Elements
DescriptionName
DescribeImageAttributeResponseType element.
Type: DescribeImageAttributeResponseType (p. 600)
Ancestor: None
Children: requestId, imageId, launchPermission,productCodes, kernel, ramdisk, description, andblockDeviceMapping
DescribeImageAttributeResponseType
The ID of the request.
Type: xsd:string
Ancestor: DescribeImageAttributeResponseType
Children: None
requestId
The ID of the AMI.
Type: xsd:string
Ancestor: DescribeImageAttributeResponseType
Children: None
imageId
Launch permissions set.
Type: LaunchPermissionListType (p. 660)
Ancestor: DescribeImageAttributeResponseType
Children: item
launchPermission
Information for launch permissions.
Type: LaunchPermissionItemType (p. 659)
Ancestor: launchPermission
Children: userId, group
item
AWS account ID.
Type: xsd:string
Ancestor: item
Children: None
userId
API Version 2010-08-31345
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Name of the group. Currently supports "all."
Type: xsd:string
Ancestor: item
Children: None
group
Product codes set.
Type: ProductCodeListType (p. 673)
Ancestor: DescribeImageAttributeResponseType
Children: item
productCodes
Information for one product code.
Type: ProductCodeItemType (p. 672)
Ancestor: productCodes
Children: productCode
item
Product code.
Type: xsd:string
Ancestor: item
Children: None
productCode
Kernel set.
Type: NullableAttributeValueType (p. 670)
Ancestor: DescribeImageAttributeResponseType
Children: value
kernel
ID of the parent element.
Type: xsd:string
Ancestor: kernel
Children: None
value
RAM disk set.
Type: NullableAttributeValueType (p. 670)
Ancestor: DescribeImageAttributeResponseType
Children: value
ramdisk
ID of the parent element.
Type: xsd:string
Ancestor: ramdisk
Children: None
value
User-created description of the AMI.
Type: NullableAttributeValueType (p. 670)
Ancestor: DescribeImageAttributeResponseType
Children: value
description
ID of the parent element.
Type: xsd:string
Ancestor: description
Children: None
value
API Version 2010-08-31346
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Block device mapping set.
Type: BlockDeviceMappingType (p. 568)
Ancestor: DescribeImageAttributeResponseType
Children: item
blockDeviceMapping
Information for one block device mapping.
Type: BlockDeviceMappingItemType (p. 567)
Ancestor: blockDeviceMapping
Children: deviceName, virtualName, ebs, and noDevice
item
The device name (e.g., /dev/sdh).
Type: xsd:string
Ancestor: item
Children: None
deviceName
The virtual device name.
Type: xsd:string
Ancestor: item
Children: None
virtualName
Specifies parameters used to automatically set up Amazon EBSvolumes when the instance is launched.
Type: EbsBlockDeviceType (p. 643)
Ancestor: item
Children:snapshotId, volumeSize, and deleteOnTermination
ebs
The ID of the snapshot.
Type: xsd:string
Ancestor: ebs
Children: None
snapshotId
The size of the volume, in GiBs. Required if you are not creating avolume from a snapshot.
Type: xsd:int
Ancestor: ebs
Children: None
volumeSize
Specifies whether the Amazon EBS volume is deleted on instancetermination.
Type: xsd:boolean
Ancestor: ebs
Children: None
deleteOnTermination
Specifies the device name to suppress during instance launch.
Type: EmptyElementType (p. 644)
Ancestor: item
Children: none
noDevice
API Version 2010-08-31347
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
This element contains no options.
Type: xsd:string
Ancestor: noDevice
Children: None
none
Examples
Example RequestThis example lists the launch permissions for the ami-61a54008 AMI.
<DescribeImageAttribute xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <imageId>ami-2bb65342</imageId> <launchPermission/></DescribeImageAttribute>
Example Response<DescribeImageAttributeResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <imageId>ami-61a54008</imageId> <launchPermission> <item> <group>all</group> </item> <item> <userId>495219933132</userId> </item> </launchPermission></DescribeImageAttributeResponse>
Example RequestThis example lists the product code for the ami-2bb65342 AMI.
<DescribeImageAttribute xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <imageId>ami-2bb65342</imageId> <productCodes/></DescribeImageAttribute>
Example Response<DescribeImageAttributeResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <imageId>ami-2bb65342</imageId> <productCodes> <item> <productCode>774F4FF8</productCode> </item> </productCodes> </DescribeImageAttributeResponse>
API Version 2010-08-31348
Amazon Elastic Compute Cloud API ReferenceExamples
Related Operations• DescribeImages (p. 350)
• ModifyImageAttribute (p. 474)
• ResetImageAttribute (p. 512)
API Version 2010-08-31349
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DescribeImages
DescriptionReturns information about AMIs, AKIs, and ARIs. Images available to you include public images, privateimages that you own, and private images owned by other AWS accounts but for which you have explicitlaunch permissions.
Launch permissions fall into three categories:
DescriptionLaunchPermission
The owner of the AMI granted launch permissions for the AMI to the all group.All AWS accounts have launch permissions for these AMIs.
public
The owner of the AMI granted launch permissions to a specific AWS account.explicit
An AWS account has implicit launch permissions for all the AMIs it owns.implicit
The list of AMIs returned can be modified by specifying AMI IDs, AMI owners, or AWS accounts withlaunch permissions. If no options are specified, Amazon EC2 returns all AMIs for which you have launchpermissions.
If you specify one or more AMI IDs, only AMIs that have the specified IDs are returned. If you specify aninvalid AMI ID, a fault is returned. If you specify an AMI ID for which you do not have access, it will notbe included in the returned results.
If you specify one or more AMI owners, only AMIs from the specified owners and for which you haveaccess are returned. The results can include the account IDs of the specified owners, amazon for AMIsowned by Amazon, or self for AMIs that you own.
If you specify a list of executable users, only AMIs with launch permissions for those users are returned.You can specify account IDs (if you own the AMI(s)), self for AMIs for which you own or have explicitpermissions, or all for public AMIs.
Note
Deregistered images are included in the returned results for an unspecified interval afterderegistration.
You can filter the results to return information only about images that match criteria you specify. Forexample, you could get information only about images that use a certain kernel.You can specify multiplevalues for a filter (e.g., the image uses either kernel aki-1a2b3c4d or kernel aki-9b8c7d6f). An imagemust match at least one of the specified values for it to be included in the results.
You can specify multiple filters (e.g., the image uses a certain kernel, and uses an Amazon EBS volumeas the root device). The result includes information for a particular image only if it matches all your filters.If there's no match, no special message is returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactlyone character.You can escape special characters using a backslash before the character. For example,a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following table shows the available filters.
API Version 2010-08-31350
Amazon Elastic Compute Cloud API ReferenceDescribeImages
DescriptionFilter Name
Image architecture.
Type: String
Valid Values: i386 | x86_64
architecture
Whether the Amazon EBS volume is deleted oninstance termination.
Type: Boolean
block-device-mapping.delete-on-termination
Device name (e.g., /dev/sdh) for an Amazon EBSvolume mapped to the image.
Type: String
block-device-mapping.device-name
Snapshot ID for an Amazon EBS volume mappedto the image.
Type: String
block-device-mapping.snapshot-id
Volume size for an Amazon EBS volume mappedto the image.
Type: Integer
block-device-mapping.volume-size
Description of the AMI (provided during imagecreation).
Type: String
description
ID of the image.
Type: String
image-id
Type of image.
Type: String
Valid Values: machine | kernel | ramdisk
image-type
Whether the image is public.
Type: Boolean
is-public
Kernel ID.
Type: String
kernel-id
Location of the image manifest.
Type: String
manifest-location
Name of the AMI (provided during image creation).
Type: String
name
AWS account alias (e.g., amazon or self) or AWSaccount ID that owns the AMI.
Type: String
owner-alias
AWS account ID of the image owner.
Type: String
owner-id
API Version 2010-08-31351
Amazon Elastic Compute Cloud API ReferenceDescription
DescriptionFilter Name
Use windows if you have Windows based AMIs;otherwise leave blank.
Type: String
Valid Value: windows
platform
Product code associated with the AMI.
Type: String
product-code
RAM disk ID.
Type: String
ramdisk-id
Root device name of the AMI (e.g., /dev/sda1).
Type: String
root-device-name
Root device type the AMI uses.
Type: String
Valid Values: ebs | instance-store
root-device-type
State of the image.
Type: String
Valid Values: available | pending | failed
state
Reason code for the state change.
Type: String
state-reason-code
Message for the state change.
Type: String
state-reason-message
Key of a tag assigned to the resource. This filter isindependent of the tag-value filter. For example,if you use both the filter tag-key=Purpose andthe filter tag-value=X, you get any resourcesassigned both the tag key Purpose (regardless ofwhat the tag's value is), and the tag value X(regardless of what the tag's key is). If you want tolist only resources where Purpose=X, see thetag:key filter later in this table.
For more information about tags, go to Using Tagsin the Amazon Elastic Compute Cloud DeveloperGuide.
Type: String
tag-key
Value of a tag assigned to the resource. This filteris independent of the tag-key filter.
Type: String
tag-value
API Version 2010-08-31352
Amazon Elastic Compute Cloud API ReferenceDescription
DescriptionFilter Name
Filters the results based on a specific tag/valuecombination.
Example: To list just the resources assigned tagPurpose=X, then specify:
Filter.1.Name=tag:Purpose
Filter.1.Value.1=X
Example: To list just resources assigned tagPurpose=X OR Purpose=Y, then specify:
Filter.1.Name=tag:Purpose
Filter.1.Value.1=X
Filter.1.Value.2=Y
tag:key
Virtualization type of the image.
Type: String
Valid Values: paravirtual | hvm
virtualization-type
Request Parameters
RequiredDescriptionName
DescribeImagesType element.
Type: DescribeImagesType (p. 608)
Ancestor: None
Children: executableBySet, imagesSet, andownersSet
DescribeImagesType
YesExecutable set. It must be present, but can be empty.
Type: DescribeImagesExecutableBySetType (p. 602)
Ancestor: DescribeImagesType
Children: item
executableBySet
NoInformation for one user.
Type: DescribeImagesExecutableByType (p. 602)
Ancestor: executableBySet
Children: user
item
NoReturns AMIs for which the specified user has explicitlaunch permissions. The user ID can be a user's accountID, self to return AMIs for which the sender of the requesthas explicit launch permissions, or all to return AMIs withpublic launch permissions.
Type: xsd:string
Default: None
Ancestor: item
Children: None
user
API Version 2010-08-31353
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
RequiredDescriptionName
YesImage set. It must be present, but can be empty.
Type: DescribeImagesInfoType (p. 603)
Ancestor: DescribeImagesType
Children: item
imagesSet
NoInformation for one image.
Type: DescribeImagesItemType (p. 603)
Ancestor: imagesSet
Children: imageId
item
NoAMI IDs to describe.
Type: xsd:string
Default: Returns all AMIs.
Ancestor: item
Children: None
imageId
YesInformation about an owner. It must be present, but canbe empty.
Type: DescribeImagesOwnersType (p. 604)
Ancestor: DescribeImagesType
Children: item
ownersSet
NoInformation for one owner.
Type: DescribeImagesOwnerType (p. 604)
Ancestor: ownersSet
Children: owner
item
NoReturns AMIs owned by the specified owner. Multipleowner values can be specified.The IDs amazon and selfcan be used to include AMIs owned by Amazon or AMIsowned by you, respectively
Type: xsd:string
Default: None
Ancestor: item
Children: None
owner
YesSet of filters. It must be present, but can be empty.
Type: FilterSetType
Children: item
filterSet
NoInformation for one filter.
Type: FilterType
Ancestor: filterSet
Children: name, valueSet
item
NoName of a filter.
Type: xsd:string
Ancestor: item
Children: None
name
API Version 2010-08-31354
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
RequiredDescriptionName
NoOne or more values.
Type: ValueSetType
Ancestor: item
Children: item
valueSet
NoAn item in the set.
Type: ValueType
Ancestor: valueSet
Children: value
item
NoAn individual value.
Type: xsd:string
Ancestor: item
Children: None
value
Response Elements
DescriptionName
DescribeImagesResponse element.
Type: DescribeImagesResponseType (p. 607)
Ancestor: None
Children: requestId, imagesSet
DescribeImagesResponse
The ID of the request.
Type: xsd:string
Ancestor: DescribeImagesResponseType
Children: None
requestId
Image set.
Type: DescribeImagesResponseInfoType (p. 605)
Ancestor: DescribeImagesResponseType
Children: item
imagesSet
Information for one image.
Type: DescribeImagesResponseItemType (p. 605)
Ancestor: imagesSet
Children:imageId, imageLocation, imageState, imageOwnerId,isPublic, productCodes, architecture, imageType,kernelId, ramdiskId, platform, stateReason,imageOwnerAlias, name, description, rootDeviceType,rootDeviceName, blockDeviceMapping, virtualizationType,tags
item
The ID of the AMI.
Type: xsd:string
Ancestor: item
Children: None
imageId
API Version 2010-08-31355
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
The location of the AMI.
Type: xsd:string
Ancestor: item
Children: None
imageLocation
Current state of the AMI. If the operation returns available, theimage is successfully registered and available for launching.
Type: xsd:string
available | pending | failed
Ancestor: item
Children: None
imageState
AWS account ID of the image owner.
Type: xsd:string
Ancestor: item
Children: None
imageOwnerId
Returns true if this image has public launch permissions. Returnsfalse if it only has implicit and explicit launch permissions.
Type: xsd:boolean
Ancestor: item
Children: None
isPublic
Product codes of the AMI.
Type: ProductCodesSetType (p. 674)
Ancestor: item
Children: item
productCodes
Information for one product code.
Type: ProductCodesSetItemType (p. 674)
Ancestor: productCodes
Children: productCode
item
Product code.
Type: xsd:string
Ancestor: item
Children: None
productCode
The architecture of the image.
Type: xsd:string
Valid Values: i386 | x86_64
Ancestor: item
Children: None
architecture
The type of image (machine, kernel, or ramdisk).
Type: xsd:string
Ancestor: item
Children: None
imageType
API Version 2010-08-31356
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
The kernel associated with the image, if any. Only applicable formachine images.
Type: xsd:string
Ancestor: item
Children: None
kernelId
The RAM disk associated with the image, if any. Only applicable formachine images.
Type: xsd:string
Ancestor: item
Children: None
ramdiskId
Value is Windows for Windows AMIs; otherwise blank.
Type: xsd:string
Valid Value: Windows
Ancestor: item
Children: None
platform
The reason for the state change. See StateReasonType (p. 704) fora listing of supported state change codes.
Type: StateReasonType (p. 704)
Ancestor: item
Children: code, message
stateReason
Reason code for the state change.
Type: xsd:string
Ancestor: stateReason
Children: None
code
Message for the state change.
Type: xsd:string
Ancestor: stateReason
Children: None
message
The AWS account alias (e.g., "amazon", "redhat", "self", etc.) or AWSaccount ID that owns the AMI.
Type: xsd:string
Ancestor: item
Children: None
imageOwnerAlias
The name of the AMI that was provided during image creation.
Type: xsd:string
Ancestor: item
Children: None
name
The description of the AMI that was provided during image creation.
Type: xsd:string
Ancestor: item
Children: None
description
API Version 2010-08-31357
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
The root device type used by the AMI. The AMI can use an AmazonEBS or instance store root device.
Type: xsd:string
Valid Values: ebs | instance-store
Ancestor: item
Children: None
rootDeviceType
The root device name (e.g., /dev/sda1).
Type: xsd:string
Ancestor: item
Children: None
rootDeviceName
Specifies how block devices are exposed to the instance.
Type: BlockDeviceMappingType (p. 568)
Ancestor: item
Children: item
blockDeviceMapping
Information for one block device mapping.
Type: BlockDeviceMappingItemType (p. 567)
Ancestor: blockDeviceMapping
Children: deviceName, virtualName, ebs, and noDevice
item
The device name (e.g., /dev/sdh).
Type: xsd:string
Ancestor: item
Children: None
deviceName
The virtual device name.
Type: xsd:string
Ancestor: item
Children: None
virtualName
Specifies parameters used to automatically setup Amazon EBSvolumes when the instance is launched.
Type: EbsBlockDeviceType (p. 643)
Ancestor: item
Children:snapshotId, volumeSize, and deleteOnTermination
ebs
The ID of the snapshot.
Type: xsd:string
Ancestor: ebs
Children: None
snapshotId
The size of the volume, in GiBs. Required if you are not creating avolume from a snapshot.
Type: xsd:int
Ancestor: ebs
Children: None
volumeSize
API Version 2010-08-31358
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Specifies whether the Amazon EBS volume is deleted on instancetermination.
Type: xsd:boolean
Ancestor: ebs
Children: None
deleteOnTermination
Specifies the device name to suppress during instance launch.
Type: EmptyElementType (p. 644)
Ancestor: item
Children:
noDevice
Specifies the type of virtualization in which your instance is running.Valid values are (paravirtual or hvm)
Type: xsd:string
Ancestor: None
Children: None
virtualizationType
Tags assigned to the resource.
Type: ResourceTagSetType
Ancestor: item
Children: item
tagSet
Information about one tag.
Type: ResourceTagSetItemType
Ancestor: tagSet
Children: key, value
item
Tag key.
Type: xsd:string
Ancestor: item
Children: None
key
Tag value.
Type: xsd:string
Ancestor: item
Children: None
value
Examples
Example RequestThis example describes the ami-be3adfd7 AMI.
<DescribeImages xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <executableBySet/> <ownersSet/> <imagesSet> <item> <imageId>ami-be3adfd7</imageId>
API Version 2010-08-31359
Amazon Elastic Compute Cloud API ReferenceExamples
</item> </imagesSet> <filterSet;></DescribeImages>
Example Response<DescribeImagesResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <imagesSet> <item> <imageId>ami-be3adfd7</imageId> <imageLocation>amazon/getting-started</imageLocation> <imageState>available</imageState> <imageOwnerId>206029621532</imageOwnerId> <isPublic>true</isPublic> <architecture>i386</architecture> <imageType>machine</imageType> <kernelId>aki-d3376696</kernelId> <ramdiskId>ari-e73766a2</ramdiskId> <imageOwnerAlias>amazon</imageOwnerAlias> <name>getting-started</name> <description>Fedora 8 v1.11 i386 lvm-rootVG-rootFS ext3 ec2pnp enabled</de scription> <rootDeviceType>ebs</rootDeviceType> <rootDeviceName>/dev/sda</rootDeviceName> <blockDeviceMapping> <item> <deviceName>/dev/sda</deviceName> <ebs> <snapshotId>snap-32885f5a</snapshotId> <volumeSize>15</volumeSize> <deleteOnTermination>false</deleteOnTermination> </ebs> </item> </blockDeviceMapping> <virtualizationType>paravirtual</virtualizationType> <tagSet/> </item> </imagesSet></DescribeImagesResponse>
Example RequestThis example filters the results to display only the public Windows images with an x86_64 architecture.
<DescribeImages xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <executableBySet/> <imagesSet/> <ownersSet/> <filterSet> <item> <name>is-public</name> <valueSet> <item> <value>true</value> </item> </valueSet> </item>
API Version 2010-08-31360
Amazon Elastic Compute Cloud API ReferenceExamples
<item> <name>architecture</name> <valueSet> <item> <value>x86_64</value> </item> </valueSet> </item> <item> <name>platform</name> <valueSet> <item> <value>windows</value> </item> </valueSet> </item> </filterSet></DescribeImages>
Example Response<DescribeImagesResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <imagesSet> <item> <imageId>ami-dd20c3b4</imageId> <imageLocation>ec2-public-windows-images/Server2003r2-x86_64-Win-v1.07.manifest.xml</imageLocation> <imageState>available</imageState> <imageOwnerId>206029621532</imageOwnerId> <isPublic>true</isPublic> <architecture>x86_64</architecture> <imageType>machine</imageType> <platform>windows</platform> <imageOwnerAlias>amazon</imageOwnerAlias> <rootDeviceType>instance-store</rootDeviceType> <blockDeviceMapping/> <virtualizationType>hvm</virtualizationType> <tagSet/> </item> ... </imagesSet></DescribeImagesResponse>
Related Operations• DescribeInstances (p. 367)
• DescribeImageAttribute (p. 344)
API Version 2010-08-31361
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DescribeInstanceAttribute
DescriptionReturns information about an attribute of an instance.You can get information about only one attributeper call.
Request Parameters
RequiredDescriptionName
DescribeInstanceAttribute element.
Type: DescribeInstanceAttributeType (p. 610)
Ancestor: None
Children: instanceId,DescribeInstanceAttributesGroup, filterSet
DescribeInstanceAttribute
YesThe instance ID.
Type: xsd:string
Default: None
Ancestor: DescribeInstanceAttribute
Children: None
instanceId
YesThe group of available attributes to describe.
Type: DescribeInstanceAttributesGroup (p. 609)
Ancestor: DescribeInstanceAttribute
Children:instanceType, kernel, ramdisk, userData,disableApiTermination,instanceInitiatedShutdownBehavior,rootDeviceName, and blockDeviceMapping
DescribeInstanceAttributesGroup
NoReturns the instance type.
Type: EmptyElementType (p. 644)
Ancestor: DescribeInstanceAttributesGroup
Children: None
instanceType
NoReturns the kernel ID.
Type: EmptyElementType (p. 644)
Ancestor: DescribeInstanceAttributesGroup
Children: None
kernel
NoReturns the RAM disk ID.
Type: EmptyElementType (p. 644)
Ancestor: DescribeInstanceAttributesGroup
Children: None
ramdisk
NoReturns the MIME, Base64-encoded user data.
Type: EmptyElementType (p. 644)
Ancestor: DescribeInstanceAttributesGroup
Children: None
userData
API Version 2010-08-31362
Amazon Elastic Compute Cloud API ReferenceDescribeInstanceAttribute
RequiredDescriptionName
NoReturns the value for the disableApiTerminationattribute, which specifies whether the instance can beterminated using the APIs. The default value for thisattribute is true.
Type: EmptyElementType (p. 644)
Ancestor: DescribeInstanceAttributesGroup
Children: None
disableApiTermination
NoReturns the value for theinstanceInitiatedShutdownBehavior attribute, whichcontrols whether the instance stops or terminates whenan instance shutdown is initiated The default value for theattribute is stop.
Type: EmptyElementType (p. 644)
Ancestor: DescribeInstanceAttributesGroup
Children: None
instanceInitiatedShutdownBehavior
NoReturns the root device name (e.g., /dev/sda1).
Type: EmptyElementType (p. 644)
Ancestor: DescribeInstanceAttributesGroup
Children: None
rootDeviceName
NoReturns the instance's block device mapping.
Type: EmptyElementType (p. 644)
Ancestor: DescribeInstanceAttributesGroup
Children: None
blockDeviceMapping
Response Elements
DescriptionName
DescribeInstanceAttributeResponseType element.
Type: DescribeInstanceAttributeResponseType (p. 608)
Ancestor: None
Children: requestId, instanceId, instanceType, kernel,ramdisk, userData, disableApiTermination,instanceInitiatedShutdownBehavior, rootDeviceName, andblockDeviceMapping
DescribeInstanceAttributeResponseType
The ID of the request.
Type: xsd:string
Ancestor: DescribeInstanceAttributeResponseType
Children: None
requestId
The ID of the instance.
Type: xsd:string
Ancestor: DescribeInstanceAttributeResponseType
Children: None
instanceId
API Version 2010-08-31363
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
The instance type (e.g., m1.small, c1.medium, m2.2xlarge, and soon).
Type: NullableAttributeValueType (p. 670)
Ancestor: DescribeInstanceAttributeResponseType
Children: value
instanceType
ID of the parent element.
Type: xsd:string
Ancestor: instanceType
Children: None
value
The kernel ID.
Type: NullableAttributeValueType (p. 670)
Ancestor: DescribeInstanceAttributeResponseType
Children: value
kernel
ID of the parent element.
Type: xsd:string
Ancestor: kernel
Children: None
value
The RAM disk ID.
Type: NullableAttributeValueType (p. 670)
Ancestor: DescribeInstanceAttributeResponseType
Children: value
ramdisk
ID of the parent element.
Type: xsd:string
Ancestor: ramdisk
Children: None
value
MIME, Base64-encoded user data.
Type: NullableAttributeValueType (p. 670)
Ancestor: DescribeInstanceAttributeResponseType
Children: value
userData
ID of the parent element.
Type: xsd:string
Ancestor: userData
Children: None
value
Specifies whether the instance can be terminated.You must modifythis attribute before you can terminate any "locked" instances.
Type: NullableAttributeBooleanValueType (p. 670)
Ancestor: DescribeInstanceAttributeResponseType
Children: value
disableApiTermination
API Version 2010-08-31364
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Generic boolean value.
Type: xsd:boolean
Valid Values: true | false
Ancestor: disableApiTermination
Children: None
value
If an instance shutdown is initiated, this determines whether theinstance stops or terminates.
Type: NullableAttributeValueType (p. 670)
Ancestor: DescribeInstanceAttributeResponseType
Children: value
instanceInitiatedShutdownBehavior
ID of the parent element.
Type: xsd:string
Ancestor: instanceInitiatedShutdownBehavior
Children: None
value
The root device name (e.g., /dev/sda1).
Type: NullableAttributeValueType (p. 670)
Ancestor: DescribeInstanceAttributeResponseType
Children: value
rootDeviceName
ID of the parent element.
Type: xsd:string
Ancestor: rootDeviceName
Children: None
value
Specifies how block devices are exposed to the instance. Eachmapping is made up of a virtualName and a deviceName.
Type: InstanceBlockDeviceMappingResponseType (p. 650)
Ancestor: DescribeInstanceAttributeResponseType
Children: item
blockDeviceMapping
The item element.
Type: InstanceBlockDeviceMappingResponseItemType (p. 650)
Ancestor: blockDeviceMapping
Children: deviceName, ebs
item
Specifies how the device is exposed to the instance (e.g., /dev/sdh).
Type: xsd:string
Ancestor: item
Children: None
deviceName
Specifies parameters used to automatically set up Amazon EBSvolumes when the instance is launched.
Type: EbsInstanceBlockDeviceMappingResponseType (p. 644)
Ancestor: item
Children: volumeId, status, attachTime, anddeleteOnTermination
ebs
API Version 2010-08-31365
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
The ID of the Amazon EBS volume.
Type: xsd:string
Ancestor: ebs
Children: None
volumeId
Attachment state.
Type: xsd:string
Valid Values: attaching | attached | detaching | detached
Ancestor: ebs
Children: None
status
Time stamp when the attachment initiated.
Type: xsd:dateTime
Ancestor: ebs
Children: None
attachTime
Specifies whether the Amazon EBS volume is deleted on instancetermination.
Type: xsd:boolean
Ancestor: ebs
Children: None
deleteOnTermination
Examples
Example RequestThis example lists the kernel ID of the i-10a64379 instance.
<DescribeInstanceAttribute xmlns="http://ec2.amazonaws.com/doc/2010-08-31/">; <instanceId>i-10a64379</instanceId> <kernel/></DescribeInstanceAttribute>
Example Response<DescribeInstanceAttributeResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <instanceId>i-10a64379</instanceId> <kernel> <value>aki-f70657b2</value> </kernel></DescribeInstanceAttributeResponse>
Related Operations• DescribeInstances (p. 367)
• ModifyInstanceAttribute (p. 479)
• ResetInstanceAttribute (p. 514)
API Version 2010-08-31366
Amazon Elastic Compute Cloud API ReferenceExamples
DescribeInstances
DescriptionReturns information about instances that you own.
If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you donot specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify aninvalid instance ID, a fault is returned. If you specify an instance that you do not own, it will not be includedin the returned results.
Recently terminated instances might appear in the returned results.This interval is usually less than onehour.
You can filter the results to return information only about instances that match criteria you specify. Forexample, you could get information about only instances launched with a certain key pair.You can specifymultiple values for a filter (e.g., the instance was launched with either key pair A or key pair B). An instancemust match at least one of the specified values for it to be included in the results.
You can specify multiple filters (e.g., the instance was launched with a certain key pair and uses anAmazon EBS volume as the root device). An instance must match all the filters for it to be included in theresults. If there's no match, no special message is returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactlyone character.You can escape special characters using a backslash before the character. For example,a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following table shows the available filters.
DescriptionFilter Name
Instance architecture.
Type: String
Valid Values: i386 | x86_64
architecture
Instance's Availability Zone.
Type: String
availability-zone
Attach time for an Amazon EBS volume mappedto the instance, e.g., 2010-09-15T17:15:20.000Z
Type: xsd:dateTime
block-device-mapping.attach-time
Whether the Amazon EBS volume is deleted oninstance termination.
Type: Boolean
block-device-mapping.delete-on-termination
Device name (e.g., /dev/sdh) for an Amazon EBSvolume mapped to the instance.
Type: String
block-device-mapping.device-name
Status for an Amazon EBS volume mapped to theinstance.
Type: String
Valid Values:attaching | attached | detaching| detached
block-device-mapping.status
API Version 2010-08-31367
Amazon Elastic Compute Cloud API ReferenceDescribeInstances
DescriptionFilter Name
ID for an Amazon EBS volume mapped to theinstance.
Type: String
block-device-mapping.volume-id
Idempotency token you provided when youlaunched the instance.
Type: String
client-token
Public DNS name of the instance.
Type: String
dns-name
A security group the instance is in.
Type: String
group-id
ID of the image used to launch the instance.
Type: String
image-id
ID of the instance.
Type: String
instance-id
Whether this is a Spot Instance.
Type: String
Valid Values: spot
instance-lifecycle
Code identifying the instance's state. A 16-bitunsigned integer. The high byte is an opaqueinternal value and should be ignored.The low byteis set based on the state represented
Type: String
Valid Values: 0 (pending) | 16 (running) | 32(shutting-down) | 48 (terminated) | 64 (stopping) |80 (stopped)
instance-state-code
Instance's state.
Type: String
Valid Values: pending | running |shutting-down | terminated | stopping |stopped
instance-state-name
Type of instance (e.g., m1.small).
Type: String
instance-type
Public IP address of the instance.
Type: String
ip-address
Kernel ID.
Type: String
kernel-id
Name of the key pair used when the instance waslaunched.
Type: String
key-name
API Version 2010-08-31368
Amazon Elastic Compute Cloud API ReferenceDescription
DescriptionFilter Name
When launching multiple instances at once, this isthe index for the instance in the launch group (e.g.,0, 1, 2, etc.).
Type: String
launch-index
Time instance was launched, e.g.,2010-08-07T11:54:42.000Z.
Type: xsd:dateTime
launch-time
Whether monitoring is enabled for the instance.
Type: String
Valid Values: disabled | enabled
monitoring-state
AWS account ID of the instance owner.
Type: String
owner-id
Name of the placement group the instance is in.
Type: String
placement-group-name
Use windows if you have Windows basedinstances; otherwise, leave blank.
Type: String
Valid Value: windows
platform
Private DNS name of the instance.
Type: String
private-dns-name
Private IP address of the instance.
Type: String
private-ip-address
Product code associated with the AMI used tolaunch the instance.
Type: String
product-code
RAM disk ID.
Type: String
ramdisk-id
Reason for the instance's current state (e.g., shows"User Initiated [date]" when you stop or terminatethe instance). Similar to the state-reason-code filter.
Type: String
reason
ID of the entity that launched the instance on yourbehalf (e.g., AWS Management Console, AutoScaling, etc.)
Type: String
requester-id
ID of the instance's reservation.
Type: String
reservation-id
Root device name of the instance (e.g., /dev/sda1).
Type: String
root-device-name
API Version 2010-08-31369
Amazon Elastic Compute Cloud API ReferenceDescription
DescriptionFilter Name
Root device type the instance uses.
Type: String
Valid Values: ebs | instance-store
root-device-type
ID of the Spot Instance request.
Type: String
spot-instance-request-id
Reason code for the state change.
Type: String
state-reason-code
Message for the state change.
Type: String
state-reason-message
ID of the subnet the instance is in (if using AmazonVirtual Private Cloud).
Type: String
subnet-id
Key of a tag assigned to the resource. This filter isindependent of the tag-value filter. For example,if you use both the filter tag-key=Purpose andthe filter tag-value=X, you get any resourcesassigned both the tag key Purpose (regardless ofwhat the tag's value is), and the tag value X(regardless of what the tag's key is). If you want tolist only resources where Purpose=X, see thetag:key filter later in this table.
For more information about tags, go to Using Tagsin the Amazon Elastic Compute Cloud DeveloperGuide.
Type: String
tag-key
Value of a tag assigned to the resource. This filteris independent of the tag-key filter.
Type: String
tag-value
Filters the results based on a specific tag/valuecombination.
Example: To list just the resources assigned tagPurpose=X, then specify:
Filter.1.Name=tag:Purpose
Filter.1.Value.1=X
Example: To list just resources assigned tagPurpose=X OR Purpose=Y, then specify:
Filter.1.Name=tag:Purpose
Filter.1.Value.1=X
Filter.1.Value.2=Y
tag:key
Virtualization type of the instance.
Type: String
Valid Values: paravirtual | hvm
virtualization-type
API Version 2010-08-31370
Amazon Elastic Compute Cloud API ReferenceDescription
DescriptionFilter Name
ID of the VPC the instance is in (if using AmazonVirtual Private Cloud).
Type: String
vpc-id
Request Parameters
RequiredDescriptionName
DescribeInstancesType element.
Type: DescribeInstancesType (p. 612)
Ancestor: None
Children: instancesSet
DescribeInstancesType
YesInstances set. It must be present, but can be empty.
Type: DescribeInstancesInfoType (p. 611)
Ancestor: DescribeInstancesType
Children: item
instancesSet
NoInformation for one instance set.
Type: DescribeInstancesItemType (p. 611)
Ancestor: instancesSet
Children: instanceId
item
NoInstance IDs to describe.
Type: xsd:string
Default: Returns all instances.
Ancestor: item
Children: None
instanceId
YesSet of filters. It must be present, but can be empty.
Type: FilterSetType
Children: item
filterSet
NoInformation for one filter.
Type: FilterType
Ancestor: filterSet
Children: name, valueSet
item
NoName of a filter.
Type: xsd:string
Ancestor: item
Children: None
name
NoOne or more values.
Type: ValueSetType
Ancestor: item
Children: item
valueSet
API Version 2010-08-31371
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
RequiredDescriptionName
NoAn item in the set.
Type: ValueType
Ancestor: valueSet
Children: value
item
NoAn individual value.
Type: xsd:string
Ancestor: item
Children: None
value
Response Elements
DescriptionName
DescribeInstancesResponse element.
Type: DescribeInstancesResponseType (p. 612)
Ancestor: None
Children: requestId, reservationSet
DescribeInstancesResponse
The ID of the request.
Type: xsd:string
Ancestor: DescribeInstancesResponseType
Children: None
requestId
Reservation set.
Type: ReservationSetType (p. 685)
Ancestor: DescribeInstancesResponseType
Children: item
reservationSet
Information for a reservation.
Type: ReservationInfoType (p. 685)
Ancestor: reservationSet
Children: reservationId, ownerId, groupSet, instancesSet,and requesterId
item
Unique ID of the reservation.
Type: xsd:string
Ancestor: item
Children: None
reservationId
AWS account ID of the user who owns the reservation.
Type: xsd:string
Ancestor: item
Children: None
ownerId
API Version 2010-08-31372
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Group set.
Type: GroupSetType (p. 648)
Ancestor: item
Children: item
groupSet
Group set item.
Type: GroupItemType (p. 648)
Ancestor: groupSet
Children: groupId
item
Name of the security group.
Type: xsd:string
Ancestor: item
Children: None
groupId
Instance set.
Type: RunningInstancesSetType (p. 696)
Ancestor: item
Children: item
instancesSet
Running instance set item.
Type: RunningInstancesItemType (p. 694)
Ancestor: instancesSet
Children: instanceId, imageId, instanceState,privateDnsName, dnsName, reason, keyName, amiLaunchIndex,productCodes, instanceType, launchTime, placement,kernelId, ramdiskId, platform, monitoring, subnetId,vpcId, privateIpAddress, ipAddress, stateReason,architecture, rootDeviceType, rootDeviceName,blockDeviceMapping, instanceLifecycle,spotInstanceRequestId, virtualizationType, clientToken,tagSet
item
Unique ID of the instance launched.
Type: xsd:string
Ancestor: item
Children: None
instanceId
Image ID of the AMI used to launch the instance.
Type: xsd:string
Ancestor: item
Children: None
imageId
The current state of the instance.
Type: InstanceStateType (p. 655)
Ancestor: item
Children: code, name
instanceState
API Version 2010-08-31373
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
A 16-bit unsigned integer. The high byte is an opaque internal valueand should be ignored. The low byte is set based on the staterepresented:
Type: xsd:int
Valid Values: 0 (pending) | 16 (running) | 32(shutting-down) | 48 (terminated) | 64 (stopping) | 80(stopped)
Ancestor: instanceState
Children: None
code
The current state of the instance.
Type: xsd:string
Valid Values: pending | running | shutting-down | terminated| stopping | stopped
Ancestor: instanceState
Children: None
name
The private DNS name assigned to the instance. This DNS namecan only be used inside the Amazon EC2 network. This elementremains empty until the instance enters a running state.
Type: xsd:string
Ancestor: item
Children: None
privateDnsName
The public DNS name assigned to the instance. This DNS name iscontactable from outside the Amazon EC2 network. This elementremains empty until the instance enters a running state.
Type: xsd:string
Ancestor: item
Children: None
dnsName
Reason for the most recent state transition. This might be an emptystring.
Type: xsd:string
Ancestor: item
Children: None
reason
If this instance was launched with an associated key pair, this displaysthe key pair name.
Type: xsd:string
Ancestor: item
Children: None
keyName
The AMI launch index, which can be used to find this instance withinthe launch group.
Type: xsd:string
Ancestor: item
Children: None
amiLaunchIndex
API Version 2010-08-31374
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Amazon DevPay product codes attached to this instance.
Type: ProductCodesSetType (p. 674)
Ancestor: item
Children: item
productCodes
Information for one product code.
Type: ProductCodesSetItemType (p. 674)
Ancestor: productCodes
Children: productCode
item
The Amazon DevPay product code associated with the instance.
Type: xsd:string
Ancestor: item
Children: None
productCode
The instance type.
Type: xsd:string
Ancestor: item
Children: None
instanceType
The time the instance launched.
Type: xsd:dateTime
Ancestor: item
Children: None
launchTime
The location where the instance launched.
Type: PlacementResponseType (p. 672)
Ancestor: item
Children: availabilityZone
placement
Returns the Availability Zone of the instance.
Type: xsd:string
Ancestor: placement
Children: None
availabilityZone
The ID of the placement group the instance is in (for cluster computeinstances).
Type: xsd:string
Default: None
Ancestor: placement
Children: None
groupName
The name of the placement group the instance is in (for clustercompute instances).
Type: xsd:string
Default: None
Ancestor: placement
Children: None
groupName
API Version 2010-08-31375
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Kernel associated with this instance.
Type: xsd:string
Ancestor: item
Children: None
kernelId
RAM disk associated with this instance.
Type: xsd:string
Ancestor: item
Children: None
ramdiskId
Platform of the instance (e.g. Windows).
Type: xsd:string
Ancestor: item
Children: None
platform
Indicates whether monitoring is enabled for the instance.
Type: InstanceMonitoringStateType (p. 653)
Ancestor: item
Children: state
monitoring
State of monitoring for the instance.
Type: xsd:string
Valid Values: monitoring-enabled (enabled) |monitoring-pending (pending) | monitoring-disabling(disabling) | monitoring-disabled (disabled)
Ancestor: monitoring
Children: None
state
Specifies the Amazon VPC subnet ID in which the instance is running.
Type: xsd:string
Ancestor: item
Children: None
subnetId
Specifies the Amazon VPC in which the instance is running.
Type: xsd:string
Ancestor: item
Children: None
vpcId
Specifies the private IP address that is assigned to the instance.
Type: xsd:string
Ancestor: item
Children: None
privateIpAddress
Specifies the IP address of the instance.
Type: xsd:string
Ancestor: item
Children: None
ipAddress
API Version 2010-08-31376
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
The reason for the most recent state transition. SeeStateReasonType (p. 704) for a listing of supported state changecodes.
Type: StateReasonType (p. 704)
Ancestor: item
Children: code, message
stateReason
Reason code for the state change.
Type: xsd:string
Ancestor: stateReason
Children: None
code
Message for the state change.
Type: xsd:string
Ancestor: stateReason
Children: None
message
The architecture of the image.
Type: xsd:string
Valid Values: i386 | x86_64
Ancestor: item
Children: None
architecture
The root device type used by the AMI. The AMI can use an AmazonEBS or instance store root device.
Type: xsd:string
Valid Values: ebs | instance-store
Ancestor: item
Children: None
rootDeviceType
The root device name (e.g., /dev/sda1).
Type: xsd:string
Ancestor: item
Children: None
rootDeviceName
Block device mapping set.
Type: InstanceBlockDeviceMappingResponseType (p. 650)
Ancestor: item
Children: item
blockDeviceMapping
The item element.
Type: InstanceBlockDeviceMappingResponseItemType (p. 650)
Ancestor: blockDeviceMapping
Children: deviceName, ebs
item
Specifies how the device is exposed to the instance (e.g., /dev/sdh).
Type: xsd:string
Ancestor: item
Children: None
deviceName
API Version 2010-08-31377
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Specifies parameters used to automatically setup Amazon EBSvolumes when the instance is launched.
Type: EbsInstanceBlockDeviceMappingResponseType (p. 644)
Ancestor: item
Children: volumeId, status, attachTime, anddeleteOnTermination
ebs
The ID of the Amazon EBS volume.
Type: xsd:string
Ancestor: ebs
Children: None
volumeId
Attachment state.
Type: xsd:string
Valid Values: attaching | attached | detaching | detached
Ancestor: ebs
Children: None
status
Time stamp when the attachment initiated.
Type: xsd:dateTime
Ancestor: ebs
Children: None
attachTime
Specifies whether the Amazon EBS volume is deleted on instancetermination.
Type: xsd:boolean
Ancestor: ebs
Children: None
deleteOnTermination
Indicates the life cycle of the instance.
Type: xsd:string
Valid Values: spot | blank (no value)
Ancestor: item
Children: None
instanceLifecycle
The ID of the Spot Instance request.
Type: xsd:string
Ancestor: item
Children: None
spotInstanceRequestId
Specifies the instance's virtualization type.
Type: xsd:string
Valid Values: paravirtual | hvm
Ancestor: item
Children: None
virtualizationType
API Version 2010-08-31378
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Idempotency token you provided when you launched the instance.
Type: xsd:string
Ancestor: item
Children: None
clientToken
Tags assigned to the resource.
Type: ResourceTagSetType
Ancestor: item
Children: item
tagSet
Information about one tag.
Type: ResourceTagSetItemType
Ancestor: tagSet
Children: key, value
item
Tag key.
Type: xsd:string
Ancestor: item
Children: None
key
Tag value.
Type: xsd:string
Ancestor: item
Children: None
value
ID of the requester.
Type: xsd:string
Ancestor: item
Children: None
requesterId
Examples
Example RequestThis example describes the current state of the instances owned by your AWS account.
<DescribeInstances xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <instancesSet/></DescribeInstances>
Example Response<DescribeInstancesResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <requestId>98e3c9a4-848c-4d6d-8e8a-b1bd857abf00</requestId> <reservationSet> <item> <reservationId>r-b27e30d9</reservationId> <ownerId>999988887777</ownerId> <groupSet>
API Version 2010-08-31379
Amazon Elastic Compute Cloud API ReferenceExamples
<item> <groupId>default</groupId> </item> </groupSet> <instancesSet> <item> <instanceId>i-c5cd56af</instanceId> <imageId>ami-1a2b3c4d</imageId> <instanceState> <code>16</code> <name>running</name> </instanceState> <privateDnsName>domU-12-31-39-10-56-34.compute-1.internal</privateDns Name> <dnsName>ec2-174-129-165-232.compute-1.amazonaws.com</dnsName> <reason/> <keyName>GSG_Keypair</keyName> <amiLaunchIndex>0</amiLaunchIndex> <productCodes/> <instanceType>m1.small</instanceType> <launchTime>2010-08-17T01:15:18.000Z</launchTime> <placement> <availabilityZone>us-east-1b</availabilityZone> <groupName/> </placement> <kernelId>aki-94c527fd</kernelId> <ramdiskId>ari-96c527ff</ramdiskId> <monitoring> <state>disabled</state> </monitoring> <privateIpAddress>10.198.85.190</privateIpAddress> <ipAddress>174.129.165.232</ipAddress> <architecture>i386</architecture> <rootDeviceType>ebs</rootDeviceType> <rootDeviceName>/dev/sda1</rootDeviceName> <blockDeviceMapping> <item> <deviceName>/dev/sda1</deviceName> <ebs> <volumeId>vol-a082c1c9</volumeId> <status>attached</status> <attachTime>2010-08-17T01:15:21.000Z</attachTime> <deleteOnTermination>false</deleteOnTermination> </ebs> </item> </blockDeviceMapping> <instanceLifecycle>spot</instanceLifecycle> <spotInstanceRequestId>sir-7a688402</spotInstanceRequestId> <virtualizationType>paravirtual</virtualizationType> <clientToken/> <tagSet/> </item> </instancesSet> <requesterId>854251627541</requesterId> </item> <item> <reservationId>r-b67e30dd</reservationId> <ownerId>999988887777</ownerId> <groupSet>
API Version 2010-08-31380
Amazon Elastic Compute Cloud API ReferenceExamples
<item> <groupId>default</groupId> </item> </groupSet> <instancesSet> <item> <instanceId>i-d9cd56b3</instanceId> <imageId>ami-1a2b3c4d</imageId> <instanceState> <code>16</code> <name>running</name> </instanceState> <privateDnsName>domU-12-31-39-10-54-E5.compute-1.internal</privateDns Name> <dnsName>ec2-184-73-58-78.compute-1.amazonaws.com</dnsName> <reason/> <keyName>GSG_Keypair</keyName> <amiLaunchIndex>0</amiLaunchIndex> <productCodes/> <instanceType>m1.large</instanceType> <launchTime>2010-08-17T01:15:19.000Z</launchTime> <placement> <availabilityZone>us-east-1b</availabilityZone> <groupName/> </placement> <kernelId>aki-94c527fd</kernelId> <ramdiskId>ari-96c527ff</ramdiskId> <monitoring> <state>disabled</state> </monitoring> <privateIpAddress>10.198.87.19</privateIpAddress> <ipAddress>184.73.58.78</ipAddress> <architecture>i386</architecture> <rootDeviceType>ebs</rootDeviceType> <rootDeviceName>/dev/sda1</rootDeviceName> <blockDeviceMapping> <item> <deviceName>/dev/sda1</deviceName> <ebs> <volumeId>vol-a282c1cb</volumeId> <status>attached</status> <attachTime>2010-08-17T01:15:23.000Z</attachTime> <deleteOnTermination>false</deleteOnTermination> </ebs> </item> </blockDeviceMapping> <instanceLifecycle>spot</instanceLifecycle> <spotInstanceRequestId>sir-55a3aa02</spotInstanceRequestId> <virtualizationType>paravirtual</virtualizationType> <clientToken/> <tagSet/> </item> </instancesSet> <requesterId>854251627541</requesterId> </item> </reservationSet></DescribeInstancesResponse>
API Version 2010-08-31381
Amazon Elastic Compute Cloud API ReferenceExamples
Example RequestThis example filters the results to display only the m1.small or m1.large instances that have an AmazonEBS volume that is both attached and set to delete on termination.
<DescribeInstances xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <instancesSet/> <filterSet> <item> <name>instance-type</name> <valueSet> <item> <value>m1.small</value> </item> <item> <value>m1.large</value> </item> </valueSet> </item> <item> <name>block-device-mapping.status</name> <valueSet> <item> <value>attached</value> </item> </valueSet> </item> <item> <name>block-device-mapping.delete-on-termination</name> <valueSet> <item> <value>true</value> </item> </valueSet> </item> </filterSet></DescribeInstances>
Example Response<DescribeInstancesResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <reservationSet> <item> <reservationId>r-bc7e30d7</reservationId> <ownerId>999988887777</ownerId> <groupSet> <item> <groupId>default</groupId> </item> </groupSet> <instancesSet> <item> <instanceId>i-c7cd56ad</instanceId> <imageId>ami-b232d0db</imageId> <instanceState> <code>16</code> <name>running</name> </instanceState>
API Version 2010-08-31382
Amazon Elastic Compute Cloud API ReferenceExamples
<privateDnsName>domU-12-31-39-01-76-06.compute-1.internal</privateDns Name> <dnsName>ec2-72-44-52-124.compute-1.amazonaws.com</dnsName> <keyName>GSG_Keypair</keyName> <amiLaunchIndex>0</amiLaunchIndex> <productCodes/> <instanceType>m1.small</instanceType> <launchTime>2010-08-17T01:15:16.000Z</launchTime> <placement> <availabilityZone>us-east-1b</availabilityZone> </placement> <kernelId>aki-94c527fd</kernelId> <ramdiskId>ari-96c527ff</ramdiskId> <monitoring> <state>disabled</state> </monitoring> <privateIpAddress>10.255.121.240</privateIpAddress> <ipAddress>72.44.52.124</ipAddress> <architecture>i386</architecture> <rootDeviceType>ebs</rootDeviceType> <rootDeviceName>/dev/sda1</rootDeviceName> <blockDeviceMapping> <item> <deviceName>/dev/sda1</deviceName> <ebs> <volumeId>vol-a482c1cd</volumeId> <status>attached</status> <attachTime>2010-08-17T01:15:26.000Z</attachTime> <deleteOnTermination>true</deleteOnTermination> </ebs> </item> </blockDeviceMapping/> <virtualizationType>paravirtual</virtualizationType> <clientToken/> <tagSet/> </item> </instancesSet> </item> </reservationSet></DescribeInstancesResponse>
Related Operations• RunInstances (p. 522)
• StopInstances (p. 542)
• StartInstances (p. 538)
• TerminateInstances (p. 546)
API Version 2010-08-31383
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DescribeKeyPairs
DescriptionReturns information about key pairs available to you. If you specify key pairs, information about thosekey pairs is returned. Otherwise, information for all registered key pairs is returned.
You can filter the results to return information only about key pairs that match criteria you specify. Forexample, you could filter the results to return only the key pairs whose names include the string Dave.You can specify multiple values for a filter. A key pair must match at least one of the specified values forit to be included in the results.
You can specify multiple filters (e.g., the key pair name includes the string Dave, and the fingerprint equalsa certain value). The result includes information for a particular key pair only if it matches all your filters.If there's no match, no special message is returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactlyone character.You can escape special characters using a backslash before the character. For example,a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following table shows the available filters.
DescriptionFilter Name
Fingerprint of the key pair.
Type: String
fingerprint
Name of the key pair.
Type: String
key-name
Request Parameters
RequiredDescriptionName
DescribeKeyPairsType element.
Type: DescribeKeyPairsType (p. 615)
Ancestor: None
Children: keySet
DescribeKeyPairsType
YesSet of key pairs. It must be present, but can be empty.
Type: DescribeKeyPairsInfoType (p. 613)
Ancestor: DescribeKeyPairsType
Children: item
keySet
NoInformation for a key pair.
Type: DescribeKeyPairsItemType (p. 613)
Ancestor: keySet
Children: keyName
item
API Version 2010-08-31384
Amazon Elastic Compute Cloud API ReferenceDescribeKeyPairs
RequiredDescriptionName
NoName of the key pair to describe.
Type: xsd:string
Default: Describes all key pairs you own, or only thoseotherwise specified.
Ancestor: item
Children: None
keyName
YesSet of filters. It must be present, but can be empty.
Type: FilterSetType
Children: item
filterSet
NoInformation for one filter.
Type: FilterType
Ancestor: filterSet
Children: name, valueSet
item
NoName of a filter.
Type: xsd:string
Ancestor: item
Children: None
name
NoOne or more values.
Type: ValueSetType
Ancestor: item
Children: item
valueSet
NoAn item in the set.
Type: ValueType
Ancestor: valueSet
Children: value
item
NoAn individual value.
Type: xsd:string
Ancestor: item
Children: None
value
Response Elements
DescriptionName
DescribeKeyPairsResponse element.
Type: DescribeKeyPairsResponseType (p. 615)
Ancestor: None
Children: requestId, keySet
DescribeKeyPairsResponse
API Version 2010-08-31385
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
The ID of the request.
Type: xsd:string
Ancestor: DescribeKeyPairsResponseType
Children: None
requestId
Information for a key pair.
Type: DescribeKeyPairsResponseInfoType (p. 614)
Ancestor: DescribeKeyPairsResponseType
Children: item
keySet
Information for a key pair.
Type: DescribeKeyPairsResponseItemType (p. 614)
Ancestor: keySet
Children: keyName, keyFingerprint
item
Name of the key pair.
Type: xsd:string
Ancestor: item
Children: None
keyName
A SHA-1 digest of the DER encoded private key.
Type: xsd:string
Ancestor: item
Children: None
keyFingerprint
Examples
Example RequestThis example describes the keypair with name gsg-keypair.
<DescribeKeyPairs xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <keySet> <item> <keyName>gsg-keypair</keyName> </item> </keySet></DescribeKeyPairs>
Example Response<DescribeKeyPairsResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <keySet> <item> <keyName>gsg-keypair</keyName> <keyFinger print>1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f</keyFinger print> </item>
API Version 2010-08-31386
Amazon Elastic Compute Cloud API ReferenceExamples
</keySet></DescribeKeyPairsResponse>
Example RequestThis example filters the results to display only key pairs whose names include the string Dave.
<DescribeKeypairs xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <keySet/> <filterSet> <item> <name>key-name</name> <valueSet> <item> <value>*Dave*</value> </item> </valueSet> </item> </filterSet></DescribeKeypairs>
Related Operations• DescribeAvailabilityZones (p. 333)
• RunInstances (p. 522)
API Version 2010-08-31387
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DescribeLicensesThis action is for the Microsoft Windows Server License Mobility Pilot for Amazon EC2, which is a pilotprogram offered by Microsoft that allows customers with Microsoft Enterprise Agreements (EA) to migratetheir existing Windows Server licenses to Amazon EC2. If you're interested in the program, go tohttp://aws.amazon.com/ec2/windows-license-mobility-pilot.
API Version 2010-08-31388
Amazon Elastic Compute Cloud API ReferenceDescribeLicenses
DescribePlacementGroups
DescriptionReturns information about one or more placement groups in your account. For more information aboutplacement groups and cluster compute instances, go to Cluster Compute Instance Concepts in theAmazon Elastic Compute Cloud Developer Guide.
You can filter the results to return information only about placement groups that match criteria you specify.For example, you could filter the results to return only the groups whose state is deleted.You can specifymultiple values for a filter. A placement group must match at least one of the specified values for it to beincluded in the results.
You can specify multiple filters (e.g., the group's state is deleted and the name includes the stringProject). The result includes information for a particular group only if it matches all your filters. If there'sno match, no special message is returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactlyone character.You can escape special characters using a backslash before the character. For example,a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following table shows the available filters.
DescriptionFilter Name
Name of the placement group.
Type: String
group-name
Placement group's state.
Type: String
Valid Values: pending | available | deleting | deleted
state
Placement group's strategy.
Type: String
Valid Value: cluster
strategy
Request Parameters
RequiredDescriptionName
DescribePlacementGroups element.
Type: DescribePlacementGroupsType
Ancestor: None
Children: placementGroupSet
DescribePlacementGroups
YesThe placementGroupSet element. It must be present, butcan be empty.
Type: DescribePlacementGroupsInfoType
Ancestor: DescribePlacementGroups
Children: item
placementGroupSet
API Version 2010-08-31389
Amazon Elastic Compute Cloud API ReferenceDescribePlacementGroups
RequiredDescriptionName
NoThe item element.
Type: DescribePlacementGroupItemType
Ancestor: placementGroupSet
Children: groupName
item
NoName of the placement group.
Type: xsd:string
Ancestor: item
Children: None
groupName
YesSet of filters. It must be present, but can be empty.
Type: FilterSetType
Children: item
filterSet
NoInformation for one filter.
Type: FilterType
Ancestor: filterSet
Children: name, valueSet
item
NoName of a filter.
Type: xsd:string
Ancestor: item
Children: None
name
NoOne or more values.
Type: ValueSetType
Ancestor: item
Children: item
valueSet
NoAn item in the set.
Type: ValueType
Ancestor: valueSet
Children: value
item
NoAn individual value.
Type: xsd:string
Ancestor: item
Children: None
value
Response Elements
DescriptionName
DescribePlacementGroupsResponseType element.
Type:
Ancestor: None
Children: requestId, placementGroupSet
DescribePlacementGroupsResponse
API Version 2010-08-31390
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
The ID of the request.
Type: xsd:string
Ancestor: DescribePlacementGroupsResponse
Children: None
requestId
Placement group set element.
Type: PlacementGroupsSetType
Ancestor: DescribePlacementGroupsResponse
Children: item
placementGroupSet
Information about one placement group.
Type: PlacementGroupType
Ancestor: placementGroupSet
Children: groupName, strategy, state
item
Name of the placement group.
Type: xsd:string
Ancestor: item
Children: None
groupName
The placement strategy.
Type: xsd:string
Valid Values: cluster
Ancestor: item
Children: None
strategy
Status of the placement group.
Type: xsd:string
Valid Values: pending | available | deleting | deleted
Ancestor: item
Children: None
state
Examples
Example RequestThis example describes the placement group named XYZ-cluster.
<DescribePlacementGroups xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <placementGroupSet> <item> <groupName>XYZ-cluster</groupName> </item> </placementGroupSet></DescribePlacementGroups>
API Version 2010-08-31391
Amazon Elastic Compute Cloud API ReferenceExamples
Example Response<DescribePlacementGroupsResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <requestID>d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE</requestID> <placementGroupSet> <item> <groupName>XYZ-cluster</groupName> <strategy>cluster</strategy> <state>available</state> </item> </placementGroupSet></DescribePlacementGroupsResponse>
Example RequestThis example filters the results to display only placement groups that include the string Project in thename.
<DescribePlacementGroups xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <placementGroupSet/> <filterSet> <item> <name>group-name</name> <valueSet> <item> <value>*Project*</value> </item> </valueSet> </item> </filterSet></DescribePlacementGroups>
Related Operations• CreatePlacementGroup (p. 295)
• DeletePlacementGroup (p. 314)
API Version 2010-08-31392
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DescribeRegions
DescriptionDescribes Regions that are currently available to the account.
You can use filters with this call just as you can with other "describe" calls.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactlyone character.You can escape special characters using a backslash before the character. For example,a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following table shows the available filters.
DescriptionFilter Name
Region's endpoint (e.g., ec2.us-east-1.amazonaws.com).
Type: String
endpoint
Name of the Region.
Type: String
region-name
Request Parameters
RequiredDescriptionName
DescribeRegionsType element.
Type: DescribeRegionsType (p. 618)
Ancestor: None
Children: regionSet
DescribeRegionsType
YesSet of Regions. It must be present, but can be empty.
Type: DescribeRegionsSetType (p. 617)
Ancestor: DescribeRegionsType
Children: item
regionSet
NoInformation for a Region.
Type: DescribeRegionsSetItemType (p. 617)
Ancestor: regionSet
Children: regionName
item
NoName of a Region.
Type: xsd:string
Default: Describes all Regions available to the account,or only those otherwise specified.
Ancestor: item
Children: None
regionName
API Version 2010-08-31393
Amazon Elastic Compute Cloud API ReferenceDescribeRegions
RequiredDescriptionName
YesSet of filters. It must be present, but can be empty.
Type: FilterSetType
Children: item
filterSet
NoInformation for one filter.
Type: FilterType
Ancestor: filterSet
Children: name, valueSet
item
NoName of a filter.
Type: xsd:string
Ancestor: item
Children: None
name
NoOne or more values.
Type: ValueSetType
Ancestor: item
Children: item
valueSet
NoAn item in the set.
Type: ValueType
Ancestor: valueSet
Children: value
item
NoAn individual value.
Type: xsd:string
Ancestor: item
Children: None
value
Response Elements
DescriptionName
DescribeRegionsResponseType element.
Type: DescribeRegionsResponseType (p. 616)
Ancestor: None
Children: requestId, regionInfo
DescribeRegionsResponseType
The ID of the request.
Type: xsd:string
Ancestor: DescribeRegionsResponseType
Children: None
requestId
Region set.
Type: RegionSetType (p. 680)
Ancestor: DescribeRegionsResponseType
Children: item
regionInfo
API Version 2010-08-31394
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Information for a Region.
Type: RegionItemType (p. 679)
Ancestor: regionInfo
Children: regionName, regionEndpoint
item
Name of the Region.
Type: xsd:string
Ancestor: item
Children: None
regionName
Region service endpoint.
Type: xsd:string
Ancestor: item
Children: None
regionEndpoint
Examples
Example RequestThis example displays information about all the Regions that are available to the account.
<DescribeRegions xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <regionSet/></DescribeRegions>
Example RequestThis example displays information for just the specified Regions.
<DescribeRegions xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <regionSet> <item> <regionName>us-east-1</regionName> </item> <item> <regionName>eu-west-1</regionName> </item> </regionSet></DescribeRegions>
Example Response<DescribeRegionsResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <regionInfo> <item> <regionName>us-east-1</regionName> <regionEndpoint>ec2.us-east-1.amazonaws.com</regionEndpoint> </item> <item> <regionName>eu-west-1</regionName> <regionEndpoint>ec2.eu-west-1.amazonaws.com</regionEndpoint>
API Version 2010-08-31395
Amazon Elastic Compute Cloud API ReferenceExamples
</item> </regionInfo></DescribeRegionsResponse>
Example RequestThis example displays information about all Regions that have the string ap in the endpoint.
<DescribeRegions xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <regionSet/> <filterSet> <item> <name>endpoint</name> <valueSet> <item> <value>*ap*</value> </item> </valueSet> </item> </filterSet></DescribeRegions>
Example Response<DescribeRegionsResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <regionInfo> <item> <regionName>ap-southeast-1</regionName> <regionEndpoint>ec2.ap-southeast-1.amazonaws.com</regionEndpoint> </item> </regionInfo></DescribeRegionsResponse>
Related Operations• DescribeAvailabilityZones (p. 333)
• RunInstances (p. 522)
API Version 2010-08-31396
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DescribeReservedInstances
DescriptionDescribes Reserved Instances that you purchased. For more information about Reserved Instances, goto the Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide.
You can filter the results to return information only about Reserved Instances that match criteria youspecify. For example, you could get information about only Reserved Instances in a particular AvailabilityZone.You can specify multiple values for a filter. A Reserved Instance must match at least one of thespecified values for it to be included in the results.
You can specify multiple filters (e.g., the instance is in a particular Availability Zone and is tagged with aparticular value). The result includes information for a particular instance only if it matches all your filters.If there's no match, no special message is returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactlyone character.You can escape special characters using a backslash before the character. For example,a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following table shows the available filters.
DescriptionFilter Name
Availability Zone where the Reserved Instance can be used.
Type: String
availability-zone
Duration of the Reserved Instance (e.g., one year or three years), inseconds.
Type: xs:long
Valid Values: 31536000 | 94608000
duration
Purchase price of the Reserved Instance (e.g., 9800.0)
Type: xs:double
fixed-price
Instance type on which the Reserved Instance can be used.
Type: String
instance-type
Reserved Instance description.
Type: String
Valid Values: Linux/UNIX | Linux/UNIX (Amazon VPC) |Windows | Windows (Amazon VPC)
product-description
Reserved Instance's ID.
Type: String
reserved-instances-id
Time the Reserved Instance purchase request was placed, e.g.,2010-08-07T11:54:42.000Z.
Type: xsd:dateTime
start
State of the Reserved Instance.
Type: String
Valid Values: pending-payment | active | payment-failed |retired
state
API Version 2010-08-31397
Amazon Elastic Compute Cloud API ReferenceDescribeReservedInstances
DescriptionFilter Name
Key of a tag assigned to the resource. This filter is independent ofthe tag-value filter. For example, if you use both the filtertag-key=Purpose and the filter tag-value=X, you get anyresources assigned both the tag key Purpose (regardless of whatthe tag's value is), and the tag value X (regardless of what the tag'skey is). If you want to list only resources where Purpose=X, see thetag:key filter later in this table.
For more information about tags, go to Using Tags in the AmazonElastic Compute Cloud Developer Guide.
Type: String
tag-key
Value of a tag assigned to the resource. This filter is independent ofthe tag-key filter.
Type: String
tag-value
Filters the results based on a specific tag/value combination.
Example: To list just the resources assigned tag Purpose=X, thenspecify:
Filter.1.Name=tag:Purpose
Filter.1.Value.1=X
Example: To list just resources assigned tag Purpose=X ORPurpose=Y, then specify:
Filter.1.Name=tag:Purpose
Filter.1.Value.1=X
Filter.1.Value.2=Y
tag:key
Usage price of the Reserved Instance, per hour (e.g., 0.84)
Type: xs:double
usage-price
Request Parameters
RequiredDescriptionName
DescribeReservedInstancesType element.
Type: DescribeReservedInstancesType (p. 625)
Ancestor: None
Children: reservedInstancesSet
DescribeReservedInstancesType
YesSet of Reserved Instances. It must be present, but can beempty.
Type: DescribeReservedInstancesSetType (p. 624)
Ancestor: DescribeReservedInstancesType
Children: item
reservedInstancesSet
NoReserved Instances item.
Type: DescribeReservedInstancesSetItemType (p. 624)
Ancestor: reservedInstancesSet
Children: reservedInstancesId
item
API Version 2010-08-31398
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
RequiredDescriptionName
NoIDs of the Reserved Instance to describe.
Type: xsd:string
Default: None
Ancestor: item
Children: None
reservedInstancesId
YesSet of filters. It must be present, but can be empty.
Type: FilterSetType
Children: item
filterSet
NoInformation for one filter.
Type: FilterType
Ancestor: filterSet
Children: name, valueSet
item
NoName of a filter.
Type: xsd:string
Ancestor: item
Children: None
name
NoOne or more values.
Type: ValueSetType
Ancestor: item
Children: item
valueSet
NoAn item in the set.
Type: ValueType
Ancestor: valueSet
Children: value
item
NoAn individual value.
Type: xsd:string
Ancestor: item
Children: None
value
Response Elements
DescriptionName
DescribeReservedInstancesResponseType element.
Type: DescribeReservedInstancesResponseType (p. 623)
Ancestor: None
Children: requestId, reservedInstancesSet
DescribeReservedInstancesResponseType
API Version 2010-08-31399
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
The ID of the request.
Type: xsd:string
Ancestor: DescribeReservedInstancesResponseType
Children: None
requestId
Reserved Instances set.
Type: DescribeReservedInstancesResponseSetType (p. 623)
Ancestor: DescribeReservedInstancesResponseType
Children: item
reservedInstancesSet
Reserved Instance set.
Type: DescribeReservedInstancesResponseSetItemType (p. 622)
Ancestor: reservedInstancesSet
Children: reservedInstancesId, instanceType,availabilityZone, start, duration, fixedPrice,usagePrice, instanceCount, productDescription, state,tagSet
item
The ID of the Reserved Instance.
Type: xsd:string
Ancestor: item
Children: None
reservedInstancesId
The instance type on which the Reserved Instance can be used.
Type: xsd:string
Ancestor: item
Children: None
instanceType
The Availability Zone in which the Reserved Instance can be used.
Type: xsd:string
Ancestor: item
Children: None
availabilityZone
The date and time the Reserved Instance started.
Type: xsd:dateTime
Ancestor: item
Children: None
start
The duration of the Reserved Instance, in seconds.
Type: xs:long
Ancestor: item
Children: None
duration
The purchase price of the Reserved Instance.
Type: xs:double
Ancestor: item
Children: None
fixedPrice
API Version 2010-08-31400
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
The usage price of the Reserved Instance, per hour.
Type: xs:double
Ancestor: item
Children: None
usagePrice
The number of Reserved Instances purchased.
Type: xs:integer
Ancestor: item
Children: None
instanceCount
The Reserved Instance description.
Type: xsd:string
Valid Values: Linux/UNIX | Linux/UNIX (Amazon VPC) |Windows | Windows (Amazon VPC)
Ancestor: item
Children: None
productDescription
The state of the Reserved Instance purchase.
Type: xsd:string
Valid Values: pending-payment | active | payment-failed |retired
Ancestor: item
Children: None
state
Tags assigned to the resource.
Type: ResourceTagSetType
Ancestor: item
Children: item
tagSet
Information about one tag.
Type: ResourceTagSetItemType
Ancestor: tagSet
Children: key, value
item
Tag key.
Type: xsd:string
Ancestor: item
Children: None
key
Tag value.
Type: xsd:string
Ancestor: item
Children: None
value
API Version 2010-08-31401
Amazon Elastic Compute Cloud API ReferenceResponse Elements
Examples
Example RequestThis example describes Reserved Instances owned by the account.
<DescribeReservedInstances xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"></DescribeReservedInstances>
Example Response<DescribeReservedInstancesResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <reservedInstancesSet> <item> <reservedInstancesId>4b2293b4-5813-4cc8-9ce3-1957fc1dcfc8</reservedIn stancesId> <instanceType>m1.xlarge</instanceType> <availabilityZone>us-east-1a</availabilityZone> <duration>31536000</duration> <usagePrice>0.24</usagePrice> <fixedPrice>1820.0</fixedPrice> <instanceCount>3</instanceCount> <productDescription>Linux/UNIX</productDescription> <state>Active</state> <tagSet/> </item> </reservedInstancesSet> </DescribeReservedInstancesResponse>
Example RequestThis example filters the results to display only one-year, m1.small Linux/UNIX Reserved Instances. If youwant Linux/UNIX Reserved Instances specifically for use with Amazon VPC, set the product descriptonto Linux/UNIX (Amazon VPC).
<DescribeReservedInstances xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <reservedInstancesSet/> <filterSet> <item> <name>duration</name> <valueSet> <item> <value>31536000</value> </item> </valueSet> </item> <item> <name>instance-type</name> <valueSet> <item> <value>m1.small</value> </item> </valueSet> </item> <item> <name>product-description</name>
API Version 2010-08-31402
Amazon Elastic Compute Cloud API ReferenceExamples
<valueSet> <item> <value>Linux/UNIX</value> </item> </valueSet> </item> </filterSet></DescribeReservedInstances>
Related Operations• PurchaseReservedInstancesOffering (p. 489)
• DescribeReservedInstancesOfferings (p. 404)
API Version 2010-08-31403
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DescribeReservedInstancesOfferings
DescriptionDescribes Reserved Instance offerings that are available for purchase. With Amazon EC2 ReservedInstances, you purchase the right to launch Amazon EC2 instances for a period of time (without gettinginsufficient capacity errors) and pay a lower usage rate for the actual time used. For more informationabout Reserved Instances, go to the Amazon Elastic Compute Cloud Developer Guide or Amazon ElasticCompute Cloud User Guide.
Note
Our policy is to provide filters for all describe calls so you can limit the results to your specifiedcriteria. Therefore, you can use filters to limit the results when describing Reserved Instancesofferings, even though you can use the regular request parameters to do something similar.
For example, you could use the regular request parameters or a filter to get the offerings for a particularinstance type.You can specify multiple request parameters or multiple filters (e.g., limit the results to them2.xlarge instance type, and only for Windows instances).The result includes information for a particularoffering only if it matches all your request parameters or filters. If there's no match, no special messageis returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactlyone character.You can escape special characters using a backslash before the character. For example,a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following table shows the available filters.
DescriptionFilter Name
Availability Zone where the Reserved Instance canbe used.
Type: String
availability-zone
Duration of the Reserved Instance (e.g., one yearor three years), in seconds.
Type: xs:long
Valid Values: 31536000 | 94608000
duration
Purchase price of the Reserved Instance (e.g.,9800.0)
Type: xs:double
fixed-price
Instance type on which the Reserved Instance canbe used.
Type: String
instance-type
Reserved Instance description.
Type: String
Valid Values: Linux/UNIX | Linux/UNIX(Amazon VPC) | Windows | Windows (AmazonVPC)
product-description
API Version 2010-08-31404
Amazon Elastic Compute Cloud API ReferenceDescribeReservedInstancesOfferings
DescriptionFilter Name
Reserved Instances offering ID.
Type: String
reserved-instances-offering-id
Usage price of the Reserved Instance, per hour(e.g., 0.84)
Type: xs:double
usage-price
Request Parameters
RequiredDescriptionName
DescribeReservedInstancesOfferingsTypeelement.
Type: DescribeReservedInstancesOfferingsType (p. 621)
Ancestor: None
Children: reservedInstancesOfferingsSet,instanceType, availabilityZone, andproductDescription
DescribeReservedInstancesOfferingsType
YesSet of Reserved Instances. It must be present, but can beempty.
Type:DescribeReservedInstancesOfferingsSetType (p.621)
Ancestor:DescribeReservedInstancesOfferingsType
Children: item
reservedInstancesOfferingsSet
NoReserved Instances item.
Type:DescribeReservedInstancesOfferingsSetItemType (p. 620)
Ancestor: reservedInstancesOfferingsSet
Children: reservedInstancesOfferingId
item
NoID of the Reserved Instances offering to describe.
Type: xsd:string
Default: None
Ancestor: item
Children: None
reservedInstancesOfferingId
NoThe instance type on which the Reserved Instance can beused.
Type: xsd:string
Default: None
Ancestor:DescribeReservedInstancesOfferingsType
Children: None
instanceType
API Version 2010-08-31405
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
RequiredDescriptionName
NoThe Availability Zone in which the Reserved Instance canbe used.
Type: xsd:string
Default: None
Ancestor:DescribeReservedInstancesOfferingsType
Children: None
availabilityZone
NoThe Reserved Instance description. Instances that include(Amazon VPC) in the description are for use with AmazonVPC.
Type: xsd:string
Valid Values: Linux/UNIX | Linux/UNIX (AmazonVPC) | Windows | Windows (Amazon VPC)
Default: None
Ancestor:DescribeReservedInstancesOfferingsType
Children: None
productDescription
YesSet of filters. It must be present, but can be empty.
Type: FilterSetType
Children: item
filterSet
NoInformation for one filter.
Type: FilterType
Ancestor: filterSet
Children: name, valueSet
item
NoName of a filter.
Type: xsd:string
Ancestor: item
Children: None
name
NoOne or more values.
Type: ValueSetType
Ancestor: item
Children: item
valueSet
NoAn item in the set.
Type: ValueType
Ancestor: valueSet
Children: value
item
NoAn individual value.
Type: xsd:string
Ancestor: item
Children: None
value
API Version 2010-08-31406
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
Response Elements
DescriptionName
DescribeReservedInstancesOfferingsResponseType element.
Type: DescribeReservedInstancesOfferingsResponseType (p. 620)
Ancestor: None
Children: requestId, reservedInstancesOfferingsSet
DescribeReservedInstancesOfferingsResponseType
The ID of the request.
Type: xsd:string
Ancestor:DescribeReservedInstancesOfferingsResponseType
Children: None
requestId
Reserved Instances offerings set.
Type:DescribeReservedInstancesOfferingsResponseSetType (p.619)
Ancestor:DescribeReservedInstancesOfferingsResponseType
Children: item
reservedInstancesOfferingsSet
Reserved Instance offerings set.
Type:DescribeReservedInstancesOfferingsResponseSetItemType (p. 618)
Ancestor: reservedInstancesOfferingsSet
Children: reservedInstancesOfferingId, instanceType,availabilityZone, duration, fixedPrice, usagePrice, andproductDescription
item
The ID of the Reserved Instance offering.
Type: xsd:string
Ancestor: item
Children: None
reservedInstancesOfferingId
The instance type on which the Reserved Instance can be used.
Type: xsd:string
Ancestor: item
Children: None
instanceType
The Availability Zone in which the Reserved Instance can be used.
Type: xsd:string
Ancestor: item
Children: None
availabilityZone
The duration of the Reserved Instance, in seconds.
Type: xs:long
Ancestor: item
Children: None
duration
API Version 2010-08-31407
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
The purchase price of the Reserved Instance.
Type: xs:double
Ancestor: item
Children: None
fixedPrice
The usage price of the Reserved Instance, per hour.
Type: xs:double
Ancestor: item
Children: None
usagePrice
The Reserved Instance description.
Type: xsd:string
Valid Values: Linux/UNIX | Linux/UNIX (Amazon VPC) |Windows | Windows (Amazon VPC)
Ancestor: item
Children: None
productDescription
Examples
Example RequestThis example describes available Reserved Instance offerings.
<DescribeReservedInstancesOfferings xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <reservedInstancesOfferingsSet/></DescribeReservedInstancesOfferings>
Example Response<DescribeReservedInstancesOfferingsResponse xmlns="http://ec2.amazon aws.com/doc/2010-08-31/"> <reservedInstancesOfferingsSet> <item> <reservedInstancesOfferingId>4b2293b4-b01c-4392-98d7-ea2629b4ad558</reservedInstancesOfferingId> <instanceType>m1.small</instanceType> <availabilityZone>us-east-1b</availabilityZone> <duration>94608000</duration> <fixedPrice>350.0</fixedPrice> <usagePrice>0.03</usagePrice> <productDescription>Linux/UNIX</productDescription> </item> ... </reservedInstancesOfferingsSet> </DescribeReservedInstancesOfferingsResponse>
Example RequestThis example uses filters to return one-year offerings for Linux/UNIX m1.small or m1.large instances.
API Version 2010-08-31408
Amazon Elastic Compute Cloud API ReferenceExamples
<DescribeReservedInstancesOfferings xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <reservedInstancesOfferingsSet/> <filterSet> <item> <name>duration</name> <valueSet> <item> <value>31536000</value> </item> </valueSet> </item> <item> <name>instance-type</name> <valueSet> <item> <value>m1.small</value> </item> <item> <value>m1.large</value> </item> </valueSet> </item> <item> <name>product-description</name> <valueSet> <item> <value>Linux/UNIX</value> </item> </valueSet> </item> </filterSet></DescribeReservedInstancesOfferings>
Related Operations• PurchaseReservedInstancesOffering (p. 489)
• DescribeReservedInstances (p. 397)
API Version 2010-08-31409
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DescribeSecurityGroups
DescriptionReturns information about security groups that you own.
You can filter the results to return information only about security groups that match criteria you specify.For example, you could get information about groups whose name contains a particular string.You canspecify multiple values for a filter. A security group must match at least one of the specified values for itto be included in the results.
You can specify multiple filters (e.g., the group's name contains a particular string, and the group givespermission to another security group with a different string in its name). The result includes informationfor a particular group only if it matches all your filters. If there's no match, no special message is returned;the response is simply empty.
Important
Filters are based on literal strings only. This is important to remember when you want to usefilters to return only security groups with access allowed on a specific port number or numbers.For example, let's say you want to get all groups that have access on port 22. And let's sayGroupA gives access on a range of ports using fromPort=20 and toPort=30. If you filter withip-permission.from-port=22 or ip-permission.to-port=22 (or both), GroupA will notbe returned in the results. It will only be returned in the results if you specifyip-permission.from-port=20 or ip-permission.to-port=30 (or both).
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactlyone character.You can escape special characters using a backslash before the character. For example,a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following table shows the available filters.
DescriptionFilter Name
Description of the security group.
Type: String
description
Name of the security group.
Type: String
group-name
CIDR range that has been granted the permission.
Type: String
ip-permission.cidr
Start of port range for the TCP and UDP protocols,or an ICMP type number. An ICMP type numberof -1 indicates a wildcard (i.e., any ICMP typenumber).
Type: String
ip-permission.from-port
Name of security group that has been granted thepermission.
Type: String
ip-permission.group-name
API Version 2010-08-31410
Amazon Elastic Compute Cloud API ReferenceDescribeSecurityGroups
DescriptionFilter Name
IP protocol for the permission.
Type: String
Valid Values: tcp | udp | icmp
ip-permission.protocol
End of port range for the TCP and UDP protocols,or an ICMP code. An ICMP type number of -1indicates a wildcard (i.e., any ICMP type number).
Type: String
ip-permission.to-port
ID of AWS account that has been granted thepermission.
Type: String
ip-permission.user-id
AWS account ID of the owner of the security group.
Type: String
owner-id
Request Parameters
RequiredDescriptionName
DescribeSecurityGroupsType element.
Type: DescribeSecurityGroupsType (p. 627)
Ancestor: None
Children: securityGroupSet
DescribeSecurityGroupsType
YesSet of security groups. It must be present, but can beempty.
Type: DescribeSecurityGroupsSetType (p. 626)
Ancestor: DescribeSecurityGroupsType
Children: item
securityGroupSet
NoInformation for a security group.
Type: DescribeSecurityGroupsSetItemType (p. 626)
Ancestor: securityGroupSet
Children: groupName
item
NoName of the security group.
Type: xsd:string
Default: Describes all groups you own, or only thoseotherwise specified.
Ancestor: item
Children: None
groupName
YesSet of filters. It must be present, but can be empty.
Type: FilterSetType
Children: item
filterSet
API Version 2010-08-31411
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
RequiredDescriptionName
NoInformation for one filter.
Type: FilterType
Ancestor: filterSet
Children: name, valueSet
item
NoName of a filter.
Type: xsd:string
Ancestor: item
Children: None
name
NoOne or more values.
Type: ValueSetType
Ancestor: item
Children: item
valueSet
NoAn item in the set.
Type: ValueType
Ancestor: valueSet
Children: value
item
NoAn individual value.
Type: xsd:string
Ancestor: item
Children: None
value
Response Elements
DescriptionName
DescribeSecurityGroupsResponse element.
Type: DescribeSecurityGroupsResponseType (p. 625)
Ancestor: None
Children: requestId, securityGroupInfo
DescribeSecurityGroupsResponse
The ID of the request.
Type: xsd:string
Ancestor: DescribeSecurityGroupsResponseType
Children: None
requestId
Security group set.
Type: SecurityGroupSetType (p. 697)
Ancestor: DescribeSecurityGroupsResponseType
Children: item
securityGroupInfo
API Version 2010-08-31412
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Information for a security group.
Type: SecurityGroupItemType (p. 697)
Ancestor: securityGroupInfo
Children: ownerId, groupName, groupDescription,ipPermissions
item
AWS account ID of the owner of the security group.
Type: xsd:string
Ancestor: item
Children: None
ownerId
Name of the security group.
Type: xsd:string
Ancestor: item
Children: None
groupName
Description of the security group.
Type: xsd:string
Ancestor: item
Children: None
groupDescription
Set of IP permissions associated with the security group.
Type: IpPermissionSetType (p. 657)
Ancestor: item
Children: item
ipPermissions
Set of IP permissions.
Type: IpPermissionType (p. 657)
Ancestor: ipPermissions
Children:ipProtocol, fromPort, toPort, groups, and ipRanges
item
IP protocol.
Type: xsd:string
Valid Values: tcp | udp | icmp
Ancestor: item
Children: None
ipProtocol
Start of port range for the TCP and UDP protocols, or an ICMP typenumber. An ICMP type number of -1 indicates a wildcard (i.e., anyICMP type number).
Type: xsd:int
Ancestor: item
Children: None
fromPort
End of port range for the TCP and UDP protocols, or an ICMP code.An ICMP code of -1 indicates a wildcard (i.e., any ICMP code).
Type: xsd:int
Ancestor: item
Children: None
toPort
API Version 2010-08-31413
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
List of security group and user ID pairs.
Type: UserIdGroupPairSetType (p. 708)
Ancestor: item
Children: item
groups
Information for one security group.
Type: UserIdGroupPairType (p. 709)
Ancestor: groups
Children: userId, groupName
item
AWS account ID. Cannot be used when specifying a CIDR IPaddress.
Type: xsd:string
Ancestor: item
Children: None
userId
Name of the security group. Cannot be used when specifying a CIDRIP address.
Type: xsd:string
Ancestor: item
Children: None
groupName
IP ranges.
Type: IpRangeSetType (p. 659)
Ancestor: item
Children: item
ipRanges
Information for one IP range.
Type: IpRangeItemType (p. 658)
Ancestor: ipRanges
Children: cidrIp
item
CIDR range.
Type: xsd:string
Ancestor: item
Children: None
cidrIp
Examples
Example RequestThis example returns information about two security groups that are configured for the account.
<DescribeSecurityGroups xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <securityGroupSet> <item> <groupName>WebServers</groupName> </item> <item>
API Version 2010-08-31414
Amazon Elastic Compute Cloud API ReferenceExamples
<groupName>RangedPortsBySource</groupName> </item> </securityGroupSet></DescribeSecurityGroups>
Example Response<DescribeSecurityGroupsResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <securityGroupInfo> <item> <ownerId>UYY3TLBUXIEON5NQVUUX6OMPWBZIQNFM</ownerId> <groupName>WebServers</groupName> <groupDescription>Web Servers</groupDescription> <ipPermissions> <item> <ipProtocol>tcp</ipProtocol> <fromPort>80</fromPort> <toPort>80</toPort> <groups/> <ipRanges> <item> <cidrIp>0.0.0.0/0</cidrIp> </item> </ipRanges> </item> </ipPermissions> </item> <item> <ownerId>UYY3TLBUXIEON5NQVUUX6OMPWBZIQNFM</ownerId> <groupName>RangedPortsBySource</groupName> <groupDescription>Group A</groupDescription> <ipPermissions> <item> <ipProtocol>tcp</ipProtocol> <fromPort>6000</fromPort> <toPort>7000</toPort> <groups/> <ipRanges/> </item> </ipPermissions> </item> </securityGroupInfo></DescribeSecurityGroupsResponse>
Example RequestThis example returns information about all security groups that grant access over TCP specifically onport 22 from instances in either the app_server_group or database_group.
<DescribeSecurityGroups xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <securityGroupSet/> <filterSet> <item> <name>ip-permission.protocol</name> <valueSet> <item> <value>tcp</value>
API Version 2010-08-31415
Amazon Elastic Compute Cloud API ReferenceExamples
</item> </valueSet> </item> <item> <name>ip-permission.from-port</name> <valueSet> <item> <value>22</value> </item> </valueSet> </item> <item> <name>ip-permission.to-port</name> <valueSet> <item> <value>22</value> </item> </valueSet> </item> <item> <name>ip-permission.group-name</name> <valueSet> <item> <value>app_server_group</value> </item> <item> <value>database_group</value> </item> </valueSet> </item> </filterSet></DescribeSecurityGroups>
Related Operations• CreateSecurityGroup (p. 297)
• AuthorizeSecurityGroupIngress (p. 269)
• RevokeSecurityGroupIngress (p. 518)
• DeleteSecurityGroup (p. 315)
API Version 2010-08-31416
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DescribeSnapshotAttribute
DescriptionReturns information about an attribute of a snapshot.You can specify only one attribute per call.
Request Parameters
RequiredDescriptionName
DescribeSnapshotAttributeType element.
Type: DescribeSnapshotAttributeType (p. 628)
Ancestor: None
Children: snapshotId,DescribeSnapshotAttributesGroup, filterSet
DescribeSnapshotAttributeType
YesThe ID of the Amazon EBS snapshot.
Type: xsd:string
Default: None
Ancestor: DescribeSnapshotAttributeType
Children: None
snapshotId
YesDescribe snapshot attribute element.
Type: DescribeSnapshotAttributesGroup (p. 628)
Ancestor: DescribeSnapshotAttributeType
Children: createVolumePermission
DescribeSnapshotAttributesGroup
YesReturns the create volume permissions attribute for thesnapshot.
Type: EmptyElementType (p. 644)
Ancestor: DescribeSnapshotAttributesGroup
Children: None
createVolumePermission
Response Elements
DescriptionName
DescribeSnapshotAttributeResponseType element.
Type: DescribeSnapshotAttributeResponseType (p. 627)
Ancestor: None
Children: requestId, snapshotId, andcreateVolumePermission
DescribeSnapshotAttributeResponseType
The ID of the request.
Type: xsd:string
Ancestor: DescribeSnapshotAttributeResponseType
Children: None
requestId
API Version 2010-08-31417
Amazon Elastic Compute Cloud API ReferenceDescribeSnapshotAttribute
DescriptionName
The ID of the Amazon EBS snapshot.
Type: xsd:string
Ancestor: DescribeSnapshotAttributeResponseType
Children: None
snapshotId
Create volume permission element.
Type: CreateVolumePermissionListType (p. 585)
Ancestor: DescribeSnapshotAttributeResponseType
Children: item
createVolumePermission
Volume permission item.
Type: CreateVolumePermissionItemType (p. 584)
Ancestor: createVolumePermission
Children: userId, group
item
ID of an AWS account that can create volumes from the snapshot.
Type: xsd:string
Ancestor: item
Children: None
userId
Group that is allowed to create volumes from the snapshot (currentlysupports "all").
Type: xsd:string
Ancestor: item
Children: None
group
Examples
Example RequestThis example describes permissions for the snap-78a54011 snapshot.
<DescribeSnapshotAttribute xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <snapshotId>snap-78a54011</snapshotId> <createVolumePermission/></DescribeSnapshotAttribute>
Example Response<DescribeSnapshotAttributeResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <snapshotId>snap-78a54011</snapshotId> <createVolumePermission> <item> <group>all</group> </item> </createVolumePermission></DescribeSnapshotAttributeResponse>
API Version 2010-08-31418
Amazon Elastic Compute Cloud API ReferenceExamples
Related Operations• ModifySnapshotAttribute (p. 483)
• DescribeSnapshots (p. 420)
• ResetSnapshotAttribute (p. 516)
• CreateSnapshot (p. 299)
API Version 2010-08-31419
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DescribeSnapshots
DescriptionReturns information about Amazon EBS snapshots available to you. Snapshots available to you includepublic snapshots available for any AWS account to launch, private snapshots you own, and privatesnapshots owned by another AWS account but for which you've been given explicit create volumepermissions.
The create volume permissions fall into 3 categories:
DescriptionPermission
The owner of the snapshot granted create volume permissions for the snapshotto the all group. All AWS accounts have create volume permissions for thesesnapshots.
public
The owner of the snapshot granted create volume permissions to a specific AWSaccount.
explicit
An AWS account has implicit create volume permissions for all snapshots it owns.implicit
The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWSaccounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshotsfor which you have create volume permissions.
If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If youspecify an invalid snapshot ID, a fault is returned. If you specify a snapshot ID for which you do not haveaccess, it will not be included in the returned results.
If you specify one or more snapshot owners, only snapshots from the specified owners and for which youhave access are returned.The results can include the AWS account IDs of the specified owners, amazonfor snapshots owned by Amazon, or self for snapshots that you own.
If you specify a list of restorable users, only snapshots with create snapshot permissions for those usersare returned.You can specify AWS account IDs (if you own the snapshot(s)), self for snapshots forwhich you own or have explicit permissions, or all for public snapshots.
You can filter the results to return information only about snapshots that match criteria you specify. Forexample, you could get information about snapshots whose status is pending.You can specify multiplevalues for a filter (e.g., the snapshot's status is either pending or completed). A snapshot must matchat least one of the specified values for it to be included in the results.
You can specify multiple filters (e.g., the snapshot's status is pending, and it is tagged with a particularvalue). The result includes information for a particular snapshot only if it matches all your filters. If there'sno match, no special message is returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactlyone character.You can escape special characters using a backslash before the character. For example,a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following table shows the available filters.
API Version 2010-08-31420
Amazon Elastic Compute Cloud API ReferenceDescribeSnapshots
DescriptionFilter Name
Description of the snapshot.
Type: String
description
The AWS account alias (e.g., amazon) that owns the snapshot.
Type: String
owner-alias
ID of the AWS account that owns the snapshot.
Type: String
owner-id
The progress of the snapshot, in percentage (e.g., 80%).
Type: String
progress
Snapshot ID.
Type: String
snapshot-id
Time stamp when the snapshot was initiated.
Type: xsd:dateTime
start-time
Status of the snapshot.
Type: String
Valid Values: pending | completed | error
status
Key of a tag assigned to the resource. This filter is independent of thetag-value filter. For example, if you use both the filter tag-key=Purposeand the filter tag-value=X, you get any resources assigned both the tagkey Purpose (regardless of what the tag's value is), and the tag value X(regardless of what the tag's key is). If you want to list only resources wherePurpose=X, see the tag:key filter later in this table.
For more information about tags, go to Using Tags in the Amazon ElasticCompute Cloud Developer Guide.
Type: String
tag-key
Value of a tag assigned to the resource. This filter is independent of thetag-key filter.
Type: String
tag-value
Filters the results based on a specific tag/value combination.
Example: To list just the resources assigned tag Purpose=X, then specify:
Filter.1.Name=tag:Purpose
Filter.1.Value.1=X
Example: To list just resources assigned tag Purpose=X OR Purpose=Y,then specify:
Filter.1.Name=tag:Purpose
Filter.1.Value.1=X
Filter.1.Value.2=Y
tag:key
ID of the volume the snapshot is for.
Type: String
volume-id
The size of the volume, in GiB (e.g., 20).
Type: String
volume-size
API Version 2010-08-31421
Amazon Elastic Compute Cloud API ReferenceDescription
Request Parameters
RequiredDescriptionName
DescribeSnapshotsType element.
Type: DescribeSnapshotsType (p. 634)
Ancestor: None
Children: snapshotSet, ownersSet, andrestorableBySet, filterSet
DescribeSnapshotsType
YesSet of snapshots. It must be present, but can be empty.
Type: DescribeSnapshotsSetType (p. 633)
Ancestor: DescribeSnapshotsType
Children: item
snapshotSet
NoInformation for a snapshot.
Type: DescribeSnapshotsSetItemType (p. 632)
Ancestor: snapshotSet
Children: snapshotId
item
NoThe ID of the Amazon EBS snapshot.
Type: xsd:string
Default: Describes snapshots for which you have launchpermissions.
Ancestor: item
Children: None
snapshotId
YesSet of owners that can create volumes from the instance.It must be present, but can be empty.
Type: DescribeSnapshotsOwnersType (p. 629)
Ancestor: DescribeSnapshotsType
Children: item
ownersSet
NoDescribe snapshot item.
Type: DescribeSnapshotsOwnerType (p. 629)
Ancestor: ownersSet
Children: owner
item
NoReturns snapshots owned by the specified owner. Multipleowners can be specified.
Type: xsd:string
Valid Values: self | amazon | AWS Account ID
Default: None
Ancestor: item
Children: None
owner
YesSet of users that can create volumes from the snapshot.It must be present, but can be empty.
Type: DescribeSnapshotsRestorableBySetType (p. 630)
Ancestor: DescribeSnapshotsType
Children: item
restorableBySet
API Version 2010-08-31422
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
RequiredDescriptionName
NoRestorable by set type item.
Type: DescribeSnapshotsRestorableByType (p. 631)
Ancestor: restorableBySet
Children: user
item
NoID of an AWS account that can create volumes from thesnapshot.
Type: xsd:string
Default: None
Ancestor: item
Children: None
user
YesSet of filters. It must be present, but can be empty.
Type: FilterSetType
Children: item
filterSet
NoInformation for one filter.
Type: FilterType
Ancestor: filterSet
Children: name, valueSet
item
NoName of a filter.
Type: xsd:string
Ancestor: item
Children: None
name
NoOne or more values.
Type: ValueSetType
Ancestor: item
Children: item
valueSet
NoAn item in the set.
Type: ValueType
Ancestor: valueSet
Children: value
item
NoAn individual value.
Type: xsd:string
Ancestor: item
Children: None
value
API Version 2010-08-31423
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
Response Elements
DescriptionName
DescribeSnapshotsResponse element.
Type: DescribeSnapshotsResponseType (p. 630)
Ancestor: None
Children: requestId, snapshotSet
DescribeSnapshotsResponse
The ID of the request.
Type: xsd:string
Ancestor: DescribeSnapshotsResponseType
Children: None
requestId
Snapshot set.
Type: DescribeSnapshotsSetResponseType (p. 633)
Ancestor: DescribeSnapshotsResponseType
Children: item
snapshotSet
Information for a snapshot.
Type: DescribeSnapshotsSetItemResponseType (p. 631)
Ancestor: snapshotSet
Children:snapshotId, volumeId, status, startTime, progress,ownerId, volumeSize, description ownerAlias, tagSet
item
The ID of the snapshot.
Type: xsd:string
Ancestor: item
Children: None
snapshotId
The ID of the volume.
Type: xsd:string
Ancestor: item
Children: None
volumeId
Snapshot state (e.g., pending, completed, or error)
Type: xsd:string
Valid Values: pending | completed | error
Ancestor: item
Children: None
status
Time stamp when the snapshot was initiated.
Type: xsd:dateTime
Ancestor: item
Children: None
startTime
The progress of the snapshot, in percentage.
Type: xsd:string
Ancestor: item
Children: None
progress
API Version 2010-08-31424
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
ID of the AWS account that owns the snapshot.
Type: xsd:string
Ancestor: item
Children: None
ownerId
The size of the volume, in GiB.
Type: xsd:string
Ancestor: item
Children: None
volumeSize
Description of the snapshot.
Type: xsd:string
Ancestor: item
Children: None
description
The AWS account alias (e.g., amazon, self, etc.) or AWS accountID that owns the AMI.
Type: xsd:string
Ancestor: item
Children: None
ownerAlias
Tags assigned to the resource.
Type: ResourceTagSetType
Ancestor: item
Children: item
tagSet
Information about one tag.
Type: ResourceTagSetItemType
Ancestor: tagSet
Children: key, value
item
Tag key.
Type: xsd:string
Ancestor: item
Children: None
key
Tag value.
Type: xsd:string
Ancestor: item
Children: None
value
Examples
Example RequestThis example describes snapshot snap-78a54011.
API Version 2010-08-31425
Amazon Elastic Compute Cloud API ReferenceExamples
<DescribeSnapshots xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <snapshotSet> <item> <snapshotId>snap-78a54011</snapshotId> </item> </snapshotSet> <ownersSet/> <restorableyBySet/> <filterSet/></DescribeSnapshots>
Example Response<DescribeSnapshotsResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <snapshotSet> <item> <snapshotId>snap-78a54011</snapshotId> <volumeId>vol-4d826724</volumeId> <status>pending</status> <startTime>2008-05-07T12:51:50.000Z</startTime> <progress>80%</progress> <ownerId>999988887777</ownerId> <volumeSize>10</volumeSize> <description>Daily Backup</description> <tagSet/> </item> </snapshotSet></DescribeSnapshotsResponse>
Example RequestThis example filters the results to display only snapshots with the pending status, and that are alsotagged with a value that includes the string db_.
<DescribeSnapshots xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <snapshotSet/> <ownersSet/> <restorableBySet/> <filterSet> <item> <name>status</name> <valueSet> <item> <value>pending</value> </item> </valueSet> </item> <item> <name>tag-value</name> <valueSet> <item> <value>*db_*</value> </item> </valueSet> </item> </filterSet></DescribeSnapshots>
API Version 2010-08-31426
Amazon Elastic Compute Cloud API ReferenceExamples
Example Response<DescribeSnapshotsResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <snapshotSet> <item> <snapshotId>snap-1a2b3c4d</snapshotId> <volumeId>vol-8875daef</volumeId> <status>pending</status> <startTime>2010-07-29T04:12:01.000Z</startTime> <progress>30%</progress> <ownerId>999988887777</ownerId> <volumeSize>15</volumeSize> <description>Daily Backup</description> <tagSet> <item> <key>Purpose</key> <value>demo_db_14_backup</value> </item> </tagSet> </item> </snapshotSet></DescribeSnapshotsResponse>
Related Operations• CreateSnapshot (p. 299)
• DeleteSnapshot (p. 317)
API Version 2010-08-31427
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DescribeSpotDatafeedSubscription
DescriptionDescribes the data feed for Spot Instances. For conceptual information about Spot Instances, refer tothe Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide.
Request ParametersThe DescribeSpotDatafeedSubscription operation does not have any request parameters.
Response Elements
DescriptionName
DescribeSpotDatafeedSubscriptionResponse element.
Type: DescribeSpotDatafeedSubscriptionResponseType (p. 634)
Ancestor: None
Children: requestId, spotDatafeedSubscription
DescribeSpotDatafeedSubscriptionResponse
The ID of the request.
Type: xsd:string
Ancestor:DescribeSpotDatafeedSubscriptionResponseType
Children: None
requestId
The Spot Instance datafeed subscription.
Type: SpotDatafeedSubscriptionType (p. 698)
Ancestor:DescribeSpotDatafeedSubscriptionResponseType
Children: ownerId, bucket, prefix, state, and fault
spotDatafeedSubscription
The AWS account ID of the account.
Type: xsd:string
Ancestor: spotDatafeedSubscription
Children: None
ownerId
The Amazon S3 bucket where the Spot Instance datafeed is located.
Type: xsd:string
Ancestor: spotDatafeedSubscription
Children: None
bucket
Prefix for the datafeed files.
Type: xsd:string
Ancestor: spotDatafeedSubscription
Children: None
prefix
API Version 2010-08-31428
Amazon Elastic Compute Cloud API ReferenceDescribeSpotDatafeedSubscription
DescriptionName
The state of the Spot Instance datafeed subscription.
Type: xsd:string
Valid Values: Active | Inactive
Ancestor: spotDatafeedSubscription
Children: None
state
Fault codes for the Spot Instance request, if any.
Type: SpotInstanceStateFaultType (p. 702)
Ancestor: spotDatafeedSubscription
Children: code, message
fault
Reason code for the Spot Instance state change.
Type: xsd:string
Ancestor: fault
Children: None
code
Message for the Spot Instance state change.
Type: xsd:string
Ancestor: fault
Children: None
message
Examples
Example RequestThis example describes the data feed for the account.
<DescribeSpotDatafeedSubscription xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"></DescribeSpotDatafeedSubscription>
Example Response<DescribeSpotDatafeedSubscriptionResponse xmlns="http://ec2.amazon aws.com/doc/2010-08-31/"> <spotDatafeedSubscription> <ownerId>999988887777</ownerId> <bucket>mybucket</bucket> <prefix>spotdata</prefix> <state>Active</state> </spotDatafeedSubscription></DescribeSpotDatafeedSubscriptionResponse>
Related Operations• CreateSpotDatafeedSubscription (p. 302)
• DeleteSpotDatafeedSubscription (p. 319)
API Version 2010-08-31429
Amazon Elastic Compute Cloud API ReferenceExamples
DescribeSpotInstanceRequests
DescriptionDescribes Spot Instance requests. Spot Instances are instances that Amazon EC2 starts on your behalfwhen the maximum price that you specify exceeds the current Spot Price. Amazon EC2 periodically setsthe Spot Price based on available Spot Instance capacity and current spot instance requests. Forconceptual information about Spot Instances, refer to the Amazon Elastic Compute Cloud DeveloperGuide or Amazon Elastic Compute Cloud User Guide.
You can filter the results to return information only about Spot Instance requests that match criteria youspecify. For example, you could get information about requests where the Spot Price you specified is acertain value (you can't use greater than or less than comparison, but you can use * and ? wildcards).You can specify multiple values for a filter. A Spot Instance request must match at least one of the specifiedvalues for it to be included in the results.
You can specify multiple filters (e.g., the Spot Price is equal to a particular value, and the instance typeis m1.small). The result includes information for a particular request only if it matches all your filters. Ifthere's no match, no special message is returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactlyone character.You can escape special characters using a backslash before the character. For example,a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following table shows the available filters.
DescriptionFilter Name
Availability Zone group. If you specify the sameAvailability Zone group for all Spot Instancerequests, all Spot Instances are launched in thesame Availability Zone.
Type: String
availability-zone-group
Time stamp when the Spot Instance request wascreated.
Type: String
create-time
Fault code related to the request.
Type: String
fault-code
Fault message related to the request.
Type: String
fault-message
ID of the instance that fulfilled the request.
Type: String
instance-id
Spot Instance launch group. Launch groups areSpot Instances that launch together and terminatetogether.
Type: String
launch-group
Whether an Amazon EBS volume mapped to theinstance is deleted on instance termination.
Type: Boolean
launch.block-device-mapping.delete-on-termination
API Version 2010-08-31430
Amazon Elastic Compute Cloud API ReferenceDescribeSpotInstanceRequests
DescriptionFilter Name
Device name (e.g., /dev/sdh) for an Amazon EBSvolume mapped to the instance.
Type: String
launch.block-device-mapping.device-name
ID for a snapshot mapped to the instance.
Type: String
launch.block-device-mapping.snapshot-id
Size of an Amazon EBS volume mapped to theinstance (in GiB).
Type: String
launch.block-device-mapping.volume-size
A security group the instance is in.
Type: String
launch.group-id
The AMI ID.
Type: String
launch.image-id
Type of instance (e.g., m1.small).
Type: String
launch.instance-type
Kernel ID.
Type: String
launch.kernel-id
Name of the key pair the instance launched with.
Type: String
launch.key-name
Whether monitoring is enabled for the SpotInstance.
Type: Boolean
launch.monitoring-enabled
RAM disk ID.
Type: String
launch.ramdisk-id
Product description associated with the instance.
Type: String
Valid Values: Linux/UNIX | Windows
product-description
Spot Instance request ID.
Type: String
spot-instance-request-id
Maximum hourly price for any Spot Instancelaunched to fulfill the request.
Type: String
spot-price
State of the Spot Instance request.
Type: String
Valid Values: active | cancelled | open |closed | failed
state
API Version 2010-08-31431
Amazon Elastic Compute Cloud API ReferenceDescription
DescriptionFilter Name
Key of a tag assigned to the resource. This filter isindependent of the tag-value filter. For example,if you use both the filter tag-key=Purpose andthe filter tag-value=X, you get any resourcesassigned both the tag key Purpose (regardless ofwhat the tag's value is), and the tag value X(regardless of what the tag's key is). If you want tolist only resources where Purpose=X, see thetag:key filter later in this table.
For more information about tags, go to Using Tagsin the Amazon Elastic Compute Cloud DeveloperGuide.
Type: String
tag-key
Value of a tag assigned to the resource. This filteris independent of the tag-key filter.
Type: String
tag-value
Filters the results based on a specific tag/valuecombination.
Example: To list just the resources assigned tagPurpose=X, then specify:
Filter.1.Name=tag:Purpose
Filter.1.Value.1=X
Example: To list just resources assigned tagPurpose=X OR Purpose=Y, then specify:
Filter.1.Name=tag:Purpose
Filter.1.Value.1=X
Filter.1.Value.2=Y
tag:key
Type of Spot Instance request.
Type: String
Valid Values: one-time | persistent
type
Start date of the request.
Type: xsd:dateTime
valid-from
End date of the request.
Type: xsd:dateTime
valid-until
Request Parameters
RequiredDescriptionName
DescribeSpotInstanceRequestsType element.
Type: DescribeSpotInstanceRequestsType (p. 635)
Ancestor: None
Children: spotInstanceRequestIdSet
DescribeSpotInstanceRequestsType
API Version 2010-08-31432
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
RequiredDescriptionName
YesThe Spot Instance requests. It must be present, but canbe empty.
Type: SpotInstanceRequestIdSetType (p. 699)
Ancestor: DescribeSpotInstanceRequestsType
Children: item
spotInstanceRequestIdSet
NoSpot Instance request ID set.
Type: SpotInstanceRequestIdSetItemType (p. 699)
Ancestor: spotInstanceRequestIdSet
Children: spotInstanceRequestId
item
NoSpecifies the ID of the Spot Instance request.
Type: xsd:string
Default: None
Ancestor: item
Children: None
spotInstanceRequestId
YesSet of filters. It must be present, but can be empty.
Type: FilterSetType
Children: item
filterSet
NoInformation for one filter.
Type: FilterType
Ancestor: filterSet
Children: name, valueSet
item
NoName of a filter.
Type: xsd:string
Ancestor: item
Children: None
name
NoOne or more values.
Type: ValueSetType
Ancestor: item
Children: item
valueSet
NoAn item in the set.
Type: ValueType
Ancestor: valueSet
Children: value
item
NoAn individual value.
Type: xsd:string
Ancestor: item
Children: None
value
API Version 2010-08-31433
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
Response Elements
DescriptionName
DescribeSpotInstanceRequestsResponse element.
Type: DescribeSpotInstanceRequestsResponseType (p. 635)
Ancestor: None
Children: requestId, spotInstanceRequestSet
DescribeSpotInstanceRequestsResponse
The ID of the request.
Type: xsd:string
Ancestor: DescribeSpotInstanceRequestsResponseType
Children: None
requestId
Spot Instance request set.
Type: SpotInstanceRequestSetType (p. 701)
Ancestor: DescribeSpotInstanceRequestsResponseType
Children: item
spotInstanceRequestSet
Spot Instance request set.
Type: SpotInstanceRequestSetItemType (p. 700)
Ancestor: spotInstanceRequestSet
Children: spotInstanceRequestId, spotPrice, type, state,fault, validFrom, validUntil, launchGroup,availabilityZoneGroup, launchSpecification, instanceId,createTime, productDescription, tagSet
item
Specifies the ID of the Spot Instance request.
Type: xsd:string
Ancestor: item
Children: None
spotInstanceRequestId
Specifies the maximum hourly price for any Spot Instance launchedto fulfill the request.
Type: xsd:string
Ancestor: item
Children: None
spotPrice
Specifies the Spot Instance request type.
Type: xsd:string
Valid Values: one-time | persistent
Ancestor: item
Children: None
type
The state of the Spot Instance request.
Type: xsd:string
Valid Values: open | closed | cancelled | failed
Ancestor: item
Children: None
state
API Version 2010-08-31434
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Fault codes for the Spot Instance request, if any.
Type: SpotInstanceStateFaultType (p. 702)
Ancestor: item
Children: code, message
fault
Reason code for the Spot Instance state change.
Type: xsd:string
Ancestor: fault
Children: None
code
Message for the Spot Instance state change.
Type: xsd:string
Ancestor: fault
Children: None
message
Start date of the request. If this is a one-time request, the requestbecomes active at this date and time and remains active until allinstances launch, the request expires, or the request is canceled. Ifthe request is persistent, the request becomes active at this date andtime and remains active until it expires or is canceled.
Type: xsd:dateTime
Ancestor: item
Children: None
validFrom
End date of the request. If this is a one-time request, the requestremains active until all instances launch, the request is canceled, orthis date is reached. If the request is persistent, it remains active untilit is canceled or this date and time is reached.
Type: xsd:dateTime
Ancestor: item
Children: None
validUntil
Specifies the instance launch group. Launch groups are SpotInstances that launch together and terminate together.
Type: xsd:string
Ancestor: item
Children: None
launchGroup
Specifies the Availability Zone group. If you specify the sameAvailability Zone group for all Spot Instance requests, all SpotInstances are launched in the same Availability Zone.
Type: xsd:string
Ancestor: item
Children: None
availabilityZoneGroup
API Version 2010-08-31435
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Specifies additional launch instance information.
Type: LaunchSpecificationType (p. 661)
Ancestor: item
Children: imageId, keyName, groupSet, addressingType,instanceType, placement, kernelId, ramdiskId,blockDeviceMapping, monitoring, and subnetId
launchSpecification
The AMI ID.
Type: xsd:string
Ancestor: launchSpecification
Children: None
imageId
The name of the key pair.
Type: xsd:string
Ancestor: launchSpecification
Children: None
keyName
Group set.
Type: GroupSetType (p. 648)
Ancestor: launchSpecification
Children: item
groupSet
Group set item.
Type: GroupItemType (p. 648)
Ancestor: groupSet
Children: groupId
item
Name of the security group.
Type: xsd:string
Ancestor: item
Children: None
groupId
Deprecated.
Type: xsd:string
Ancestor: launchSpecification
Children: None
addressingType
Specifies the instance type.
Type: xsd:string
Valid Values: m1.small | m1.large | m1.xlarge | c1.medium |c1.xlarge | m2.xlarge | m2.2xlarge | m2.4xlarge | t1.micro
Ancestor: launchSpecification
Children: None
instanceType
Placement item.
Type: PlacementRequestType (p. 671)
Ancestor: launchSpecification
Children: availabilityZone
placement
API Version 2010-08-31436
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Specifies the placement constraints (Availability Zones) for launchingthe instances.
Type: xsd:string
Ancestor: placement
Children: None
availabilityZone
The ID of the kernel to select.
Type: xsd:string
Ancestor: launchSpecification
Children: None
kernelId
The ID of the RAM disk to select. Some kernels require additionaldrivers at launch. Check the kernel requirements for information onwhether you need to specify a RAM disk and search for the kernelID.
Type: xsd:string
Ancestor: launchSpecification
Children: None
ramdiskId
Specifies how block devices are exposed to the instance. Eachmapping is made up of a virtualName and a deviceName.
Type: BlockDeviceMappingType (p. 568)
Ancestor: launchSpecification
Children: item
blockDeviceMapping
Information for one block device mapping.
Type: BlockDeviceMappingItemType (p. 567)
Ancestor: blockDeviceMapping
Children: deviceName, virtualName, ebs, and noDevice
item
The device name (e.g., /dev/sdh).
Type: xsd:string
Ancestor: item
Children: None
deviceName
The virtual device name.
Type: xsd:string
Ancestor: item
Children: None
virtualName
Specifies parameters used to automatically set up Amazon EBSvolumes when the instance is launched.
Type: EbsBlockDeviceType (p. 643)
Ancestor: item
Children:snapshotId, volumeSize, and deleteOnTermination
ebs
The ID of the snapshot.
Type: xsd:string
Ancestor: ebs
Children: None
snapshotId
API Version 2010-08-31437
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
The size of the volume, in GiBs. Required if you are not creating avolume from a snapshot.
Type: xsd:int
Ancestor: ebs
Children: None
volumeSize
Specifies whether the Amazon EBS volume is deleted on instancetermination.
Type: xsd:boolean
Ancestor: ebs
Children: None
deleteOnTermination
Specifies the device name to suppress during instance launch.
Type: EmptyElementType (p. 644)
Ancestor: item
Children: none
noDevice
This element contains no options.
Type: xsd:string
Ancestor: noDevice
Children: None
none
Specifies whether to enable monitoring for the instance.
Type: MonitoringInstanceType (p. 666)
Ancestor: launchSpecification
Children: enabled
monitoring
Enables monitoring for the instance.
Type: xsd:boolean
Ancestor: monitoring
Children: None
enabled
Specifies the Amazon VPC subnet ID within which to launch theinstance(s) for Amazon Virtual Private Cloud.
Type: xsd:string
Ancestor: launchSpecification
Children: None
subnetId
Specifies the instance ID.
Type: xsd:string
Ancestor: item
Children: None
instanceId
Time stamp when the Spot Instance request was created.
Type: xsd:dateTime
Ancestor: item
Children: None
createTime
API Version 2010-08-31438
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
The product description associated with the Spot Instance.
Type: xsd:dateTime
Ancestor: item
Children: None
productDescription
Tags assigned to the resource.
Type: ResourceTagSetType
Ancestor: item
Children: item
tagSet
Information about one tag.
Type: ResourceTagSetItemType
Ancestor: tagSet
Children: key, value
item
Tag key.
Type: xsd:string
Ancestor: item
Children: None
key
Tag value.
Type: xsd:string
Ancestor: item
Children: None
value
Examples
Example RequestThis example returns information about current Spot Instance requests.
<DescribeSpotInstanceRequests xmlns="http://ec2.amazonaws.com/doc/2010-08-31/">
<SpotInstanceRequestIdSet/> <filterSet/></DescribeSpotInstanceRequests>
Example Response<DescribeSpotInstanceRequestsResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <spotInstanceRequestSet> <item> <spotInstanceRequestId>sir-e95fae02</spotInstanceRequestId> <spotPrice>0.01</spotPrice> <type>one-time</type> <state>open</state> <launchSpecification> <imageId>ami-235fba4a</imageId> <keyName>MyKey</keyName>
API Version 2010-08-31439
Amazon Elastic Compute Cloud API ReferenceExamples
<groupSet> <item> <groupId>default</groupId> </item> </groupSet> <instanceType>m1.small</instanceType> <blockDeviceMapping/> <monitoring> <enabled>false</enabled> </monitoring> </launchSpecification> <instanceId>i-2fd4ca67</instanceId> <createTime>2009-12-04T22:51:14.000Z</createTime> <productDescription>Linux/UNIX</productDescription> <tagSet/> </item> </spotInstanceRequestSet></DescribeSpotInstanceRequestsResponse>
Example RequestThis example describes all persistent Spot Instance requests that have resulted in the launch of at leastone m1.small instance that also has monitoring enabled.
<DescribeSpotInstanceRequests xmlns="http://ec2.amazonaws.com/doc/2010-08-31/">
<SpotInstanceRequestIdSet/> <filterSet> <item> <name>type</name> <valueSet> <item> <value>persistent</value> </item> </valueSet> </item> <item> <name>instance-type</name> <valueSet> <item> <value>m1.small</value> </item> </valueSet> </item> <item> <name>monitoring-enabled</name> <valueSet> <item> <value>true</value> </item> </valueSet> </item> </filterSet></DescribeSpotInstanceRequests>
Related Operations• RequestSpotInstances (p. 500)
API Version 2010-08-31440
Amazon Elastic Compute Cloud API ReferenceRelated Operations
• CancelSpotInstanceRequests (p. 284)
• DescribeSpotPriceHistory (p. 442)
API Version 2010-08-31441
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DescribeSpotPriceHistory
DescriptionDescribes Spot Price history. Spot Instances are instances that Amazon EC2 starts on your behalf whenthe maximum price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets theSpot Price based on available Spot Instance capacity and current spot instance requests. For conceptualinformation about Spot Instances, refer to the Amazon Elastic Compute Cloud Developer Guide or AmazonElastic Compute Cloud User Guide.
Note
Although you can specify an Availability Zone or Availability Zone group when placing a SpotInstances request, the Spot Price does not vary by Availability Zone.
Note
Our policy is to provide filters for all "describe" calls so you can limit the results to your specifiedcriteria. Therefore, you can use filters to limit the results when describing Spot Price histories,even though you can use the regular request parameters to do something similar.
For example, you could use the regular request parameters or a filter to get the history for a particularinstance type.You can specify multiple request parameters or multiple filters (e.g., limit the results to them2.xlarge instance type, and only for Windows instances).The result includes information for a particularprice history only if it matches all your request parameters or filters. If there's no match, no special messageis returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactlyone character.You can escape special characters using a backslash before the character. For example,a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following table shows the available filters.
DescriptionFilter Name
Type of instance (e.g., m1.small).
Type: String
instance-type
Product description for the Spot Price.
Type: String
Valid Values: Linux/UNIX | Windows
product-description
Spot Price. The value must match exactly (or use wildcards; greater than orless than comparison is not supported).
Type: String
spot-price
Timestamp of the Spot Price history, e.g., 2010-08-16T05:06:11.000Z.Youcan use wildcards (* and ?). Greater than or less than comparison is notsupported.
Type: xsd:dateTime
timestamp
API Version 2010-08-31442
Amazon Elastic Compute Cloud API ReferenceDescribeSpotPriceHistory
Request Parameters
RequiredDescriptionName
DescribeSpotPriceHistoryType element.
Type: DescribeSpotPriceHistoryType (p. 636)
Ancestor: None
Children:startTime, endTime, instanceTypeSet, andproductDescriptionSet
DescribeSpotPriceHistoryType
NoStart date and time of the Spot Instance price history data.
Type: xsd:dateTime
Default: None
Ancestor: DescribeSpotPriceHistoryType
Children: None
startTime
NoEnd date and time of the Spot Instance price history data.
Type: xsd:dateTime
Default: None
Ancestor: DescribeSpotPriceHistoryType
Children: None
endTime
YesThe instance type set. It must be present, but can beempty.
Type: InstanceTypeSetType (p. 656)
Ancestor: DescribeSpotPriceHistoryType
Children: item
instanceTypeSet
NoInstance type set item.
Type: InstanceTypeSetItemType (p. 656)
Ancestor: instanceTypeSet
Children: instanceType
item
NoSpecifies the instance type to return.
Type: xsd:string
Valid Values: m1.small | m1.large | m1.xlarge |c1.medium | c1.xlarge | m2.xlarge | m2.2xlarge |m2.4xlarge | t1.micro
Default: None
Ancestor: item
Children: None
instanceType
YesThe product description set. It must be present, but canbe empty.
Type: ProductDescriptionSetType (p. 676)
Ancestor: DescribeSpotPriceHistoryType
Children: item
productDescriptionSet
API Version 2010-08-31443
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
RequiredDescriptionName
NoProduct description set.
Type: ProductDescriptionSetItemType (p. 675)
Ancestor: productDescriptionSet
Children: productDescription
item
NoFilters the results by Linux/UNIX vs. Windows.
Type: xsd:string
Valid Values: Linux/UNIX | Windows
Default: None
Ancestor: item
Children: None
productDescription
YesSet of filters. It must be present, but can be empty.
Type: FilterSetType
Children: item
filterSet
NoInformation for one filter.
Type: FilterType
Ancestor: filterSet
Children: name, valueSet
item
NoName of a filter.
Type: xsd:string
Ancestor: item
Children: None
name
NoOne or more values.
Type: ValueSetType
Ancestor: item
Children: item
valueSet
NoAn item in the set.
Type: ValueType
Ancestor: valueSet
Children: value
item
NoAn individual value.
Type: xsd:string
Ancestor: item
Children: None
value
API Version 2010-08-31444
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
Response Elements
DescriptionName
DescribeSpotPriceHistoryResponse element.
Type: DescribeSpotPriceHistoryResponseType (p. 636)
Ancestor: None
Children: requestId, spotPriceHistorySet
DescribeSpotPriceHistoryResponse
The ID of the request.
Type: xsd:string
Ancestor: DescribeSpotPriceHistoryResponseType
Children: None
requestId
Spot Price history set.
Type: SpotPriceHistorySetType (p. 703)
Ancestor: DescribeSpotPriceHistoryResponseType
Children: item
spotPriceHistorySet
Spot Price history set.
Type: SpotPriceHistorySetItemType (p. 702)
Ancestor: spotPriceHistorySet
Children:instanceType, productDescription, spotPrice, andtimestamp
item
The instance type.
Type: xsd:string
Ancestor: item
Children: None
instanceType
The description of the AMI.
Type: xsd:string
Valid Values: Linux/UNIX | Windows
Ancestor: item
Children: None
productDescription
Specifies the maximum price you will pay to launch one or more SpotInstances.
Type: xsd:string
Ancestor: item
Children: None
spotPrice
Specifies the date and time the request was created.
Type: xsd:dateTime
Ancestor: item
Children: None
timestamp
API Version 2010-08-31445
Amazon Elastic Compute Cloud API ReferenceResponse Elements
Examples
Example RequestThis example returns Spot Price history for the month of December.
<DescribeSpotPriceHistory xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <startTime>2009-12-01T00:00:00.000Z</startTime> <endTime>2009-12-31T23:59:59.000Z</endTime></DescribeSpotPriceHistory>
This request uses filters instead of regular request parameters to achieve the same results.
<DescribeSpotPriceHistory xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <instanceTypeSet/> <productDescriptionSet/> <filterSet> <item> <name>timestamp</name> <valueSet> <item> <value>2009-12-*</value> </item> </valueSet> </item> </filterSet></DescribeSpotPriceHistory>
Example Response<DescribeSpotPriceHistoryResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <spotPriceHistorySet> <item> <instanceType>m1.small</instanceType> <productDescription>Linux/UNIX</productDescription> <spotPrice>0.287</spotPrice> <timestamp>2009-12-04T20:56:05.000Z</timestamp> </item> <item> <instanceType>m1.small</instanceType> <productDescription>Windows</productDescription> <spotPrice>0.033</spotPrice> <timestamp>2009-12-04T22:33:47.000Z</timestamp> </item> </ spotPriceHistorySet></DescribeSpotPriceHistoryResponse>
Related Operations• DescribeSpotInstanceRequests (p. 430)
• RequestSpotInstances (p. 500)
• CancelSpotInstanceRequests (p. 284)
API Version 2010-08-31446
Amazon Elastic Compute Cloud API ReferenceExamples
DescribeTags
DescriptionLists your tags. For more information about tags, go to Using Tags in the Amazon Elastic Compute CloudDeveloper Guide.
You can use filters to limit the results when describing tags. For example, you could get only the tags fora particular resource type.You can specify multiple values for a filter. A tag must match at least one ofthe specified values for it to be included in the results.
You can specify multiple filters (e.g., limit the results to a specific resource type, and get only tags withvalues that contain the string database). The result includes information for a particular tag only if itmatches all your filters. If there's no match, no special message is returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactlyone character.You can escape special characters using a backslash before the character. For example,a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following table shows the available filters.
DescriptionFilter Name
Tag key.
Type: String
key
Resource ID.
Type: String
resource-id
Resource type.
Type: String
Valid Values: customer-gateway | dhcp-options | image | instance |snapshot | spot-instances-request | subnet | volume | vpc |vpn-connection | vpn-gateway
resource-type
Tag value.
Type: String
value
Request Parameters
RequiredDescriptionName
DescribeTags element.
Type: DescribeTagsType
Ancestor: None
Children: filterSet
DescribeTags
YesSet of filters. It must be present, but can be empty.
Type: FilterSetType
Children: item
filterSet
API Version 2010-08-31447
Amazon Elastic Compute Cloud API ReferenceDescribeTags
RequiredDescriptionName
NoInformation for one filter.
Type: FilterType
Ancestor: filterSet
Children: name, valueSet
item
NoName of a filter.
Type: xsd:string
Ancestor: item
Children: None
name
NoOne or more values.
Type: ValueSetType
Ancestor: item
Children: item
valueSet
NoAn item in the set.
Type: ValueType
Ancestor: valueSet
Children: value
item
NoAn individual value.
Type: xsd:string
Ancestor: item
Children: None
value
Response Elements
DescriptionName
DescribeTagsResponse element.
Type: DescribeTagsResponseType
Ancestor: None
Children: requestId, tagSet
DescribeTagsResponse
The ID of the request.
Type: xsd:string
Ancestor: DescribeTagsResponse
Children: None
requestId
Information about the tags.
Type: TagSetType
Ancestor: DescribeTagsResponse
Children: item
tagSet
API Version 2010-08-31448
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Information about one tag.
Type: TagSetItemType
Ancestor: tagSet
Children: resourceId, resourceType, key, value
item
The resource's ID. For example, ami-1a2b3c4d.
Type: String
resourceId
Type of resource.
Type: String
Valid Values: customer-gateway | dhcp-options | image |instance | snapshot | spot-instances-request | subnet |volume | vpc | vpn-connection | vpn-gateway
resourceType
The tag's key.
Type: String
key
The tag's value.
Type: String
value
Examples
Example RequestThis example describes all the tags in your account.
<DescribeTags xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <filterset/></DescribeTags>
Sample response:
<DescribeTagsResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId> <tagSet> <item> <resourceId>ami-1a2b3c4d</resourceId> <resourceType>image</resourceType> <key>webserver</key> <value/> </item> <item> <resourceId>ami-1a2b3c4d</resourceId> <resourceType>image</resourceType> <key>stack</key> <value>Production</value> </item> <item> <resourceId>i-5f4e3d2a</resourceId> <resourceType>instance</resourceType> <key>webserver</key> <value/>
API Version 2010-08-31449
Amazon Elastic Compute Cloud API ReferenceExamples
</item> <item> <resourceId>i-5f4e3d2a</resourceId> <resourceType>instance</resourceType> <key>stack</key> <value>Production</value> </item> <item> <resourceId>i-12345678</resourceId> <resourceType>instance</resourceType> <key>database_server</key> <value/> </item> <item> <resourceId>i-12345678</resourceId> <resourceType>instance</resourceType> <key>stack</key> <value>Test</value> </item> </tagSet></DescribeTagsResponse>
Example RequestThis example describes only the tags for the AMI with ID ami-1a2b3c4d.
<DescribeTags xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <filterSet> <item> <name>resource-id</name> <valueSet> <item> <value>ami-1a2b3c4d</value> </item> </valueSet> </item> </filterSet></DescribeTags>
Sample response:
<DescribeTagsResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId> <tagSet> <item> <resourceId>ami-1a2b3c4d</resourceId> <resourceType>image</resourceType> <key>webserver</key> <value/> </item> <item> <resourceId>ami-1a2b3c4d</resourceId> <resourceType>image</resourceType> <key>stack</key> <value>Production</value> </item> </tagSet></DescribeTagsResponse>
API Version 2010-08-31450
Amazon Elastic Compute Cloud API ReferenceExamples
Example RequestThis example describes the tags for all your instances.
<DescribeTags xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <filterSet> <item> <name>resource-type</name> <valueSet> <item> <value>instance</value> </item> </valueSet> </item> </filterSet></DescribeTags>
Sample response:
<DescribeTagsResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId> <tagSet> <item> <resourceId>i-5f4e3d2a</resourceId> <resourceType>instance</resourceType> <key>webserver</key> <value/> </item> <item> <resourceId>i-5f4e3d2a</resourceId> <resourceType>instance</resourceType> <key>stack</key> <value>Production</value> </item> <item> <resourceId>i-12345678</resourceId> <resourceType>instance</resourceType> <key>database_server</key> <value/> </item> <item> <resourceId>i-12345678</resourceId> <resourceType>instance</resourceType> <key>stack</key> <value>Test</value> </item> </tagSet></DescribeTagsResponse>
Example RequestThis example describes the tags for all your instances tagged with the key webserver.
<DescribeTags xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <filterSet> <item> <name>resource-type</name> <valueSet> <item>
API Version 2010-08-31451
Amazon Elastic Compute Cloud API ReferenceExamples
<value>instance</value> </item> </valueSet> </item> <item> <name>key</name> <valueSet> <item> <value>webserver</value> </item> </valueSet> </item> </filterSet></DescribeTags>
Sample response:
<DescribeTagsResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId> <tagSet> <item> <resourceId>i-5f4e3d2a</resourceId> <resourceType>instance</resourceType> <key>webserver</key> <value/> </item> </tagSet></DescribeTagsResponse>
Example RequestThis example describes the tags for all your instances tagged with either stack=Test or stack=Production.
<DescribeTags xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <filterSet> <item> <name>resource-type</name> <valueSet> <item> <value>instance</value> </item> </valueSet> </item> <item> <name>key</name> <valueSet> <item> <value>stack</value> </item> </valueSet> </item> <item> <name>value</name> <valueSet> <item> <value>Test</value> </item> <item> <value>Production</value>
API Version 2010-08-31452
Amazon Elastic Compute Cloud API ReferenceExamples
</item> </valueSet> </item> </filterSet></DescribeTags>
Sample response:
<DescribeTagsResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId> <tagSet> <item> <resourceId>i-5f4e3d2a</resourceId> <resourceType>instance</resourceType> <key>stack</key> <value>Production</value> </item> <item> <resourceId>i-12345678</resourceId> <resourceType>instance</resourceType> <key>stack</key> <value>Test</value> </item> </tagSet></DescribeTagsResponse>
Example RequestThis example describes the tags for all your instances tagged with Purpose=[empty string].
<DescribeTags xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <filterSet> <item> <name>resource-type</name> <valueSet> <item> <value>instance</value> </item> </valueSet> </item> <item> <name>key</name> <valueSet> <item> <value>Purpose</value> </item> </valueSet> </item> <item> <name>value</name> <valueSet> <item> <value/> </item> </valueSet> </item> </filterSet></DescribeTags>
API Version 2010-08-31453
Amazon Elastic Compute Cloud API ReferenceExamples
Related Operations• CreateTags (p. 305)
• DeleteTags (p. 321)
API Version 2010-08-31454
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DescribeVolumes
DescriptionDescribes your Amazon EBS volumes. For more information about Amazon EBS, go to the AmazonElastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide.
You can filter the results to return information only about volumes that match criteria you specify. Forexample, you could get information about volumes whose status is available.You can specify multiplevalues for a filter (e.g., the volume's status is either available or in-use). A volume must match atleast one of the specified values for it to be included in the results.
You can specify multiple filters (e.g., the volume's status is available, and it is tagged with a particularvalue). The result includes information for a particular volume only if it matches all your filters. If there'sno match, no special message is returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactlyone character.You can escape special characters using a backslash before the character. For example,a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following table shows the available filters.
DescriptionFilter Name
Time stamp when the attachment initiated.
Type: xsd:dateTime
attachement.attach-time
Whether the volume will be deleted on instancetermination.
Type: Boolean
attachment.delete-on-termination
How the volume is exposed to the instance (e.g.,/dev/sda1).
Type: String
attachement.device
ID of the instance the volume is attached to.
Type: String
attachment.instance-id
Attachment state.
Type: String
Valid Values:attaching | attached | detaching| detached
attachment.status
Availability Zone in which the volume was created.
Type: String
availability-zone
Time stamp when the volume was created.
Type: xsd:dateTime
create-time
Size of the volume, in GiB (e.g., 20).
Type: String
size
Snapshot from which the volume was created.
Type: String
snapshot-id
API Version 2010-08-31455
Amazon Elastic Compute Cloud API ReferenceDescribeVolumes
DescriptionFilter Name
Status of the volume.
Type: String
Valid Values: creating | available | in-use |deleting | deleted | error
status
Key of a tag assigned to the resource. This filter isindependent of the tag-value filter. For example,if you use both the filter tag-key=Purpose andthe filter tag-value=X, you get any resourcesassigned both the tag key Purpose (regardless ofwhat the tag's value is), and the tag value X(regardless of what the tag's key is). If you want tolist only resources where Purpose=X, see thetag:key filter later in this table.
For more information about tags, go to Using Tagsin the Amazon Elastic Compute Cloud DeveloperGuide.
Type: String
tag-key
Value of a tag assigned to the resource. This filteris independent of the tag-key filter.
Type: String
tag-value
Filters the results based on a specific tag/valuecombination.
Example: To list just the resources assigned tagPurpose=X, then specify:
Filter.1.Name=tag:Purpose
Filter.1.Value.1=X
Example: To list just resources assigned tagPurpose=X OR Purpose=Y, then specify:
Filter.1.Name=tag:Purpose
Filter.1.Value.1=X
Filter.1.Value.2=Y
tag:key
Volume ID.
Type: String
volume-id
Request Parameters
RequiredDescriptionName
DescribeVolumesType element.
Type: DescribeVolumesType (p. 640)
Ancestor: None
Children: volumeSet
DescribeVolumesType
API Version 2010-08-31456
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
RequiredDescriptionName
YesSet of volumes. It must be present, but can be empty.
Type: DescribeVolumesSetType (p. 639)
Ancestor: DescribeVolumesType
Children: item
volumeSet
NoInformation for a volume.
Type: DescribeVolumesSetItemType (p. 638)
Ancestor: volumeSet
Children: volumeId
item
NoThe ID of the volume to list.
Type: xsd:string
Default: Describes all volumes that you own.
Ancestor: item
Children: None
volumeId
YesSet of filters. It must be present, but can be empty.
Type: FilterSetType
Children: item
filterSet
NoInformation for one filter.
Type: FilterType
Ancestor: filterSet
Children: name, valueSet
item
NoName of a filter.
Type: xsd:string
Ancestor: item
Children: None
name
NoOne or more values.
Type: ValueSetType
Ancestor: item
Children: item
valueSet
NoAn item in the set.
Type: ValueType
Ancestor: valueSet
Children: value
item
NoAn individual value.
Type: xsd:string
Ancestor: item
Children: None
value
API Version 2010-08-31457
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
Response Elements
DescriptionName
DescribeVolumesResponse element.
Type: DescribeVolumesResponseType (p. 637)
Ancestor: None
Children: requestId, volumeSet
DescribeVolumesResponse
The ID of the request.
Type: xsd:string
Ancestor: DescribeVolumesResponseType
Children: None
requestId
Volume set.
Type: DescribeVolumesSetResponseType (p. 639)
Ancestor: DescribeVolumesResponseType
Children: item
volumeSet
Information for a volume.
Type: DescribeVolumesSetItemResponseType (p. 637)
Ancestor: volumeSet
Children: volumeId, size, snapshotId, availabilityZone,status, createTime, attachmentSet, tagSet
item
The ID of the volume.
Type: xsd:string
Ancestor: item
Children: None
volumeId
The size of the volume, in GiBs.
Type: xsd:string
Ancestor: item
Children: None
size
Snapshot from which the volume was created (optional).
Type: xsd:string
Ancestor: item
Children: None
snapshotId
Availability Zone in which the volume was created.
Type: xsd:string
Ancestor: item
Children: None
availabilityZone
Volume state.
Type: xsd:string
Valid Values: creating | available | in-use | deleting |deleted | error
Ancestor: item
Children: None
status
API Version 2010-08-31458
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Time stamp when volume creation was initiated.
Type: xsd:dateTime
Ancestor: item
Children: None
createTime
Attachment set.
Type: AttachmentSetResponseType (p. 561)
Ancestor: item
Children: item
attachmentSet
Information for a attachment set.
Type: AttachmentSetItemResponseType (p. 560)
Ancestor: attachmentSet
Children:volumeId, instanceId, device, status, attachTime,and deleteOnTermination
item
The ID of the volume.
Type: xsd:string
Ancestor: item
Children: None
volumeId
The ID of the instance.
Type: xsd:string
Ancestor: item
Children: None
instanceId
Specifies how the device is exposed to the instance (e.g., /dev/sdh).
Type: xsd:string
Ancestor: item
Children: None
device
Attachment state.
Type: xsd:string
Valid Values: attaching | attached | detaching | detached
Ancestor: item
Children: None
status
Time stamp when the attachment initiated.
Type: xsd:dateTime
Ancestor: item
Children: None
attachTime
Specifies whether the Amazon EBS volume is deleted on instancetermination.
Type: xsd:boolean
Ancestor: item
Children: None
deleteOnTermination
API Version 2010-08-31459
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Tags assigned to the resource.
Type: ResourceTagSetType
Ancestor: item
Children: item
tagSet
Information about one tag.
Type: ResourceTagSetItemType
Ancestor: tagSet
Children: key, value
item
Tag key.
Type: xsd:string
Ancestor: item
Children: None
key
Tag value.
Type: xsd:string
Ancestor: item
Children: None
value
Examples
Example RequestThis example describes all volumes associated with your account.
<DescribeVolumes xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"></DescribeVolumes>
Example Response<DescribeVolumesResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <volumeSet> <item> <volumeId>vol-4282672b</volumeId> <size>80</size> <snapshotId/> <availabilityZone>us-east-1a</availabilityZone> <status>in-use</status> <createTime>2008-05-07T11:51:50.000Z</createTime> <attachmentSet> <item> <volumeId>vol-4282672b</volumeId> <instanceId>i-6058a509</instanceId> <device>/dev/sdh</device> <status>attached</status> <attachTime>2008-05-07T12:51:50.000Z</attachTime> <deleteOnTermination>false</deleteOnTermination> </item> </attachmentSet> <tagSet/>
API Version 2010-08-31460
Amazon Elastic Compute Cloud API ReferenceExamples
</item> </volumeSet></DescribeVolumesResponse>
Example RequestThis example describes all volumes that are both attached to instance i-1a2b3c4d and also set to deletewhen the instance terminates.
<DescribeVolumes xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <volumeSet/> <filterSet> <item> <name>attachment.instance-id</name> <valueSet> <item> <value>i-1a2b3c4d</value> </item> </valueSet> </item> <item> <name>attachment.delete-on-termination</name> <valueSet> <item> <value>true</value> </item> </valueSet> </item> </filterSet></DescribeVolumes>
Related Operations• CreateVolume (p. 308)
• DeleteVolume (p. 325)
• AttachVolume (p. 266)
• DetachVolume (p. 462)
API Version 2010-08-31461
Amazon Elastic Compute Cloud API ReferenceRelated Operations
DetachVolume
DescriptionDetaches an Amazon EBS volume from an instance. For more information about Amazon EBS, go to theAmazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide.
Important
Make sure to unmount any file systems on the device within your operating system beforedetaching the volume. Failure to unmount file systems, or otherwise properly release the devicefrom use, can result in lost data and will corrupt the file system.
Note
If an Amazon EBS volume is the root device of an instance, it cannot be detached while theinstance is in the ‘running’ state. To detach the root volume, stop the instance first.
Request Parameters
RequiredDescriptionName
DetachVolumeType element.
Type: DetachVolumeType (p. 641)
Ancestor: None
Children: volumeId, instanceId, device, and force
DetachVolumeType
YesThe ID of the volume.
Type: xsd:string
Default: None
Ancestor: DetachVolumeType
Children: None
volumeId
NoThe ID of the instance.
Type: xsd:string
Default: None
Ancestor: DetachVolumeType
Children: None
instanceId
NoThe device name.
Type: xsd:string
Default: None
Ancestor: DetachVolumeType
Children: None
device
API Version 2010-08-31462
Amazon Elastic Compute Cloud API ReferenceDetachVolume
RequiredDescriptionName
NoForces detachment if the previous detachment attempt didnot occur cleanly (logging into an instance, unmountingthe volume, and detaching normally).This option can leadto data loss or a corrupted file system. Use this option onlyas a last resort to detach a volume from a failed instance.The instance will not have an opportunity to flush filesystem caches nor file system meta data. If you use thisoption, you must perform file system check and repairprocedures.
Type: xsd:boolean
Default: None
Ancestor: DetachVolumeType
Children: None
force
Response Elements
DescriptionName
DetachVolumeResponseType element.
Type: DetachVolumeResponseType (p. 640)
Ancestor: None
Children: requestId, volumeId, instanceId, device, status,and attachTime
DetachVolumeResponseType
The ID of the request.
Type: xsd:string
Ancestor: DetachVolumeResponseType
Children: None
requestId
The ID of the volume.
Type: xsd:string
Ancestor: DetachVolumeResponseType
Children: None
volumeId
The ID of the instance.
Type: xsd:string
Ancestor: DetachVolumeResponseType
Children: None
instanceId
The device as it is exposed to the instance.
Type: xsd:string
Ancestor: DetachVolumeResponseType
Children: None
device
API Version 2010-08-31463
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Attachment state.
Type: xsd:string
Valid Values: attaching | attached | detaching | detached
Ancestor: DetachVolumeResponseType
Children: None
status
Time stamp when the attachment initiated.
Type: xsd:dateTime
Ancestor: DetachVolumeResponseType
Children: None
attachTime
Examples
Example RequestThis example detaches volume vol-4d826724.
<DetachVolume xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <volumeId>vol-4d826724</volumeId> <instanceId>i-6058a509</instanceId></DetachVolume>
Example Response<DetachVolumeResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <volumeId>vol-4d826724</volumeId> <instanceId>i-6058a509</instanceId> <device>/dev/sdh</device> <status>detaching</status> <attachTime>2008-05-08T11:51:50.000Z</attachTime></DetachVolumeResponse>
Related Operations• CreateVolume (p. 308)
• DeleteVolume (p. 325)
• DescribeVolumes (p. 455)
• AttachVolume (p. 266)
API Version 2010-08-31464
Amazon Elastic Compute Cloud API ReferenceExamples
DisassociateAddress
DescriptionDisassociates the specified elastic IP address from the instance to which it is assigned. This is anidempotent operation. If you enter it more than once, Amazon EC2 does not return an error.
Request Parameters
RequiredDescriptionName
DisassociateAddressType element.
Type: DisassociateAddressType (p. 642)
Ancestor: None
Children: publicIp
DisassociateAddressType
YesIP address that you are disassociating from the instance.
Type: xsd:string
Default: None
Ancestor: DisassociateAddressType
Children: None
publicIp
Response Elements
DescriptionName
DisassociateAddressResponseType element.
Type: DisassociateAddressResponseType (p. 642)
Ancestor: None
Children: requestId, return
DisassociateAddressResponseType
The ID of the request.
Type: xsd:string
Ancestor: DisassociateAddressResponseType
Children: None
requestId
Returns true if the IP address is disassociated from the instance.Otherwise, returns an error.
Type: xsd:boolean
Ancestor: DisassociateAddressResponseType
Children: None
return
Examples
Example RequestThis example disassociates the 67.202.55.255 IP address from the instance to which it is assigned.
API Version 2010-08-31465
Amazon Elastic Compute Cloud API ReferenceDisassociateAddress
<DisassociateAddress xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <publicIp>67.202.55.255</publicIp></DisassociateAddress>
Example Response<DisassociateAddressResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/">
<return>true</return></DisassociateAddressResponse>
Related Operations• AllocateAddress (p. 262)
• DescribeAddresses (p. 329)
• ReleaseAddress (p. 498)
• AssociateAddress (p. 264)
API Version 2010-08-31466
Amazon Elastic Compute Cloud API ReferenceRelated Operations
GetConsoleOutput
DescriptionRetrieves console output for the specified instance.
Instance console output is buffered and posted shortly after instance boot, reboot, and termination.Amazon EC2 preserves the most recent 64 KB output which will be available for at least one hour afterthe most recent post.
Request Parameters
RequiredDescriptionName
GetConsoleOutputType element.
Type: GetConsoleOutputType (p. 646)
Ancestor: None
Children: instanceId
GetConsoleOutputType
YesID of the instance for which you want console output.
Type: xsd:string
Default: None
Ancestor: GetConsoleOutputType
Children: None
instanceId
Response Elements
DescriptionName
GetConsoleOutputResponseType element.
Type: GetConsoleOutputResponseType (p. 646)
Ancestor: None
Children: requestId, instanceId, timestamp, and output
GetConsoleOutputResponseType
The ID of the request.
Type: xsd:string
Ancestor: GetConsoleOutputResponseType
Children: None
requestId
The instance ID.
Type: xsd:string
Ancestor: GetConsoleOutputResponseType
Children: None
instanceId
The time the output was last updated.
Type: xsd:dateTime
Ancestor: GetConsoleOutputResponseType
Children: None
timestamp
API Version 2010-08-31467
Amazon Elastic Compute Cloud API ReferenceGetConsoleOutput
DescriptionName
The console output, Base64 encoded.
Type: xsd:string
Ancestor: GetConsoleOutputResponseType
Children: None
output
Examples
Example RequestThis example retrieves the console output for the i-10a64379 Linux and UNIX instance.
<GetConsoleOutput xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <instanceId>i-28a64341</instanceId></GetConsoleOutput>
Example Response<GetConsoleOutputResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <instanceId>i-28a64341</instanceId> <timestamp>2007-01-03 15:00:00</timestamp> <output>TGludXggdmVyc2lvbiAyLjYuMTYteGVuVSAoYnVpbGRlckBwYXRjaGJhdC5hb WF6b25zYSkgKGdjYyB2ZXJzaW9uIDQuMC4xIDIwMDUwNzI3IChSZWQgSGF0IDQuMC4xLTUpKSAjMSBTTVAgVGh1IE9jdCAyNiAwODo0MToyNiBTQVNUIDIwMDYKQklPUy1wcm92aWRlZCBwaHlzaWNhbCBSQU0gbWFwOgpYZW46IDAwMDAwMDAwMDAwMDAwMDAgLSAwMDAwMDAwMDZhNDAwMDAwICh1c2FibGUpCjk4ME1CIEhJR0hNRU0gYXZhaWxhYmxlLgo3MjdNQiBMT1dNRU0gYXZhaWxhYmxlLgpOWCAoRXhlY3V0ZSBEaXNhYmxlKSBwcm90ZWN0aW9uOiBhY3RpdmUKSVJRIGxvY2t1cCBkZXRlY3Rpb24gZGlzYWJsZWQKQnVpbHQgMSB6b25lbGlzdHMKS2VybmVsIGNvbW1hbmQgbGluZTogcm9vdD0vZGV2L3NkYTEgcm8gNApFbmFibGluZyBmYXN0IEZQVSBzYXZlIGFuZCByZXN0b3JlLi4uIGRvbmUuCg==</output></GetConsoleOutputResponse>
Related Operations• RunInstances (p. 522)
API Version 2010-08-31468
Amazon Elastic Compute Cloud API ReferenceExamples
GetPasswordData
DescriptionRetrieves the encrypted administrator password for the instances running Windows.
Note
The Windows password is only generated the first time an AMI is launched. It is not generatedfor rebundled AMIs or after the password is changed on an instance.
The password is encrypted using the key pair that you provided.
Request Parameters
RequiredDescriptionName
GetPasswordDataType element.
Type: GetPasswordDataType (p. 647)
Ancestor: None
Children: instanceId
GetPasswordDataType
YesThe ID of the instance for which to get the password.
Type: xsd:string
Default: None
Ancestor: GetPasswordDataType
Children: None
instanceId
Response Elements
DescriptionName
GetPasswordDataResponseType element.
Type: GetPasswordDataResponseType (p. 647)
Ancestor: None
Children: requestId, instanceId, timestamp, andpasswordData
GetPasswordDataResponseType
The ID of the request.
Type: xsd:string
Ancestor: GetPasswordDataResponseType
Children: None
requestId
The ID of the instance.
Type: xsd:string
Ancestor: GetPasswordDataResponseType
Children: None
instanceId
API Version 2010-08-31469
Amazon Elastic Compute Cloud API ReferenceGetPasswordData
DescriptionName
The time the data was last updated.
Type: xsd:dateTime
Ancestor: GetPasswordDataResponseType
Children: None
timestamp
The password of the instance.
Type: xsd:string
Ancestor: GetPasswordDataResponseType
Children: None
passwordData
Examples
Example RequestThis example returns the encrypted version of the administrator password for the i-2574e22a instance.
<GetPasswordData xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <instanceId>i-2574e22a</instanceId></GetPasswordData>
Example Response<GetPasswordDataResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <instanceId>i-2574e22a</instanceId> <timestamp>2009-10-24 15:00:00</timestamp> <passwordData>TGludXggdmVyc2lvbiAyLjYuMTYteGVuVSAoYnVpbGRlckBwYXRjaGJhdC5hb WF6b25zYSkgKGdj</passwordData></GetPasswordDataResponse>
Related Operations• RunInstances (p. 522)
API Version 2010-08-31470
Amazon Elastic Compute Cloud API ReferenceExamples
ImportKeyPair
DescriptionImports the public key from an RSA key pair that you created with a third-party tool. Compare this withCreateKeyPair, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy ofthe public key). With ImportKeyPair, you create the key pair and give AWS just the public key. Theprivate key is never transferred between you and AWS.
You can easily create an RSA key pair on Windows and Linux using the ssh-keygen command line tool(provided with the standard OpenSSH installation). Standard library support for RSA key pair creation isalso available in Java, Ruby, Python, and many other programming languages.
Supported formats:
• OpenSSH public key format (e.g., the format in ~/.ssh/authorized_keys)
• Base64 encoded DER format
• SSH public key file format as specified in RFC4716
DSA keys are not supported. Make sure your key generator is set up to create RSA keys.
Supported lengths: 1024, 2048, and 4096.
Request Parameters
RequiredDescriptionName
ImportKeyPair element.
Type: ImportKeyPair
Ancestor: None
Children: keyName, publicKeyMaterial
ImportKeyPair
YesA unique name for the key pair.
Type: xsd:string
Default: None
Constraints: Accepts alphanumeric characters, spaces,dashes, and underscores.
Ancestor: ImportKeyPair
Children: None
keyName
YesThe public key.You must base64 encode the public keymaterial before sending it to AWS.
Type: xsd:string
Default: None
Ancestor: ImportKeyPair
Children: None
publicKeyMaterial
API Version 2010-08-31471
Amazon Elastic Compute Cloud API ReferenceImportKeyPair
Response Elements
DescriptionName
ImportKeyPairResponse element.
Type: ImportKeyPairResponse
Ancestor: None
Children: requestId, keyName, keyFingerprint
ImportKeyPairResponse
The ID of the request.
Type: xsd:string
Ancestor: ImportKeyPairResponse
Children: None
requestId
The key pair name you provided.
Type: xsd:string
Ancestor: ImportKeyPairResponse
Children: None
keyName
MD5 public key fingerprint as specified in section 4 of RFC4716.
Type: xsd:string
Ancestor: ImportKeyPairResponse
Children: None
keyFingerprint
Examples
Example RequestThis example uploads the public key for a key pair you name gsg-keypair.
<ImportKeyPair xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <keyName>gsg-keypair</keyName> <publicKeyMaterial>LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tDQpNSUlDZHpDQ0FlQ2dBd0lCQWdJR0FQalRyR3pQTUEwR0NTcUdTSWIzRFFFQkJRVUFNRk14Q3pBSkJnTlZCQVlUDQpBbFZUTVJNd0VRWURWUVFLRXdwQmJXRjZiMjR1WTI5dE1Rd3dDZ1lEVlFRTEV3TkJWMU14SVRBZkJnTlZCQU1UDQpHRUZYVXlCTWFXMXBkR1ZrTFVGemMzVnlZVzVqWlNCRFFUQWVGdzB3T1RBM016RXlNVFEzTXpWYUZ3MHhNREEzDQpNekV5TVRRM016VmFNRkl4Q3pBSkJnTlZCQVlUQWxWVE1STXdFUVlEVlFRS0V3cEJiV0Y2YjI0dVkyOXRNUmN3DQpGUVlEVlFRTEV3NUJWMU10UkdWMlpXeHZjR1Z5Y3pFVk1CTUdBMVVFQXhNTWJUSnViRGhxZW00MWVHUjFNSUdmDQpNQTBHQ1NxR1NJYjNEUUVCQVFVQUE0R05BRENCaVFLQmdRQ1dOazBoQytrcExBRnp2YkFQc3U1TDU5bFMwUnI0DQprZEpaM0RFak1pL0IwV2ZDSzhpS2hWYWt1WitHSnJtNDdMUHZCaFVKWk9IeHVUU0VXakFDNmlybDJzKzlSWXVjDQpFZXg0TjI4ZlpCZGpORlAzdEgwZ2NuWjdIbXZ4aFBrTEtoRTdpZmViNmNGWUhRdHpHRnRPQ0ZQTmdUSE92VDE5DQoyR3lZb1VyU3BDVGFCUUlEQVFBQm8xY3dWVEFPQmdOVkhROEJBZjhFQkFNQ0JhQXdGZ1lEVlIwbEFRSC9CQXd3DQpDZ1lJS3dZQkJRVUhBd0l3REFZRFZSMFRBUUgvQkFJd0FEQWRCZ05WSFE0RUZnUVU1RVNuTUZZUzdyTDNXTUdLDQpqejMxVXZ5TThnMHdEUVlKS29aSWh2Y05BUUVGQlFBRGdZRUFnWjdDZ1lJWHR1WFM1NHVqbU5jOTR0NWRNc3krDQpCM0Z3WVVNdUd4WUI2eGQvSUVWMTFLRVEyZ0hpZUdMU21jUWg4c2JXTTdtKzcrYm9UNmc2U2hLbU1jblkzWkRTDQpWRVFZZ25qcEt1aEZRd2pmaVpTUEc1UG5SVENhdkVqS3lTTUpDVGxpdTdTTjMrR2J3cFU5Uzg3K21GM2tsMGRmDQpZNlIrbEl5SWcrU3ROOTg9DQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tEXAMPLE </publicKeyMaterial></ImportKeyPair>
API Version 2010-08-31472
Amazon Elastic Compute Cloud API ReferenceResponse Elements
Example Response<ImportKeyPairResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId> <keyName>gsg-keypair</keyName> <keyFingerprint> 1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f </keyFingerprint></ImportKeyPairResponse>
Related Operations• CreateKeyPair (p. 292)
• DescribeKeyPairs (p. 384)
• DeleteKeyPair (p. 312)
API Version 2010-08-31473
Amazon Elastic Compute Cloud API ReferenceRelated Operations
ModifyImageAttribute
DescriptionModifies an attribute of an AMI.
Request Parameters
RequiredDescriptionName
ModifyImageAttributeType element.
Type: ModifyImageAttributeType (p. 663)
Ancestor: None
Children:imageId, launchPermission, productCodes,and description
ModifyImageAttributeType
YesThe AMI ID.
Type: xsd:string
Default: None
Ancestor: ModifyImageAttributeType
Children: None
imageId
Launch permission set.
Type: LaunchPermissionOperationType (p. 660)
Ancestor: ModifyImageAttributeType
Children: add, remove
launchPermission
Adds permission.
Type: LaunchPermissionListType (p. 660)
Ancestor: launchPermission
Children: item
add
Information for launch permissions.
Type: LaunchPermissionItemType (p. 659)
Ancestor: add
Children: userId, group
item
YesID of the AWS account you want to give permission to.
Type: xsd:string
Default: None
Ancestor: item
Children: None
userId
API Version 2010-08-31474
Amazon Elastic Compute Cloud API ReferenceModifyImageAttribute
RequiredDescriptionName
YesName of the group you want to give permission to. Theonly valid value is all.
Type: xsd:string
Valid Value: all (makes the AMI public)
Default: None
Ancestor: item
Children: None
group
Remove permission.
Type: LaunchPermissionListType (p. 660)
Ancestor: launchPermission
Children: item
remove
Information for launch permissions.
Type: LaunchPermissionItemType (p. 659)
Ancestor: remove
Children: userId, group
item
YesID of the AWS account you want to remove permissionfrom.
Type: xsd:string
Default: None
Ancestor: item
Children: None
userId
YesName of the group you want to remove permission from.The only valid value is all.
Type: xsd:string
Valid Value: all (makes the AMI private)
Default: None
Ancestor: item
Children: None
group
Product code set.
Type: ProductCodeListType (p. 673)
Ancestor: ModifyImageAttributeType
Children: item
productCodes
Information for one product code.
Type: ProductCodeItemType (p. 672)
Ancestor: productCodes
Children: productCode
item
NoProduct code. Once you add a product code to an AMI, itcan't be removed.
Type: xsd:string
Default: None
Ancestor: item
Children: None
productCode
API Version 2010-08-31475
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
RequiredDescriptionName
The description of the AMI.
Type: AttributeValueType (p. 563)
Ancestor: ModifyImageAttributeType
Children: value
description
ID of the item.
Type: xsd:string
Default: None
Ancestor: description
Children: None
value
Response Elements
DescriptionName
ModifyImageAttributeResponseType element.
Type: ModifyImageAttributeResponseType (p. 662)
Ancestor: None
Children: requestId, return
ModifyImageAttributeResponseType
The ID of the request.
Type: xsd:string
Ancestor: ModifyImageAttributeResponseType
Children: None
requestId
Returns true if successful. Otherwise, returns an error.
Type: xsd:boolean
Ancestor: ModifyImageAttributeResponseType
Children: None
return
Examples
Example RequestThis example makes the AMI public (i.e., so any AWS account can launch it).
<ModifyImageAttribute xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <imageId>ami-61a54008</imageId> <launchPermission> <add> <item> <group>all</group> </item> </add> <launchPermission></ModifyImageAttribute>
API Version 2010-08-31476
Amazon Elastic Compute Cloud API ReferenceResponse Elements
Example RequestThis example makes the AMI private (i.e., so only you as the owner can launch it).
<ModifyImageAttribute xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <imageId>ami-61a54008</imageId> <launchPermission> <remove> <item> <group>all</group> </item> </remove> <launchPermission></ModifyImageAttribute>
Example RequestThis example grants launch permission to the AWS account with ID 111122223333.
<ModifyImageAttribute xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <imageId>ami-61a54008</imageId> <launchPermission> <add> <item> <userId>111122223333</userId> </item> </add> <launchPermission></ModifyImageAttribute>
Example RequestThis example removes launch permission from the AWS account with ID 111122223333.
<ModifyImageAttribute xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <imageId>ami-61a54008</imageId> <launchPermission> <remove> <item> <userId>111122223333</userId> </item> </remove> <launchPermission></ModifyImageAttribute>
Example RequestThis example adds the 774F4FF8 product code to the ami-61a54008 AMI.
<ModifyImageAttribute xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <imageId>ami-61a54008</imageId> <productCodes> <item> <productCode>774F4FF8</productCode> </item> <productCodes></ModifyImageAttribute>
API Version 2010-08-31477
Amazon Elastic Compute Cloud API ReferenceExamples
Example Response<ModifyImageAttributeResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/">
<return>true</return></ModifyImageAttributeResponse>
Related Operations• ResetImageAttribute (p. 512)
• DescribeImageAttribute (p. 344)
API Version 2010-08-31478
Amazon Elastic Compute Cloud API ReferenceRelated Operations
ModifyInstanceAttribute
DescriptionModifies an attribute of an instance.
Request Parameters
RequiredDescriptionName
YesModifyInstanceAttributeType element.
Type: ModifyInstanceAttributeType (p. 664)
Ancestor: None
Children: instanceId, instanceType, kernel,ramdisk, userData, disableApiTermination,instanceInitiatedShutdownBehavior, andblockDeviceMapping
ModifyInstanceAttributeType
YesThe instance ID.
Type: xsd:string
Default: None
Ancestor: ModifyInstanceAttributeType
Children: None
instanceId
NoThe instance type.
Type: AttributeValueType (p. 563)
Ancestor: ModifyInstanceAttributeType
Children: value
instanceType
NoID of the item.
Type: xsd:string
Default: None
Ancestor: instanceType
Children: None
value
NoKernel set.
Type: AttributeValueType (p. 563)
Ancestor: ModifyInstanceAttributeType
Children: value
kernel
NoID of the item.
Type: xsd:string
Default: None
Ancestor: kernel
Children: None
value
NoRAM disk set.
Type: AttributeValueType (p. 563)
Ancestor: ModifyInstanceAttributeType
Children: value
ramdisk
API Version 2010-08-31479
Amazon Elastic Compute Cloud API ReferenceModifyInstanceAttribute
RequiredDescriptionName
NoID of the item.
Type: xsd:string
Default: None
Ancestor: ramdisk
Children: None
value
NoMIME, Base64-encoded user data.
Type: AttributeValueType (p. 563)
Ancestor: ModifyInstanceAttributeType
Children: value
userData
NoID of the item.
Type: xsd:string
Default: None
Ancestor: userData
Children: None
value
NoSpecifies whether the instance can be terminated.Youmust modify this attribute before you can terminate any"locked" instances.
Type: AttributeBooleanValueType (p. 563)
Ancestor: ModifyInstanceAttributeType
Children: value
disableApiTermination
YesGeneric boolean value.
Type: xsd:boolean
Valid Values: true | false
Default: false
Ancestor: disableApiTermination
Children: None
value
NoIf an instance shutdown is initiated, this determineswhether the instance stops or terminates.
Type: AttributeValueType (p. 563)
Ancestor: ModifyInstanceAttributeType
Children: value
instanceInitiatedShutdownBehavior
NoValue of the item.
Type: xsd:string
Valid Values: stop | terminate
Default: stop
Ancestor: instanceInitiatedShutdownBehavior
Children: None
value
NoBlock device mapping set.
Type: InstanceBlockDeviceMappingType (p. 651)
Ancestor: ModifyInstanceAttributeType
Children: item
blockDeviceMapping
API Version 2010-08-31480
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
RequiredDescriptionName
NoThe item element.
Type: InstanceBlockDeviceMappingItemType (p. 649)
Ancestor: blockDeviceMapping
Children: deviceName, virtualName, ebs, andnoDevice
item
NoThe device name (e.g., /dev/sdh).
Type: xsd:string
Default: None
Ancestor: item
Children: None
deviceName
NoThe virtual device name.
Type: xsd:string
Default: None
Ancestor: item
Children: None
virtualName
YesSpecifies parameters used to automatically set up AmazonEBS volumes when the instance is launched.
Type: InstanceEbsBlockDeviceType (p. 652)
Ancestor: item
Children: volumeId, deleteOnTermination
ebs
YesThe ID of the Amazon EBS volume.
Type: xsd:string
Default: None
Ancestor: ebs
Children: None
volumeId
NoSpecifies whether the Amazon EBS volume is deleted oninstance termination.
Type: xsd:boolean
Default: true
Ancestor: ebs
Children: None
deleteOnTermination
NoSpecifies the device name (e.g., /dev/sdb) to suppressduring instance launch.
Type: EmptyElementType (p. 644)
Ancestor: item
Children: none
noDevice
API Version 2010-08-31481
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
Response Elements
DescriptionName
ModifyInstanceAttributeResponseType element.
Type: ModifyInstanceAttributeResponseType (p. 663)
Ancestor: None
Children: requestId, return
ModifyInstanceAttributeResponseType
The ID of the request.
Type: xsd:string
Ancestor: ModifyInstanceAttributeResponseType
Children: None
requestId
Returns true if successful. Otherwise, returns an error.
Type: xsd:boolean
Ancestor: ModifyInstanceAttributeResponseType
Children: None
return
Examples
Example RequestThis example changed the kernel for the instance.
<ModifyInstanceAttribute xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <instanceId>i-10a64379</instanceId> <kernel> <value>aki-f70657b2</value> </kernel></ModifyInstanceAttribute>
Example Response<ModifyInstanceAttributeResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <return>true</return></ModifyInstanceAttributeResponse>
Related Operations• ResetInstanceAttribute (p. 514)
• DescribeInstanceAttribute (p. 362)
API Version 2010-08-31482
Amazon Elastic Compute Cloud API ReferenceResponse Elements
ModifySnapshotAttribute
DescriptionAdds or remove permission settings for the specified snapshot.
Request Parameters
RequiredDescriptionName
ModifySnapshotAttributeType element.
Type: ModifySnapshotAttributeType (p. 665)
Ancestor: None
Children: snapshotId, createVolumePermission
ModifySnapshotAttributeType
YesThe ID of the snapshot.
Type: xsd:string
Default: None
Ancestor: ModifySnapshotAttributeType
Children: None
snapshotId
Create volume permission element.
Type: CreateVolumePermissionOperationType (p. 585)
Ancestor: ModifySnapshotAttributeType
Children: add, remove
createVolumePermission
Add permission.
Type: CreateVolumePermissionListType (p. 585)
Ancestor: createVolumePermission
Children: item
add
Volume permission item.
Type: CreateVolumePermissionItemType (p. 584)
Ancestor: add
Children: userId, group
item
NoID of an AWS account that can create volumes from thesnapshot.
Type: xsd:string
Default: None
Ancestor: item
Children: None
userId
NoGroup that is allowed to create volumes from the snapshot(currently supports "all").
Type: xsd:string
Default: None
Ancestor: item
Children: None
group
API Version 2010-08-31483
Amazon Elastic Compute Cloud API ReferenceModifySnapshotAttribute
RequiredDescriptionName
Remove permission.
Type: CreateVolumePermissionListType (p. 585)
Ancestor: createVolumePermission
Children: item
remove
Volume permission item.
Type: CreateVolumePermissionItemType (p. 584)
Ancestor: remove
Children: userId, group
item
NoUser ID of a user that can create volumes from thesnapshot.
Type: xsd:string
Default: None
Ancestor: item
Children: None
userId
NoGroup that is allowed to create volumes from the snapshot(currently supports "all").
Type: xsd:string
Default: None
Ancestor: item
Children: None
group
Response Elements
DescriptionName
ModifySnapshotAttributeResponseType element.
Type: ModifySnapshotAttributeResponseType (p. 665)
Ancestor: None
Children: requestId, return
ModifySnapshotAttributeResponseType
The ID of the request.
Type: xsd:string
Ancestor: ModifySnapshotAttributeResponseType
Children: None
requestId
Returns true if successful. Otherwise, returns an error.
Type: xsd:boolean
Ancestor: ModifySnapshotAttributeResponseType
Children: None
return
API Version 2010-08-31484
Amazon Elastic Compute Cloud API ReferenceResponse Elements
Examples
Example RequestThis example makes the snap-78a54011 snapshot public.
<ModifySnapshotAttribute xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <snapshotId>snap-78a54011</snapshotId> <createVolumePermission> <add> <item> <group>all</group> </item> </add> </createVolumePermission></ModifySnapshotAttribute>
Example Response<ModifySnapshotAttributeResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <return>true</return></ModifySnapshotAttributeResponse>
Related Operations• DescribeSnapshotAttribute (p. 417)
• DescribeSnapshots (p. 420)
• ResetSnapshotAttribute (p. 516)
• CreateSnapshot (p. 299)
API Version 2010-08-31485
Amazon Elastic Compute Cloud API ReferenceExamples
MonitorInstances
DescriptionEnables monitoring for a running instance. For more information, refer to the Amazon CloudWatchDeveloper Guide.
Request Parameters
RequiredDescriptionName
MonitorInstancesType element.
Type: MonitorInstancesType (p. 669)
Ancestor: None
Children: instancesSet
MonitorInstancesType
Set of instances.
Type: MonitorInstancesSetType (p. 669)
Ancestor: MonitorInstancesType
Children: item
instancesSet
Instance set.
Type: MonitorInstancesSetItemType (p. 668)
Ancestor: instancesSet
Children: instanceId
item
YesInstance ID.
Type: xsd:string
Default: None
Ancestor: item
Children: None
instanceId
Response Elements
DescriptionName
MonitorInstancesResponseType element.
Type: MonitorInstancesResponseType (p. 668)
Ancestor: None
Children: requestId, instancesSet
MonitorInstancesResponseType
The ID of the request.
Type: xsd:string
Ancestor: MonitorInstancesResponseType
Children: None
requestId
API Version 2010-08-31486
Amazon Elastic Compute Cloud API ReferenceMonitorInstances
DescriptionName
Monitor instance response set.
Type: MonitorInstancesResponseSetType (p. 667)
Ancestor: MonitorInstancesResponseType
Children: item
instancesSet
Instance Item.
Type: MonitorInstancesResponseSetItemType (p. 666)
Ancestor: instancesSet
Children: instanceId, monitoring
item
Instance ID.
Type: xsd:string
Ancestor: item
Children: None
instanceId
Monitoring information.
Type: InstanceMonitoringStateType (p. 653)
Ancestor: item
Children: state
monitoring
State of monitoring for the instance.
Type: xsd:string
Valid Values: monitoring-enabled (enabled) |monitoring-pending (pending) | monitoring-disabling(disabling) | monitoring-disabled (disabled)
Ancestor: monitoring
Children: None
state
Examples
Example RequestThis example enables monitoring for i-43a4412a and i-23a3397d.
<MonitorInstances xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <instancesSet> <item> <instanceId>i-43a4412a</instanceId> </item> <item> <instanceId>i-23a3397d</instanceId> </item> </instancesSet></MonitorInstances>
Example Response<MonitorInstancesResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <instancesSet> <item>
API Version 2010-08-31487
Amazon Elastic Compute Cloud API ReferenceExamples
<instanceId>i-43a4412a</instanceId> <monitoring> <state>pending</state> </monitoring> </item> <item> <instanceId>i-23a3397d</instanceId> <monitoring> <state>pending</state> </monitoring> </item> </instancesSet></MonitorInstancesResponse>
Related Operations• UnmonitorInstances (p. 550)
• RunInstances (p. 522)
API Version 2010-08-31488
Amazon Elastic Compute Cloud API ReferenceRelated Operations
PurchaseReservedInstancesOffering
DescriptionPurchases a Reserved Instance for use with your account. With Amazon EC2 Reserved Instances, youpurchase the right to launch Amazon EC2 instances for a period of time (without getting insufficientcapacity errors) and pay a lower usage rate for the actual time used. For more information about ReservedInstances, go to the Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute CloudUser Guide.
Request Parameters
RequiredDescriptionName
PurchaseReservedInstancesOfferingType element.
Type: PurchaseReservedInstancesOfferingType (p. 677)
Ancestor: None
Children: reservedInstancesOfferingId,instanceCount
PurchaseReservedInstancesOfferingType
YesThe offering ID of the Reserved Instance to purchase.
Type: xsd:string
Default: None
Ancestor:PurchaseReservedInstancesOfferingType
Children: None
reservedInstancesOfferingId
NoThe number of Reserved Instances to purchase.
Type: xsd:int
Default: 1
Ancestor:PurchaseReservedInstancesOfferingType
Children: None
instanceCount
Response Elements
DescriptionName
PurchaseReservedInstancesOfferingResponseType element.
Type: PurchaseReservedInstancesOfferingResponseType (p. 676)
Ancestor: None
Children: requestId, reservedInstancesId
PurchaseReservedInstancesOfferingResponseType
The ID of the request.
Type: xsd:string
Ancestor:PurchaseReservedInstancesOfferingResponseType
Children: None
requestId
API Version 2010-08-31489
Amazon Elastic Compute Cloud API ReferencePurchaseReservedInstancesOffering
DescriptionName
The IDs of the purchased Reserved Instances.
Type: xsd:string
Ancestor:PurchaseReservedInstancesOfferingResponseType
Children: None
reservedInstancesId
Examples
Example RequestThis example purchases Reserved Instances.
<PurchaseReservedInstancesOffering xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <reservedInstancesOfferingId>4b2293b4-5813-4cc8-9ce3-1957fc1dcfc8</reserved InstancesOfferingId> <instanceCount>19</instanceCount> </PurchaseReservedInstancesOffering>
Example Response<PurchaseReservedInstancesOfferingResponse xmlns="http://ec2.amazon aws.com/doc/2010-08-31/"> <reservedInstancesId>reservation-1001001</reservedInstancesId> </PurchaseReservedInstancesOfferingResponse>
Related Operations• DescribeReservedInstancesOfferings (p. 404)
• DescribeReservedInstances (p. 397)
API Version 2010-08-31490
Amazon Elastic Compute Cloud API ReferenceExamples
RebootInstances
DescriptionRequests a reboot of one or more instances. This operation is asynchronous; it only queues a requestto reboot the specified instance(s). The operation will succeed if the instances are valid and belong toyou. Requests to reboot terminated instances are ignored.
Note
If a Linux/UNIX instance does not cleanly shut down within four minutes, Amazon EC2 will performa hard reboot.
Request Parameters
RequiredDescriptionName
RebootInstancesType element.
Type: RebootInstancesType (p. 679)
Ancestor: None
Children: instancesSet
RebootInstancesType
Launch permission set.
Type: RebootInstancesInfoType (p. 677)
Ancestor: RebootInstancesType
Children: item
instancesSet
Information for an instance.
Type: RebootInstancesItemType (p. 678)
Ancestor: instancesSet
Children: instanceId
item
YesOne or more instance IDs.
Type: xsd:string
Default: None
Ancestor: item
Children: None
instanceId
Response Elements
DescriptionName
RebootInstancesResponseType element.
Type: RebootInstancesResponseType (p. 678)
Ancestor: None
Children: requestId, return
RebootInstancesResponseType
API Version 2010-08-31491
Amazon Elastic Compute Cloud API ReferenceRebootInstances
DescriptionName
The ID of the request.
Type: xsd:string
Ancestor: RebootInstancesResponseType
Children: None
requestId
Returns true if successful. Otherwise, returns an error.
Type: xsd:boolean
Ancestor: RebootInstancesResponseType
Children: None
return
Examples
Example RequestThis example reboots an instance.
<RebootInstances xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <instancesSet> <item> <instanceId>i-28a64341</instanceId> </item> </instancesSet></RebootInstances>
Example Response<RebootInstancesResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <return>true</return></RebootInstancesResponse>
Related Operations• RunInstances (p. 522)
API Version 2010-08-31492
Amazon Elastic Compute Cloud API ReferenceExamples
RegisterImage
DescriptionRegisters an AMI with Amazon EC2. Images must be registered before they can be launched. To launchinstances, use the RunInstances operation.
Each AMI is associated with an unique ID which is provided by the Amazon EC2 service through thisoperation. If needed, you can deregister an AMI at any time.
Note
For EBS-backed instances, the CreateImage request allows for an image to be created andregistered in a single request. However, you can use this to register a snapshot of an instancebacked by Amazon EBS.
Amazon EBS snapshots are not guaranteed to be bootable. For information on creating AMIsbacked by Amazon EBS, go to the Amazon Elastic Compute Cloud Developer Guide or AmazonElastic Compute Cloud User Guide.
Any modifications to an AMI backed by Amazon S3 invalidates this registration. If you makechanges to an image, deregister the previous image and register the new image.
Request Parameters
RequiredDescriptionName
YesRegisterImage element.
Type: RegisterImageType (p. 681)
Ancestor: None
Children: imageLocation, name, description,architecture, kernelId, ramdiskId,rootDeviceName, and blockDeviceMapping
RegisterImage
NoFull path to your AMI manifest in Amazon S3 storage.
Type: xsd:string
Default: None
Ancestor: RegisterImageType
Children: None
imageLocation
NoA name for your AMI
Type: xsd:string
Default: None
Constraints: 3-128 alphanumeric characters, parenthesis(()), commas (,), slashes (/), dashes (-), or underscores(_)
Ancestor: RegisterImageType
Children: None
name
API Version 2010-08-31493
Amazon Elastic Compute Cloud API ReferenceRegisterImage
RequiredDescriptionName
NoThe description of the AMI.
Type: xsd:string
Default: None
Constraints: Up to 255 characters.
Ancestor: RegisterImageType
Children: None
description
NoThe architecture of the image.
Type: xsd:string
Valid Values: i386 | x86_64
Default: None
Ancestor: RegisterImageType
Children: None
architecture
NoThe ID of the kernel to select.
Type: xsd:string
Default: None
Ancestor: RegisterImageType
Children: None
kernelId
NoThe ID of the RAM disk to select. Some kernels requireadditional drivers at launch. Check the kernel requirementsfor information on whether you need to specify a RAMdisk. To find kernel requirements, refer to the ResourceCenter and search for the kernel ID.
Type: xsd:string
Default: None
Ancestor: RegisterImageType
Children: None
ramdiskId
NoThe root device name (e.g. /dev/sda1).
Type: xsd:string
Default: None
Ancestor: RegisterImageType
Children: None
rootDeviceName
NoSpecifies how block devices are exposed to the instance.Each mapping is made up of a virtualName and adeviceName.
Type: BlockDeviceMappingType (p. 568)
Ancestor: RegisterImageType
Children: item
blockDeviceMapping
NoInformation for one block device mapping.
Type: BlockDeviceMappingItemType (p. 567)
Ancestor: blockDeviceMapping
Children: deviceName, virtualName, ebs, andnoDevice
item
API Version 2010-08-31494
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
RequiredDescriptionName
NoThe device name (e.g. /dev/sdh).
Type: xsd:string
Default: None
Ancestor: item
Children: None
deviceName
NoThe virtual device name.
Type: xsd:string
Default: None
Ancestor: item
Children: None
virtualName
YesSpecifies parameters used to automatically set up AmazonEBS volumes when the instance is launched.
Type: EbsBlockDeviceType (p. 643)
Ancestor: item
Children: snapshotId, volumeSize, anddeleteOnTermination
ebs
NoThe ID of the snapshot.
Type: xsd:string
Default: None
Ancestor: ebs
Children: None
snapshotId
NoThe size of the volume, in GiBs. Required if you are notcreating a volume from a snapshot.
Type: xsd:int
Default: None
Ancestor: ebs
Children: None
volumeSize
NoSpecifies whether the Amazon EBS volume is deleted oninstance termination.
Type: xsd:boolean
Default: true
Ancestor: ebs
Children: None
deleteOnTermination
NoSpecifies the device name to suppress during instancelaunch.
Type: EmptyElementType (p. 644)
Ancestor: item
Children: none
noDevice
API Version 2010-08-31495
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
Response Elements
DescriptionName
RegisterImageResponseType element.
Type: RegisterImageResponseType (p. 680)
Ancestor: None
Children: requestId, imageId
RegisterImageResponseType
The ID of the request.
Type: xsd:string
Ancestor: RegisterImageResponseType
Children: None
requestId
Unique ID of the newly registered machine image.
Type: xsd:string
Ancestor: RegisterImageResponseType
Children: None
imageId
Examples
Example RequestThis example registers the AMI specified in the image.manifest.xml manifest file.
<RegisterImage> <imageLocation>mybucket/image.manifest.xml</imageLocation> <name>my_image</name> <rootDeviceName>/dev/sda1</rootDeviceName> <blockDeviceMapping/></RegisterImage>
Example Response<RegisterImageResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <requestId>c1b4f085-70ea-48d2-a417-9fbab67aca92</requestId> <imageId>ami-b5614bc1</imageId></RegisterImageResponse>
Example RequestThis example registers an Amazon EBS snapshot to create an AMI backed by Amazon EBS.
<RegisterImage xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <name>MyImage</name> <kernelId>aki-f70657b2</kernelId> <ramdiskId>ari-ff0d5cba</ramdiskId> <rootDeviceName>/dev/sda1</rootDeviceName> <blockDeviceMapping> <item> <deviceName>/dev/sda1</deviceName> <ebs>
API Version 2010-08-31496
Amazon Elastic Compute Cloud API ReferenceResponse Elements
<snapshotId>snap-6eba6e06</snapshotId> </ebs> </item> </blockDeviceMapping></RegisterImage>
Example Response<RegisterImageResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <requestId>c1b4f085-70ea-48d2-a417-9fbab67aca92</requestId> <imageId>ami-b5614bc1</imageId></RegisterImageResponse>
Example RequestThis example registers the AMI with an Amazon EBS snapshot as the root device, a separate snapshotas a secondary device, and an empty 100 GiB Amazon EBS volume as a storage device.
<RegisterImage xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <name>MyImage</name> <rootDeviceName>/dev/sda1</rootDeviceName> <blockDeviceMapping> <item> <deviceName>/dev/sda1</deviceName> <ebs> <snapshotId>snap-6eba6e06</snapshotId> </ebs> </item> <item> <deviceName>/dev/sdb</deviceName> <ebs> <snapshotId>snap-823ea6df</snapshotId> </ebs> </item> <item> <deviceName>/dev/sdc</deviceName> <ebs> <volumeSize>100</volumeSize> </ebs> </item> </blockDeviceMapping></RegisterImage>
Example Response<RegisterImageResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <requestId>c1b4f085-70ea-48d2-a417-9fbab67aca92</requestId> <imageId>ami-b5614bc1</imageId></RegisterImageResponse>
Related Operations• DescribeImages (p. 350)
• DeregisterImage (p. 327)
API Version 2010-08-31497
Amazon Elastic Compute Cloud API ReferenceRelated Operations
ReleaseAddress
DescriptionReleases an elastic IP address associated with your account.
If you run this operation on an elastic IP address that is already released, the address might be assignedto another account which will cause Amazon EC2 to return an error.
Note
Releasing an IP address automatically disassociates it from any instance with which it isassociated.To disassociate an IP address without releasing it, use the DisassociateAddressoperation.
Important
After releasing an elastic IP address, it is released to the IP address pool and might no longerbe available to your account. Make sure to update your DNS records and any servers or devicesthat communicate with the address.
Request Parameters
RequiredDescriptionName
ReleaseAddressType element.
Type: ReleaseAddressType (p. 682)
Ancestor: None
Children: publicIp
ReleaseAddressType
YesThe IP address that you are releasing from your account.
Type: xsd:string
Default: None
Ancestor: ReleaseAddressType
Children: None
publicIp
Response Elements
DescriptionName
ReleaseAddressResponseType element.
Type: ReleaseAddressResponseType (p. 682)
Ancestor: None
Children: requestId, return
ReleaseAddressResponseType
API Version 2010-08-31498
Amazon Elastic Compute Cloud API ReferenceReleaseAddress
DescriptionName
The ID of the request.
Type: xsd:string
Ancestor: ReleaseAddressResponseType
Children: None
requestId
Returns true if successful. Otherwise, returns an error.
Type: xsd:boolean
Ancestor: ReleaseAddressResponseType
Children: None
return
Examples
Example RequestThis example releases an elastic IP address associated with the account.
<ReleaseAddress xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <publicIp>67.202.55.255</publicIp></ReleaseAddress>
Example Response<ReleaseAddressResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <return>true</return></ReleaseAddressResponse>
Related Operations• AllocateAddress (p. 262)
• DescribeAddresses (p. 329)
• AssociateAddress (p. 264)
• DisassociateAddress (p. 465)
API Version 2010-08-31499
Amazon Elastic Compute Cloud API ReferenceExamples
RequestSpotInstances
DescriptionCreates a Spot Instance request. Spot Instances are instances that Amazon EC2 starts on your behalfwhen the maximum price that you specify exceeds the current Spot Price. Amazon EC2 periodically setsthe Spot Price based on available Spot Instance capacity and current spot instance requests. Forconceptual information about Spot Instances, refer to the Amazon Elastic Compute Cloud DeveloperGuide or Amazon Elastic Compute Cloud User Guide.
Request Parameters
RequiredDescriptionName
RequestSpotInstancesType element.
Type: RequestSpotInstancesType (p. 683)
Ancestor: None
Children: spotPrice, instanceCount, type,validFrom, validUntil, launchGroup,availabilityZoneGroup, and launchSpecification
RequestSpotInstancesType
YesSpecifies the maximum hourly price for any Spot Instancelaunched to fulfill the request.
Type: xsd:string
Default: None
Ancestor: RequestSpotInstancesType
Children: None
spotPrice
NoThe maximum number of Spot Instances to launch.
Type: xs:integer
Default: 1
Ancestor: RequestSpotInstancesType
Children: None
instanceCount
NoSpecifies the Spot Instance request type.
Type: xsd:string
Valid Values: one-time | persistent
Default: one-time
Ancestor: RequestSpotInstancesType
Children: None
type
API Version 2010-08-31500
Amazon Elastic Compute Cloud API ReferenceRequestSpotInstances
RequiredDescriptionName
NoStart date of the request. If this is a one-time request, therequest becomes active at this date and time and remainsactive until all instances launch, the request expires, orthe request is canceled. If the request is persistent, therequest becomes active at this date and time and remainsactive until it expires or is canceled.
Type: xsd:dateTime
Default: Request is effective independently
Ancestor: RequestSpotInstancesType
Children: None
validFrom
NoEnd date of the request. If this is a one-time request, therequest remains active until all instances launch, therequest is canceled, or this date is reached. If the requestis persistent, it remains active until it is canceled or thisdate and time is reached.
Type: xsd:dateTime
Default: Request is effective indefinitely
Ancestor: RequestSpotInstancesType
Children: None
validUntil
NoSpecifies the instance launch group. Launch groups areSpot Instances that launch together and terminate together.
Type: xsd:string
Default: Instances are launched and terminated individually
Ancestor: RequestSpotInstancesType
Children: None
launchGroup
NoSpecifies the Availability Zone group. If you specify thesame Availability Zone group for all Spot Instance requests,all Spot Instances are launched in the same AvailabilityZone.
Type: xsd:string
Default: Instances are launched in any available AvailabilityZone.
Ancestor: RequestSpotInstancesType
Children: None
availabilityZoneGroup
NoSpecifies additional launch instance information.
Type: LaunchSpecificationType (p. 661)
Ancestor: RequestSpotInstancesType
Children: imageId, keyName, groupSet, userData,addressingType, instanceType, placement,kernelId, ramdiskId, blockDeviceMapping,monitoring, and subnetId
launchSpecification
API Version 2010-08-31501
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
RequiredDescriptionName
YesThe AMI ID.
Type: xsd:string
Default: None
Ancestor: launchSpecification
Children: None
imageId
NoThe name of the key pair.
Type: xsd:string
Default: None
Ancestor: launchSpecification
Children: None
keyName
Group set.
Type: GroupSetType (p. 648)
Ancestor: launchSpecification
Children: item
groupSet
Group set item.
Type: GroupItemType (p. 648)
Ancestor: groupSet
Children: groupId
item
NoName of the security group.
Type: xsd:string
Default: None
Ancestor: item
Children: None
groupId
NoMIME, Base64-encoded user data.
Type: UserDataType (p. 708)
Ancestor: launchSpecification
Children: data
userData
NoMIME, Base64-encoded user data.
Type: xsd:string
Default: None
Ancestor: userData
Children: None
data
NoDeprecated.
Type: xsd:string
Default: None
Ancestor: launchSpecification
Children: None
addressingType
API Version 2010-08-31502
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
RequiredDescriptionName
NoSpecifies the instance type.
Type: xsd:string
Valid Values: m1.small | m1.large | m1.xlarge |c1.medium | c1.xlarge | m2.xlarge | m2.2xlarge |m2.4xlarge | t1.micro
Default: m1.small
Ancestor: launchSpecification
Children: None
instanceType
NoPlacement item.
Type: PlacementRequestType (p. 671)
Ancestor: launchSpecification
Children: availabilityZone
placement
NoSpecifies the placement constraints (Availability Zones)for launching the instances.
Type: xsd:string
Default: Amazon EC2 selects an Availability Zone.
Ancestor: placement
Children: None
availabilityZone
NoThe ID of the kernel to select.
Type: xsd:string
Default: None
Ancestor: launchSpecification
Children: None
kernelId
NoThe ID of the RAM disk to select. Some kernels requireadditional drivers at launch. Check the kernel requirementsfor information on whether you need to specify a RAM diskand search for the kernel ID.
Type: xsd:string
Default: None
Ancestor: launchSpecification
Children: None
ramdiskId
NoSpecifies how block devices are exposed to the instance.Each mapping is made up of a virtualName and adeviceName.
Type: BlockDeviceMappingType (p. 568)
Ancestor: launchSpecification
Children: item
blockDeviceMapping
Information for one block device mapping.
Type: BlockDeviceMappingItemType (p. 567)
Ancestor: blockDeviceMapping
Children: deviceName, virtualName, ebs, andnoDevice
item
API Version 2010-08-31503
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
RequiredDescriptionName
NoThe device name (e.g., /dev/sdh).
Type: xsd:string
Default: None
Ancestor: item
Children: None
deviceName
NoThe virtual device name.
Type: xsd:string
Default: None
Ancestor: item
Children: None
virtualName
YesSpecifies parameters used to automatically set up AmazonEBS volumes when the instance is launched.
Type: EbsBlockDeviceType (p. 643)
Ancestor: item
Children: snapshotId, volumeSize, anddeleteOnTermination
ebs
NoThe ID of the snapshot.
Type: xsd:string
Default: None
Ancestor: ebs
Children: None
snapshotId
NoThe size of the volume, in GiBs. Required if you are notcreating a volume from a snapshot.
Type: xsd:int
Default: None
Ancestor: ebs
Children: None
volumeSize
NoSpecifies whether the Amazon EBS volume is deleted oninstance termination.
Type: xsd:boolean
Default: true
Ancestor: ebs
Children: None
deleteOnTermination
NoSpecifies the device name to suppress during instancelaunch.
Type: EmptyElementType (p. 644)
Ancestor: item
Children: none
noDevice
API Version 2010-08-31504
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
RequiredDescriptionName
NoThis element contains no options.
Type: xsd:string
Default: None
Ancestor: noDevice
Children: None
none
NoSpecifies whether to enable monitoring for the instance.
Type: MonitoringInstanceType (p. 666)
Ancestor: launchSpecification
Children: enabled
monitoring
NoEnables monitoring for the instance.
Type: xsd:boolean
Default: Disabled
Ancestor: monitoring
Children: None
enabled
NoSpecifies the Amazon VPC subnet ID within which tolaunch the instance(s) for Amazon Virtual Private Cloud.
Type: xsd:string
Default: None
Ancestor: launchSpecification
Children: None
subnetId
Response Elements
DescriptionName
RequestSpotInstancesResponseType element.
Type: RequestSpotInstancesResponseType (p. 683)
Ancestor: None
Children: requestId, spotInstanceRequestSet
RequestSpotInstancesResponseType
The ID of the request.
Type: xsd:string
Ancestor: RequestSpotInstancesResponseType
Children: None
requestId
Spot Instance request set.
Type: SpotInstanceRequestSetType (p. 701)
Ancestor: RequestSpotInstancesResponseType
Children: item
spotInstanceRequestSet
API Version 2010-08-31505
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Spot Instance request set.
Type: SpotInstanceRequestSetItemType (p. 700)
Ancestor: spotInstanceRequestSet
Children: spotInstanceRequestId, spotPrice, type, state,fault, validFrom, validUntil, launchGroup,availabilityZoneGroup, launchSpecification, instanceId,createTime, and productDescription
item
Specifies the ID of the Spot Instance request.
Type: xsd:string
Ancestor: item
Children: None
spotInstanceRequestId
Specifies the maximum hourly price for any Spot Instance launchedto fulfill the request.
Type: xsd:string
Ancestor: item
Children: None
spotPrice
Specifies the Spot Instance request type.
Type: xsd:string
Valid Values: one-time | persistent
Ancestor: item
Children: None
type
The state of the Spot Instance request.
Type: xsd:string
Valid Values: active | open | closed | cancelled | failed
Ancestor: item
Children: None
state
Fault codes for the Spot Instance request, if any.
Type: SpotInstanceStateFaultType (p. 702)
Ancestor: item
Children: code, message
fault
Reason code for the Spot Instance state change.
Type: xsd:string
Ancestor: fault
Children: None
code
Message for the Spot Instance state change.
Type: xsd:string
Ancestor: fault
Children: None
message
API Version 2010-08-31506
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Start date of the request. If this is a one-time request, the requestbecomes active at this date and time and remains active until allinstances launch, the request expires, or the request is canceled. Ifthe request is persistent, the request becomes active at this date andtime and remains active until it expires or is canceled.
Type: xsd:dateTime
Ancestor: item
Children: None
validFrom
End date of the request. If this is a one-time request, the requestremains active until all instances launch, the request is canceled, orthis date is reached. If the request is persistent, it remains active untilit is canceled or this date and time is reached.
Type: xsd:dateTime
Ancestor: item
Children: None
validUntil
Specifies the instance launch group. Launch groups are SpotInstances that launch together and terminate together.
Type: xsd:string
Ancestor: item
Children: None
launchGroup
Specifies the Availability Zone group. If you specify the sameAvailability Zone group for all Spot Instance requests, all SpotInstances are launched in the same Availability Zone.
Type: xsd:string
Ancestor: item
Children: None
availabilityZoneGroup
Specifies additional launch instance information.
Type: LaunchSpecificationType (p. 661)
Ancestor: item
Children: imageId, keyName, groupSet, userData,addressingType, instanceType, placement, kernelId,ramdiskId, blockDeviceMapping, monitoring, and subnetId
launchSpecification
The AMI ID.
Type: xsd:string
Ancestor: launchSpecification
Children: None
imageId
The name of the key pair.
Type: xsd:string
Ancestor: launchSpecification
Children: None
keyName
API Version 2010-08-31507
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Group set.
Type: GroupSetType (p. 648)
Ancestor: launchSpecification
Children: item
groupSet
Group set item.
Type: GroupItemType (p. 648)
Ancestor: groupSet
Children: groupId
item
Name of the security group.
Type: xsd:string
Ancestor: item
Children: None
groupId
MIME, Base64-encoded user data.
Type: UserDataType (p. 708)
Ancestor: launchSpecification
Children: data
userData
MIME, Base64-encoded user data.
Type: xsd:string
Ancestor: userData
Children: None
data
Deprecated.
Type: xsd:string
Ancestor: launchSpecification
Children: None
addressingType
Specifies the instance type.
Type: xsd:string
Valid Values: m1.small | m1.large | m1.xlarge | c1.medium |c1.xlarge | m2.xlarge | m2.2xlarge | m2.4xlarge | t1.micro
Ancestor: launchSpecification
Children: None
instanceType
Placement item.
Type: PlacementRequestType (p. 671)
Ancestor: launchSpecification
Children: availabilityZone
placement
Specifies the placement constraints (Availability Zones) for launchingthe instances.
Type: xsd:string
Ancestor: placement
Children: None
availabilityZone
API Version 2010-08-31508
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
The ID of the kernel to select.
Type: xsd:string
Ancestor: launchSpecification
Children: None
kernelId
The ID of the RAM disk to select. Some kernels require additionaldrivers at launch. Check the kernel requirements for information onwhether you need to specify a RAM disk and search for the kernelID.
Type: xsd:string
Ancestor: launchSpecification
Children: None
ramdiskId
Specifies how block devices are exposed to the instance. Eachmapping is made up of a virtualName and a deviceName.
Type: BlockDeviceMappingType (p. 568)
Ancestor: launchSpecification
Children: item
blockDeviceMapping
Information for one block device mapping.
Type: BlockDeviceMappingItemType (p. 567)
Ancestor: blockDeviceMapping
Children: deviceName, virtualName, ebs, and noDevice
item
The device name (e.g., /dev/sdh).
Type: xsd:string
Ancestor: item
Children: None
deviceName
The virtual device name.
Type: xsd:string
Ancestor: item
Children: None
virtualName
Specifies parameters used to automatically set up Amazon EBSvolumes when the instance is launched.
Type: EbsBlockDeviceType (p. 643)
Ancestor: item
Children:snapshotId, volumeSize, and deleteOnTermination
ebs
The ID of the snapshot.
Type: xsd:string
Ancestor: ebs
Children: None
snapshotId
The size of the volume, in GiBs. Required if you are not creating avolume from a snapshot.
Type: xsd:int
Ancestor: ebs
Children: None
volumeSize
API Version 2010-08-31509
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Specifies whether the Amazon EBS volume is deleted on instancetermination.
Type: xsd:boolean
Ancestor: ebs
Children: None
deleteOnTermination
Specifies the device name to suppress during instance launch.
Type: EmptyElementType (p. 644)
Ancestor: item
Children: none
noDevice
This element contains no options.
Type: xsd:string
Ancestor: noDevice
Children: None
none
Specifies whether to enable monitoring for the instance.
Type: MonitoringInstanceType (p. 666)
Ancestor: launchSpecification
Children: enabled
monitoring
Enables monitoring for the instance.
Type: xsd:boolean
Ancestor: monitoring
Children: None
enabled
Specifies the Amazon VPC subnet ID within which to launch theinstance(s) for Amazon Virtual Private Cloud.
Type: xsd:string
Ancestor: launchSpecification
Children: None
subnetId
Specifies the instance ID.
Type: xsd:string
Ancestor: item
Children: None
instanceId
Time stamp when the Spot Instance request was fulfilled.
Type: xsd:dateTime
Ancestor: item
Children: None
createTime
The product description associated with the Spot Instance.
Type: xsd:dateTime
Ancestor: item
Children: None
productDescription
API Version 2010-08-31510
Amazon Elastic Compute Cloud API ReferenceResponse Elements
Examples
Example RequestThis example creates a Spot Instances request for ten m1.small instances.
<RequestSpotInstances xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <spotPrice>0.50</spotPrice> <instanceCount>10</instanceCount> <type>one-time</type> <availabilityZoneGroup>MyAzGroup</availabilityZoneGroup> <launchSpecification> <imageId> i-43a4412a</imageId> <keyName>MyKeypair</keyName> <groupSet>websrv</groupSet> <instanceType>m1.small</instanceType> </launchSpecification></RequestSpotInstances>
Example Response<RequestSpotInstancesResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/">
<spotInstanceRequestSet> <item> <spotInstanceRequestId>sir-f102a405</spotInstanceRequestId> <spotPrice>0.50</spotPrice> <type>one-time</type> <state>open</state> <fault/> <validFrom/> <validUntil/> <launchGroup/> <availabilityZoneGroup>MyAzGroup</availabilityZoneGroup> <launchSpecification> <imageId> i-43a4412a</imageId> <keyName>MyKeypair</keyName> <groupSet>websrv</groupSet> <instanceType>m1.small</instanceType> </launchSpecification> <instanceId>i-123345678</instanceId> <createTime>2009-10-19T00:00:00+0000</createTime> <productDescription/> </item> </spotInstanceRequestSet></RequestSpotInstancesResponse>
Related Operations• DescribeSpotInstanceRequests (p. 430)
• CancelSpotInstanceRequests (p. 284)
• DescribeSpotPriceHistory (p. 442)
API Version 2010-08-31511
Amazon Elastic Compute Cloud API ReferenceExamples
ResetImageAttribute
DescriptionResets an attribute of an AMI to its default value.
Note
The productCodes attribute cannot be reset.
Request Parameters
RequiredDescriptionName
ResetImageAttributeType element.
Type: ResetImageAttributeType (p. 687)
Ancestor: None
Children: imageId, ResetImageAttributesGroup
ResetImageAttributeType
YesID of the AMI on which the attribute will be reset.
Type: xsd:string
Default: None
Ancestor: ResetImageAttributeType
Children: None
imageId
The reset image attribute group.
Type: ResetImageAttributesGroup (p. 686)
Ancestor: ResetImageAttributeType
Children: launchPermission
ResetImageAttributesGroup
Resets the launch permission attribute.
Type: EmptyElementType (p. 644)
Ancestor: ResetImageAttributesGroup
Children: none
launchPermission
NoThis element contains no options.
Type: xsd:string
Default: None
Ancestor: launchPermission
Children: None
none
API Version 2010-08-31512
Amazon Elastic Compute Cloud API ReferenceResetImageAttribute
Response Elements
DescriptionName
ResetImageAttributeResponseType element.
Type: ResetImageAttributeResponseType (p. 686)
Ancestor: None
Children: requestId, return
ResetImageAttributeResponseType
The ID of the request.
Type: xsd:string
Ancestor: ResetImageAttributeResponseType
Children: None
requestId
Indicates whether the attribute successfully reset.
Type: xsd:boolean
Ancestor: ResetImageAttributeResponseType
Children: None
return
Examples
Example RequestThis example resets the launchPermission attribute.
<ResetImageAttribute xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <imageId>ami-6ba54002</imageId> <launchPermission/></ResetImageAttribute>
Example Response<ResetImageAttributeResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/">
<return>true</return></ResetImageAttributeResponse>
Related Operations• ModifyImageAttribute (p. 474)
• DescribeImageAttribute (p. 344)
API Version 2010-08-31513
Amazon Elastic Compute Cloud API ReferenceResponse Elements
ResetInstanceAttribute
DescriptionResets an attribute of an instance to its default value.
Request Parameters
RequiredDescriptionName
ResetInstanceAttributeType element.
Type: ResetInstanceAttributeType (p. 688)
Ancestor: None
Children: instanceId,ResetInstanceAttributesGroup
ResetInstanceAttributeType
YesID of the instance on which the attribute will be reset.
Type: xsd:string
Default: None
Ancestor: ResetInstanceAttributeType
Children: None
instanceId
Group of attributes to reset.
Type: ResetInstanceAttributesGroup (p. 688)
Ancestor: ResetInstanceAttributeType
Children: kernel, ramdisk
ResetInstanceAttributesGroup
NoThe kernel ID.
Type: EmptyElementType (p. 644)
Ancestor: ResetInstanceAttributesGroup
Children: none
kernel
NoThis element contains no options.
Type: xsd:string
Default: None
Ancestor: kernel
Children: None
none
NoThe RAM disk ID.
Type: EmptyElementType (p. 644)
Ancestor: ResetInstanceAttributesGroup
Children: none
ramdisk
NoThis element contains no options.
Type: xsd:string
Default: None
Ancestor: ramdisk
Children: None
none
API Version 2010-08-31514
Amazon Elastic Compute Cloud API ReferenceResetInstanceAttribute
Response Elements
DescriptionName
ResetInstanceAttributeResponseType element.
Type: ResetInstanceAttributeResponseType (p. 687)
Ancestor: None
Children: requestId, return
ResetInstanceAttributeResponseType
The ID of the request.
Type: xsd:string
Ancestor: ResetInstanceAttributeResponseType
Children: None
requestId
Indicates whether the attribute successfully reset.
Type: xsd:boolean
Ancestor: ResetInstanceAttributeResponseType
Children: None
return
Examples
Example RequestThis example resets the kernel attribute.
<ResetInstanceAttribute xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <instanceId>i-10a64379</instanceId> <kernel/></ResetInstanceAttribute>
Example Response<ResetInstanceAttributeResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <return>true</return></ResetInstanceAttributeResponse>
Related Operations• ModifyInstanceAttribute (p. 479)
• DescribeInstanceAttribute (p. 362)
API Version 2010-08-31515
Amazon Elastic Compute Cloud API ReferenceResponse Elements
ResetSnapshotAttribute
DescriptionResets permission settings for the specified snapshot.
Request Parameters
RequiredDescriptionName
ResetSnapshotAttributeType element.
Type: ResetSnapshotAttributeType (p. 690)
Ancestor: None
Children: snapshotId,ResetSnapshotAttributesGroup
ResetSnapshotAttributeType
NoThe ID of the snapshot.
Type: xsd:string
Default: None
Ancestor: ResetSnapshotAttributeType
Children: None
snapshotId
Snapshot group.
Type: ResetSnapshotAttributesGroup (p. 689)
Ancestor: ResetSnapshotAttributeType
Children: createVolumePermission
ResetSnapshotAttributesGroup
Create volume permission type.
Type: EmptyElementType (p. 644)
Ancestor: ResetSnapshotAttributesGroup
Children: none
createVolumePermission
NoThis element contains no options.
Type: xsd:string
Default: None
Ancestor: createVolumePermission
Children: None
none
Response Elements
DescriptionName
ResetSnapshotAttributeResponseType element.
Type: ResetSnapshotAttributeResponseType (p. 689)
Ancestor: None
Children: requestId, return
ResetSnapshotAttributeResponseType
API Version 2010-08-31516
Amazon Elastic Compute Cloud API ReferenceResetSnapshotAttribute
DescriptionName
The ID of the request.
Type: xsd:string
Ancestor: ResetSnapshotAttributeResponseType
Children: None
requestId
Specifies whether the snapshot permissions were reset.
Type: xsd:boolean
Ancestor: ResetSnapshotAttributeResponseType
Children: None
return
Examples
Example RequestThis example resets the permissions for snap-78a54011, making it a private snapshot that can only beused by the account that created it.
<ResetSnapshotAttribute xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <snapshotId>snap-78a54011</snapshotId> <createVolumePermission\></ResetSnapshotAttribute>
Example Response<ResetSnapshotAttributeResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <return>true</return></ResetSnapshotAttributeResponse>
Related Operations• ModifySnapshotAttribute (p. 483)
• DescribeSnapshotAttribute (p. 417)
• DescribeSnapshots (p. 420)
• CreateSnapshot (p. 299)
API Version 2010-08-31517
Amazon Elastic Compute Cloud API ReferenceExamples
RevokeSecurityGroupIngress
DescriptionRevokes permissions from a security group. The permissions used to revoke must be specified using thesame values used to grant the permissions.
The permission is comprised of the IP protocol (TCP, UDP or ICMP) and the CIDR range or source group.For TCP and UDP, you also specify the source and destination port ranges; for ICMP, you also specifythe ICMP types.You can use -1 as a wildcard for the ICMP type.
Permission changes are quickly propagated to instances within the security group. However, dependingon the number of instances in the group, a small delay might occur.
Request Parameters
RequiredDescriptionName
RevokeSecurityGroupIngressType element.
Type: RevokeSecurityGroupIngressType (p. 691)
Ancestor: None
Children: userId, groupName, and ipPermissions
RevokeSecurityGroupIngressType
YesAWS account ID.
Type: xsd:string
Default: None
Ancestor: RevokeSecurityGroupIngressType
Children: None
userId
YesName of the group to modify.
Type: xsd:string
Default: None
Ancestor: RevokeSecurityGroupIngressType
Children: None
groupName
YesSet of permissions to add to the group.
Type: IpPermissionSetType (p. 657)
Ancestor: RevokeSecurityGroupIngressType
Children: item
ipPermissions
YesSet of IP permissions.
Type: IpPermissionType (p. 657)
Ancestor: ipPermissions
Children:ipProtocol, fromPort, toPort, groups, andipRanges
item
API Version 2010-08-31518
Amazon Elastic Compute Cloud API ReferenceRevokeSecurityGroupIngress
RequiredDescriptionName
YesIP protocol.
Type: xsd:string
Valid Values: tcp | udp | icmp
Default: None
Ancestor: item
Children: None
ipProtocol
YesStart of port range for the TCP and UDP protocols, or anICMP type number. An ICMP type number of -1 indicatesa wildcard (i.e., any ICMP type number).
Type: xsd:int
Default: None
Ancestor: item
Children: None
fromPort
YesEnd of port range for the TCP and UDP protocols, or anICMP code. An ICMP code of -1 indicates a wildcard (i.e.,any ICMP code).
Type: xsd:int
Default: None
Ancestor: item
Children: None
toPort
YesList of security group and user ID pairs.
Type: UserIdGroupPairSetType (p. 708)
Ancestor: item
Children: item
groups
YesInformation for one security group.
Type: UserIdGroupPairType (p. 709)
Ancestor: groups
Children: userId, groupName
item
YesAWS User ID of an account. Cannot be used whenspecifying a CIDR IP address.
Type: xsd:string
Default: None
Ancestor: item
Children: None
userId
YesName of the security group. Cannot be used whenspecifying a CIDR IP address.
Type: xsd:string
Default: None
Ancestor: item
Children: None
groupName
API Version 2010-08-31519
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
RequiredDescriptionName
YesIP ranges.
Type: IpRangeSetType (p. 659)
Ancestor: item
Children: item
ipRanges
YesInformation for one IP range.
Type: IpRangeItemType (p. 658)
Ancestor: ipRanges
Children: cidrIp
item
YesCIDR range.
Type: xsd:string
Default: None
Constraints: Valid CIDR IP address range.
Ancestor: item
Children: None
cidrIp
Response Elements
DescriptionName
RevokeSecurityGroupIngressResponseType element.
Type: RevokeSecurityGroupIngressResponseType (p. 690)
Ancestor: None
Children: requestId, return
RevokeSecurityGroupIngressResponseType
The ID of the request.
Type: xsd:string
Ancestor: RevokeSecurityGroupIngressResponseType
Children: None
requestId
Returns true if the request is successful. Otherwise, returns an error.
Type: xsd:boolean
Ancestor: RevokeSecurityGroupIngressResponseType
Children: None
return
Examples
Example RequestThis example revokes TCP port 80 access from the 205.192.0.0/16 address range for the websrv securitygroup.
<RevokeSecurityGroupIngress xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <userId/> <groupName>websrv</groupName> <ipPermissions>
API Version 2010-08-31520
Amazon Elastic Compute Cloud API ReferenceResponse Elements
<item> <ipProtocol>tcp</ipProtocol> <fromPort>80</fromPort> <toPort>80</toPort> <groups/> <ipRanges> <item> <cidrIp>205.192.0.0/16</cidrIp> </item> <ipRanges> </item> </ipPermissions></RevokeSecurityGroupIngress>
Example Response<RevokeSecurityGroupIngressResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <return>true</return></RevokeSecurityGroupIngressResponse>
Related Operations• CreateSecurityGroup (p. 297)
• DescribeSecurityGroups (p. 410)
• AuthorizeSecurityGroupIngress (p. 269)
• DeleteSecurityGroup (p. 315)
API Version 2010-08-31521
Amazon Elastic Compute Cloud API ReferenceRelated Operations
RunInstances
DescriptionLaunches a specified number of instances of an AMI for which you have permissions.
If Amazon EC2 cannot launch the minimum number AMIs you request, no instances will be launched. Ifthere is insufficient capacity to launch the maximum number of AMIs you request, Amazon EC2 launchesthe minimum number specified for each AMI and allocates the remaining available instances using roundrobin.
Note
Every instance is launched in a security group (created using the CreateSecurityGroupoperation). If no security group is specified in the RunInstances request, the "default" securitygroup will be used.
For Linux instances, you can provide an optional key pair ID in the launch request (created using theCreateKeyPair operation). The instances will have access to the public key at boot.You can use thiskey to provide secure access to an instance of an image on a per-instance basis. Amazon EC2 publicimages use this feature to provide secure access without passwords.
Important
Launching public images without a key pair ID will leave them inaccessible.
The public key material is made available to the instance at boot time by placing it in the openssh_id.pubfile on a logical device that is exposed to the instance as /dev/sda2 (the instance store). The format ofthis file is suitable for use as an entry within ~/.ssh/authorized_keys (the OpenSSH format). Thiscan be done at boot (e.g., as part of rc.local) allowing for secure access without passwords.
Optional user data can be provided in the launch request. All instances that collectively comprise thelaunch request have access to this data. For more information, go to the Amazon Elastic Compute CloudDeveloper Guide or Amazon Elastic Compute Cloud User Guide.
Note
If any of the AMIs have a AWS DevPay product code attached for which the user has notsubscribed, the RunInstances call will fail.
API Version 2010-08-31522
Amazon Elastic Compute Cloud API ReferenceRunInstances
Request Parameters
RequiredDescriptionName
RunInstancesType element.
Type: RunInstancesType (p. 692)
Ancestor: None
Children: imageId, minCount, maxCount, keyName,groupSet, additionalInfo, userData,addressingType, instanceType, placement,kernelId, ramdiskId, blockDeviceMapping,monitoring, subnetId, disableApiTermination,instanceInitiatedShutdownBehavior,privateIpAddress
RunInstancesType
YesUnique ID of a machine image, returned by a call toDescribeImages.
Type: xsd:string
Default: None
Ancestor: RunInstancesType
Children: None
imageId
YesMinimum number of instances to launch. If the value ismore than Amazon EC2 can launch, no instances arelaunched at all.
Type: xsd:int
Default: None
Constraints: Between 1 and the maximum number allowedfor your account (default: 20).
Ancestor: RunInstancesType
Children: None
minCount
YesMaximum number of instances to launch. If the value ismore than Amazon EC2 can launch, the largest possiblenumber above minCount will be launched instead.
Type: xsd:int
Default: None
Constraints: Between 1 and the maximum number allowedfor your account (default: 20).
Ancestor: RunInstancesType
Children: None
maxCount
NoThe name of the key pair.
Type: xsd:string
Default: None
Ancestor: RunInstancesType
Children: None
keyName
API Version 2010-08-31523
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
RequiredDescriptionName
Group set.
Type: GroupSetType (p. 648)
Ancestor: RunInstancesType
Children: item
groupSet
Group set item.
Type: GroupItemType (p. 648)
Ancestor: groupSet
Children: groupId
item
NoName of the security group.
Type: xsd:string
Default: None
Ancestor: item
Children: None
groupId
NoSpecifies additional information to make available to theinstance(s).
Type: xsd:string
Default: None
Ancestor: RunInstancesType
Children: None
additionalInfo
MIME, Base64-encoded user data.
Type: UserDataType (p. 708)
Ancestor: RunInstancesType
Children: data
userData
NoMIME, Base64-encoded user data.
Type: xsd:string
Default: None
Ancestor: userData
Children: None
data
NoDeprecated.
Type: xsd:string
Default: None
Ancestor: RunInstancesType
Children: None
addressingType
NoSpecifies the instance type.
Type: xsd:string
Valid Values: m1.small | m1.large | m1.xlarge |c1.medium | c1.xlarge | m2.xlarge | m2.2xlarge |m2.4xlarge | cc1.4xlarge | t1.micro
Default: m1.small
Ancestor: RunInstancesType
Children: None
instanceType
API Version 2010-08-31524
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
RequiredDescriptionName
NoPlacement item.
Type: PlacementRequestType (p. 671)
Ancestor: RunInstancesType
Children: availabilityZone, groupName
placement
NoSpecifies the placement constraints (Availability Zones)for launching the instances.
Type: xsd:string
Default: Amazon EC2 selects an Availability Zone.
Ancestor: placement
Children: None
availabilityZone
YesSpecifies the name of an existing placement group youwant to launch the instance into (for cluster computeinstances).
Type: xsd:string
Default: None
Ancestor: placement
Children: None
groupName
NoThe ID of the kernel with which to launch the instance.
Type: xsd:string
Default: None
Ancestor: RunInstancesType
Children: None
kernelId
NoThe ID of the RAM disk to select. Some kernels requireadditional drivers at launch. Check the kernel requirementsfor information on whether you need to specify a RAMdisk. To find kernel requirements, refer to the ResourceCenter and search for the kernel ID.
Type: xsd:string
Default: None
Ancestor: RunInstancesType
Children: None
ramdiskId
NoSpecifies how block devices are exposed to the instance.Each mapping is made up of a virtualName and adeviceName.
Type: BlockDeviceMappingType (p. 568)
Ancestor: RunInstancesType
Children: item
blockDeviceMapping
Information for one block device mapping.
Type: BlockDeviceMappingItemType (p. 567)
Ancestor: blockDeviceMapping
Children: deviceName, virtualName, ebs, andnoDevice
item
API Version 2010-08-31525
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
RequiredDescriptionName
NoThe device name (e.g., /dev/sdh).
Type: xsd:string
Default: None
Ancestor: item
Children: None
deviceName
NoThe virtual device name.
Type: xsd:string
Default: None
Ancestor: item
Children: None
virtualName
YesSpecifies parameters used to automatically set up AmazonEBS volumes when the instance is launched.
Type: EbsBlockDeviceType (p. 643)
Ancestor: item
Children: snapshotId, volumeSize, anddeleteOnTermination
ebs
NoThe ID of the snapshot.
Type: xsd:string
Default: None
Ancestor: ebs
Children: None
snapshotId
NoThe size of the volume, in GiBs. Required if you are notcreating a volume from a snapshot.
Type: xsd:int
Default: None
Ancestor: ebs
Children: None
volumeSize
NoSpecifies whether the Amazon EBS volume is deleted oninstance termination.
Type: xsd:boolean
Default: true
Ancestor: ebs
Children: None
deleteOnTermination
NoSpecifies the device name to suppress during instancelaunch.
Type: EmptyElementType (p. 644)
Ancestor: item
Children: none
noDevice
NoSpecifies whether to enable monitoring for the instance.
Type: MonitoringInstanceType (p. 666)
Ancestor: RunInstancesType
Children: enabled
monitoring
API Version 2010-08-31526
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
RequiredDescriptionName
NoEnables monitoring for the instance.
Type: xsd:boolean
Default: Disabled
Ancestor: monitoring
Children: None
enabled
NoIf you're using Amazon Virtual Private Cloud, this specifiesthe ID of the subnet you want to launch the instance into.
Type: xsd:string
Default: None
Ancestor: RunInstancesType
Children: None
subnetId
NoSpecifies whether the instance can be terminated usingthe APIs.You must modify this attribute using theec2-modify-instance command before you can terminateany "locked" instances via the APIs.
Type: xsd:boolean
Default: true
Ancestor: RunInstancesType
Children: None
disableApiTermination
NoDetermines whether the instance stops or terminates oninstance-initiated shutdown.
Type: xsd:string
Valid Values: stop | terminate
Default: stop
Ancestor: RunInstancesType
Children: None
instanceInitiatedShutdownBehavior
NoIf you're using Amazon Virtual Private Cloud, you canoptionally use this parameter to assign the instance aspecific available IP address from the subnet (e.g.,10.0.0.25).
Type: xsd:string
Default: Amazon VPC selects an IP address from thesubnet for the instance
Ancestor: RunInstancesType
Children: None
privateIpAddress
NoUnique, case-sensitive identifier you provide to ensureidempotency of the request. For more information, go toHow to Ensure Idempotency in the Amazon ElasticCompute Cloud Developer Guide.
Type: xsd:String
Default: None
Constraints: Maximum 64 ASCII characters
Ancestor: RunInstancesType
Children: None
clientToken
API Version 2010-08-31527
Amazon Elastic Compute Cloud API ReferenceRequest Parameters
Response Elements
DescriptionName
RunInstancesResponse element.
Type: RunInstancesResponseType (p. 692)
Ancestor: None
Children: requestId, reservationId, ownerId, groupSet,instancesSet, and requesterId
RunInstancesResponse
The ID of the request.
Type: xsd:string
Ancestor: RunInstancesResponseType
Children: None
requestId
Unique ID of the reservation.
Type: xsd:string
Ancestor: RunInstancesResponseType
Children: None
reservationId
ID of the AWS account that owns the reservation.
Type: xsd:string
Ancestor: RunInstancesResponseType
Children: None
ownerId
Security group set.
Type: GroupSetType (p. 648)
Ancestor: RunInstancesResponseType
Children: item
groupSet
Group set item.
Type: GroupItemType (p. 648)
Ancestor: groupSet
Children: groupId
item
Name of the security group.
Type: xsd:string
Ancestor: item
Children: None
groupId
Instance set.
Type: RunningInstancesSetType (p. 696)
Ancestor: item
Children: item
instancesSet
API Version 2010-08-31528
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Running instance set item.
Type: RunningInstancesItemType (p. 694)
Ancestor: instancesSet
Children: instanceId, imageId, instanceState,privateDnsName, dnsName, reason, keyName, amiLaunchIndex,productCodes, instanceType, launchTime, placement,kernelId, ramdiskId, platform, monitoring, subnetId,vpcId, privateIpAddress, ipAddress, stateReason,architecture, rootDeviceType, rootDeviceName,blockDeviceMapping, instanceLifecycle,spotInstanceRequestId, virtualizationType, clientToken,tagSet
item
Unique ID of the instance launched.
Type: xsd:string
Ancestor: item
Children: None
instanceId
Image ID of the AMI used to launch the instance.
Type: xsd:string
Ancestor: item
Children: None
imageId
The current state of the instance.
Type: InstanceStateType (p. 655)
Ancestor: item
Children: code, name
instanceState
A 16-bit unsigned integer. The high byte is an opaque internal valueand should be ignored. The low byte is set based on the staterepresented:
Type: xsd:int
Valid Values: 0 (pending) | 16 (running) | 32(shutting-down) | 48 (terminated) | 64 (stopping) | 80(stopped)
Ancestor: instanceState
Children: None
code
The current state of the instance.
Type: xsd:string
Valid Values: pending | running | shutting-down | terminated| stopping | stopped
Ancestor: instanceState
Children: None
name
API Version 2010-08-31529
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
The private DNS name assigned to the instance. This DNS namecan only be used inside the Amazon EC2 network. This elementremains empty until the instance enters a running state.
Type: xsd:string
Ancestor: item
Children: None
privateDnsName
The public DNS name assigned to the instance. This DNS name iscontactable from outside the Amazon EC2 network. This elementremains empty until the instance enters a running state.
Type: xsd:string
Ancestor: item
Children: None
dnsName
Reason for the most recent state transition. This might be an emptystring.
Type: xsd:string
Ancestor: item
Children: None
reason
If this instance was launched with an associated key pair, this displaysthe key pair name.
Type: xsd:string
Ancestor: item
Children: None
keyName
The AMI launch index, which can be used to find this instance withinthe launch group.
Type: xsd:string
Ancestor: item
Children: None
amiLaunchIndex
Amazon DevPay product codes attached to this instance.
Type: ProductCodesSetType (p. 674)
Ancestor: item
Children: item
productCodes
Information for one product code.
Type: ProductCodesSetItemType (p. 674)
Ancestor: productCodes
Children: productCode
item
The Amazon DevPay product code associated with the instance.
Type: xsd:string
Ancestor: item
Children: None
productCode
API Version 2010-08-31530
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
The instance type.
Type: xsd:string
Ancestor: item
Children: None
instanceType
The time the instance launched.
Type: xsd:dateTime
Ancestor: item
Children: None
launchTime
The location where the instance launched.
Type: PlacementResponseType (p. 672)
Ancestor: item
Children: availabilityZone
placement
Returns the Availability Zone of the instance.
Type: xsd:string
Ancestor: placement
Children: None
availabilityZone
The ID of the placement group the instance is in (for cluster computeinstances).
Type: xsd:string
Default: None
Ancestor: placement
Children: None
groupName
The name of the placement group the instance is in (for clustercompute instances).
Type: xsd:string
Default: None
Ancestor: placement
Children: None
groupName
Kernel associated with this instance.
Type: xsd:string
Ancestor: item
Children: None
kernelId
RAM disk associated with this instance.
Type: xsd:string
Ancestor: item
Children: None
ramdiskId
Platform of the instance (e.g. Windows).
Type: xsd:string
Ancestor: item
Children: None
platform
API Version 2010-08-31531
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Indicates whether monitoring is enabled for the instance.
Type: InstanceMonitoringStateType (p. 653)
Ancestor: item
Children: state
monitoring
State of monitoring for the instance.
Type: xsd:string
Valid Values: monitoring-enabled (enabled) |monitoring-pending (pending) | monitoring-disabling(disabling) | monitoring-disabled (disabled)
Ancestor: monitoring
Children: None
state
Specifies the Amazon VPC subnet ID in which the instance is running.
Type: xsd:string
Ancestor: item
Children: None
subnetId
Specifies the Amazon VPC in which the instance is running.
Type: xsd:string
Ancestor: item
Children: None
vpcId
Specifies the private IP address that is assigned to the instance.
Type: xsd:string
Ancestor: item
Children: None
privateIpAddress
Specifies the IP address of the instance.
Type: xsd:string
Ancestor: item
Children: None
ipAddress
The reason for the most recent state transition. SeeStateReasonType (p. 704) for a listing of supported state changecodes.
Type: StateReasonType (p. 704)
Ancestor: item
Children: code, message
stateReason
Reason code for the state change.
Type: xsd:string
Ancestor: stateReason
Children: None
code
Message for the state change.
Type: xsd:string
Ancestor: stateReason
Children: None
message
API Version 2010-08-31532
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
The architecture of the image.
Type: xsd:string
Valid Values: i386 | x86_64
Ancestor: item
Children: None
architecture
The root device type used by the AMI. The AMI can use an AmazonEBS or instance store root device.
Type: xsd:string
Valid Values: ebs | instance-store
Ancestor: item
Children: None
rootDeviceType
The root device name (e.g., /dev/sda1).
Type: xsd:string
Ancestor: item
Children: None
rootDeviceName
Block device mapping set.
Type: InstanceBlockDeviceMappingResponseType (p. 650)
Ancestor: item
Children: item
blockDeviceMapping
The item element.
Type: InstanceBlockDeviceMappingResponseItemType (p. 650)
Ancestor: blockDeviceMapping
Children: deviceName, ebs
item
Specifies how the device is exposed to the instance (e.g., /dev/sdh).
Type: xsd:string
Ancestor: item
Children: None
deviceName
Specifies parameters used to automatically setup Amazon EBSvolumes when the instance is launched.
Type: EbsInstanceBlockDeviceMappingResponseType (p. 644)
Ancestor: item
Children: volumeId, status, attachTime, anddeleteOnTermination
ebs
The ID of the Amazon EBS volume.
Type: xsd:string
Ancestor: ebs
Children: None
volumeId
API Version 2010-08-31533
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Attachment state.
Type: xsd:string
Valid Values: attaching | attached | detaching | detached
Ancestor: ebs
Children: None
status
Time stamp when the attachment initiated.
Type: xsd:dateTime
Ancestor: ebs
Children: None
attachTime
Specifies whether the Amazon EBS volume is deleted on instancetermination.
Type: xsd:boolean
Ancestor: ebs
Children: None
deleteOnTermination
Indicates the life cycle of the instance.
Type: xsd:string
Valid Values: spot | blank (no value)
Ancestor: item
Children: None
instanceLifecycle
The ID of the Spot Instance request.
Type: xsd:string
Ancestor: item
Children: None
spotInstanceRequestId
Specifies the instance's virtualization type.
Type: xsd:string
Valid Values: paravirtual | hvm
Ancestor: item
Children: None
virtualizationType
Idempotency token you provided when you launched the instance.
Type: xsd:string
Ancestor: item
Children: None
clientToken
Tags assigned to the resource.
Type: ResourceTagSetType
Ancestor: item
Children: item
tagSet
Information about one tag.
Type: ResourceTagSetItemType
Ancestor: tagSet
Children: key, value
item
API Version 2010-08-31534
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
Tag key.
Type: xsd:string
Ancestor: item
Children: None
key
Tag value.
Type: xsd:string
Ancestor: item
Children: None
value
ID of the requester that launched the instances on your behalf (e.g.,AWS Management Console, Auto Scaling).
Type: xsd:string
Ancestor: RunInstancesResponseType
Children: None
requesterId
Examples
Example RequestThis example launches three instances of the ami-60a54009 AMI.
<RunInstances xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <imageId>ami-60a54009</imageId> <minCount>1</minCount> <maxCount>3</maxCount> <keyName>example-key-name</keyName> <groupSet/> <placement> <availabilityZone>us-east-1b</availabilityZone> </placement> <kernelId>aki-ba3adfd3</kernelId> <ramdiskId>ari-badbad00</ramdiskId> <blockDeviceMapping> <item> <virtualName>ami</virtualName> <deviceName>sda1<deviceName> </item> <item> <virtualName>root</virtualName> <deviceName>/dev/sda1</deviceName> </item> <item> <virtualName>instancestore0</virtualName> <deviceName>sdb</deviceName> </item> <item> <virtualName>instance1</virtualName> <deviceName>sdc</deviceName> </item> </blockDeviceMapping> <userData version="1.0" encoding="base64"><data>"VGhpcyBpcyBiYXN
API Version 2010-08-31535
Amazon Elastic Compute Cloud API ReferenceExamples
lIDY0IQ==</data></userData> <addressingType>public</addressingType> <monitoring>enabled</monitoring></RunInstances>
Example Response<RunInstancesResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <reservationId>r-47a5402e</reservationId> <ownerId>999988887777</ownerId> <groupSet> <item> <groupId>default</groupId> </item> </groupSet> <instancesSet> <item> <instanceId>i-2ba64342</instanceId> <imageId>ami-60a54009</imageId> <instanceState> <code>0</code> <name>pending</name> </instanceState> <privateDnsName></privateDnsName> <dnsName></dnsName> <keyName>example-key-name</keyName> <amiLaunchIndex>0</amiLaunchIndex> <instanceType>m1.small</instanceType> <launchTime>2007-08-07T11:51:50.000Z</launchTime> <placement> <availabilityZone>us-east-1b</availabilityZone> </placement> <monitoring> <enabled>true</enabled> </monitoring> <virtualizationType>paravirtual</virtualizationType> </item> <item> <instanceId>i-2bc64242</instanceId> <imageId>ami-60a54009</imageId> <instanceState> <code>0</code> <name>pending</name> </instanceState> <privateDnsName></privateDnsName> <dnsName></dnsName> <keyName>example-key-name</keyName> <amiLaunchIndex>1</amiLaunchIndex> <instanceType>m1.small</instanceType> <launchTime>2007-08-07T11:51:50.000Z</launchTime> <placement> <availabilityZone>us-east-1b</availabilityZone> </placement> <monitoring> <enabled>true</enabled> </monitoring> <virtualizationType>paravirtual</virtualizationType> </item>
API Version 2010-08-31536
Amazon Elastic Compute Cloud API ReferenceExamples
<item> <instanceId>i-2be64332</instanceId> <imageId>ami-60a54009</imageId> <instanceState> <code>0</code> <name>pending</name> </instanceState> <privateDnsName></privateDnsName> <dnsName></dnsName> <keyName>example-key-name</keyName> <amiLaunchIndex>2</amiLaunchIndex> <instanceType>m1.small</instanceType> <launchTime>2007-08-07T11:51:50.000Z</launchTime> <placement> <availabilityZone>us-east-1b</availabilityZone> </placement> <monitoring> <enabled>true</enabled> </monitoring> <virtualizationType>paravirtual</virtualizationType> </item> </instancesSet></RunInstancesResponse>
Related Operations• DescribeInstances (p. 367)
• StopInstances (p. 542)
• StartInstances (p. 538)
• TerminateInstances (p. 546)
• AuthorizeSecurityGroupIngress (p. 269)
• RevokeSecurityGroupIngress (p. 518)
• DescribeSecurityGroups (p. 410)
• CreateSecurityGroup (p. 297)
• CreateKeyPair (p. 292)
API Version 2010-08-31537
Amazon Elastic Compute Cloud API ReferenceRelated Operations
StartInstances
DescriptionStarts an instance that uses an Amazon EBS volume as its root device.
Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started.Whenan instance is stopped, the compute resources are released and you are not billed for hourly instanceusage. However, your root partition Amazon EBS volume remains, continues to persist your data, andyou are charged for Amazon EBS volume usage.You can restart your instance at any time.
Note
Before stopping an instance, make sure it is in a state from which it can be restarted. Stoppingan instance does not preserve data stored in RAM.
Performing this operation on an instance that uses an instance store as its root device returnsan error.
Request Parameters
RequiredDescriptionName
StartInstancesType element.
Type: StartInstancesType (p. 704)
Ancestor: None
Children: instancesSet
StartInstancesType
Instances set.
Type: InstanceIdSetType (p. 652)
Ancestor: StartInstancesType
Children: item
instancesSet
The item element.
Type: InstanceIdType (p. 653)
Ancestor: instancesSet
Children: instanceId
item
YesThe instance ID.
Type: xsd:string
Default: None
Ancestor: item
Children: None
instanceId
API Version 2010-08-31538
Amazon Elastic Compute Cloud API ReferenceStartInstances
Response Elements
DescriptionName
StartInstancesResponseType element.
Type: StartInstancesResponseType (p. 703)
Ancestor: None
Children: requestId, instancesSet
StartInstancesResponseType
The ID of the request.
Type: xsd:string
Ancestor: StartInstancesResponseType
Children: None
requestId
Instances set.
Type: InstanceStateChangeSetType (p. 654)
Ancestor: StartInstancesResponseType
Children: item
instancesSet
The item element.
Type: InstanceStateChangeType (p. 654)
Ancestor: instancesSet
Children: instanceId, currentState, and previousState
item
The instance ID.
Type: xsd:string
Ancestor: item
Children: None
instanceId
The current state of the instance.
Type: InstanceStateType (p. 655)
Ancestor: item
Children: code, name
currentState
A 16-bit unsigned integer. The high byte is an opaque internal valueand should be ignored. The low byte is set based on the staterepresented:
Type: xsd:int
Valid Values: 0 (pending) | 16 (running) | 32(shutting-down) | 48 (terminated) | 64 (stopping) | 80(stopped)
Ancestor: currentState
Children: None
code
The current state of the instance.
Type: xsd:string
Valid Values: pending | running | shutting-down | terminated| stopping | stopped
Ancestor: currentState
Children: None
name
API Version 2010-08-31539
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
The previous state of the instance.
Type: InstanceStateType (p. 655)
Ancestor: item
Children: code, name
previousState
A 16-bit unsigned integer. The high byte is an opaque internal valueand should be ignored. The low byte is set based on the staterepresented:
Type: xsd:int
Valid Values: 0 (pending) | 16 (running) | 32(shutting-down) | 48 (terminated) | 64 (stopping) | 80(stopped)
Ancestor: previousState
Children: None
code
The current state of the instance.
Type: xsd:string
Valid Values: pending | running | shutting-down | terminated| stopping | stopped
Ancestor: previousState
Children: None
name
Examples
Example RequestThis example starts the i-10a64379 instance.
<StartInstances xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <instancesSet> <item> <instanceId>i-10a64379</instanceId> </item> </instancesSet></StartInstances>
Example Response<StartInstancesResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <instancesSet> <item> <instanceId>i-10a64379</instanceId> <currentState> <code>0</code> <name>pending</name> </currentState> <previousState> <code>80</code> <name>stopped</name> </previousState> </item>
API Version 2010-08-31540
Amazon Elastic Compute Cloud API ReferenceExamples
</instancesSet></StartInstancesResponse>
Related Operations• StopInstances (p. 542)
• RunInstances (p. 522)
• DescribeInstances (p. 367)
• TerminateInstances (p. 546)
API Version 2010-08-31541
Amazon Elastic Compute Cloud API ReferenceRelated Operations
StopInstances
DescriptionStops an instance that uses an Amazon EBS volume as its root device.
Important
Although Spot Instances can use Amazon EBS-backed AMIs, they don't support Stop/Start. Inother words, you can't stop and start Spot Instances launched from an AMI with an Amazon EBSroot device.
Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started.Whenan instance is stopped, the compute resources are released and you are not billed for hourly instanceusage. However, your root partition Amazon EBS volume remains, continues to persist your data, andyou are charged for Amazon EBS volume usage.You can restart your instance at any time.
Note
Before stopping an instance, make sure it is in a state from which it can be restarted. Stoppingan instance does not preserve data stored in RAM.
Performing this operation on an instance that uses an instance store as its root device returnsan error.
Request Parameters
RequiredDescriptionName
StopInstancesType element.
Type: StopInstancesType (p. 706)
Ancestor: None
Children: instancesSet, force
StopInstancesType
Instances set.
Type: InstanceIdSetType (p. 652)
Ancestor: StopInstancesType
Children: item
instancesSet
The item element.
Type: InstanceIdType (p. 653)
Ancestor: instancesSet
Children: instanceId
item
YesThe instance ID.
Type: xsd:string
Default: None
Ancestor: item
Children: None
instanceId
API Version 2010-08-31542
Amazon Elastic Compute Cloud API ReferenceStopInstances
RequiredDescriptionName
NoForces the instance to stop. The instance will not have anopportunity to flush file system caches nor file system metadata. If you use this option, you must perform file systemcheck and repair procedures. This option is notrecommended for Windows instances.
Type: xsd:boolean
Default: None
Ancestor: StopInstancesType
Children: None
force
Response Elements
DescriptionName
StopInstancesResponseType element.
Type: StopInstancesResponseType (p. 706)
Ancestor: None
Children: requestId, instancesSet
StopInstancesResponseType
The ID of the request.
Type: xsd:string
Ancestor: StopInstancesResponseType
Children: None
requestId
Instances set.
Type: InstanceStateChangeSetType (p. 654)
Ancestor: StopInstancesResponseType
Children: item
instancesSet
The item element.
Type: InstanceStateChangeType (p. 654)
Ancestor: instancesSet
Children: instanceId, currentState, and previousState
item
The instance ID.
Type: xsd:string
Ancestor: item
Children: None
instanceId
The current state of the instance.
Type: InstanceStateType (p. 655)
Ancestor: item
Children: code, name
currentState
API Version 2010-08-31543
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
A 16-bit unsigned integer. The high byte is an opaque internal valueand should be ignored. The low byte is set based on the staterepresented:
Type: xsd:int
Valid Values: 0 (pending) | 16 (running) | 32(shutting-down) | 48 (terminated) | 64 (stopping) | 80(stopped)
Ancestor: currentState
Children: None
code
The current state of the instance.
Type: xsd:string
Valid Values: pending | running | shutting-down | terminated| stopping | stopped
Ancestor: currentState
Children: None
name
The previous state of the instance.
Type: InstanceStateType (p. 655)
Ancestor: item
Children: code, name
previousState
A 16-bit unsigned integer. The high byte is an opaque internal valueand should be ignored. The low byte is set based on the staterepresented:
Type: xsd:int
Valid Values: 0 (pending) | 16 (running) | 32(shutting-down) | 48 (terminated) | 64 (stopping) | 80(stopped)
Ancestor: previousState
Children: None
code
The current state of the instance.
Type: xsd:string
Valid Values: pending | running | shutting-down | terminated| stopping | stopped
Ancestor: previousState
Children: None
name
Examples
Example RequestThis example stops the i-10a64379 instance.
<StopInstances xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <instancesSet> <item> <instanceId>i-10a64379</instanceId>
API Version 2010-08-31544
Amazon Elastic Compute Cloud API ReferenceExamples
</item> </instancesSet></StopInstances>
Example Response<StopInstancesResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <instancesSet> <item> <instanceId>i-10a64379</instanceId> <currentState> <code>64</code> <name>stopping</name> </currentState> <previousState> <code>16</code> <name>running</name> </previousState> </instancesSet></StopInstancesResponse>
Related Operations• StartInstances (p. 538)
• RunInstances (p. 522)
• DescribeInstances (p. 367)
• TerminateInstances (p. 546)
API Version 2010-08-31545
Amazon Elastic Compute Cloud API ReferenceRelated Operations
TerminateInstances
DescriptionShuts down one or more instances. This operation is idempotent; if you terminate an instance more thanonce, each call will succeed.
Terminated instances will remain visible after termination (approximately one hour).
Note
By default, Amazon EC2 deletes all Amazon EBS volumes that were attached when the instancelaunched. Amazon EBS volumes attached after instance launch continue running.
Request Parameters
RequiredDescriptionName
TerminateInstancesType element.
Type: TerminateInstancesType (p. 707)
Ancestor: None
Children: instancesSet
TerminateInstancesType
YesSet of instances.
Type: InstanceIdSetType (p. 652)
Ancestor: TerminateInstancesType
Children: item
instancesSet
The item element.
Type: InstanceIdType (p. 653)
Ancestor: instancesSet
Children: instanceId
item
YesThe instance ID.
Type: xsd:string
Default: None
Ancestor: item
Children: None
instanceId
Response Elements
DescriptionName
TerminateInstancesResponseType element.
Type: TerminateInstancesResponseType (p. 707)
Ancestor: None
Children: requestId, instancesSet
TerminateInstancesResponseType
API Version 2010-08-31546
Amazon Elastic Compute Cloud API ReferenceTerminateInstances
DescriptionName
The ID of the request.
Type: xsd:string
Ancestor: TerminateInstancesResponseType
Children: None
requestId
Instances set.
Type: InstanceStateChangeSetType (p. 654)
Ancestor: TerminateInstancesResponseType
Children: item
instancesSet
The item element.
Type: InstanceStateChangeType (p. 654)
Ancestor: instancesSet
Children: instanceId, currentState, and previousState
item
The instance ID.
Type: xsd:string
Ancestor: item
Children: None
instanceId
The current state of the instance.
Type: InstanceStateType (p. 655)
Ancestor: item
Children: code, name
currentState
A 16-bit unsigned integer. The high byte is an opaque internal valueand should be ignored. The low byte is set based on the staterepresented:
Type: xsd:int
Valid Values: 0 (pending) | 16 (running) | 32(shutting-down) | 48 (terminated) | 64 (stopping) | 80(stopped)
Ancestor: currentState
Children: None
code
The current state of the instance.
Type: xsd:string
Valid Values: pending | running | shutting-down | terminated| stopping | stopped
Ancestor: currentState
Children: None
name
The previous state of the instance.
Type: InstanceStateType (p. 655)
Ancestor: item
Children: code, name
previousState
API Version 2010-08-31547
Amazon Elastic Compute Cloud API ReferenceResponse Elements
DescriptionName
A 16-bit unsigned integer. The high byte is an opaque internal valueand should be ignored. The low byte is set based on the staterepresented:
Type: xsd:int
Valid Values: 0 (pending) | 16 (running) | 32(shutting-down) | 48 (terminated) | 64 (stopping) | 80(stopped)
Ancestor: previousState
Children: None
code
The current state of the instance.
Type: xsd:string
Valid Values: pending | running | shutting-down | terminated| stopping | stopped
Ancestor: previousState
Children: None
name
Examples
Example RequestThis example terminates the i-3ea74257 instance.
<TerminateInstances xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <instancesSet> <item> <instanceId>i-3ea74257</instanceId> </item> </instancesSet></TerminateInstances>
Example Response<TerminateInstancesResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <instancesSet> <item> <instanceId>i-3ea74257</instanceId> <currentState> <code>32</code> <name>shutting-down</name> </currentState> <previousState> <code>16</code> <name>running</name> </previousState> </item> </instancesSet></TerminateInstancesResponse>
API Version 2010-08-31548
Amazon Elastic Compute Cloud API ReferenceExamples
Related Operations• DescribeInstances (p. 367)
• RunInstances (p. 522)
API Version 2010-08-31549
Amazon Elastic Compute Cloud API ReferenceRelated Operations
UnmonitorInstances
DescriptionDisables monitoring for a running instance. For more information, refer to the Amazon CloudWatchDeveloper Guide.
Request Parameters
RequiredDescriptionName
MonitorInstancesType element.
Type: MonitorInstancesType (p. 669)
Ancestor: None
Children: instancesSet
MonitorInstancesType
Set of instances.
Type: MonitorInstancesSetType (p. 669)
Ancestor: MonitorInstancesType
Children: item
instancesSet
Instance set.
Type: MonitorInstancesSetItemType (p. 668)
Ancestor: instancesSet
Children: instanceId
item
YesInstance ID.
Type: xsd:string
Default: None
Ancestor: item
Children: None
instanceId
Response Elements
DescriptionName
MonitorInstancesResponseType element.
Type: MonitorInstancesResponseType (p. 668)
Ancestor: None
Children: requestId, instancesSet
MonitorInstancesResponseType
The ID of the request.
Type: xsd:string
Ancestor: MonitorInstancesResponseType
Children: None
requestId
API Version 2010-08-31550
Amazon Elastic Compute Cloud API ReferenceUnmonitorInstances
DescriptionName
Monitor instance response set.
Type: MonitorInstancesResponseSetType (p. 667)
Ancestor: MonitorInstancesResponseType
Children: item
instancesSet
Instance Item.
Type: MonitorInstancesResponseSetItemType (p. 666)
Ancestor: instancesSet
Children: instanceId, monitoring
item
Instance ID.
Type: xsd:string
Ancestor: item
Children: None
instanceId
Monitoring information.
Type: InstanceMonitoringStateType (p. 653)
Ancestor: item
Children: state
monitoring
State of monitoring for the instance.
Type: xsd:string
Valid Values: monitoring-enabled (enabled) |monitoring-pending (pending) | monitoring-disabling(disabling) | monitoring-disabled (disabled)
Ancestor: monitoring
Children: None
state
Examples
Example RequestThis example disables monitoring for i-43a4412a and i-23a3397d.
<UnmonitorInstances xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <instancesSet> <instanceId>i-43a4412a</instanceId> <instanceId>i-23a3397d</instanceId> </instancesSet></UnmonitorInstances>
Example Response<UnmonitorInstancesResponse xmlns="http://ec2.amazonaws.com/doc/2010-08-31/"> <instancesSet> <item> <instanceId>i-43a4412a</instanceId> <monitoring> <state>pending</state> </monitoring>
API Version 2010-08-31551
Amazon Elastic Compute Cloud API ReferenceExamples
</item> <item> <instanceId>i-23a3397d</instanceId> <monitoring> <state>pending</state> </monitoring> </item> </instancesSet></UnmonitorInstancesResponse>
Related Operations• MonitorInstances (p. 486)
• RunInstances (p. 522)
API Version 2010-08-31552
Amazon Elastic Compute Cloud API ReferenceRelated Operations
Data Types
Topics
• AllocateAddressResponseType (p. 559)
• AssociateAddressResponseType (p. 559)
• AssociateAddressType (p. 560)
• AttachmentSetItemResponseType (p. 560)
• AttachmentSetResponseType (p. 561)
• AttachVolumeResponseType (p. 562)
• AttachVolumeType (p. 562)
• AttributeBooleanValueType (p. 563)
• AttributeValueType (p. 563)
• AuthorizeSecurityGroupIngressResponseType (p. 564)
• AuthorizeSecurityGroupIngressType (p. 565)
• AvailabilityZoneItemType (p. 565)
• AvailabilityZoneMessageSetType (p. 566)
• AvailabilityZoneMessageType (p. 566)
• AvailabilityZoneSetType (p. 567)
• BlockDeviceMappingItemType (p. 567)
• BlockDeviceMappingType (p. 568)
• BundleInstanceResponseType (p. 569)
• BundleInstanceS3StorageType (p. 569)
• BundleInstanceTaskErrorType (p. 570)
• BundleInstanceTasksSetType (p. 571)
• BundleInstanceTaskStorageType (p. 571)
• BundleInstanceTaskType (p. 572)
• BundleInstanceType (p. 573)
• CancelBundleTaskResponseType (p. 574)
• CancelBundleTaskType (p. 574)
• CancelSpotInstanceRequestsResponseSetItemType (p. 575)
• CancelSpotInstanceRequestsResponseSetType (p. 575)
• CancelSpotInstanceRequestsResponseType (p. 576)
• CancelSpotInstanceRequestsType (p. 576)
API Version 2010-08-31553
Amazon Elastic Compute Cloud API Reference
• ConfirmProductInstanceResponseType (p. 577)
• ConfirmProductInstanceType (p. 577)
• CreateImageResponseType (p. 578)
• CreateImageType (p. 578)
• CreateKeyPairResponseType (p. 579)
• CreateKeyPairType (p. 580)
• CreatePlacementGroupResponseType (p. 580)
• CreatePlacementGroupType (p. 580)
• CreateSecurityGroupResponseType (p. 580)
• CreateSecurityGroupType (p. 581)
• CreateSnapshotResponseType (p. 581)
• CreateSnapshotType (p. 582)
• CreateSpotDatafeedSubscriptionResponseType (p. 583)
• CreateSpotDatafeedSubscriptionType (p. 583)
• CreateVolumePermissionItemType (p. 584)
• CreateVolumePermissionListType (p. 585)
• CreateVolumePermissionOperationType (p. 585)
• CreateVolumeResponseType (p. 586)
• CreateVolumeType (p. 586)
• DeleteKeyPairResponseType (p. 587)
• DeleteKeyPairType (p. 588)
• DeletePlacementGroupResponseType (p. 588)
• DeletePlacementGroupType (p. 588)
• DeleteSecurityGroupResponseType (p. 588)
• DeleteSecurityGroupType (p. 589)
• DeleteSnapshotResponseType (p. 589)
• DeleteSnapshotType (p. 590)
• DeleteSpotDatafeedSubscriptionResponseType (p. 590)
• DeleteVolumeResponseType (p. 591)
• DeleteVolumeType (p. 591)
• DeregisterImageResponseType (p. 592)
• DeregisterImageType (p. 592)
• DescribeAddressesInfoType (p. 593)
• DescribeAddressesItemType (p. 593)
• DescribeAddressesResponseInfoType (p. 594)
• DescribeAddressesResponseItemType (p. 594)
• DescribeAddressesResponseType (p. 595)
• DescribeAddressesType (p. 595)
• DescribeAvailabilityZonesResponseType (p. 596)
• DescribeAvailabilityZonesSetItemType (p. 596)
• DescribeAvailabilityZonesSetType (p. 597)
• DescribeAvailabilityZonesType (p. 597)
• DescribeBundleTasksInfoType (p. 598)
• DescribeBundleTasksItemType (p. 598)
• DescribeBundleTasksResponseType (p. 599)
• DescribeBundleTasksType (p. 599)
API Version 2010-08-31554
Amazon Elastic Compute Cloud API Reference
• DescribeImageAttributeResponseType (p. 600)
• DescribeImageAttributesGroup (p. 601)
• DescribeImageAttributeType (p. 601)
• DescribeImagesExecutableBySetType (p. 602)
• DescribeImagesExecutableByType (p. 602)
• DescribeImagesInfoType (p. 603)
• DescribeImagesItemType (p. 603)
• DescribeImagesOwnersType (p. 604)
• DescribeImagesOwnerType (p. 604)
• DescribeImagesResponseInfoType (p. 605)
• DescribeImagesResponseItemType (p. 605)
• DescribeImagesResponseType (p. 607)
• DescribeImagesType (p. 608)
• DescribeInstanceAttributeResponseType (p. 608)
• DescribeInstanceAttributesGroup (p. 609)
• DescribeInstanceAttributeType (p. 610)
• DescribeInstancesInfoType (p. 611)
• DescribeInstancesItemType (p. 611)
• DescribeInstancesResponseType (p. 612)
• DescribeInstancesType (p. 612)
• DescribeKeyPairsInfoType (p. 613)
• DescribeKeyPairsItemType (p. 613)
• DescribeKeyPairsResponseInfoType (p. 614)
• DescribeKeyPairsResponseItemType (p. 614)
• DescribeKeyPairsResponseType (p. 615)
• DescribeKeyPairsType (p. 615)
• DescribePlacementGroupInfoType (p. 616)
• DescribePlacementGroupItemType (p. 616)
• DescribePlacementGroupsResponseType (p. 616)
• DescribePlacementGroupsType (p. 616)
• DescribeRegionsResponseType (p. 616)
• DescribeRegionsSetItemType (p. 617)
• DescribeRegionsSetType (p. 617)
• DescribeRegionsType (p. 618)
• DescribeReservedInstancesOfferingsResponseSetItemType (p. 618)
• DescribeReservedInstancesOfferingsResponseSetType (p. 619)
• DescribeReservedInstancesOfferingsResponseType (p. 620)
• DescribeReservedInstancesOfferingsSetItemType (p. 620)
• DescribeReservedInstancesOfferingsSetType (p. 621)
• DescribeReservedInstancesOfferingsType (p. 621)
• DescribeReservedInstancesResponseSetItemType (p. 622)
• DescribeReservedInstancesResponseSetType (p. 623)
• DescribeReservedInstancesResponseType (p. 623)
• DescribeReservedInstancesSetItemType (p. 624)
• DescribeReservedInstancesSetType (p. 624)
• DescribeReservedInstancesType (p. 625)
API Version 2010-08-31555
Amazon Elastic Compute Cloud API Reference
• DescribeSecurityGroupsResponseType (p. 625)
• DescribeSecurityGroupsSetItemType (p. 626)
• DescribeSecurityGroupsSetType (p. 626)
• DescribeSecurityGroupsType (p. 627)
• DescribeSnapshotAttributeResponseType (p. 627)
• DescribeSnapshotAttributesGroup (p. 628)
• DescribeSnapshotAttributeType (p. 628)
• DescribeSnapshotsOwnersType (p. 629)
• DescribeSnapshotsOwnerType (p. 629)
• DescribeSnapshotsResponseType (p. 630)
• DescribeSnapshotsRestorableBySetType (p. 630)
• DescribeSnapshotsRestorableByType (p. 631)
• DescribeSnapshotsSetItemResponseType (p. 631)
• DescribeSnapshotsSetItemType (p. 632)
• DescribeSnapshotsSetResponseType (p. 633)
• DescribeSnapshotsSetType (p. 633)
• DescribeSnapshotsType (p. 634)
• DescribeSpotDatafeedSubscriptionResponseType (p. 634)
• DescribeSpotInstanceRequestsResponseType (p. 635)
• DescribeSpotInstanceRequestsType (p. 635)
• DescribeSpotPriceHistoryResponseType (p. 636)
• DescribeSpotPriceHistoryType (p. 636)
• DescribeVolumesResponseType (p. 637)
• DescribeVolumesSetItemResponseType (p. 637)
• DescribeVolumesSetItemType (p. 638)
• DescribeVolumesSetResponseType (p. 639)
• DescribeVolumesSetType (p. 639)
• DescribeVolumesType (p. 640)
• DetachVolumeResponseType (p. 640)
• DetachVolumeType (p. 641)
• DisassociateAddressResponseType (p. 642)
• DisassociateAddressType (p. 642)
• EbsBlockDeviceType (p. 643)
• EbsInstanceBlockDeviceMappingResponseType (p. 644)
• EmptyElementType (p. 644)
• GetConsoleOutputResponseType (p. 646)
• GetConsoleOutputType (p. 646)
• GetPasswordDataResponseType (p. 647)
• GetPasswordDataType (p. 647)
• GroupItemType (p. 648)
• GroupSetType (p. 648)
• InstanceBlockDeviceMappingItemType (p. 649)
• InstanceBlockDeviceMappingResponseItemType (p. 650)
• InstanceBlockDeviceMappingResponseType (p. 650)
• InstanceBlockDeviceMappingType (p. 651)
• InstanceEbsBlockDeviceType (p. 652)
API Version 2010-08-31556
Amazon Elastic Compute Cloud API Reference
• InstanceIdSetType (p. 652)
• InstanceIdType (p. 653)
• InstanceMonitoringStateType (p. 653)
• InstanceStateChangeSetType (p. 654)
• InstanceStateChangeType (p. 654)
• InstanceStateType (p. 655)
• InstanceTypeSetItemType (p. 656)
• InstanceTypeSetType (p. 656)
• IpPermissionSetType (p. 657)
• IpPermissionType (p. 657)
• IpRangeItemType (p. 658)
• IpRangeSetType (p. 659)
• LaunchPermissionItemType (p. 659)
• LaunchPermissionListType (p. 660)
• LaunchPermissionOperationType (p. 660)
• LaunchSpecificationType (p. 661)
• ModifyImageAttributeResponseType (p. 662)
• ModifyImageAttributeType (p. 663)
• ModifyInstanceAttributeResponseType (p. 663)
• ModifyInstanceAttributeType (p. 664)
• ModifySnapshotAttributeResponseType (p. 665)
• ModifySnapshotAttributeType (p. 665)
• MonitoringInstanceType (p. 666)
• MonitorInstancesResponseSetItemType (p. 666)
• MonitorInstancesResponseSetType (p. 667)
• MonitorInstancesResponseType (p. 668)
• MonitorInstancesSetItemType (p. 668)
• MonitorInstancesSetType (p. 669)
• MonitorInstancesType (p. 669)
• NullableAttributeBooleanValueType (p. 670)
• NullableAttributeValueType (p. 670)
• PlacementGroupInfoType (p. 671)
• PlacementGroupSetType (p. 671)
• PlacementRequestType (p. 671)
• PlacementResponseType (p. 672)
• ProductCodeItemType (p. 672)
• ProductCodeListType (p. 673)
• ProductCodeSetType (p. 673)
• ProductCodesSetItemType (p. 674)
• ProductCodesSetType (p. 674)
• ProductCodeType (p. 675)
• ProductDescriptionSetItemType (p. 675)
• ProductDescriptionSetType (p. 676)
• PurchaseReservedInstancesOfferingResponseType (p. 676)
• PurchaseReservedInstancesOfferingType (p. 677)
• RebootInstancesInfoType (p. 677)
API Version 2010-08-31557
Amazon Elastic Compute Cloud API Reference
• RebootInstancesItemType (p. 678)
• RebootInstancesResponseType (p. 678)
• RebootInstancesType (p. 679)
• RegionItemType (p. 679)
• RegionSetType (p. 680)
• RegisterImageResponseType (p. 680)
• RegisterImageType (p. 681)
• ReleaseAddressResponseType (p. 682)
• ReleaseAddressType (p. 682)
• RequestSpotInstancesResponseType (p. 683)
• RequestSpotInstancesType (p. 683)
• ReservationInfoType (p. 685)
• ReservationSetType (p. 685)
• ResetImageAttributeResponseType (p. 686)
• ResetImageAttributesGroup (p. 686)
• ResetImageAttributeType (p. 687)
• ResetInstanceAttributeResponseType (p. 687)
• ResetInstanceAttributesGroup (p. 688)
• ResetInstanceAttributeType (p. 688)
• ResetSnapshotAttributeResponseType (p. 689)
• ResetSnapshotAttributesGroup (p. 689)
• ResetSnapshotAttributeType (p. 690)
• RevokeSecurityGroupIngressResponseType (p. 690)
• RevokeSecurityGroupIngressType (p. 691)
• RunInstancesResponseType (p. 692)
• RunInstancesType (p. 692)
• RunningInstancesItemType (p. 694)
• RunningInstancesSetType (p. 696)
• SecurityGroupItemType (p. 697)
• SecurityGroupSetType (p. 697)
• SpotDatafeedSubscriptionType (p. 698)
• SpotInstanceRequestIdSetItemType (p. 699)
• SpotInstanceRequestIdSetType (p. 699)
• SpotInstanceRequestSetItemType (p. 700)
• SpotInstanceRequestSetType (p. 701)
• SpotInstanceStateFaultType (p. 702)
• SpotPriceHistorySetItemType (p. 702)
• SpotPriceHistorySetType (p. 703)
• StartInstancesResponseType (p. 703)
• StartInstancesType (p. 704)
• StateReasonType (p. 704)
• StopInstancesResponseType (p. 706)
• StopInstancesType (p. 706)
• TerminateInstancesResponseType (p. 707)
• TerminateInstancesType (p. 707)
• UserDataType (p. 708)
API Version 2010-08-31558
Amazon Elastic Compute Cloud API Reference
• UserIdGroupPairSetType (p. 708)
• UserIdGroupPairType (p. 709)
AllocateAddressResponseTypeThe AllocateAddressResponseType data type.
AncestorsNone
Relevant Operations• AllocateAddress
ContentsThe following table describes the elements contained in AllocateAddressResponseType.
DescriptionName
IP address for use with your account.
Type: xsd:string
publicIp
The ID of the request.
Type: xsd:string
requestId
AssociateAddressResponseTypeThe AssociateAddressResponseType data type.
AncestorsNone
Relevant Operations• AssociateAddress
ContentsThe following table describes the elements contained in AssociateAddressResponseType.
API Version 2010-08-31559
Amazon Elastic Compute Cloud API ReferenceAllocateAddressResponseType
DescriptionName
The ID of the request.
Type: xsd:string
requestId
Returns true if instance and IP address successfully associated.Otherwise, returns an error.
Type: xsd:boolean
return
AssociateAddressTypeThe AssociateAddressType data type.
AncestorsNone
Relevant Operations• AssociateAddress
ContentsThe following table describes the elements contained in AssociateAddressType.
DescriptionName
The instance to associate with the IP address.
Type: xsd:string
instanceId
IP address that you are assigning to the instance.
Type: xsd:string
publicIp
AttachmentSetItemResponseTypeThe AttachmentSetItemResponseType data type.
Ancestors• AttachmentSetResponseType (p. 561)
Relevant Operations• DescribeVolumes
API Version 2010-08-31560
Amazon Elastic Compute Cloud API ReferenceAssociateAddressType
ContentsThe following table describes the elements contained in AttachmentSetItemResponseType.
DescriptionName
Time stamp when the attachment initiated.
Type: xsd:dateTime
attachTime
Specifies whether the Amazon EBS volume is deleted on instancetermination.
Type: xsd:boolean
deleteOnTermination
Specifies how the device is exposed to the instance (e.g., /dev/sdh).
Type: xsd:string
device
The ID of the instance.
Type: xsd:string
instanceId
Attachment state.
Type: xsd:string
status
The ID of the volume.
Type: xsd:string
volumeId
AttachmentSetResponseTypeThe AttachmentSetResponseType data type.
Ancestors• DescribeVolumesSetItemResponseType (p. 637)
Relevant Operations• DescribeVolumes
ContentsThe following table describes the elements contained in AttachmentSetResponseType.
DescriptionName
Information for a attachment set.
Type: AttachmentSetItemResponseType (p. 560)
item
API Version 2010-08-31561
Amazon Elastic Compute Cloud API ReferenceContents
AttachVolumeResponseTypeThe AttachVolumeResponseType data type.
AncestorsNone
Relevant Operations• AttachVolume
ContentsThe following table describes the elements contained in AttachVolumeResponseType.
DescriptionName
Time stamp when the attachment initiated.
Type: xsd:dateTime
attachTime
The device as it is exposed to the instance.
Type: xsd:string
device
The ID of the instance.
Type: xsd:string
instanceId
The ID of the request.
Type: xsd:string
requestId
Volume state.
Type: xsd:string
status
The ID of the volume.
Type: xsd:string
volumeId
AttachVolumeTypeThe AttachVolumeType data type.
AncestorsNone
Relevant Operations• AttachVolume
API Version 2010-08-31562
Amazon Elastic Compute Cloud API ReferenceAttachVolumeResponseType
ContentsThe following table describes the elements contained in AttachVolumeType.
DescriptionName
Specifies how the device is exposed to the instance (e.g., /dev/sdh).
Type: xsd:string
device
The ID of the instance to which the volume attaches. The volumeand instance must be within the same Availability Zone and theinstance must be running.
Type: xsd:string
instanceId
The ID of the Amazon EBS volume. The volume and instance mustbe within the same Availability Zone and the instance must berunning.
Type: xsd:string
volumeId
AttributeBooleanValueTypeThe AttributeBooleanValueType data type.
Ancestors• ModifyInstanceAttributeType (p. 664)
Relevant Operations• ModifyInstanceAttribute
ContentsThe following table describes the elements contained in AttributeBooleanValueType.
DescriptionName
Generic boolean value.
Type: xsd:boolean
value
AttributeValueTypeThe AttributeValueType data type.
API Version 2010-08-31563
Amazon Elastic Compute Cloud API ReferenceContents
Ancestors• ModifyImageAttributeType (p. 663)
• ModifyInstanceAttributeType (p. 664)
Relevant Operations• ModifyImageAttribute
• ModifyInstanceAttribute
ContentsThe following table describes the elements contained in AttributeValueType.
DescriptionName
ID of the item.
Type: xsd:string
value
AuthorizeSecurityGroupIngressResponseTypeThe AuthorizeSecurityGroupIngressResponseType data type.
AncestorsNone
Relevant Operations• AuthorizeSecurityGroupIngress
ContentsThe following table describes the elements contained in AuthorizeSecurityGroupIngressResponseType.
DescriptionName
The ID of the request.
Type: xsd:string
requestId
Returns true if request is successful. Otherwise, returns an error.
Type: xsd:boolean
return
API Version 2010-08-31564
Amazon Elastic Compute Cloud API ReferenceAncestors
AuthorizeSecurityGroupIngressTypeThe AuthorizeSecurityGroupIngressType data type.
AncestorsNone
Relevant Operations• AuthorizeSecurityGroupIngress
ContentsThe following table describes the elements contained in AuthorizeSecurityGroupIngressType.
DescriptionName
Name of the group to modify. The name must be valid and belongto the account
Type: xsd:string
groupName
Set of permissions.
Type: IpPermissionSetType (p. 657)
ipPermissions
DeprecateduserId
AvailabilityZoneItemTypeThe AvailabilityZoneItemType data type.
Ancestors• AvailabilityZoneSetType (p. 567)
Relevant Operations• DescribeAvailabilityZones
ContentsThe following table describes the elements contained in AvailabilityZoneItemType.
API Version 2010-08-31565
Amazon Elastic Compute Cloud API ReferenceAuthorizeSecurityGroupIngressType
DescriptionName
Message set.
Type: AvailabilityZoneMessageSetType (p. 566)
messageSet
Name of the Region.
Type: xsd:string
regionName
Name of the Availability Zone.
Type: xsd:string
zoneName
State of the Availability Zone.
Type: xsd:string
zoneState
AvailabilityZoneMessageSetTypeThe AvailabilityZoneMessageSetType data type.
Ancestors• AvailabilityZoneItemType (p. 565)
Relevant Operations• DescribeAvailabilityZones
ContentsThe following table describes the elements contained in AvailabilityZoneMessageSetType.
DescriptionName
Availability Zone message set.
Type: AvailabilityZoneMessageType (p. 566)
item
AvailabilityZoneMessageTypeThe AvailabilityZoneMessageType data type.
Ancestors• AvailabilityZoneMessageSetType (p. 566)
API Version 2010-08-31566
Amazon Elastic Compute Cloud API ReferenceAvailabilityZoneMessageSetType
Relevant Operations• DescribeAvailabilityZones
ContentsThe following table describes the elements contained in AvailabilityZoneMessageType.
DescriptionName
The Availability Zone message.
Type: xsd:string
message
AvailabilityZoneSetTypeThe AvailabilityZoneSetType data type.
Ancestors• DescribeAvailabilityZonesResponseType (p. 596)
Relevant Operations• DescribeAvailabilityZones
ContentsThe following table describes the elements contained in AvailabilityZoneSetType.
DescriptionName
Information for one Availability Zone.
Type: AvailabilityZoneItemType (p. 565)
item
BlockDeviceMappingItemTypeThe BlockDeviceMappingItemType data type.
Ancestors• BlockDeviceMappingType (p. 568)
API Version 2010-08-31567
Amazon Elastic Compute Cloud API ReferenceRelevant Operations
Relevant Operations• DescribeImageAttribute
• DescribeImages
• RequestSpotInstances
• DescribeSpotInstanceRequests
• RequestSpotInstances
• RegisterImage
• RunInstances
ContentsThe following table describes the elements contained in BlockDeviceMappingItemType.
DescriptionName
The device name (e.g., /dev/sdh).
Type: xsd:string
deviceName
Specifies parameters used to automatically setup Amazon EBSvolumes when the instance is launched.
Type: EbsBlockDeviceType (p. 643)
ebs
Specifies the device name to suppress during instance launch.
Type: EmptyElementType (p. 644)
noDevice
The virtual device name.
Type: xsd:string
virtualName
BlockDeviceMappingTypeThe BlockDeviceMappingType data type.
Ancestors• DescribeImageAttributeResponseType (p. 600)
• DescribeImagesResponseItemType (p. 605)
• LaunchSpecificationType (p. 661)
• RegisterImageType (p. 681)
• RunInstancesType (p. 692)
Relevant Operations• DescribeImageAttribute
API Version 2010-08-31568
Amazon Elastic Compute Cloud API ReferenceRelevant Operations
• DescribeImages
• RequestSpotInstances
• DescribeSpotInstanceRequests
• RequestSpotInstances
• RegisterImage
• RunInstances
ContentsThe following table describes the elements contained in BlockDeviceMappingType.
DescriptionName
Information for one block device mapping.
Type: BlockDeviceMappingItemType (p. 567)
item
BundleInstanceResponseTypeThe BundleInstanceResponseType data type.
AncestorsNone
Relevant Operations• BundleInstance
ContentsThe following table describes the elements contained in BundleInstanceResponseType.
DescriptionName
Bundle task.
Type: BundleInstanceTaskType (p. 572)
bundleInstanceTask
The ID of the request.
Type: xsd:string
requestId
BundleInstanceS3StorageTypeThe BundleInstanceS3StorageType data type.
API Version 2010-08-31569
Amazon Elastic Compute Cloud API ReferenceContents
Ancestors• BundleInstanceTaskStorageType (p. 571)
Relevant Operations• BundleInstance
• DescribeBundleTasks
• CancelBundleTask
• BundleInstance
ContentsThe following table describes the elements contained in BundleInstanceS3StorageType.
DescriptionName
The Access Key ID of the owner of the Amazon S3 bucket.
Type: xsd:string
awsAccessKeyId
The bucket in which to store the AMI.You can specify a bucket thatyou already own or a new bucket that Amazon EC2 creates on yourbehalf. If you specify a bucket that belongs to someone else, AmazonEC2 returns an error.
Type: xsd:string
bucket
Specifies the beginning of the file name of the AMI.
Type: xsd:string
prefix
A Base64-encoded Amazon S3 upload policy that gives AmazonEC2 permission to upload items into Amazon S3 on the user's behalf.
Type: xsd:string
uploadPolicy
The signature of the Base64 encoded JSON document.
Type: xsd:string
uploadPolicySignature
BundleInstanceTaskErrorTypeThe BundleInstanceTaskErrorType data type.
Ancestors• BundleInstanceTaskType (p. 572)
API Version 2010-08-31570
Amazon Elastic Compute Cloud API ReferenceAncestors
Relevant Operations• BundleInstance
• DescribeBundleTasks
• CancelBundleTask
ContentsThe following table describes the elements contained in BundleInstanceTaskErrorType.
DescriptionName
Error code.
Type: xsd:string
code
Error message.
Type: xsd:string
message
BundleInstanceTasksSetTypeThe BundleInstanceTasksSetType data type.
Ancestors• DescribeBundleTasksResponseType (p. 599)
Relevant Operations• DescribeBundleTasks
ContentsThe following table describes the elements contained in BundleInstanceTasksSetType.
DescriptionName
Bundle task.
Type: BundleInstanceTaskType (p. 572)
item
BundleInstanceTaskStorageTypeThe BundleInstanceTaskStorageType data type.
API Version 2010-08-31571
Amazon Elastic Compute Cloud API ReferenceRelevant Operations
Ancestors• BundleInstanceTaskType (p. 572)
• BundleInstanceType (p. 573)
Relevant Operations• BundleInstance
• DescribeBundleTasks
• CancelBundleTask
• BundleInstance
ContentsThe following table describes the elements contained in BundleInstanceTaskStorageType.
DescriptionName
Amazon S3 storage location.
Type: BundleInstanceS3StorageType (p. 569)
S3
BundleInstanceTaskTypeThe BundleInstanceTaskType data type.
Ancestors• BundleInstanceResponseType (p. 569)
• BundleInstanceTasksSetType (p. 571)
• CancelBundleTaskResponseType (p. 574)
Relevant Operations• BundleInstance
• DescribeBundleTasks
• CancelBundleTask
ContentsThe following table describes the elements contained in BundleInstanceTaskType.
API Version 2010-08-31572
Amazon Elastic Compute Cloud API ReferenceAncestors
DescriptionName
Identifier for this task.
Type: xsd:string
bundleId
If the task fails, a description of the error.
Type: BundleInstanceTaskErrorType (p. 570)
error
Instance associated with this bundle task.
Type: xsd:string
instanceId
The level of task completion, in percent (e.g., 20%).
Type: xsd:string
progress
The time this task started.
Type: xsd:dateTime
startTime
The state of the task.
Type: xsd:string
state
Amazon S3 storage locations.
Type: BundleInstanceTaskStorageType (p. 571)
storage
The time of the most recent update for the task.
Type: xsd:dateTime
updateTime
BundleInstanceTypeThe BundleInstanceType data type.
AncestorsNone
Relevant Operations• BundleInstance
ContentsThe following table describes the elements contained in BundleInstanceType.
DescriptionName
The ID of the instance to bundle.
Type: xsd:string
instanceId
Amazon S3 storage locations.
Type: BundleInstanceTaskStorageType (p. 571)
storage
API Version 2010-08-31573
Amazon Elastic Compute Cloud API ReferenceBundleInstanceType
CancelBundleTaskResponseTypeThe CancelBundleTaskResponseType data type.
AncestorsNone
Relevant Operations• CancelBundleTask
ContentsThe following table describes the elements contained in CancelBundleTaskResponseType.
DescriptionName
Bundle task to cancel.
Type: BundleInstanceTaskType (p. 572)
bundleInstanceTask
The ID of the request.
Type: xsd:string
requestId
CancelBundleTaskTypeThe CancelBundleTaskType data type.
AncestorsNone
Relevant Operations• CancelBundleTask
ContentsThe following table describes the elements contained in CancelBundleTaskType.
DescriptionName
The ID of the bundle task to cancel.
Type: xsd:string
bundleId
API Version 2010-08-31574
Amazon Elastic Compute Cloud API ReferenceCancelBundleTaskResponseType
CancelSpotInstanceRequestsResponseSetItemTypeThe CancelSpotInstanceRequestsResponseSetItemType data type.
Ancestors• CancelSpotInstanceRequestsResponseSetType (p. 575)
Relevant Operations• CancelSpotInstanceRequests
ContentsThe following table describes the elements contained inCancelSpotInstanceRequestsResponseSetItemType.
DescriptionName
Specifies the ID of the Spot Instance request.
Type: xsd:string
spotInstanceRequestId
The state of the Spot Instance request.
Type: xsd:string
state
CancelSpotInstanceRequestsResponseSetTypeThe CancelSpotInstanceRequestsResponseSetType data type.
Ancestors• CancelSpotInstanceRequestsResponseType (p. 576)
Relevant Operations• CancelSpotInstanceRequests
ContentsThe following table describes the elements contained in CancelSpotInstanceRequestsResponseSetType.
DescriptionName
Cancel Spot Instance requests item.
Type: CancelSpotInstanceRequestsResponseSetItemType (p. 575)
item
API Version 2010-08-31575
Amazon Elastic Compute Cloud API ReferenceCancelSpotInstanceRequestsResponseSetItemType
CancelSpotInstanceRequestsResponseTypeThe CancelSpotInstanceRequestsResponseType data type.
AncestorsNone
Relevant Operations• CancelSpotInstanceRequests
ContentsThe following table describes the elements contained in CancelSpotInstanceRequestsResponseType.
DescriptionName
The ID of the request.
Type: xsd:string
requestId
Spot Instance requests set.
Type: CancelSpotInstanceRequestsResponseSetType (p. 575)
spotInstanceRequestSet
CancelSpotInstanceRequestsTypeThe CancelSpotInstanceRequestsType data type.
AncestorsNone
Relevant Operations• CancelSpotInstanceRequests
ContentsThe following table describes the elements contained in CancelSpotInstanceRequestsType.
DescriptionName
Spot Instance requests set.
Type: SpotInstanceRequestIdSetType (p. 699)
spotInstanceRequestIdSet
API Version 2010-08-31576
Amazon Elastic Compute Cloud API ReferenceCancelSpotInstanceRequestsResponseType
ConfirmProductInstanceResponseTypeThe ConfirmProductInstanceResponseType data type.
AncestorsNone
Relevant Operations• ConfirmProductInstance
ContentsThe following table describes the elements contained in ConfirmProductInstanceResponseType.
DescriptionName
The instance owner's account ID. Only present if the product codeis attached to the instance.
Type: xsd:string
ownerId
The ID of the request.
Type: xsd:string
requestId
Returns true if the product code is attached to the instance.Otherwise, returns an error.
Type: xsd:boolean
return
ConfirmProductInstanceTypeThe ConfirmProductInstanceType data type.
AncestorsNone
Relevant Operations• ConfirmProductInstance
ContentsThe following table describes the elements contained in ConfirmProductInstanceType.
API Version 2010-08-31577
Amazon Elastic Compute Cloud API ReferenceConfirmProductInstanceResponseType
DescriptionName
The instance to confirm.
Type: xsd:string
instanceId
The product code to confirm.
Type: xsd:string
productCode
CreateImageResponseTypeThe CreateImageResponseType data type.
AncestorsNone
Relevant Operations• CreateImage
ContentsThe following table describes the elements contained in CreateImageResponseType.
DescriptionName
The ID of the AMI.
Type: xsd:string
imageId
The ID of the request.
Type: xsd:string
requestId
CreateImageTypeThe CreateImageType data type.
AncestorsNone
Relevant Operations• CreateImage
API Version 2010-08-31578
Amazon Elastic Compute Cloud API ReferenceCreateImageResponseType
ContentsThe following table describes the elements contained in CreateImageType.
DescriptionName
The description of the AMI that was provided during image creation.
Type: xsd:string
description
The ID of the instance.
Type: xsd:string
instanceId
The name of the AMI that was provided during image creation.
Type: xsd:string
name
By default this property is set to false, which means Amazon EC2attempts to cleanly shut down the instance before image creationand reboots the instance afterwards. When set to true, Amazon EC2does not shut down the instance before creating the image. Whenthis option is used, file system integrity on the created image cannotbe guaranteed.
Type: xsd:boolean
noReboot
CreateKeyPairResponseTypeThe CreateKeyPairResponseType data type.
AncestorsNone
Relevant Operations• CreateKeyPair
ContentsThe following table describes the elements contained in CreateKeyPairResponseType.
DescriptionName
A SHA-1 digest of the DER encoded private key.
Type: xsd:string
keyFingerprint
An unencrypted PEM encoded RSA private key.
Type: xsd:string
keyMaterial
The key pair name provided in the original request.
Type: xsd:string
keyName
API Version 2010-08-31579
Amazon Elastic Compute Cloud API ReferenceContents
DescriptionName
The ID of the request.
Type: xsd:string
requestId
CreateKeyPairTypeThe CreateKeyPairType data type.
AncestorsNone
Relevant Operations• CreateKeyPair
ContentsThe following table describes the elements contained in CreateKeyPairType.
DescriptionName
A unique name for the key pair.
Type: xsd:string
keyName
CreatePlacementGroupResponseTypeFor Query, see CreatePlacementGroup (p. 42).
For SOAP, see CreatePlacementGroup (p. 295).
CreatePlacementGroupTypeSee CreatePlacementGroup (p. 295).
CreateSecurityGroupResponseTypeThe CreateSecurityGroupResponseType data type.
AncestorsNone
API Version 2010-08-31580
Amazon Elastic Compute Cloud API ReferenceCreateKeyPairType
Relevant Operations• CreateSecurityGroup
ContentsThe following table describes the elements contained in CreateSecurityGroupResponseType.
DescriptionName
The ID of the request.
Type: xsd:string
requestId
Returns true if creation succeeded. Otherwise, returns an error.
Type: xsd:boolean
return
CreateSecurityGroupTypeThe CreateSecurityGroupType data type.
AncestorsNone
Relevant Operations• CreateSecurityGroup
ContentsThe following table describes the elements contained in CreateSecurityGroupType.
DescriptionName
Description of the group. This is informational only. If the descriptioncontains spaces, you must enclose it in single quotes (') orURL-encode it.
Type: xsd:string
groupDescription
Name of the security group.
Type: xsd:string
groupName
CreateSnapshotResponseTypeThe CreateSnapshotResponseType data type.
API Version 2010-08-31581
Amazon Elastic Compute Cloud API ReferenceRelevant Operations
AncestorsNone
Relevant Operations• CreateSnapshot
ContentsThe following table describes the elements contained in CreateSnapshotResponseType.
DescriptionName
Description of the snapshot.
Type: xsd:string
description
The AWS account ID of the Amazon EBS snapshot owner.
Type: xsd:string
ownerId
The progress of the snapshot, in percentage.
Type: xsd:string
progress
The ID of the request.
Type: xsd:string
requestId
The ID of the snapshot.
Type: xsd:string
snapshotId
Time stamp when the snapshot was initiated.
Type: xsd:dateTime
startTime
Snapshot state (e.g., pending, completed, or error)
Type: xsd:string
status
The ID of the volume.
Type: xsd:string
volumeId
The size of the volume, in GiB.
Type: xsd:string
volumeSize
CreateSnapshotTypeThe CreateSnapshotType data type.
AncestorsNone
API Version 2010-08-31582
Amazon Elastic Compute Cloud API ReferenceAncestors
Relevant Operations• CreateSnapshot
ContentsThe following table describes the elements contained in CreateSnapshotType.
DescriptionName
Description of the Amazon EBS snapshot.
Type: xsd:string
description
The ID of the Amazon EBS volume of which to take a snapshot.
Type: xsd:string
volumeId
CreateSpotDatafeedSubscriptionResponseTypeThe CreateSpotDatafeedSubscriptionResponseType data type.
AncestorsNone
Relevant Operations• CreateSpotDatafeedSubscription
ContentsThe following table describes the elements contained in CreateSpotDatafeedSubscriptionResponseType.
DescriptionName
The ID of the request.
Type: xsd:string
requestId
Datafeed subscription.
Type: SpotDatafeedSubscriptionType (p. 698)
spotDatafeedSubscription
CreateSpotDatafeedSubscriptionTypeThe CreateSpotDatafeedSubscriptionType data type.
API Version 2010-08-31583
Amazon Elastic Compute Cloud API ReferenceRelevant Operations
AncestorsNone
Relevant Operations• CreateSpotDatafeedSubscription
ContentsThe following table describes the elements contained in CreateSpotDatafeedSubscriptionType.
DescriptionName
The Amazon S3 bucket in which to store the Spot Instance datafeed.
Type: xsd:string
bucket
Prefix that is prepended to datafeed files.
Type: xsd:string
prefix
CreateVolumePermissionItemTypeThe CreateVolumePermissionItemType data type.
Ancestors• CreateVolumePermissionListType (p. 585)
Relevant Operations• ModifySnapshotAttribute
• DescribeSnapshotAttribute
ContentsThe following table describes the elements contained in CreateVolumePermissionItemType.
DescriptionName
Group that is allowed to create volumes from the snapshot (currentlysupports "all").
Type: xsd:string
group
ID of an AWS account that can create volumes from the snapshot.
Type: xsd:string
userId
API Version 2010-08-31584
Amazon Elastic Compute Cloud API ReferenceAncestors
CreateVolumePermissionListTypeThe CreateVolumePermissionListType data type.
Ancestors• CreateVolumePermissionOperationType (p. 585)
• CreateVolumePermissionOperationType (p. 585)
• DescribeSnapshotAttributeResponseType (p. 627)
Relevant Operations• ModifySnapshotAttribute
• DescribeSnapshotAttribute
ContentsThe following table describes the elements contained in CreateVolumePermissionListType.
DescriptionName
Volume permission item.
Type: CreateVolumePermissionItemType (p. 584)
item
CreateVolumePermissionOperationTypeThe CreateVolumePermissionOperationType data type.
Ancestors• ModifySnapshotAttributeType (p. 665)
Relevant Operations• ModifySnapshotAttribute
ContentsThe following table describes the elements contained in CreateVolumePermissionOperationType.
DescriptionName
Add permission.
Type: CreateVolumePermissionListType (p. 585)
add
API Version 2010-08-31585
Amazon Elastic Compute Cloud API ReferenceCreateVolumePermissionListType
DescriptionName
Remove permission.
Type: CreateVolumePermissionListType (p. 585)
remove
CreateVolumeResponseTypeThe CreateVolumeResponseType data type.
AncestorsNone
Relevant Operations• CreateVolume
ContentsThe following table describes the elements contained in CreateVolumeResponseType.
DescriptionName
Availability Zone in which the volume was created.
Type: xsd:string
availabilityZone
Time stamp when volume creation was initiated.
Type: xsd:dateTime
createTime
The ID of the request.
Type: xsd:string
requestId
The size of the volume, in GiBs.
Type: xsd:string
size
Snapshot from which the volume was created, if applicable.
Type: xsd:string
snapshotId
Volume state (e.g., creating, available)
Type: xsd:string
status
The ID of the volume.
Type: xsd:string
volumeId
CreateVolumeTypeThe CreateVolumeType data type.
API Version 2010-08-31586
Amazon Elastic Compute Cloud API ReferenceCreateVolumeResponseType
AncestorsNone
Relevant Operations• CreateVolume
ContentsThe following table describes the elements contained in CreateVolumeType.
DescriptionName
The Availability Zone in which to create the new volume.
Type: xsd:string
availabilityZone
The size of the volume, in GiBs. Required if you are not creating avolume from a snapshot.
Type: xsd:string
size
The snapshot from which to create the new volume.
Type: xsd:string
snapshotId
DeleteKeyPairResponseTypeThe DeleteKeyPairResponseType data type.
AncestorsNone
Relevant Operations• DeleteKeyPair
ContentsThe following table describes the elements contained in DeleteKeyPairResponseType.
DescriptionName
The ID of the request.
Type: xsd:string
requestId
Returns true if deletion succeeded. Otherwise, returns an error.
Type: xsd:boolean
return
API Version 2010-08-31587
Amazon Elastic Compute Cloud API ReferenceAncestors
DeleteKeyPairTypeThe DeleteKeyPairType data type.
AncestorsNone
Relevant Operations• DeleteKeyPair
ContentsThe following table describes the elements contained in DeleteKeyPairType.
DescriptionName
Name of the key pair to delete.
Type: xsd:string
keyName
DeletePlacementGroupResponseTypeFor Query, see DeletePlacementGroup (p. 60).
For SOAP, see DeletePlacementGroup (p. 314).
DeletePlacementGroupTypeSee DeletePlacementGroup (p. 314).
DeleteSecurityGroupResponseTypeThe DeleteSecurityGroupResponseType data type.
AncestorsNone
Relevant Operations• DeleteSecurityGroup
API Version 2010-08-31588
Amazon Elastic Compute Cloud API ReferenceDeleteKeyPairType
ContentsThe following table describes the elements contained in DeleteSecurityGroupResponseType.
DescriptionName
The ID of the request.
Type: xsd:string
requestId
Returns true if deletion succeeded. Otherwise, returns an error.
Type: xsd:boolean
return
DeleteSecurityGroupTypeThe DeleteSecurityGroupType data type.
AncestorsNone
Relevant Operations• DeleteSecurityGroup
ContentsThe following table describes the elements contained in DeleteSecurityGroupType.
DescriptionName
Name of the security group to delete.
Type: xsd:string
groupName
DeleteSnapshotResponseTypeThe DeleteSnapshotResponseType data type.
AncestorsNone
Relevant Operations• DeleteSnapshot
API Version 2010-08-31589
Amazon Elastic Compute Cloud API ReferenceContents
ContentsThe following table describes the elements contained in DeleteSnapshotResponseType.
DescriptionName
The ID of the request.
Type: xsd:string
requestId
Returns true if deletion succeeded. Otherwise, returns an error.
Type: xsd:boolean
return
DeleteSnapshotTypeThe DeleteSnapshotType data type.
AncestorsNone
Relevant Operations• DeleteSnapshot
ContentsThe following table describes the elements contained in DeleteSnapshotType.
DescriptionName
The ID of the Amazon EBS snapshot to delete.
Type: xsd:string
snapshotId
DeleteSpotDatafeedSubscriptionResponseTypeThe DeleteSpotDatafeedSubscriptionResponseType data type.
AncestorsNone
Relevant Operations• DeleteSpotDatafeedSubscription
API Version 2010-08-31590
Amazon Elastic Compute Cloud API ReferenceContents
ContentsThe following table describes the elements contained in DeleteSpotDatafeedSubscriptionResponseType.
DescriptionName
The ID of the request.
Type: xsd:string
requestId
Returns true if deletion succeeded. Otherwise, returns an error.
Type: xsd:boolean
return
DeleteVolumeResponseTypeThe DeleteVolumeResponseType data type.
AncestorsNone
Relevant Operations• DeleteVolume
ContentsThe following table describes the elements contained in DeleteVolumeResponseType.
DescriptionName
The ID of the request.
Type: xsd:string
requestId
Returns true if deletion succeeded. Otherwise, returns an error.
Type: xsd:boolean
return
DeleteVolumeTypeThe DeleteVolumeType data type.
AncestorsNone
Relevant Operations• DeleteVolume
API Version 2010-08-31591
Amazon Elastic Compute Cloud API ReferenceContents
ContentsThe following table describes the elements contained in DeleteVolumeType.
DescriptionName
The ID of the volume to delete. The volume remains in the deletingstate for several minutes after entering this command.
Type: xsd:string
volumeId
DeregisterImageResponseTypeThe DeregisterImageResponseType data type.
AncestorsNone
Relevant Operations• DeregisterImage
ContentsThe following table describes the elements contained in DeregisterImageResponseType.
DescriptionName
The ID of the request.
Type: xsd:string
requestId
Returns true if deregistration succeeded. Otherwise, returns an error.
Type: xsd:boolean
return
DeregisterImageTypeThe DeregisterImageType data type.
AncestorsNone
Relevant Operations• DeregisterImage
API Version 2010-08-31592
Amazon Elastic Compute Cloud API ReferenceContents
ContentsThe following table describes the elements contained in DeregisterImageType.
DescriptionName
Unique ID of the AMI which was assigned during registration. Toregister an AMI, use RegisterImage. To view the AMI IDs of AMIsthat belong to your account. use DescribeImages.
Type: xsd:string
imageId
DescribeAddressesInfoTypeThe DescribeAddressesInfoType data type.
Ancestors• DescribeAddressesType (p. 595)
Relevant Operations• DescribeAddresses
ContentsThe following table describes the elements contained in DescribeAddressesInfoType.
DescriptionName
Information for one elastic IP address.
Type: DescribeAddressesItemType (p. 593)
item
DescribeAddressesItemTypeThe DescribeAddressesItemType data type.
Ancestors• DescribeAddressesInfoType (p. 593)
Relevant Operations• DescribeAddresses
API Version 2010-08-31593
Amazon Elastic Compute Cloud API ReferenceContents
ContentsThe following table describes the elements contained in DescribeAddressesItemType.
DescriptionName
Elastic IP address to describe.
Type: xsd:string
publicIp
DescribeAddressesResponseInfoTypeThe DescribeAddressesResponseInfoType data type.
Ancestors• DescribeAddressesResponseType (p. 595)
Relevant Operations• DescribeAddresses
ContentsThe following table describes the elements contained in DescribeAddressesResponseInfoType.
DescriptionName
Information about an instance.
Type: DescribeAddressesResponseItemType (p. 594)
item
DescribeAddressesResponseItemTypeThe DescribeAddressesResponseItemType data type.
Ancestors• DescribeAddressesResponseInfoType (p. 594)
Relevant Operations• DescribeAddresses
API Version 2010-08-31594
Amazon Elastic Compute Cloud API ReferenceContents
ContentsThe following table describes the elements contained in DescribeAddressesResponseItemType.
DescriptionName
The ID of the instance.
Type: xsd:string
instanceId
The public IP address.
Type: xsd:string
publicIp
DescribeAddressesResponseTypeThe DescribeAddressesResponseType data type.
AncestorsNone
Relevant Operations• DescribeAddresses
ContentsThe following table describes the elements contained in DescribeAddressesResponseType.
DescriptionName
The set of IP addresses.
Type: DescribeAddressesResponseInfoType (p. 594)
addressesSet
The ID of the request.
Type: xsd:string
requestId
DescribeAddressesTypeThe DescribeAddressesType data type.
AncestorsNone
Relevant Operations• DescribeAddresses
API Version 2010-08-31595
Amazon Elastic Compute Cloud API ReferenceContents
ContentsThe following table describes the elements contained in DescribeAddressesType.
DescriptionName
Set of elastic IP addresses.
Type: DescribeAddressesInfoType (p. 593)
publicIpsSet
DescribeAvailabilityZonesResponseTypeThe DescribeAvailabilityZonesResponseType data type.
AncestorsNone
Relevant Operations• DescribeAvailabilityZones
ContentsThe following table describes the elements contained in DescribeAvailabilityZonesResponseType.
DescriptionName
Availability Zone information.
Type: AvailabilityZoneSetType (p. 567)
availabilityZoneInfo
The ID of the request.
Type: xsd:string
requestId
DescribeAvailabilityZonesSetItemTypeThe DescribeAvailabilityZonesSetItemType data type.
Ancestors• DescribeAvailabilityZonesSetType (p. 597)
Relevant Operations• DescribeAvailabilityZones
API Version 2010-08-31596
Amazon Elastic Compute Cloud API ReferenceContents
ContentsThe following table describes the elements contained in DescribeAvailabilityZonesSetItemType.
DescriptionName
Availability Zone name.
Type: xsd:string
zoneName
DescribeAvailabilityZonesSetTypeThe DescribeAvailabilityZonesSetType data type.
Ancestors• DescribeAvailabilityZonesType (p. 597)
Relevant Operations• DescribeAvailabilityZones
ContentsThe following table describes the elements contained in DescribeAvailabilityZonesSetType.
DescriptionName
Information for one Availability Zone.
Type: DescribeAvailabilityZonesSetItemType (p. 596)
item
DescribeAvailabilityZonesTypeThe DescribeAvailabilityZonesType data type.
AncestorsNone
Relevant Operations• DescribeAvailabilityZones
API Version 2010-08-31597
Amazon Elastic Compute Cloud API ReferenceContents
ContentsThe following table describes the elements contained in DescribeAvailabilityZonesType.
DescriptionName
Set of Availability Zones.
Type: DescribeAvailabilityZonesSetType (p. 597)
availabilityZoneSet
DescribeBundleTasksInfoTypeThe DescribeBundleTasksInfoType data type.
Ancestors• DescribeBundleTasksType (p. 599)
Relevant Operations• DescribeBundleTasks
ContentsThe following table describes the elements contained in DescribeBundleTasksInfoType.
DescriptionName
Information for one bundle task.
Type: DescribeBundleTasksItemType (p. 598)
item
DescribeBundleTasksItemTypeThe DescribeBundleTasksItemType data type.
Ancestors• DescribeBundleTasksInfoType (p. 598)
Relevant Operations• DescribeBundleTasks
API Version 2010-08-31598
Amazon Elastic Compute Cloud API ReferenceContents
ContentsThe following table describes the elements contained in DescribeBundleTasksItemType.
DescriptionName
The ID of the bundle task to describe.
Type: xsd:string
bundleId
DescribeBundleTasksResponseTypeThe DescribeBundleTasksResponseType data type.
AncestorsNone
Relevant Operations• DescribeBundleTasks
ContentsThe following table describes the elements contained in DescribeBundleTasksResponseType.
DescriptionName
Bundle task set.
Type: BundleInstanceTasksSetType (p. 571)
bundleInstanceTasksSet
The ID of the request.
Type: xsd:string
requestId
DescribeBundleTasksTypeThe DescribeBundleTasksType data type.
AncestorsNone
Relevant Operations• DescribeBundleTasks
API Version 2010-08-31599
Amazon Elastic Compute Cloud API ReferenceContents
ContentsThe following table describes the elements contained in DescribeBundleTasksType.
DescriptionName
Set of bundle tasks.
Type: DescribeBundleTasksInfoType (p. 598)
bundlesSet
DescribeImageAttributeResponseTypeThe DescribeImageAttributeResponseType data type.
AncestorsNone
Relevant Operations• DescribeImageAttribute
ContentsThe following table describes the elements contained in DescribeImageAttributeResponseType.
DescriptionName
Block device mapping set.
Type: BlockDeviceMappingType (p. 568)
blockDeviceMapping
User-created description of the AMI.
Type: NullableAttributeValueType (p. 670)
description
The ID of the AMI.
Type: xsd:string
imageId
Kernel set.
Type: NullableAttributeValueType (p. 670)
kernel
Launch permissions set.
Type: LaunchPermissionListType (p. 660)
launchPermission
Product codes set.
Type: ProductCodeListType (p. 673)
productCodes
RAM disk set.
Type: NullableAttributeValueType (p. 670)
ramdisk
API Version 2010-08-31600
Amazon Elastic Compute Cloud API ReferenceContents
DescriptionName
The ID of the request.
Type: xsd:string
requestId
DescribeImageAttributesGroupThe DescribeImageAttributesGroup data type.
Ancestors• DescribeImageAttributeType (p. 601)
Relevant Operations• DescribeImageAttribute
ContentsThe following table describes the elements contained in DescribeImageAttributesGroup.
DescriptionName
Describes the mapping that defines native device names to use whenexposing virtual devices.
Type: EmptyElementType (p. 644)
blockDeviceMapping
The description of the AMI that was provided during image creation.
Type: EmptyElementType (p. 644)
description
Describes the ID of the kernel associated with the AMI.
Type: EmptyElementType (p. 644)
kernel
Describes the launch permissions associated with the AMI.
Type: EmptyElementType (p. 644)
launchPermission
Describes the product code associated with the AMI.
Type: EmptyElementType (p. 644)
productCodes
Describes the ID of the RAM disk associated with the AMI.
Type: EmptyElementType (p. 644)
ramdisk
DescribeImageAttributeTypeThe DescribeImageAttributeType data type.
API Version 2010-08-31601
Amazon Elastic Compute Cloud API ReferenceDescribeImageAttributesGroup
AncestorsNone
Relevant Operations• DescribeImageAttribute
ContentsThe following table describes the elements contained in DescribeImageAttributeType.
DescriptionName
The image attributes group.
Type: DescribeImageAttributesGroup (p. 601)
DescribeImageAttributesGroup
The ID of the AMI for which an attribute will be described.
Type: xsd:string
imageId
DescribeImagesExecutableBySetTypeThe DescribeImagesExecutableBySetType data type.
Ancestors• DescribeImagesType (p. 608)
Relevant Operations• DescribeImages
ContentsThe following table describes the elements contained in DescribeImagesExecutableBySetType.
DescriptionName
Information for one user.
Type: DescribeImagesExecutableByType (p. 602)
item
DescribeImagesExecutableByTypeThe DescribeImagesExecutableByType data type.
API Version 2010-08-31602
Amazon Elastic Compute Cloud API ReferenceAncestors
Ancestors• DescribeImagesExecutableBySetType (p. 602)
Relevant Operations• DescribeImages
ContentsThe following table describes the elements contained in DescribeImagesExecutableByType.
DescriptionName
Returns AMIs for which the specified user ID has explicit launchpermissions.The user ID can be an AWS account ID, self to returnAMIs for which the sender of the request has explicit launchpermissions, or all to return AMIs with public launch permissions.
Type: xsd:string
user
DescribeImagesInfoTypeThe DescribeImagesInfoType data type.
Ancestors• DescribeImagesType (p. 608)
Relevant Operations• DescribeImages
ContentsThe following table describes the elements contained in DescribeImagesInfoType.
DescriptionName
Information for one image.
Type: DescribeImagesItemType (p. 603)
item
DescribeImagesItemTypeThe DescribeImagesItemType data type.
API Version 2010-08-31603
Amazon Elastic Compute Cloud API ReferenceAncestors
Ancestors• DescribeImagesInfoType (p. 603)
Relevant Operations• DescribeImages
ContentsThe following table describes the elements contained in DescribeImagesItemType.
DescriptionName
AMI IDs to describe.
Type: xsd:string
imageId
DescribeImagesOwnersTypeThe DescribeImagesOwnersType data type.
Ancestors• DescribeImagesType (p. 608)
Relevant Operations• DescribeImages
ContentsThe following table describes the elements contained in DescribeImagesOwnersType.
DescriptionName
Information for one owner.
Type: DescribeImagesOwnerType (p. 604)
item
DescribeImagesOwnerTypeThe DescribeImagesOwnerType data type.
API Version 2010-08-31604
Amazon Elastic Compute Cloud API ReferenceAncestors
Ancestors• DescribeImagesOwnersType (p. 604)
Relevant Operations• DescribeImages
ContentsThe following table describes the elements contained in DescribeImagesOwnerType.
DescriptionName
Returns AMIs owned by the specified owner. Multiple owners canbe specified.The IDs amazon and self can be used to include AMIsowned by Amazon or AMIs owned by you, respectively.
Type: xsd:string
owner
DescribeImagesResponseInfoTypeThe DescribeImagesResponseInfoType data type.
Ancestors• DescribeImagesResponseType (p. 607)
Relevant Operations• DescribeImages
ContentsThe following table describes the elements contained in DescribeImagesResponseInfoType.
DescriptionName
Information for one image.
Type: DescribeImagesResponseItemType (p. 605)
item
DescribeImagesResponseItemTypeThe DescribeImagesResponseItemType data type.
API Version 2010-08-31605
Amazon Elastic Compute Cloud API ReferenceAncestors
Ancestors• DescribeImagesResponseInfoType (p. 605)
Relevant Operations• DescribeImages
ContentsThe following table describes the elements contained in DescribeImagesResponseItemType.
DescriptionName
The architecture of the image.
Type: xsd:string
architecture
Specifies how block devices are exposed to the instance.
Type: BlockDeviceMappingType (p. 568)
blockDeviceMapping
The description of the AMI that was provided during image creation.
Type: xsd:string
description
The ID of the AMI.
Type: xsd:string
imageId
The location of the AMI.
Type: xsd:string
imageLocation
The AWS account alias (e.g., "amazon", "redhat", "self", etc.) or AWSaccount ID that owns the AMI.
Type: xsd:string
imageOwnerAlias
AWS account ID of the image owner.
Type: xsd:string
imageOwnerId
Current state of the AMI. If the operation returns available, the imageis successfully registered and available for launching. If the operationreturns deregistered, the image is deregistered and no longeravailable for launching.
Type: xsd:string
imageState
The type of image (machine, kernel, or ramdisk).
Type: xsd:string
imageType
Returns true if this image has public launch permissions. Returnsfalse if it only has implicit and explicit launch permissions.
Type: xsd:boolean
isPublic
API Version 2010-08-31606
Amazon Elastic Compute Cloud API ReferenceAncestors
DescriptionName
The kernel associated with the image, if any. Only applicable formachine images.
Type: xsd:string
kernelId
The name of the AMI that was provided during image creation.
Type: xsd:string
name
The operating platform of the instance.
Type: xsd:string
platform
Product codes of the AMI.
Type: ProductCodesSetType (p. 674)
productCodes
The RAM disk associated with the image, if any. Only applicable formachine images.
Type: xsd:string
ramdiskId
The root device name (e.g., /dev/sda1).
Type: xsd:string
rootDeviceName
The root device type used by the AMI. The AMI can use an AmazonEBS or instance store root device.
Type: xsd:string
rootDeviceType
The reason for the state change.
Type: StateReasonType (p. 704)
stateReason
DescribeImagesResponseTypeThe DescribeImagesResponseType data type.
AncestorsNone
Relevant Operations• DescribeImages
ContentsThe following table describes the elements contained in DescribeImagesResponseType.
DescriptionName
Image set.
Type: DescribeImagesResponseInfoType (p. 605)
imagesSet
API Version 2010-08-31607
Amazon Elastic Compute Cloud API ReferenceDescribeImagesResponseType
DescriptionName
The ID of the request.
Type: xsd:string
requestId
DescribeImagesTypeThe DescribeImagesType data type.
AncestorsNone
Relevant Operations• DescribeImages
ContentsThe following table describes the elements contained in DescribeImagesType.
DescriptionName
Executable set.
Type: DescribeImagesExecutableBySetType (p. 602)
executableBySet
Image set.
Type: DescribeImagesInfoType (p. 603)
imagesSet
Information about an owner.
Type: DescribeImagesOwnersType (p. 604)
ownersSet
DescribeInstanceAttributeResponseTypeThe DescribeInstanceAttributeResponseType data type.
AncestorsNone
Relevant Operations• DescribeInstanceAttribute
API Version 2010-08-31608
Amazon Elastic Compute Cloud API ReferenceDescribeImagesType
ContentsThe following table describes the elements contained in DescribeInstanceAttributeResponseType.
DescriptionName
Specifies how block devices are exposed to the instance. Eachmapping is made up of a virtualName and a deviceName.
Type: InstanceBlockDeviceMappingResponseType (p. 650)
blockDeviceMapping
Specifies whether the instance can be terminated.You must modifythis attribute before you can terminate any "locked" instances.
Type: NullableAttributeBooleanValueType (p. 670)
disableApiTermination
The ID of the instance.
Type: xsd:string
instanceId
If an instance shutdown is initiated, this determines whether theinstance stops or terminates.
Type: NullableAttributeValueType (p. 670)
instanceInitiatedShutdownBehavior
The instance type (e.g., m1.small, c1.medium, m2.2xlarge, and soon).
Type: NullableAttributeValueType (p. 670)
instanceType
The kernel ID.
Type: NullableAttributeValueType (p. 670)
kernel
The RAM disk ID.
Type: NullableAttributeValueType (p. 670)
ramdisk
The ID of the request.
Type: xsd:string
requestId
The root device name (e.g., /dev/sda1).
Type: NullableAttributeValueType (p. 670)
rootDeviceName
MIME, Base64-encoded user data.
Type: NullableAttributeValueType (p. 670)
userData
DescribeInstanceAttributesGroupThe DescribeInstanceAttributesGroup data type.
Ancestors• DescribeInstanceAttributeType (p. 610)
API Version 2010-08-31609
Amazon Elastic Compute Cloud API ReferenceContents
Relevant Operations• DescribeInstanceAttribute
ContentsThe following table describes the elements contained in DescribeInstanceAttributesGroup.
DescriptionName
Block device mapping set.
Type: EmptyElementType (p. 644)
blockDeviceMapping
Specifies whether the instance can be terminated.You must modifythis attribute before you can terminate any "locked" instances.
Type: EmptyElementType (p. 644)
disableApiTermination
If an instance shutdown is initiated, this determines whether theinstance stops or terminates.
Type: EmptyElementType (p. 644)
instanceInitiatedShutdownBehavior
The instance type (e.g., m1.small, c1.medium, m2.2xlarge, and soon).
Type: EmptyElementType (p. 644)
instanceType
The kernel ID.
Type: EmptyElementType (p. 644)
kernel
The RAM disk ID.
Type: EmptyElementType (p. 644)
ramdisk
The root device name (e.g., /dev/sda1).
Type: EmptyElementType (p. 644)
rootDeviceName
MIME, Base64-encoded user data.
Type: EmptyElementType (p. 644)
userData
DescribeInstanceAttributeTypeThe DescribeInstanceAttributeType data type.
AncestorsNone
Relevant Operations• DescribeInstanceAttribute
API Version 2010-08-31610
Amazon Elastic Compute Cloud API ReferenceRelevant Operations
ContentsThe following table describes the elements contained in DescribeInstanceAttributeType.
DescriptionName
The group of attributes to describe.
Type: DescribeInstanceAttributesGroup (p. 609)
DescribeInstanceAttributesGroup
The instance ID.
Type: xsd:string
instanceId
DescribeInstancesInfoTypeThe DescribeInstancesInfoType data type.
Ancestors• DescribeInstancesType (p. 612)
Relevant Operations• DescribeInstances
ContentsThe following table describes the elements contained in DescribeInstancesInfoType.
DescriptionName
Information for one instance set.
Type: DescribeInstancesItemType (p. 611)
item
DescribeInstancesItemTypeThe DescribeInstancesItemType data type.
Ancestors• DescribeInstancesInfoType (p. 611)
Relevant Operations• DescribeInstances
API Version 2010-08-31611
Amazon Elastic Compute Cloud API ReferenceContents
ContentsThe following table describes the elements contained in DescribeInstancesItemType.
DescriptionName
Instance IDs to describe.
Type: xsd:string
instanceId
DescribeInstancesResponseTypeThe DescribeInstancesResponseType data type.
AncestorsNone
Relevant Operations• DescribeInstances
ContentsThe following table describes the elements contained in DescribeInstancesResponseType.
DescriptionName
The ID of the request.
Type: xsd:string
requestId
Reservation set.
Type: ReservationSetType (p. 685)
reservationSet
DescribeInstancesTypeThe DescribeInstancesType data type.
AncestorsNone
Relevant Operations• DescribeInstances
API Version 2010-08-31612
Amazon Elastic Compute Cloud API ReferenceContents
ContentsThe following table describes the elements contained in DescribeInstancesType.
DescriptionName
Instances set.
Type: DescribeInstancesInfoType (p. 611)
instancesSet
DescribeKeyPairsInfoTypeThe DescribeKeyPairsInfoType data type.
Ancestors• DescribeKeyPairsType (p. 615)
Relevant Operations• DescribeKeyPairs
ContentsThe following table describes the elements contained in DescribeKeyPairsInfoType.
DescriptionName
Information for a key pair.
Type: DescribeKeyPairsItemType (p. 613)
item
DescribeKeyPairsItemTypeThe DescribeKeyPairsItemType data type.
Ancestors• DescribeKeyPairsInfoType (p. 613)
Relevant Operations• DescribeKeyPairs
API Version 2010-08-31613
Amazon Elastic Compute Cloud API ReferenceContents
ContentsThe following table describes the elements contained in DescribeKeyPairsItemType.
DescriptionName
Key pair to describe.
Type: xsd:string
keyName
DescribeKeyPairsResponseInfoTypeThe DescribeKeyPairsResponseInfoType data type.
Ancestors• DescribeKeyPairsResponseType (p. 615)
Relevant Operations• DescribeKeyPairs
ContentsThe following table describes the elements contained in DescribeKeyPairsResponseInfoType.
DescriptionName
Information for a key pair.
Type: DescribeKeyPairsResponseItemType (p. 614)
item
DescribeKeyPairsResponseItemTypeThe DescribeKeyPairsResponseItemType data type.
Ancestors• DescribeKeyPairsResponseInfoType (p. 614)
Relevant Operations• DescribeKeyPairs
API Version 2010-08-31614
Amazon Elastic Compute Cloud API ReferenceContents
ContentsThe following table describes the elements contained in DescribeKeyPairsResponseItemType.
DescriptionName
A SHA-1 digest of the DER encoded private key.
Type: xsd:string
keyFingerprint
The key pair name provided in the original request.
Type: xsd:string
keyName
DescribeKeyPairsResponseTypeThe DescribeKeyPairsResponseType data type.
AncestorsNone
Relevant Operations• DescribeKeyPairs
ContentsThe following table describes the elements contained in DescribeKeyPairsResponseType.
DescriptionName
Information for a key pair.
Type: DescribeKeyPairsResponseInfoType (p. 614)
keySet
The ID of the request.
Type: xsd:string
requestId
DescribeKeyPairsTypeThe DescribeKeyPairsType data type.
AncestorsNone
Relevant Operations• DescribeKeyPairs
API Version 2010-08-31615
Amazon Elastic Compute Cloud API ReferenceContents
ContentsThe following table describes the elements contained in DescribeKeyPairsType.
DescriptionName
Set of key pairs.
Type: DescribeKeyPairsInfoType (p. 613)
keySet
DescribePlacementGroupInfoTypeSee DescribePlacementGroups (p. 389).
DescribePlacementGroupItemTypeSee DescribePlacementGroups (p. 389).
DescribePlacementGroupsResponseTypeFor Query, see DescribePlacementGroups (p. 125).
For SOAP, see DescribePlacementGroups (p. 389).
DescribePlacementGroupsTypeSee DescribePlacementGroups (p. 389).
DescribeRegionsResponseTypeThe DescribeRegionsResponseType data type.
AncestorsNone
Relevant Operations• DescribeRegions
ContentsThe following table describes the elements contained in DescribeRegionsResponseType.
API Version 2010-08-31616
Amazon Elastic Compute Cloud API ReferenceContents
DescriptionName
Region set.
Type: RegionSetType (p. 680)
regionInfo
The ID of the request.
Type: xsd:string
requestId
DescribeRegionsSetItemTypeThe DescribeRegionsSetItemType data type.
Ancestors• DescribeRegionsSetType (p. 617)
Relevant Operations• DescribeRegions
ContentsThe following table describes the elements contained in DescribeRegionsSetItemType.
DescriptionName
Name of a Region.
Type: xsd:string
regionName
DescribeRegionsSetTypeThe DescribeRegionsSetType data type.
Ancestors• DescribeRegionsType (p. 618)
Relevant Operations• DescribeRegions
ContentsThe following table describes the elements contained in DescribeRegionsSetType.
API Version 2010-08-31617
Amazon Elastic Compute Cloud API ReferenceDescribeRegionsSetItemType
DescriptionName
Information for a Region.
Type: DescribeRegionsSetItemType (p. 617)
item
DescribeRegionsTypeThe DescribeRegionsType data type.
AncestorsNone
Relevant Operations• DescribeRegions
ContentsThe following table describes the elements contained in DescribeRegionsType.
DescriptionName
Set of Regions.
Type: DescribeRegionsSetType (p. 617)
regionSet
DescribeReservedInstancesOfferingsResponseSetItemTypeThe DescribeReservedInstancesOfferingsResponseSetItemType data type.
Ancestors• DescribeReservedInstancesOfferingsResponseSetType (p. 619)
Relevant Operations• DescribeReservedInstancesOfferings
ContentsThe following table describes the elements contained inDescribeReservedInstancesOfferingsResponseSetItemType.
API Version 2010-08-31618
Amazon Elastic Compute Cloud API ReferenceDescribeRegionsType
DescriptionName
The Availability Zone in which the Reserved Instance can be used.
Type: xsd:string
availabilityZone
The duration of the Reserved Instance, in seconds.
Type: xs:long
duration
The purchase price of the Reserved Instance.
Type: xs:double
fixedPrice
The instance type on which the Reserved Instance can be used.
Type: xsd:string
instanceType
The Reserved Instance description.
Valid Values: Linux/UNIX | Linux/UNIX (Amazon VPC) |Windows | Windows (Amazon VPC)
Type: xsd:string
productDescription
The ID of the Reserved Instance offering.
Type: xsd:string
reservedInstancesOfferingId
The usage price of the Reserved Instance, per hour.
Type: xs:double
usagePrice
DescribeReservedInstancesOfferingsResponseSetTypeThe DescribeReservedInstancesOfferingsResponseSetType data type.
Ancestors• DescribeReservedInstancesOfferingsResponseType (p. 620)
Relevant Operations• DescribeReservedInstancesOfferings
ContentsThe following table describes the elements contained inDescribeReservedInstancesOfferingsResponseSetType.
DescriptionName
Reserved Instance offerings set.
Type:DescribeReservedInstancesOfferingsResponseSetItemType (p. 618)
item
API Version 2010-08-31619
Amazon Elastic Compute Cloud API ReferenceDescribeReservedInstancesOfferingsResponseSetType
DescribeReservedInstancesOfferingsResponseTypeThe DescribeReservedInstancesOfferingsResponseType data type.
AncestorsNone
Relevant Operations• DescribeReservedInstancesOfferings
ContentsThe following table describes the elements contained inDescribeReservedInstancesOfferingsResponseType.
DescriptionName
The ID of the request.
Type: xsd:string
requestId
Reserved Instances offerings set.
Type:DescribeReservedInstancesOfferingsResponseSetType (p.619)
reservedInstancesOfferingsSet
DescribeReservedInstancesOfferingsSetItemTypeThe DescribeReservedInstancesOfferingsSetItemType data type.
Ancestors• DescribeReservedInstancesOfferingsSetType (p. 621)
Relevant Operations• DescribeReservedInstancesOfferings
ContentsThe following table describes the elements contained in DescribeReservedInstancesOfferingsSetItemType.
DescriptionName
ID of the Reserved Instances to describe.
Type: xsd:string
reservedInstancesOfferingId
API Version 2010-08-31620
Amazon Elastic Compute Cloud API ReferenceDescribeReservedInstancesOfferingsResponseType
DescribeReservedInstancesOfferingsSetTypeThe DescribeReservedInstancesOfferingsSetType data type.
Ancestors• DescribeReservedInstancesOfferingsType (p. 621)
Relevant Operations• DescribeReservedInstancesOfferings
ContentsThe following table describes the elements contained in DescribeReservedInstancesOfferingsSetType.
DescriptionName
Reserved Instances item.
Type: DescribeReservedInstancesOfferingsSetItemType (p. 620)
item
DescribeReservedInstancesOfferingsTypeThe DescribeReservedInstancesOfferingsType data type.
AncestorsNone
Relevant Operations• DescribeReservedInstancesOfferings
ContentsThe following table describes the elements contained in DescribeReservedInstancesOfferingsType.
DescriptionName
The Availability Zone in which the Reserved Instance can be used.
Type: xsd:string
availabilityZone
The instance type on which the Reserved Instance can be used.
Type: xsd:string
instanceType
API Version 2010-08-31621
Amazon Elastic Compute Cloud API ReferenceDescribeReservedInstancesOfferingsSetType
DescriptionName
The Reserved Instance description.
Type: xsd:string
Valid Values: Linux/UNIX | Linux/UNIX (Amazon VPC) |Windows | Windows (Amazon VPC)
productDescription
Set of Reserved Instances.
Type: DescribeReservedInstancesOfferingsSetType (p. 621)
reservedInstancesOfferingsSet
DescribeReservedInstancesResponseSetItemTypeThe DescribeReservedInstancesResponseSetItemType data type.
Ancestors• DescribeReservedInstancesResponseSetType (p. 623)
Relevant Operations• DescribeReservedInstances
ContentsThe following table describes the elements contained in DescribeReservedInstancesResponseSetItemType.
DescriptionName
The Availability Zone in which the Reserved Instance can be used.
Type: xsd:string
availabilityZone
The duration of the Reserved Instance, in seconds.
Type: xs:long
duration
The purchase price of the Reserved Instance.
Type: xs:double
fixedPrice
The number of Reserved Instances purchased.
Type: xs:integer
instanceCount
The instance type on which the Reserved Instance can be used.
Type: xsd:string
instanceType
The Reserved Instance description.
Valid Values: Linux/UNIX | Linux/UNIX (Amazon VPC) |Windows | Windows (Amazon VPC)
Type: xsd:string
productDescription
API Version 2010-08-31622
Amazon Elastic Compute Cloud API ReferenceDescribeReservedInstancesResponseSetItemType
DescriptionName
The ID of the Reserved Instance.
Type: xsd:string
reservedInstancesId
The date and time the Reserved Instance started.
Type: xsd:dateTime
start
The state of the Reserved Instance purchase.
Type: xsd:string
state
The usage price of the Reserved Instance, per hour.
Type: xs:double
usagePrice
DescribeReservedInstancesResponseSetTypeThe DescribeReservedInstancesResponseSetType data type.
Ancestors• DescribeReservedInstancesResponseType (p. 623)
Relevant Operations• DescribeReservedInstances
ContentsThe following table describes the elements contained in DescribeReservedInstancesResponseSetType.
DescriptionName
Reserved Instance set.
Type: DescribeReservedInstancesResponseSetItemType (p. 622)
item
DescribeReservedInstancesResponseTypeThe DescribeReservedInstancesResponseType data type.
AncestorsNone
Relevant Operations• DescribeReservedInstances
API Version 2010-08-31623
Amazon Elastic Compute Cloud API ReferenceDescribeReservedInstancesResponseSetType
ContentsThe following table describes the elements contained in DescribeReservedInstancesResponseType.
DescriptionName
The ID of the request.
Type: xsd:string
requestId
Reserved Instances set.
Type: DescribeReservedInstancesResponseSetType (p. 623)
reservedInstancesSet
DescribeReservedInstancesSetItemTypeThe DescribeReservedInstancesSetItemType data type.
Ancestors• DescribeReservedInstancesSetType (p. 624)
Relevant Operations• DescribeReservedInstances
ContentsThe following table describes the elements contained in DescribeReservedInstancesSetItemType.
DescriptionName
IDs of the Reserved Instance to describe.
Type: xsd:string
reservedInstancesId
DescribeReservedInstancesSetTypeThe DescribeReservedInstancesSetType data type.
Ancestors• DescribeReservedInstancesType (p. 625)
Relevant Operations• DescribeReservedInstances
API Version 2010-08-31624
Amazon Elastic Compute Cloud API ReferenceContents
ContentsThe following table describes the elements contained in DescribeReservedInstancesSetType.
DescriptionName
Reserved Instances item.
Type: DescribeReservedInstancesSetItemType (p. 624)
item
DescribeReservedInstancesTypeThe DescribeReservedInstancesType data type.
AncestorsNone
Relevant Operations• DescribeReservedInstances
ContentsThe following table describes the elements contained in DescribeReservedInstancesType.
DescriptionName
Set of Reserved Instances.
Type: DescribeReservedInstancesSetType (p. 624)
reservedInstancesSet
DescribeSecurityGroupsResponseTypeThe DescribeSecurityGroupsResponseType data type.
AncestorsNone
Relevant Operations• DescribeSecurityGroups
ContentsThe following table describes the elements contained in DescribeSecurityGroupsResponseType.
API Version 2010-08-31625
Amazon Elastic Compute Cloud API ReferenceContents
DescriptionName
The ID of the request.
Type: xsd:string
requestId
Security group set.
Type: SecurityGroupSetType (p. 697)
securityGroupInfo
DescribeSecurityGroupsSetItemTypeThe DescribeSecurityGroupsSetItemType data type.
Ancestors• DescribeSecurityGroupsSetType (p. 626)
Relevant Operations• DescribeSecurityGroups
ContentsThe following table describes the elements contained in DescribeSecurityGroupsSetItemType.
DescriptionName
Name of the security group.
Type: xsd:string
groupName
DescribeSecurityGroupsSetTypeThe DescribeSecurityGroupsSetType data type.
Ancestors• DescribeSecurityGroupsType (p. 627)
Relevant Operations• DescribeSecurityGroups
ContentsThe following table describes the elements contained in DescribeSecurityGroupsSetType.
API Version 2010-08-31626
Amazon Elastic Compute Cloud API ReferenceDescribeSecurityGroupsSetItemType
DescriptionName
Information for a security group.
Type: DescribeSecurityGroupsSetItemType (p. 626)
item
DescribeSecurityGroupsTypeThe DescribeSecurityGroupsType data type.
AncestorsNone
Relevant Operations• DescribeSecurityGroups
ContentsThe following table describes the elements contained in DescribeSecurityGroupsType.
DescriptionName
Set of security groups.
Type: DescribeSecurityGroupsSetType (p. 626)
securityGroupSet
DescribeSnapshotAttributeResponseTypeThe DescribeSnapshotAttributeResponseType data type.
AncestorsNone
Relevant Operations• DescribeSnapshotAttribute
ContentsThe following table describes the elements contained in DescribeSnapshotAttributeResponseType.
API Version 2010-08-31627
Amazon Elastic Compute Cloud API ReferenceDescribeSecurityGroupsType
DescriptionName
Create volume permission element.
Type: CreateVolumePermissionListType (p. 585)
createVolumePermission
The ID of the request.
Type: xsd:string
requestId
The ID of the Amazon EBS snapshot.
Type: xsd:string
snapshotId
DescribeSnapshotAttributesGroupThe DescribeSnapshotAttributesGroup data type.
Ancestors• DescribeSnapshotAttributeType (p. 628)
Relevant Operations• DescribeSnapshotAttribute
ContentsThe following table describes the elements contained in DescribeSnapshotAttributesGroup.
DescriptionName
Describes the snapshot attributes group.
Type: EmptyElementType (p. 644)
createVolumePermission
DescribeSnapshotAttributeTypeThe DescribeSnapshotAttributeType data type.
AncestorsNone
Relevant Operations• DescribeSnapshotAttribute
API Version 2010-08-31628
Amazon Elastic Compute Cloud API ReferenceDescribeSnapshotAttributesGroup
ContentsThe following table describes the elements contained in DescribeSnapshotAttributeType.
DescriptionName
Describe snapshot attribute element.
Type: DescribeSnapshotAttributesGroup (p. 628)
DescribeSnapshotAttributesGroup
The ID of the Amazon EBS snapshot.
Type: xsd:string
snapshotId
DescribeSnapshotsOwnersTypeThe DescribeSnapshotsOwnersType data type.
Ancestors• DescribeSnapshotsType (p. 634)
Relevant Operations• DescribeSnapshots
ContentsThe following table describes the elements contained in DescribeSnapshotsOwnersType.
DescriptionName
Describe snapshot item.
Type: DescribeSnapshotsOwnerType (p. 629)
item
DescribeSnapshotsOwnerTypeThe DescribeSnapshotsOwnerType data type.
Ancestors• DescribeSnapshotsOwnersType (p. 629)
Relevant Operations• DescribeSnapshots
API Version 2010-08-31629
Amazon Elastic Compute Cloud API ReferenceContents
ContentsThe following table describes the elements contained in DescribeSnapshotsOwnerType.
DescriptionName
Returns snapshots owned by the specified owner. Multiple ownerscan be specified.
Type: xsd:string
owner
DescribeSnapshotsResponseTypeThe DescribeSnapshotsResponseType data type.
AncestorsNone
Relevant Operations• DescribeSnapshots
ContentsThe following table describes the elements contained in DescribeSnapshotsResponseType.
DescriptionName
The ID of the request.
Type: xsd:string
requestId
Snapshot set.
Type: DescribeSnapshotsSetResponseType (p. 633)
snapshotSet
DescribeSnapshotsRestorableBySetTypeThe DescribeSnapshotsRestorableBySetType data type.
Ancestors• DescribeSnapshotsType (p. 634)
Relevant Operations• DescribeSnapshots
API Version 2010-08-31630
Amazon Elastic Compute Cloud API ReferenceContents
ContentsThe following table describes the elements contained in DescribeSnapshotsRestorableBySetType.
DescriptionName
Restorable by set type item.
Type: DescribeSnapshotsRestorableByType (p. 631)
item
DescribeSnapshotsRestorableByTypeThe DescribeSnapshotsRestorableByType data type.
Ancestors• DescribeSnapshotsRestorableBySetType (p. 630)
Relevant Operations• DescribeSnapshots
ContentsThe following table describes the elements contained in DescribeSnapshotsRestorableByType.
DescriptionName
ID of an AWS account that can create volumes from the snapshot.
Type: xsd:string
user
DescribeSnapshotsSetItemResponseTypeThe DescribeSnapshotsSetItemResponseType data type.
Ancestors• DescribeSnapshotsSetResponseType (p. 633)
Relevant Operations• DescribeSnapshots
API Version 2010-08-31631
Amazon Elastic Compute Cloud API ReferenceContents
ContentsThe following table describes the elements contained in DescribeSnapshotsSetItemResponseType.
DescriptionName
Description of the snapshot.
Type: xsd:string
description
The AWS account alias (e.g., "amazon", "redhat", "self", etc.) or AWSaccount ID that owns the AMI.
Type: xsd:string
ownerAlias
ID of the AWS account that owns the snapshot.
Type: xsd:string
ownerId
The progress of the snapshot, in percentage.
Type: xsd:string
progress
The ID of the snapshot.
Type: xsd:string
snapshotId
Time stamp when the snapshot was initiated.
Type: xsd:dateTime
startTime
Snapshot state (e.g., pending, completed, or error)
Type: xsd:string
status
The ID of the volume.
Type: xsd:string
volumeId
The size of the volume, in GiB.
Type: xsd:string
volumeSize
DescribeSnapshotsSetItemTypeThe DescribeSnapshotsSetItemType data type.
Ancestors• DescribeSnapshotsSetType (p. 633)
Relevant Operations• DescribeSnapshots
ContentsThe following table describes the elements contained in DescribeSnapshotsSetItemType.
API Version 2010-08-31632
Amazon Elastic Compute Cloud API ReferenceContents
DescriptionName
The ID of the Amazon EBS snapshot.
Type: xsd:string
snapshotId
DescribeSnapshotsSetResponseTypeThe DescribeSnapshotsSetResponseType data type.
Ancestors• DescribeSnapshotsResponseType (p. 630)
Relevant Operations• DescribeSnapshots
ContentsThe following table describes the elements contained in DescribeSnapshotsSetResponseType.
DescriptionName
Information for a snapshot.
Type: DescribeSnapshotsSetItemResponseType (p. 631)
item
DescribeSnapshotsSetTypeThe DescribeSnapshotsSetType data type.
Ancestors• DescribeSnapshotsType (p. 634)
Relevant Operations• DescribeSnapshots
ContentsThe following table describes the elements contained in DescribeSnapshotsSetType.
API Version 2010-08-31633
Amazon Elastic Compute Cloud API ReferenceDescribeSnapshotsSetResponseType
DescriptionName
Information for a snapshot.
Type: DescribeSnapshotsSetItemType (p. 632)
item
DescribeSnapshotsTypeThe DescribeSnapshotsType data type.
AncestorsNone
Relevant Operations• DescribeSnapshots
ContentsThe following table describes the elements contained in DescribeSnapshotsType.
DescriptionName
Set of owners that can create volumes from the instance.
Type: DescribeSnapshotsOwnersType (p. 629)
ownersSet
Set of users that can create volumes from the snapshot.
Type: DescribeSnapshotsRestorableBySetType (p. 630)
restorableBySet
Set of snapshots.
Type: DescribeSnapshotsSetType (p. 633)
snapshotSet
DescribeSpotDatafeedSubscriptionResponseTypeThe DescribeSpotDatafeedSubscriptionResponseType data type.
AncestorsNone
Relevant Operations• DescribeSpotDatafeedSubscription
API Version 2010-08-31634
Amazon Elastic Compute Cloud API ReferenceDescribeSnapshotsType
ContentsThe following table describes the elements contained in DescribeSpotDatafeedSubscriptionResponseType.
DescriptionName
The ID of the request.
Type: xsd:string
requestId
The Spot Instance datafeed subscription.
Type: SpotDatafeedSubscriptionType (p. 698)
spotDatafeedSubscription
DescribeSpotInstanceRequestsResponseTypeThe DescribeSpotInstanceRequestsResponseType data type.
AncestorsNone
Relevant Operations• DescribeSpotInstanceRequests
ContentsThe following table describes the elements contained in DescribeSpotInstanceRequestsResponseType.
DescriptionName
The ID of the request.
Type: xsd:string
requestId
Spot Instance request set.
Type: SpotInstanceRequestSetType (p. 701)
spotInstanceRequestSet
DescribeSpotInstanceRequestsTypeThe DescribeSpotInstanceRequestsType data type.
AncestorsNone
Relevant Operations• DescribeSpotInstanceRequests
API Version 2010-08-31635
Amazon Elastic Compute Cloud API ReferenceContents
ContentsThe following table describes the elements contained in DescribeSpotInstanceRequestsType.
DescriptionName
The Spot Instance requests.
Type: SpotInstanceRequestIdSetType (p. 699)
spotInstanceRequestIdSet
DescribeSpotPriceHistoryResponseTypeThe DescribeSpotPriceHistoryResponseType data type.
AncestorsNone
Relevant Operations• DescribeSpotPriceHistory
ContentsThe following table describes the elements contained in DescribeSpotPriceHistoryResponseType.
DescriptionName
The ID of the request.
Type: xsd:string
requestId
Spot Price history set.
Type: SpotPriceHistorySetType (p. 703)
spotPriceHistorySet
DescribeSpotPriceHistoryTypeThe DescribeSpotPriceHistoryType data type.
AncestorsNone
Relevant Operations• DescribeSpotPriceHistory
API Version 2010-08-31636
Amazon Elastic Compute Cloud API ReferenceContents
ContentsThe following table describes the elements contained in DescribeSpotPriceHistoryType.
DescriptionName
End date and time of the Spot Instance price history data.
Type: xsd:dateTime
endTime
The instance type set.
Type: InstanceTypeSetType (p. 656)
instanceTypeSet
The product description set.
Type: ProductDescriptionSetType (p. 676)
productDescriptionSet
Start date and time of the Spot Instance price history data.
Type: xsd:dateTime
startTime
DescribeVolumesResponseTypeThe DescribeVolumesResponseType data type.
AncestorsNone
Relevant Operations• DescribeVolumes
ContentsThe following table describes the elements contained in DescribeVolumesResponseType.
DescriptionName
The ID of the request.
Type: xsd:string
requestId
Volume set.
Type: DescribeVolumesSetResponseType (p. 639)
volumeSet
DescribeVolumesSetItemResponseTypeThe DescribeVolumesSetItemResponseType data type.
API Version 2010-08-31637
Amazon Elastic Compute Cloud API ReferenceContents
Ancestors• DescribeVolumesSetResponseType (p. 639)
Relevant Operations• DescribeVolumes
ContentsThe following table describes the elements contained in DescribeVolumesSetItemResponseType.
DescriptionName
Attachment set.
Type: AttachmentSetResponseType (p. 561)
attachmentSet
Availability Zone in which the volume was created.
Type: xsd:string
availabilityZone
Time stamp when volume creation was initiated.
Type: xsd:dateTime
createTime
The size of the volume, in GiBs.
Type: xsd:string
size
Snapshot from which the volume was created (optional).
Type: xsd:string
snapshotId
Volume state (e.g., creating, available)
Type: xsd:string
status
The ID of the volume.
Type: xsd:string
volumeId
DescribeVolumesSetItemTypeThe DescribeVolumesSetItemType data type.
Ancestors• DescribeVolumesSetType (p. 639)
Relevant Operations• DescribeVolumes
API Version 2010-08-31638
Amazon Elastic Compute Cloud API ReferenceAncestors
ContentsThe following table describes the elements contained in DescribeVolumesSetItemType.
DescriptionName
The ID of the volume to list.
Type: xsd:string
volumeId
DescribeVolumesSetResponseTypeThe DescribeVolumesSetResponseType data type.
Ancestors• DescribeVolumesResponseType (p. 637)
Relevant Operations• DescribeVolumes
ContentsThe following table describes the elements contained in DescribeVolumesSetResponseType.
DescriptionName
Information for a volume.
Type: DescribeVolumesSetItemResponseType (p. 637)
item
DescribeVolumesSetTypeThe DescribeVolumesSetType data type.
Ancestors• DescribeVolumesType (p. 640)
Relevant Operations• DescribeVolumes
API Version 2010-08-31639
Amazon Elastic Compute Cloud API ReferenceContents
ContentsThe following table describes the elements contained in DescribeVolumesSetType.
DescriptionName
Information for a volume.
Type: DescribeVolumesSetItemType (p. 638)
item
DescribeVolumesTypeThe DescribeVolumesType data type.
AncestorsNone
Relevant Operations• DescribeVolumes
ContentsThe following table describes the elements contained in DescribeVolumesType.
DescriptionName
Set of volumes.
Type: DescribeVolumesSetType (p. 639)
volumeSet
DetachVolumeResponseTypeThe DetachVolumeResponseType data type.
AncestorsNone
Relevant Operations• DetachVolume
ContentsThe following table describes the elements contained in DetachVolumeResponseType.
API Version 2010-08-31640
Amazon Elastic Compute Cloud API ReferenceContents
DescriptionName
Time stamp when the attachment initiated.
Type: xsd:dateTime
attachTime
The device as it is exposed to the instance.
Type: xsd:string
device
The ID of the instance.
Type: xsd:string
instanceId
The ID of the request.
Type: xsd:string
requestId
Attachment state.
Type: xsd:string
status
The ID of the volume.
Type: xsd:string
volumeId
DetachVolumeTypeThe DetachVolumeType data type.
AncestorsNone
Relevant Operations• DetachVolume
ContentsThe following table describes the elements contained in DetachVolumeType.
DescriptionName
The device name.
Type: xsd:string
device
Forces detachment if the previous detachment attempt did not occurcleanly (logging into an instance, unmounting the volume, anddetaching normally).This option can lead to data loss or a corruptedfile system. Use this option only as a last resort to detach a volumefrom a failed instance. The instance will not have an opportunity toflush file system caches nor file system meta data. If you use thisoption, you must perform file system check and repair procedures.
Type: xsd:boolean
force
API Version 2010-08-31641
Amazon Elastic Compute Cloud API ReferenceDetachVolumeType
DescriptionName
The ID of the instance.
Type: xsd:string
instanceId
The ID of the volume.
Type: xsd:string
volumeId
DisassociateAddressResponseTypeThe DisassociateAddressResponseType data type.
AncestorsNone
Relevant Operations• DisassociateAddress
ContentsThe following table describes the elements contained in DisassociateAddressResponseType.
DescriptionName
The ID of the request.
Type: xsd:string
requestId
Returns true if the IP address is disassociated from the instance.Otherwise, returns an error.
Type: xsd:boolean
return
DisassociateAddressTypeThe DisassociateAddressType data type.
AncestorsNone
Relevant Operations• DisassociateAddress
API Version 2010-08-31642
Amazon Elastic Compute Cloud API ReferenceDisassociateAddressResponseType
ContentsThe following table describes the elements contained in DisassociateAddressType.
DescriptionName
IP address that you are disassociating from the instance.
Type: xsd:string
publicIp
EbsBlockDeviceTypeThe EbsBlockDeviceType data type.
Ancestors• BlockDeviceMappingItemType (p. 567)
Relevant Operations• DescribeImageAttribute
• DescribeImages
• RequestSpotInstances
• DescribeSpotInstanceRequests
• RequestSpotInstances
• RegisterImage
• RunInstances
ContentsThe following table describes the elements contained in EbsBlockDeviceType.
DescriptionName
Specifies whether the Amazon EBS volume is deleted on instancetermination.
Type: xsd:boolean
deleteOnTermination
The ID of the snapshot.
Type: xsd:string
snapshotId
The size of the volume, in GiBs. Required if you are not creating avolume from a snapshot.
Type: integer
volumeSize
API Version 2010-08-31643
Amazon Elastic Compute Cloud API ReferenceContents
EbsInstanceBlockDeviceMappingResponseTypeThe EbsInstanceBlockDeviceMappingResponseType data type.
Ancestors• InstanceBlockDeviceMappingResponseItemType (p. 650)
Relevant Operations• DescribeInstanceAttribute
• DescribeInstances
• RunInstances
ContentsThe following table describes the elements contained in EbsInstanceBlockDeviceMappingResponseType.
DescriptionName
Time stamp when the attachment initiated.
Type: xsd:dateTime
attachTime
Specifies whether the Amazon EBS volume is deleted on instancetermination.
Type: xsd:boolean
deleteOnTermination
Attachment state.
Type: xsd:string
status
The ID of the Amazon EBS volume.
Type: xsd:string
volumeId
EmptyElementTypeThe EmptyElementType data type.
Ancestors• BlockDeviceMappingItemType (p. 567)
• InstanceBlockDeviceMappingItemType (p. 649)
• DescribeImageAttributesGroup (p. 601)
• DescribeImageAttributesGroup (p. 601)
• DescribeImageAttributesGroup (p. 601)
• DescribeImageAttributesGroup (p. 601)
API Version 2010-08-31644
Amazon Elastic Compute Cloud API ReferenceEbsInstanceBlockDeviceMappingResponseType
• DescribeImageAttributesGroup (p. 601)
• DescribeImageAttributesGroup (p. 601)
• DescribeInstanceAttributesGroup (p. 609)
• DescribeInstanceAttributesGroup (p. 609)
• DescribeInstanceAttributesGroup (p. 609)
• DescribeInstanceAttributesGroup (p. 609)
• DescribeInstanceAttributesGroup (p. 609)
• DescribeInstanceAttributesGroup (p. 609)
• DescribeInstanceAttributesGroup (p. 609)
• DescribeInstanceAttributesGroup (p. 609)
• DescribeSnapshotAttributesGroup (p. 628)
• ResetImageAttributesGroup (p. 686)
• ResetImageAttributesGroup (p. 686)
• ResetInstanceAttributesGroup (p. 688)
• ResetInstanceAttributesGroup (p. 688)
• ResetSnapshotAttributesGroup (p. 689)
Relevant Operations• DescribeImageAttribute
• DescribeImages
• RequestSpotInstances
• DescribeSpotInstanceRequests
• RequestSpotInstances
• RegisterImage
• RunInstances
• ModifyInstanceAttribute
• DescribeImageAttribute
• DescribeInstanceAttribute
• DescribeSnapshotAttribute
• ResetImageAttribute
• ResetInstanceAttribute
• ResetSnapshotAttribute
ContentsThe following table describes the elements contained in EmptyElementType.
API Version 2010-08-31645
Amazon Elastic Compute Cloud API ReferenceRelevant Operations
DescriptionName
This element contains no options.
Type: xsd:string
none
GetConsoleOutputResponseTypeThe GetConsoleOutputResponseType data type.
AncestorsNone
Relevant Operations• GetConsoleOutput
ContentsThe following table describes the elements contained in GetConsoleOutputResponseType.
DescriptionName
The instance ID.
Type: xsd:string
instanceId
The console output, Base64 encoded.
Type: xsd:string
output
The ID of the request.
Type: xsd:string
requestId
The time the output was last updated.
Type: xsd:dateTime
timestamp
GetConsoleOutputTypeThe GetConsoleOutputType data type.
AncestorsNone
Relevant Operations• GetConsoleOutput
API Version 2010-08-31646
Amazon Elastic Compute Cloud API ReferenceGetConsoleOutputResponseType
ContentsThe following table describes the elements contained in GetConsoleOutputType.
DescriptionName
ID of the instance for which you want console output.
Type: xsd:string
instanceId
GetPasswordDataResponseTypeThe GetPasswordDataResponseType data type.
AncestorsNone
Relevant Operations• GetPasswordData
ContentsThe following table describes the elements contained in GetPasswordDataResponseType.
DescriptionName
The ID of the instance.
Type: xsd:string
instanceId
The password of the instance.
Type: xsd:string
passwordData
The ID of the request.
Type: xsd:string
requestId
The time the data was last updated.
Type: xsd:dateTime
timestamp
GetPasswordDataTypeThe GetPasswordDataType data type.
AncestorsNone
API Version 2010-08-31647
Amazon Elastic Compute Cloud API ReferenceContents
Relevant Operations• GetPasswordData
ContentsThe following table describes the elements contained in GetPasswordDataType.
DescriptionName
The ID of the instance for which to get the password.
Type: xsd:string
instanceId
GroupItemTypeThe GroupItemType data type.
Ancestors• GroupSetType (p. 648)
Relevant Operations• RequestSpotInstances
• DescribeSpotInstanceRequests
• RequestSpotInstances
• DescribeInstances
• RunInstances
• RunInstances
ContentsThe following table describes the elements contained in GroupItemType.
DescriptionName
Name of the security group.
Type: xsd:string
groupId
GroupSetTypeThe GroupSetType data type.
API Version 2010-08-31648
Amazon Elastic Compute Cloud API ReferenceRelevant Operations
Ancestors• LaunchSpecificationType (p. 661)
• ReservationInfoType (p. 685)
• RunInstancesResponseType (p. 692)
• RunInstancesType (p. 692)
Relevant Operations• RequestSpotInstances
• DescribeSpotInstanceRequests
• RequestSpotInstances
• DescribeInstances
• RunInstances
• RunInstances
ContentsThe following table describes the elements contained in GroupSetType.
DescriptionName
Group set item.
Type: GroupItemType (p. 648)
item
InstanceBlockDeviceMappingItemTypeThe InstanceBlockDeviceMappingItemType data type.
Ancestors• InstanceBlockDeviceMappingType (p. 651)
Relevant Operations• ModifyInstanceAttribute
ContentsThe following table describes the elements contained in InstanceBlockDeviceMappingItemType.
API Version 2010-08-31649
Amazon Elastic Compute Cloud API ReferenceAncestors
DescriptionName
The device name (e.g., /dev/sdh).
Type: xsd:string
deviceName
Specifies parameters used to automatically setup Amazon EBSvolumes when the instance is launched.
Type: InstanceEbsBlockDeviceType (p. 652)
ebs
Specifies the device name (e.g., /dev/sdb) to suppress during instancelaunch.
Type: EmptyElementType (p. 644)
noDevice
The virtual device name.
Type: xsd:string
virtualName
InstanceBlockDeviceMappingResponseItemTypeThe InstanceBlockDeviceMappingResponseItemType data type.
Ancestors• InstanceBlockDeviceMappingResponseType (p. 650)
Relevant Operations• DescribeInstanceAttribute
• DescribeInstances
• RunInstances
ContentsThe following table describes the elements contained in InstanceBlockDeviceMappingResponseItemType.
DescriptionName
Specifies how the device is exposed to the instance (e.g., /dev/sdh).
Type: xsd:string
deviceName
Specifies parameters used to automatically setup Amazon EBSvolumes when the instance is launched.
Type: EbsInstanceBlockDeviceMappingResponseType (p. 644)
ebs
InstanceBlockDeviceMappingResponseTypeThe InstanceBlockDeviceMappingResponseType data type.
API Version 2010-08-31650
Amazon Elastic Compute Cloud API ReferenceInstanceBlockDeviceMappingResponseItemType
Ancestors• DescribeInstanceAttributeResponseType (p. 608)
• RunningInstancesItemType (p. 694)
Relevant Operations• DescribeInstanceAttribute
• DescribeInstances
• RunInstances
ContentsThe following table describes the elements contained in InstanceBlockDeviceMappingResponseType.
DescriptionName
The item element.
Type: InstanceBlockDeviceMappingResponseItemType (p. 650)
item
InstanceBlockDeviceMappingTypeThe InstanceBlockDeviceMappingType data type.
Ancestors• ModifyInstanceAttributeType (p. 664)
Relevant Operations• ModifyInstanceAttribute
ContentsThe following table describes the elements contained in InstanceBlockDeviceMappingType.
DescriptionName
The item element.
Type: InstanceBlockDeviceMappingItemType (p. 649)
item
API Version 2010-08-31651
Amazon Elastic Compute Cloud API ReferenceAncestors
InstanceEbsBlockDeviceTypeThe InstanceEbsBlockDeviceType data type.
Ancestors• InstanceBlockDeviceMappingItemType (p. 649)
Relevant Operations• ModifyInstanceAttribute
ContentsThe following table describes the elements contained in InstanceEbsBlockDeviceType.
DescriptionName
Specifies whether the Amazon EBS volume is deleted on instancetermination.
Type: xsd:boolean
deleteOnTermination
The ID of the Amazon EBS volume.
Type: xsd:string
volumeId
InstanceIdSetTypeThe InstanceIdSetType data type.
Ancestors• StartInstancesType (p. 704)
• StopInstancesType (p. 706)
• TerminateInstancesType (p. 707)
Relevant Operations• StartInstances
• StopInstances
• TerminateInstances
ContentsThe following table describes the elements contained in InstanceIdSetType.
API Version 2010-08-31652
Amazon Elastic Compute Cloud API ReferenceInstanceEbsBlockDeviceType
DescriptionName
The item element.
Type: InstanceIdType (p. 653)
item
InstanceIdTypeThe InstanceIdType data type.
Ancestors• InstanceIdSetType (p. 652)
Relevant Operations• StartInstances
• StopInstances
• TerminateInstances
ContentsThe following table describes the elements contained in InstanceIdType.
DescriptionName
The instance ID.
Type: xsd:string
instanceId
InstanceMonitoringStateTypeThe InstanceMonitoringStateType data type.
Ancestors• MonitorInstancesResponseSetItemType (p. 666)
• RunningInstancesItemType (p. 694)
Relevant Operations• MonitorInstances
• UnmonitorInstances
• DescribeInstances
• RunInstances
API Version 2010-08-31653
Amazon Elastic Compute Cloud API ReferenceInstanceIdType
ContentsThe following table describes the elements contained in InstanceMonitoringStateType.
DescriptionName
State of monitoring for the instance.
Type: xsd:string
state
InstanceStateChangeSetTypeThe InstanceStateChangeSetType data type.
Ancestors• StartInstancesResponseType (p. 703)
• StopInstancesResponseType (p. 706)
• TerminateInstancesResponseType (p. 707)
Relevant Operations• StartInstances
• StopInstances
• TerminateInstances
ContentsThe following table describes the elements contained in InstanceStateChangeSetType.
DescriptionName
The item element.
Type: InstanceStateChangeType (p. 654)
item
InstanceStateChangeTypeThe InstanceStateChangeType data type.
Ancestors• InstanceStateChangeSetType (p. 654)
API Version 2010-08-31654
Amazon Elastic Compute Cloud API ReferenceContents
Relevant Operations• StartInstances
• StopInstances
• TerminateInstances
ContentsThe following table describes the elements contained in InstanceStateChangeType.
DescriptionName
The current state of the instance.
Type: InstanceStateType (p. 655)
currentState
The instance ID.
Type: xsd:string
instanceId
The previous state of the instance.
Type: InstanceStateType (p. 655)
previousState
InstanceStateTypeThe InstanceStateType data type.
Ancestors• InstanceStateChangeType (p. 654)
• InstanceStateChangeType (p. 654)
• RunningInstancesItemType (p. 694)
Relevant Operations• StartInstances
• StopInstances
• TerminateInstances
• DescribeInstances
• RunInstances
ContentsThe following table describes the elements contained in InstanceStateType.
API Version 2010-08-31655
Amazon Elastic Compute Cloud API ReferenceRelevant Operations
DescriptionName
A 16-bit unsigned integer. The high byte is an opaque internal valueand should be ignored. The low byte is set based on the staterepresented:
Type: integer
code
The current state of the instance.
Type: xsd:string
name
InstanceTypeSetItemTypeThe InstanceTypeSetItemType data type.
Ancestors• InstanceTypeSetType (p. 656)
Relevant Operations• DescribeSpotPriceHistory
ContentsThe following table describes the elements contained in InstanceTypeSetItemType.
DescriptionName
Specifies the instance type to return.
Type: xsd:string
instanceType
InstanceTypeSetTypeThe InstanceTypeSetType data type.
Ancestors• DescribeSpotPriceHistoryType (p. 636)
Relevant Operations• DescribeSpotPriceHistory
API Version 2010-08-31656
Amazon Elastic Compute Cloud API ReferenceInstanceTypeSetItemType
ContentsThe following table describes the elements contained in InstanceTypeSetType.
DescriptionName
Instance type set item.
Type: InstanceTypeSetItemType (p. 656)
item
IpPermissionSetTypeThe IpPermissionSetType data type.
Ancestors• AuthorizeSecurityGroupIngressType (p. 565)
• RevokeSecurityGroupIngressType (p. 691)
• SecurityGroupItemType (p. 697)
Relevant Operations• AuthorizeSecurityGroupIngress
• RevokeSecurityGroupIngress
• DescribeSecurityGroups
ContentsThe following table describes the elements contained in IpPermissionSetType.
DescriptionName
Set of IP permissions.
Type: IpPermissionType (p. 657)
item
IpPermissionTypeThe IpPermissionType data type.
Ancestors• IpPermissionSetType (p. 657)
API Version 2010-08-31657
Amazon Elastic Compute Cloud API ReferenceContents
Relevant Operations• AuthorizeSecurityGroupIngress
• RevokeSecurityGroupIngress
• DescribeSecurityGroups
ContentsThe following table describes the elements contained in IpPermissionType.
DescriptionName
Start of port range for the TCP and UDP protocols, or an ICMP typenumber. An ICMP type number of -1 indicates a wildcard (i.e., anyICMP type number).
Type: integer
fromPort
List of security group and user ID pairs.
Type: UserIdGroupPairSetType (p. 708)
groups
IP protocol.
Type: xsd:string
ipProtocol
IP ranges.
Type: IpRangeSetType (p. 659)
ipRanges
End of port range for the TCP and UDP protocols, or an ICMP code.An ICMP code of -1 indicates a wildcard (i.e., any ICMP code).
Type: integer
toPort
IpRangeItemTypeThe IpRangeItemType data type.
Ancestors• IpRangeSetType (p. 659)
Relevant Operations• AuthorizeSecurityGroupIngress
• RevokeSecurityGroupIngress
• DescribeSecurityGroups
API Version 2010-08-31658
Amazon Elastic Compute Cloud API ReferenceRelevant Operations
ContentsThe following table describes the elements contained in IpRangeItemType.
DescriptionName
CIDR range.
Type: xsd:string
cidrIp
IpRangeSetTypeThe IpRangeSetType data type.
Ancestors• IpPermissionType (p. 657)
Relevant Operations• AuthorizeSecurityGroupIngress
• RevokeSecurityGroupIngress
• DescribeSecurityGroups
ContentsThe following table describes the elements contained in IpRangeSetType.
DescriptionName
Information for one IP range.
Type: IpRangeItemType (p. 658)
item
LaunchPermissionItemTypeThe LaunchPermissionItemType data type.
Ancestors• LaunchPermissionListType (p. 660)
Relevant Operations• DescribeImageAttribute
• ModifyImageAttribute
API Version 2010-08-31659
Amazon Elastic Compute Cloud API ReferenceContents
ContentsThe following table describes the elements contained in LaunchPermissionItemType.
DescriptionName
Name of the group. Currently supports "all."
Type: xsd:string
group
AWS account ID.
Type: xsd:string
userId
LaunchPermissionListTypeThe LaunchPermissionListType data type.
Ancestors• DescribeImageAttributeResponseType (p. 600)
• LaunchPermissionOperationType (p. 660)
• LaunchPermissionOperationType (p. 660)
• LaunchPermissionOperationType (p. 660)
Relevant Operations• DescribeImageAttribute
• ModifyImageAttribute
ContentsThe following table describes the elements contained in LaunchPermissionListType.
DescriptionName
Information for launch permissions.
Type: LaunchPermissionItemType (p. 659)
item
LaunchPermissionOperationTypeThe LaunchPermissionOperationType data type.
Ancestors• ModifyImageAttributeType (p. 663)
API Version 2010-08-31660
Amazon Elastic Compute Cloud API ReferenceContents
Relevant Operations• ModifyImageAttribute
ContentsThe following table describes the elements contained in LaunchPermissionOperationType.
DescriptionName
Adds permission.
Type: LaunchPermissionListType (p. 660)
add
Remove permission.
Type: LaunchPermissionListType (p. 660)
remove
LaunchSpecificationTypeThe LaunchSpecificationType data type.
Ancestors• RequestSpotInstancesType (p. 683)
• SpotInstanceRequestSetItemType (p. 700)
Relevant Operations• RequestSpotInstances
• DescribeSpotInstanceRequests
• RequestSpotInstances
ContentsThe following table describes the elements contained in LaunchSpecificationType.
DescriptionName
Deprecated.
Type: xsd:string
addressingType
Specifies how block devices are exposed to the instance. Eachmapping is made up of a virtualName and a deviceName.
Type: BlockDeviceMappingType (p. 568)
blockDeviceMapping
Group set.
Type: GroupSetType (p. 648)
groupSet
API Version 2010-08-31661
Amazon Elastic Compute Cloud API ReferenceRelevant Operations
DescriptionName
The AMI ID.
Type: xsd:string
imageId
Specifies the instance type.
Type: xsd:string
instanceType
The ID of the kernel to select.
Type: xsd:string
kernelId
The name of the key pair.
Type: xsd:string
keyName
Specifies whether to enable monitoring for the instance.
Type: MonitoringInstanceType (p. 666)
monitoring
Placement item.
Type: PlacementRequestType (p. 671)
placement
The ID of the RAM disk to select. Some kernels require additionaldrivers at launch. Check the kernel requirements for information onwhether you need to specify a RAM disk and search for the kernelID.
Type: xsd:string
ramdiskId
Specifies the Amazon VPC subnet ID within which to launch theinstance(s) for Amazon Virtual Private Cloud.
Type: xsd:string
subnetId
MIME, Base64-encoded user data.
Type: UserDataType (p. 708)
userData
ModifyImageAttributeResponseTypeThe ModifyImageAttributeResponseType data type.
AncestorsNone
Relevant Operations• ModifyImageAttribute
ContentsThe following table describes the elements contained in ModifyImageAttributeResponseType.
API Version 2010-08-31662
Amazon Elastic Compute Cloud API ReferenceModifyImageAttributeResponseType
DescriptionName
The ID of the request.
Type: xsd:string
requestId
Returns true if successful. Otherwise, returns an error.
Type: xsd:boolean
return
ModifyImageAttributeTypeThe ModifyImageAttributeType data type.
AncestorsNone
Relevant Operations• ModifyImageAttribute
ContentsThe following table describes the elements contained in ModifyImageAttributeType.
DescriptionName
The description of the AMI.
Type: AttributeValueType (p. 563)
description
The AMI ID.
Type: xsd:string
imageId
Launch permission set.
Type: LaunchPermissionOperationType (p. 660)
launchPermission
Product code set.
Type: ProductCodeListType (p. 673)
productCodes
ModifyInstanceAttributeResponseTypeThe ModifyInstanceAttributeResponseType data type.
AncestorsNone
API Version 2010-08-31663
Amazon Elastic Compute Cloud API ReferenceModifyImageAttributeType
Relevant Operations• ModifyInstanceAttribute
ContentsThe following table describes the elements contained in ModifyInstanceAttributeResponseType.
DescriptionName
The ID of the request.
Type: xsd:string
requestId
Returns true if successful. Otherwise, returns an error.
Type: xsd:boolean
return
ModifyInstanceAttributeTypeThe ModifyInstanceAttributeType data type.
AncestorsNone
Relevant Operations• ModifyInstanceAttribute
ContentsThe following table describes the elements contained in ModifyInstanceAttributeType.
DescriptionName
Block device mapping set.
Type: InstanceBlockDeviceMappingType (p. 651)
blockDeviceMapping
Specifies whether the instance can be terminated.You must modifythis attribute before you can terminate any "locked" instances.
Type: AttributeBooleanValueType (p. 563)
disableApiTermination
The instance ID.
Type: xsd:string
instanceId
If an instance shutdown is initiated, this determines whether theinstance stops or terminates.
Type: AttributeValueType (p. 563)
instanceInitiatedShutdownBehavior
API Version 2010-08-31664
Amazon Elastic Compute Cloud API ReferenceRelevant Operations
DescriptionName
The instance type (e.g., m1.small, c1.medium, m2.2xlarge, and soon).
Type: AttributeValueType (p. 563)
instanceType
Kernel set.
Type: AttributeValueType (p. 563)
kernel
RAM disk set.
Type: AttributeValueType (p. 563)
ramdisk
MIME, Base64-encoded user data.
Type: AttributeValueType (p. 563)
userData
ModifySnapshotAttributeResponseTypeThe ModifySnapshotAttributeResponseType data type.
AncestorsNone
Relevant Operations• ModifySnapshotAttribute
ContentsThe following table describes the elements contained in ModifySnapshotAttributeResponseType.
DescriptionName
The ID of the request.
Type: xsd:string
requestId
Returns true if successful. Otherwise, returns an error.
Type: xsd:boolean
return
ModifySnapshotAttributeTypeThe ModifySnapshotAttributeType data type.
AncestorsNone
API Version 2010-08-31665
Amazon Elastic Compute Cloud API ReferenceModifySnapshotAttributeResponseType
Relevant Operations• ModifySnapshotAttribute
ContentsThe following table describes the elements contained in ModifySnapshotAttributeType.
DescriptionName
Create volume permission element.
Type: CreateVolumePermissionOperationType (p. 585)
createVolumePermission
The ID of the snapshot.
Type: xsd:string
snapshotId
MonitoringInstanceTypeThe MonitoringInstanceType data type.
Ancestors• LaunchSpecificationType (p. 661)
• RunInstancesType (p. 692)
Relevant Operations• RequestSpotInstances
• DescribeSpotInstanceRequests
• RequestSpotInstances
• RunInstances
ContentsThe following table describes the elements contained in MonitoringInstanceType.
DescriptionName
Enables monitoring for the instance.
Type: xsd:boolean
enabled
MonitorInstancesResponseSetItemTypeThe MonitorInstancesResponseSetItemType data type.
API Version 2010-08-31666
Amazon Elastic Compute Cloud API ReferenceRelevant Operations
Ancestors• MonitorInstancesResponseSetType (p. 667)
Relevant Operations• MonitorInstances
• UnmonitorInstances
ContentsThe following table describes the elements contained in MonitorInstancesResponseSetItemType.
DescriptionName
Instance ID.
Type: xsd:string
instanceId
Monitoring information.
Type: InstanceMonitoringStateType (p. 653)
monitoring
MonitorInstancesResponseSetTypeThe MonitorInstancesResponseSetType data type.
Ancestors• MonitorInstancesResponseType (p. 668)
Relevant Operations• MonitorInstances
• UnmonitorInstances
ContentsThe following table describes the elements contained in MonitorInstancesResponseSetType.
DescriptionName
Instance Item.
Type: MonitorInstancesResponseSetItemType (p. 666)
item
API Version 2010-08-31667
Amazon Elastic Compute Cloud API ReferenceAncestors
MonitorInstancesResponseTypeThe MonitorInstancesResponseType data type.
AncestorsNone
Relevant Operations• MonitorInstances
• UnmonitorInstances
ContentsThe following table describes the elements contained in MonitorInstancesResponseType.
DescriptionName
Monitor instance response set.
Type: MonitorInstancesResponseSetType (p. 667)
instancesSet
The ID of the request.
Type: xsd:string
requestId
MonitorInstancesSetItemTypeThe MonitorInstancesSetItemType data type.
Ancestors• MonitorInstancesSetType (p. 669)
Relevant Operations• MonitorInstances
• UnmonitorInstances
ContentsThe following table describes the elements contained in MonitorInstancesSetItemType.
API Version 2010-08-31668
Amazon Elastic Compute Cloud API ReferenceMonitorInstancesResponseType
DescriptionName
Instance ID.
Type: xsd:string
instanceId
MonitorInstancesSetTypeThe MonitorInstancesSetType data type.
Ancestors• MonitorInstancesType (p. 669)
Relevant Operations• MonitorInstances
• UnmonitorInstances
ContentsThe following table describes the elements contained in MonitorInstancesSetType.
DescriptionName
Instance set.
Type: MonitorInstancesSetItemType (p. 668)
item
MonitorInstancesTypeThe MonitorInstancesType data type.
AncestorsNone
Relevant Operations• MonitorInstances
• UnmonitorInstances
ContentsThe following table describes the elements contained in MonitorInstancesType.
API Version 2010-08-31669
Amazon Elastic Compute Cloud API ReferenceMonitorInstancesSetType
DescriptionName
Set of instances.
Type: MonitorInstancesSetType (p. 669)
instancesSet
NullableAttributeBooleanValueTypeThe NullableAttributeBooleanValueType data type.
Ancestors• DescribeInstanceAttributeResponseType (p. 608)
Relevant Operations• DescribeInstanceAttribute
ContentsThe following table describes the elements contained in NullableAttributeBooleanValueType.
DescriptionName
Generic boolean value.
Type: xsd:boolean
value
NullableAttributeValueTypeThe NullableAttributeValueType data type.
Ancestors• DescribeImageAttributeResponseType (p. 600)
• DescribeImageAttributeResponseType (p. 600)
• DescribeImageAttributeResponseType (p. 600)
• DescribeInstanceAttributeResponseType (p. 608)
• DescribeInstanceAttributeResponseType (p. 608)
• DescribeInstanceAttributeResponseType (p. 608)
• DescribeInstanceAttributeResponseType (p. 608)
• DescribeInstanceAttributeResponseType (p. 608)
• DescribeInstanceAttributeResponseType (p. 608)
API Version 2010-08-31670
Amazon Elastic Compute Cloud API ReferenceNullableAttributeBooleanValueType
Relevant Operations• DescribeImageAttribute
• DescribeInstanceAttribute
ContentsThe following table describes the elements contained in NullableAttributeValueType.
DescriptionName
ID of the parent element.
Type: xsd:string
value
PlacementGroupInfoTypeFor Query, see DescribePlacementGroups (p. 125).
For SOAP, see DescribePlacementGroups (p. 389).
PlacementGroupSetTypeFor Query, see DescribePlacementGroups (p. 125).
For SOAP, see DescribePlacementGroups (p. 389).
PlacementRequestTypeThe PlacementRequestType data type.
Ancestors• LaunchSpecificationType (p. 661)
• RunInstancesType (p. 692)
Relevant Operations• RequestSpotInstances
• DescribeSpotInstanceRequests
• RequestSpotInstances
• RunInstances
API Version 2010-08-31671
Amazon Elastic Compute Cloud API ReferenceRelevant Operations
ContentsThe following table describes the elements contained in PlacementRequestType.
DescriptionName
Specifies the placement constraints (Availability Zones) for launchingthe instances.
Type: xsd:string
availabilityZone
Specifies the name of a placement group.
Type: xsd:string
groupName
PlacementResponseTypeThe PlacementResponseType data type.
Ancestors• RunningInstancesItemType (p. 694)
Relevant Operations• DescribeInstances
• RunInstances
ContentsThe following table describes the elements contained in PlacementResponseType.
DescriptionName
Returns the Availability Zone of the instance.
Type: xsd:string
availabilityZone
ProductCodeItemTypeThe ProductCodeItemType data type.
Ancestors• ProductCodeListType (p. 673)
API Version 2010-08-31672
Amazon Elastic Compute Cloud API ReferenceContents
Relevant Operations• DescribeImageAttribute
• ModifyImageAttribute
ContentsThe following table describes the elements contained in ProductCodeItemType.
DescriptionName
Product code.
Type: xsd:string
productCode
ProductCodeListTypeThe ProductCodeListType data type.
Ancestors• DescribeImageAttributeResponseType (p. 600)
• ModifyImageAttributeType (p. 663)
Relevant Operations• DescribeImageAttribute
• ModifyImageAttribute
ContentsThe following table describes the elements contained in ProductCodeListType.
DescriptionName
Information for one product code.
Type: ProductCodeItemType (p. 672)
item
ProductCodeSetTypeThe ProductCodeSetType data type.
AncestorsNone
API Version 2010-08-31673
Amazon Elastic Compute Cloud API ReferenceRelevant Operations
Relevant Operations•
ContentsThe following table describes the elements contained in ProductCodeSetType.
DescriptionName
Information for a set of product codes.
Type: ProductCodeType (p. 675)
item
ProductCodesSetItemTypeThe ProductCodesSetItemType data type.
Ancestors• ProductCodesSetType (p. 674)
Relevant Operations• DescribeImages
• DescribeInstances
• RunInstances
ContentsThe following table describes the elements contained in ProductCodesSetItemType.
DescriptionName
Product code.
Type: xsd:string
productCode
ProductCodesSetTypeThe ProductCodesSetType data type.
Ancestors• DescribeImagesResponseItemType (p. 605)
• RunningInstancesItemType (p. 694)
API Version 2010-08-31674
Amazon Elastic Compute Cloud API ReferenceRelevant Operations
Relevant Operations• DescribeImages
• DescribeInstances
• RunInstances
ContentsThe following table describes the elements contained in ProductCodesSetType.
DescriptionName
Information for one product code.
Type: ProductCodesSetItemType (p. 674)
item
ProductCodeTypeThe ProductCodeType data type.
Ancestors• ProductCodeSetType (p. 673)
Relevant Operations•
ContentsThe following table describes the elements contained in ProductCodeType.
DescriptionName
Describes the product code associated with the AMI.
Type: xsd:string
productCode
ProductDescriptionSetItemTypeThe ProductDescriptionSetItemType data type.
Ancestors• ProductDescriptionSetType (p. 676)
API Version 2010-08-31675
Amazon Elastic Compute Cloud API ReferenceRelevant Operations
Relevant Operations• DescribeSpotPriceHistory
ContentsThe following table describes the elements contained in ProductDescriptionSetItemType.
DescriptionName
The description of the AMI (Linux/UNIX or Windows).
Type: xsd:string
productDescription
ProductDescriptionSetTypeThe ProductDescriptionSetType data type.
Ancestors• DescribeSpotPriceHistoryType (p. 636)
Relevant Operations• DescribeSpotPriceHistory
ContentsThe following table describes the elements contained in ProductDescriptionSetType.
DescriptionName
Product description set.
Type: ProductDescriptionSetItemType (p. 675)
item
PurchaseReservedInstancesOfferingResponseTypeThe PurchaseReservedInstancesOfferingResponseType data type.
AncestorsNone
API Version 2010-08-31676
Amazon Elastic Compute Cloud API ReferenceRelevant Operations
Relevant Operations• PurchaseReservedInstancesOffering
ContentsThe following table describes the elements contained inPurchaseReservedInstancesOfferingResponseType.
DescriptionName
The ID of the request.
Type: xsd:string
requestId
The IDs of the purchased Reserved Instances.
Type: xsd:string
reservedInstancesId
PurchaseReservedInstancesOfferingTypeThe PurchaseReservedInstancesOfferingType data type.
AncestorsNone
Relevant Operations• PurchaseReservedInstancesOffering
ContentsThe following table describes the elements contained in PurchaseReservedInstancesOfferingType.
DescriptionName
The number of Reserved Instances to purchase.
Type: integer
instanceCount
The offering ID of the Reserved Instance to purchase.
Type: xsd:string
reservedInstancesOfferingId
RebootInstancesInfoTypeThe RebootInstancesInfoType data type.
API Version 2010-08-31677
Amazon Elastic Compute Cloud API ReferenceRelevant Operations
Ancestors• RebootInstancesType (p. 679)
Relevant Operations• RebootInstances
ContentsThe following table describes the elements contained in RebootInstancesInfoType.
DescriptionName
Information for an instance.
Type: RebootInstancesItemType (p. 678)
item
RebootInstancesItemTypeThe RebootInstancesItemType data type.
Ancestors• RebootInstancesInfoType (p. 677)
Relevant Operations• RebootInstances
ContentsThe following table describes the elements contained in RebootInstancesItemType.
DescriptionName
One or more instance IDs.
Type: xsd:string
instanceId
RebootInstancesResponseTypeThe RebootInstancesResponseType data type.
API Version 2010-08-31678
Amazon Elastic Compute Cloud API ReferenceAncestors
AncestorsNone
Relevant Operations• RebootInstances
ContentsThe following table describes the elements contained in RebootInstancesResponseType.
DescriptionName
The ID of the request.
Type: xsd:string
requestId
Returns true if successful. Otherwise, returns an error.
Type: xsd:boolean
return
RebootInstancesTypeThe RebootInstancesType data type.
AncestorsNone
Relevant Operations• RebootInstances
ContentsThe following table describes the elements contained in RebootInstancesType.
DescriptionName
Launch permission set.
Type: RebootInstancesInfoType (p. 677)
instancesSet
RegionItemTypeThe RegionItemType data type.
API Version 2010-08-31679
Amazon Elastic Compute Cloud API ReferenceAncestors
Ancestors• RegionSetType (p. 680)
Relevant Operations• DescribeRegions
ContentsThe following table describes the elements contained in RegionItemType.
DescriptionName
Region service endpoint.
Type: xsd:string
regionEndpoint
Name of the Region.
Type: xsd:string
regionName
RegionSetTypeThe RegionSetType data type.
Ancestors• DescribeRegionsResponseType (p. 616)
Relevant Operations• DescribeRegions
ContentsThe following table describes the elements contained in RegionSetType.
DescriptionName
Information for a Region.
Type: RegionItemType (p. 679)
item
RegisterImageResponseTypeThe RegisterImageResponseType data type.
API Version 2010-08-31680
Amazon Elastic Compute Cloud API ReferenceAncestors
AncestorsNone
Relevant Operations• RegisterImage
ContentsThe following table describes the elements contained in RegisterImageResponseType.
DescriptionName
Unique ID of the newly registered machine image.
Type: xsd:string
imageId
The ID of the request.
Type: xsd:string
requestId
RegisterImageTypeThe RegisterImageType data type.
AncestorsNone
Relevant Operations• RegisterImage
ContentsThe following table describes the elements contained in RegisterImageType.
DescriptionName
The architecture of the image.
Type: xsd:string
architecture
Specifies how block devices are exposed to the instance. Eachmapping is made up of a virtualName and a deviceName.
Type: BlockDeviceMappingType (p. 568)
blockDeviceMapping
The description of the AMI.
Type: xsd:string
description
API Version 2010-08-31681
Amazon Elastic Compute Cloud API ReferenceAncestors
DescriptionName
Full path to your AMI manifest in Amazon S3 storage.
Type: xsd:string
imageLocation
The ID of the kernel to select.
Type: xsd:string
kernelId
The name of the AMI that was provided during image creation.
Type: xsd:string
name
The ID of the RAM disk to select. Some kernels require additionaldrivers at launch. Check the kernel requirements for information onwhether you need to specify a RAM disk.To find kernel requirements,refer to the Resource Center and search for the kernel ID.
Type: xsd:string
ramdiskId
The root device name (e.g., /dev/sda1).
Type: xsd:string
rootDeviceName
ReleaseAddressResponseTypeThe ReleaseAddressResponseType data type.
AncestorsNone
Relevant Operations• ReleaseAddress
ContentsThe following table describes the elements contained in ReleaseAddressResponseType.
DescriptionName
The ID of the request.
Type: xsd:string
requestId
Returns true if successful. Otherwise, returns an error.
Type: xsd:boolean
return
ReleaseAddressTypeThe ReleaseAddressType data type.
API Version 2010-08-31682
Amazon Elastic Compute Cloud API ReferenceReleaseAddressResponseType
AncestorsNone
Relevant Operations• ReleaseAddress
ContentsThe following table describes the elements contained in ReleaseAddressType.
DescriptionName
The IP address that you are releasing from your account.
Type: xsd:string
publicIp
RequestSpotInstancesResponseTypeThe RequestSpotInstancesResponseType data type.
AncestorsNone
Relevant Operations• RequestSpotInstances
ContentsThe following table describes the elements contained in RequestSpotInstancesResponseType.
DescriptionName
The ID of the request.
Type: xsd:string
requestId
Spot Instance request set.
Type: SpotInstanceRequestSetType (p. 701)
spotInstanceRequestSet
RequestSpotInstancesTypeThe RequestSpotInstancesType data type.
API Version 2010-08-31683
Amazon Elastic Compute Cloud API ReferenceAncestors
AncestorsNone
Relevant Operations• RequestSpotInstances
ContentsThe following table describes the elements contained in RequestSpotInstancesType.
DescriptionName
Specifies the Availability Zone group. If you specify the sameAvailability Zone group for all Spot Instance requests, all SpotInstances are launched in the same Availability Zone.
Type: xsd:string
availabilityZoneGroup
The maximum number of Spot Instances to launch.
Type: xs:integer
instanceCount
Specifies the instance launch group. Launch groups are SpotInstances that launch together and terminate together.
Type: xsd:string
launchGroup
Specifies additional launch instance information.
Type: LaunchSpecificationType (p. 661)
launchSpecification
Specifies the maximum hourly price for any Spot Instance launchedto fulfill the request.
Type: xsd:string
spotPrice
Specifies the Spot Instance type.
Type: xsd:string
type
Start date of the request. If this is a one-time request, the requestbecomes active at this date and time and remains active until allinstances launch, the request expires, or the request is canceled. Ifthe request is persistent, the request becomes active at this date andtime and remains active until it expires or is canceled.
Type: xsd:dateTime
validFrom
End date of the request. If this is a one-time request, the requestremains active until all instances launch, the request is canceled, orthis date is reached. If the request is persistent, it remains active untilit is canceled or this date and time is reached.
Type: xsd:dateTime
validUntil
API Version 2010-08-31684
Amazon Elastic Compute Cloud API ReferenceAncestors
ReservationInfoTypeThe ReservationInfoType data type.
Ancestors• ReservationSetType (p. 685)
Relevant Operations• DescribeInstances
ContentsThe following table describes the elements contained in ReservationInfoType.
DescriptionName
Group set.
Type: GroupSetType (p. 648)
groupSet
Instance set.
Type: RunningInstancesSetType (p. 696)
instancesSet
ID of the AWS account that owns the reservation.
Type: xsd:string
ownerId
ID of the requester.
Type: xsd:string
requesterId
Unique ID of the reservation.
Type: xsd:string
reservationId
ReservationSetTypeThe ReservationSetType data type.
Ancestors• DescribeInstancesResponseType (p. 612)
Relevant Operations• DescribeInstances
API Version 2010-08-31685
Amazon Elastic Compute Cloud API ReferenceReservationInfoType
ContentsThe following table describes the elements contained in ReservationSetType.
DescriptionName
Information for a reservation.
Type: ReservationInfoType (p. 685)
item
ResetImageAttributeResponseTypeThe ResetImageAttributeResponseType data type.
AncestorsNone
Relevant Operations• ResetImageAttribute
ContentsThe following table describes the elements contained in ResetImageAttributeResponseType.
DescriptionName
The ID of the request.
Type: xsd:string
requestId
Indicates whether the attribute successfully reset.
Type: xsd:boolean
return
ResetImageAttributesGroupThe ResetImageAttributesGroup data type.
Ancestors• ResetImageAttributeType (p. 687)
Relevant Operations• ResetImageAttribute
API Version 2010-08-31686
Amazon Elastic Compute Cloud API ReferenceContents
ContentsThe following table describes the elements contained in ResetImageAttributesGroup.
DescriptionName
Resets the launch permission attribute.
Type: EmptyElementType (p. 644)
launchPermission
ResetImageAttributeTypeThe ResetImageAttributeType data type.
AncestorsNone
Relevant Operations• ResetImageAttribute
ContentsThe following table describes the elements contained in ResetImageAttributeType.
DescriptionName
ID of the AMI on which the attribute will be reset.
Type: xsd:string
imageId
The reset image attribute group.
Type: ResetImageAttributesGroup (p. 686)
ResetImageAttributesGroup
ResetInstanceAttributeResponseTypeThe ResetInstanceAttributeResponseType data type.
AncestorsNone
Relevant Operations• ResetInstanceAttribute
API Version 2010-08-31687
Amazon Elastic Compute Cloud API ReferenceContents
ContentsThe following table describes the elements contained in ResetInstanceAttributeResponseType.
DescriptionName
The ID of the request.
Type: xsd:string
requestId
Indicates whether the attribute successfully reset.
Type: xsd:boolean
return
ResetInstanceAttributesGroupThe ResetInstanceAttributesGroup data type.
Ancestors• ResetInstanceAttributeType (p. 688)
Relevant Operations• ResetInstanceAttribute
ContentsThe following table describes the elements contained in ResetInstanceAttributesGroup.
DescriptionName
The kernel ID.
Type: EmptyElementType (p. 644)
kernel
The RAM disk ID.
Type: EmptyElementType (p. 644)
ramdisk
ResetInstanceAttributeTypeThe ResetInstanceAttributeType data type.
AncestorsNone
API Version 2010-08-31688
Amazon Elastic Compute Cloud API ReferenceContents
Relevant Operations• ResetInstanceAttribute
ContentsThe following table describes the elements contained in ResetInstanceAttributeType.
DescriptionName
ID of the instance on which the attribute will be reset.
Type: xsd:string
instanceId
Group of attributes to reset.
Type: ResetInstanceAttributesGroup (p. 688)
ResetInstanceAttributesGroup
ResetSnapshotAttributeResponseTypeThe ResetSnapshotAttributeResponseType data type.
AncestorsNone
Relevant Operations• ResetSnapshotAttribute
ContentsThe following table describes the elements contained in ResetSnapshotAttributeResponseType.
DescriptionName
The ID of the request.
Type: xsd:string
requestId
Specifies whether the snapshot permissions were reset.
Type: xsd:boolean
return
ResetSnapshotAttributesGroupThe ResetSnapshotAttributesGroup data type.
API Version 2010-08-31689
Amazon Elastic Compute Cloud API ReferenceRelevant Operations
Ancestors• ResetSnapshotAttributeType (p. 690)
Relevant Operations• ResetSnapshotAttribute
ContentsThe following table describes the elements contained in ResetSnapshotAttributesGroup.
DescriptionName
Create volume permission type.
Type: EmptyElementType (p. 644)
createVolumePermission
ResetSnapshotAttributeTypeThe ResetSnapshotAttributeType data type.
AncestorsNone
Relevant Operations• ResetSnapshotAttribute
ContentsThe following table describes the elements contained in ResetSnapshotAttributeType.
DescriptionName
Snapshot group.
Type: ResetSnapshotAttributesGroup (p. 689)
ResetSnapshotAttributesGroup
The ID of the snapshot.
Type: xsd:string
snapshotId
RevokeSecurityGroupIngressResponseTypeThe RevokeSecurityGroupIngressResponseType data type.
API Version 2010-08-31690
Amazon Elastic Compute Cloud API ReferenceAncestors
AncestorsNone
Relevant Operations• RevokeSecurityGroupIngress
ContentsThe following table describes the elements contained in RevokeSecurityGroupIngressResponseType.
DescriptionName
The ID of the request.
Type: xsd:string
requestId
Returns true if the request is successful. Otherwise, returns an error.
Type: xsd:boolean
return
RevokeSecurityGroupIngressTypeThe RevokeSecurityGroupIngressType data type.
AncestorsNone
Relevant Operations• RevokeSecurityGroupIngress
ContentsThe following table describes the elements contained in RevokeSecurityGroupIngressType.
DescriptionName
Name of the group to modify.
Type: xsd:string
groupName
Set of permissions to add to the group.
Type: IpPermissionSetType (p. 657)
ipPermissions
AWS account ID.
Type: xsd:string
userId
API Version 2010-08-31691
Amazon Elastic Compute Cloud API ReferenceAncestors
RunInstancesResponseTypeThe RunInstancesResponseType data type.
AncestorsNone
Relevant Operations• RunInstances
ContentsThe following table describes the elements contained in RunInstancesResponseType.
DescriptionName
Group set.
Type: GroupSetType (p. 648)
groupSet
Instance set.
Type: RunningInstancesSetType (p. 696)
instancesSet
ID of the AWS account that owns the reservation.
Type: xsd:string
ownerId
ID of the requester.
Type: xsd:string
requesterId
The ID of the request.
Type: xsd:string
requestId
Unique ID of the reservation.
Type: xsd:string
reservationId
RunInstancesTypeThe RunInstancesType data type.
AncestorsNone
Relevant Operations• RunInstances
API Version 2010-08-31692
Amazon Elastic Compute Cloud API ReferenceRunInstancesResponseType
ContentsThe following table describes the elements contained in RunInstancesType.
DescriptionName
Specifies additional information to make available to the instance(s).
Type: xsd:string
additionalInfo
Deprecated.
Type: xsd:string
addressingType
Specifies how block devices are exposed to the instance. Eachmapping is made up of a virtualName and a deviceName.
Type: BlockDeviceMappingType (p. 568)
blockDeviceMapping
Specifies whether the instance can be terminated using the APIs.You must modify this attribute before you can terminate any "locked"instances from the APIs.
Type: xsd:boolean
disableApiTermination
Group set.
Type: GroupSetType (p. 648)
groupSet
Unique ID of a machine image, returned by a call to RegisterImage.
Type: xsd:string
imageId
If an instance shutdown is initiated, this determines whether theinstance stops or terminates.
Type: xsd:string
Valid Values: stop | terminate
instanceInitiatedShutdownBehavior
Specifies the instance type.
Type: xsd:string
instanceType
The ID of the kernel with which to launch the instance.
Type: xsd:string
kernelId
The name of the key pair.
Type: xsd:string
keyName
Maximum number of instances to launch. If the value is more thanAmazon EC2 can launch, the largest possible number aboveminCount will be launched instead.
Type: integer
maxCount
Minimum number of instances to launch. If the value is more thanAmazon EC2 can launch, no instances are launched at all.
Type: integer
minCount
Specifies whether to enable monitoring for the instance.
Type: MonitoringInstanceType (p. 666)
monitoring
API Version 2010-08-31693
Amazon Elastic Compute Cloud API ReferenceContents
DescriptionName
Placement item.
Type: PlacementRequestType (p. 671)
placement
If you're using Amazon Virtual Private Cloud, you can optionally usethis parameter to assign the instance a specific available IP addressfrom the subnet (e.g., 10.0.0.25).
Type: xsd:string
privateIpAddress
The ID of the RAM disk to select. Some kernels require additionaldrivers at launch. Check the kernel requirements for information onwhether you need to specify a RAM disk.To find kernel requirements,refer to the Resource Center and search for the kernel ID.
Type: xsd:string
ramdiskId
Specifies the Amazon VPC subnet ID within which to launch theinstance(s) for Amazon Virtual Private Cloud.
Type: xsd:string
subnetId
MIME, Base64-encoded user data.
Type: UserDataType (p. 708)
userData
RunningInstancesItemTypeThe RunningInstancesItemType data type.
Ancestors• RunningInstancesSetType (p. 696)
Relevant Operations• DescribeInstances
• RunInstances
ContentsThe following table describes the elements contained in RunningInstancesItemType.
DescriptionName
The AMI launch index, which can be used to find this instance withinthe launch group.
Type: xsd:string
amiLaunchIndex
The architecture of the image.
Type: xsd:string
architecture
API Version 2010-08-31694
Amazon Elastic Compute Cloud API ReferenceRunningInstancesItemType
DescriptionName
Block device mapping set.
Type: InstanceBlockDeviceMappingResponseType (p. 650)
blockDeviceMapping
The public DNS name assigned to the instance. This DNS name iscontactable from outside the Amazon EC2 network. This elementremains empty until the instance enters a running state.
Type: xsd:string
dnsName
Image ID of the AMI used to launch the instance.
Type: xsd:string
imageId
Unique ID of the instance launched.
Type: xsd:string
instanceId
Specifies whether this is a Spot Instance.
Type: xsd:string
instanceLifecycle
The current state of the instance.
Type: InstanceStateType (p. 655)
instanceState
The instance type.
Type: xsd:string
instanceType
Specifies the IP address of the instance.
Type: xsd:string
ipAddress
Kernel associated with this instance.
Type: xsd:string
kernelId
If this instance was launched with an associated key pair, this displaysthe key pair name.
Type: xsd:string
keyName
The time the instance launched.
Type: xsd:dateTime
launchTime
Specifies whether monitoring is enabled for the instance.
Type: InstanceMonitoringStateType (p. 653)
monitoring
The location where the instance launched.
Type: PlacementResponseType (p. 672)
placement
Platform of the instance (e.g., Windows).
Type: xsd:string
platform
The private DNS name assigned to the instance. This DNS namecan only be used inside the Amazon EC2 network. This elementremains empty until the instance enters a running state.
Type: xsd:string
privateDnsName
Specifies the private IP address that is assigned to the instance.
Type: xsd:string
privateIpAddress
API Version 2010-08-31695
Amazon Elastic Compute Cloud API ReferenceContents
DescriptionName
Product codes attached to this instance.
Type: ProductCodesSetType (p. 674)
productCodes
RAM disk associated with this instance.
Type: xsd:string
ramdiskId
Reason for the most recent state transition. This might be an emptystring.
Type: xsd:string
reason
The root device name (e.g., /dev/sda1).
Type: xsd:string
rootDeviceName
The root device type used by the AMI. The AMI can use an AmazonEBS or instance store root device.
Type: xsd:string
rootDeviceType
The ID of the Spot Instance request.
Type: xsd:string
spotInstanceRequestId
The reason for the state change.
Type: StateReasonType (p. 704)
stateReason
Specifies the Amazon VPC subnet ID in which the instance is running.
Type: xsd:string
subnetId
Specifies the instance's virtualization type (paravirtual or hvm).
Type: xsd:string
virtualizationType
Specifies the Amazon VPC in which the instance is running.
Type: xsd:string
vpcId
RunningInstancesSetTypeThe RunningInstancesSetType data type.
Ancestors• ReservationInfoType (p. 685)
• RunInstancesResponseType (p. 692)
Relevant Operations• DescribeInstances
• RunInstances
API Version 2010-08-31696
Amazon Elastic Compute Cloud API ReferenceRunningInstancesSetType
ContentsThe following table describes the elements contained in RunningInstancesSetType.
DescriptionName
Running instance set item.
Type: RunningInstancesItemType (p. 694)
item
SecurityGroupItemTypeThe SecurityGroupItemType data type.
Ancestors• SecurityGroupSetType (p. 697)
Relevant Operations• DescribeSecurityGroups
ContentsThe following table describes the elements contained in SecurityGroupItemType.
DescriptionName
Description of the security group.
Type: xsd:string
groupDescription
Name of the security group.
Type: xsd:string
groupName
Set of IP permissions associated with the security group.
Type: IpPermissionSetType (p. 657)
ipPermissions
AWS account ID of the owner of the security group.
Type: xsd:string
ownerId
SecurityGroupSetTypeThe SecurityGroupSetType data type.
Ancestors• DescribeSecurityGroupsResponseType (p. 625)
API Version 2010-08-31697
Amazon Elastic Compute Cloud API ReferenceContents
Relevant Operations• DescribeSecurityGroups
ContentsThe following table describes the elements contained in SecurityGroupSetType.
DescriptionName
Information for a security group.
Type: SecurityGroupItemType (p. 697)
item
SpotDatafeedSubscriptionTypeThe SpotDatafeedSubscriptionType data type.
Ancestors• CreateSpotDatafeedSubscriptionResponseType (p. 583)
• DescribeSpotDatafeedSubscriptionResponseType (p. 634)
Relevant Operations• CreateSpotDatafeedSubscription
• DescribeSpotDatafeedSubscription
ContentsThe following table describes the elements contained in SpotDatafeedSubscriptionType.
DescriptionName
The Amazon S3 bucket where the Spot Instance datafeed is located.
Type: xsd:string
bucket
Fault codes for the Spot Instance request, if any.
Type: SpotInstanceStateFaultType (p. 702)
fault
The AWS account ID of the account.
Type: xsd:string
ownerId
Prefix that is prepended to datafeed files.
Type: xsd:string
prefix
API Version 2010-08-31698
Amazon Elastic Compute Cloud API ReferenceRelevant Operations
DescriptionName
The state of the Spot Instance request.
Type: xsd:string
state
SpotInstanceRequestIdSetItemTypeThe SpotInstanceRequestIdSetItemType data type.
Ancestors• SpotInstanceRequestIdSetType (p. 699)
Relevant Operations• CancelSpotInstanceRequests
• DescribeSpotInstanceRequests
ContentsThe following table describes the elements contained in SpotInstanceRequestIdSetItemType.
DescriptionName
Specifies the ID of the Spot Instance request.
Type: xsd:string
spotInstanceRequestId
SpotInstanceRequestIdSetTypeThe SpotInstanceRequestIdSetType data type.
Ancestors• CancelSpotInstanceRequestsType (p. 576)
• DescribeSpotInstanceRequestsType (p. 635)
Relevant Operations• CancelSpotInstanceRequests
• DescribeSpotInstanceRequests
API Version 2010-08-31699
Amazon Elastic Compute Cloud API ReferenceSpotInstanceRequestIdSetItemType
ContentsThe following table describes the elements contained in SpotInstanceRequestIdSetType.
DescriptionName
Spot Instance request ID set.
Type: SpotInstanceRequestIdSetItemType (p. 699)
item
SpotInstanceRequestSetItemTypeThe SpotInstanceRequestSetItemType data type.
Ancestors• SpotInstanceRequestSetType (p. 701)
Relevant Operations• DescribeSpotInstanceRequests
• RequestSpotInstances
ContentsThe following table describes the elements contained in SpotInstanceRequestSetItemType.
DescriptionName
Specifies the Availability Zone group. If you specify the sameAvailability Zone group for all Spot Instance requests, all SpotInstances are launched in the same Availability Zone.
Type: xsd:string
availabilityZoneGroup
Time stamp when the Spot Instance request was created.
Type: xsd:dateTime
createTime
Fault codes for the Spot Instance request, if any.
Type: SpotInstanceStateFaultType (p. 702)
fault
Specifies the instance ID.
Type: xsd:string
instanceId
Specifies the instance launch group. Launch groups are SpotInstances that launch together and terminate together.
Type: xsd:string
launchGroup
Specifies additional launch instance information.
Type: LaunchSpecificationType (p. 661)
launchSpecification
API Version 2010-08-31700
Amazon Elastic Compute Cloud API ReferenceContents
DescriptionName
The product description associated with the Spot Instance.
Type: xsd:string
productDescription
Specifies the ID of the Spot Instance request.
Type: xsd:string
spotInstanceRequestId
Specifies the maximum hourly price for any Spot Instance launchedto fulfill the request.
Type: xsd:string
spotPrice
The state of the Spot Instance request.
Type: xsd:string
state
Specifies the instance type.
Type: xsd:string
type
Start date of the request. If this is a one-time request, the requestbecomes active at this date and time and remains active until allinstances launch, the request expires, or the request is canceled. Ifthe request is persistent, the request becomes active at this date andtime and remains active until it expires or is canceled.
Type: xsd:dateTime
validFrom
End date of the request. If this is a one-time request, the requestremains active until all instances launch, the request is canceled, orthis date is reached. If the request is persistent, it remains active untilit is canceled or this date and time is reached.
Type: xsd:dateTime
validUntil
SpotInstanceRequestSetTypeThe SpotInstanceRequestSetType data type.
Ancestors• DescribeSpotInstanceRequestsResponseType (p. 635)
• RequestSpotInstancesResponseType (p. 683)
Relevant Operations• DescribeSpotInstanceRequests
• RequestSpotInstances
ContentsThe following table describes the elements contained in SpotInstanceRequestSetType.
API Version 2010-08-31701
Amazon Elastic Compute Cloud API ReferenceSpotInstanceRequestSetType
DescriptionName
Spot Instance request set.
Type: SpotInstanceRequestSetItemType (p. 700)
item
SpotInstanceStateFaultTypeThe SpotInstanceStateFaultType data type.
Ancestors• SpotDatafeedSubscriptionType (p. 698)
• SpotInstanceRequestSetItemType (p. 700)
Relevant Operations• CreateSpotDatafeedSubscription
• DescribeSpotDatafeedSubscription
• DescribeSpotInstanceRequests
• RequestSpotInstances
ContentsThe following table describes the elements contained in SpotInstanceStateFaultType.
DescriptionName
Reason code for the Spot Instance state change.
Type: xsd:string
code
Message for the Spot Instance state change.
Type: xsd:string
message
SpotPriceHistorySetItemTypeThe SpotPriceHistorySetItemType data type.
Ancestors• SpotPriceHistorySetType (p. 703)
Relevant Operations• DescribeSpotPriceHistory
API Version 2010-08-31702
Amazon Elastic Compute Cloud API ReferenceSpotInstanceStateFaultType
ContentsThe following table describes the elements contained in SpotPriceHistorySetItemType.
DescriptionName
The instance type.
Type: xsd:string
instanceType
The description of the AMI.
Type: xsd:string
productDescription
Specifies the maximum price you will pay to launch one or more SpotInstances.
Type: xsd:string
spotPrice
Specifies the date and time the request was created.
Type: xsd:dateTime
timestamp
SpotPriceHistorySetTypeThe SpotPriceHistorySetType data type.
Ancestors• DescribeSpotPriceHistoryResponseType (p. 636)
Relevant Operations• DescribeSpotPriceHistory
ContentsThe following table describes the elements contained in SpotPriceHistorySetType.
DescriptionName
Spot Price history set.
Type: SpotPriceHistorySetItemType (p. 702)
item
StartInstancesResponseTypeThe StartInstancesResponseType data type.
API Version 2010-08-31703
Amazon Elastic Compute Cloud API ReferenceContents
AncestorsNone
Relevant Operations• StartInstances
ContentsThe following table describes the elements contained in StartInstancesResponseType.
DescriptionName
Instances set.
Type: InstanceStateChangeSetType (p. 654)
instancesSet
The ID of the request.
Type: xsd:string
requestId
StartInstancesTypeThe StartInstancesType data type.
AncestorsNone
Relevant Operations• StartInstances
ContentsThe following table describes the elements contained in StartInstancesType.
DescriptionName
Instances set.
Type: InstanceIdSetType (p. 652)
instancesSet
StateReasonTypeThe StateReasonType data type.
API Version 2010-08-31704
Amazon Elastic Compute Cloud API ReferenceAncestors
Ancestors• DescribeImagesResponseItemType (p. 605)
• RunningInstancesItemType (p. 694)
Relevant Operations• DescribeImages
• DescribeInstances
• RunInstances
ContentsThe following table describes the elements contained in StateReasonType.
DescriptionName
Reason code for the state change.
Type: xsd:string
code
Message for the state change.
Type: xsd:string
message
The following table lists the currently supported state reason codes:
DescriptionCode
A Spot Instance was terminated due to an increase in the marketprice.
Server.SpotInstanceTermination
An internal error occurred during instance launch, resulting intermination.
Server.InternalError
There was insufficient instance capacity to satisfy the launch request.Server.InsufficientInstanceCapacity
A client error caused the instance to terminate on launch.Client.InternalError
The instance initiated shutdown by a shutdown -h command issuedfrom inside the instance.
Client.InstanceInitiatedShutdown
The instance was shutdown by a user via an API call.Client.UserInitiatedShutdown
The volume limit was exceeded.Client.VolumeLimitExceeded
The specified snapshot was not found.Client.InvalidSnapshot.NotFound
API Version 2010-08-31705
Amazon Elastic Compute Cloud API ReferenceAncestors
StopInstancesResponseTypeThe StopInstancesResponseType data type.
AncestorsNone
Relevant Operations• StopInstances
ContentsThe following table describes the elements contained in StopInstancesResponseType.
DescriptionName
Instances set.
Type: InstanceStateChangeSetType (p. 654)
instancesSet
The ID of the request.
Type: xsd:string
requestId
StopInstancesTypeThe StopInstancesType data type.
AncestorsNone
Relevant Operations• StopInstances
ContentsThe following table describes the elements contained in StopInstancesType.
DescriptionName
Forces the instance to stop.The instance will not have an opportunityto flush file system caches nor file system meta data. If you use thisoption, you must perform file system check and repair procedures.This option is not recommended for Windows instances.
Type: xsd:boolean
force
API Version 2010-08-31706
Amazon Elastic Compute Cloud API ReferenceStopInstancesResponseType
DescriptionName
Instances set.
Type: InstanceIdSetType (p. 652)
instancesSet
TerminateInstancesResponseTypeThe TerminateInstancesResponseType data type.
AncestorsNone
Relevant Operations• TerminateInstances
ContentsThe following table describes the elements contained in TerminateInstancesResponseType.
DescriptionName
Instances set.
Type: InstanceStateChangeSetType (p. 654)
instancesSet
The ID of the request.
Type: xsd:string
requestId
TerminateInstancesTypeThe TerminateInstancesType data type.
AncestorsNone
Relevant Operations• TerminateInstances
ContentsThe following table describes the elements contained in TerminateInstancesType.
API Version 2010-08-31707
Amazon Elastic Compute Cloud API ReferenceTerminateInstancesResponseType
DescriptionName
Set of instances.
Type: InstanceIdSetType (p. 652)
instancesSet
UserDataTypeThe UserDataType data type.
Ancestors• LaunchSpecificationType (p. 661)
• RunInstancesType (p. 692)
Relevant Operations• RequestSpotInstances
• DescribeSpotInstanceRequests
• RequestSpotInstances
• RunInstances
ContentsThe following table describes the elements contained in UserDataType.
DescriptionName
MIME, Base64-encoded user data.
Type: xsd:string
data
UserIdGroupPairSetTypeThe UserIdGroupPairSetType data type.
Ancestors• IpPermissionType (p. 657)
Relevant Operations• AuthorizeSecurityGroupIngress
• RevokeSecurityGroupIngress
• DescribeSecurityGroups
API Version 2010-08-31708
Amazon Elastic Compute Cloud API ReferenceUserDataType
ContentsThe following table describes the elements contained in UserIdGroupPairSetType.
DescriptionName
Information for one security group.
Type: UserIdGroupPairType (p. 709)
item
UserIdGroupPairTypeThe UserIdGroupPairType data type.
Ancestors• UserIdGroupPairSetType (p. 708)
Relevant Operations• AuthorizeSecurityGroupIngress
• RevokeSecurityGroupIngress
• DescribeSecurityGroups
ContentsThe following table describes the elements contained in UserIdGroupPairType.
DescriptionName
Name of the security group. Cannot be used when specifying a CIDRIP address.
Type: xsd:string
groupName
ID of an AWS account. Cannot be used when specifying a CIDR IPaddress.
Type: xsd:string
userId
API Version 2010-08-31709
Amazon Elastic Compute Cloud API ReferenceContents
API Error Codes
OverviewThere are two types of error codes: client and server.
Client error codes suggest that the error was caused by something the client did, such as an authenticationfailure or an invalid AMI identifier. In the SOAP API, These error codes are prefixed with Client. Forexample:Client.AuthFailure. In the Query API, these errors are accompanied by a 400-series HTTPresponse code.
Server error codes suggest a server-side issue caused the error and should be reported. In the SOAPAPI, these error codes are prefixed with Server. For example: Server.Unavailable. In the QueryAPI, these errors are accompanied by a 500-series HTTP response code.
Summary of Client Error CodesNotesDescriptionError Code
Each AWS account has anIP address limit. For newaccounts, this limit is 5. Ifyou need more than 5 ElasticIP addresses, pleasecomplete the Amazon EC2Elastic IP Address RequestForm. We will ask you tothink through your use caseand help us understand yourneed for additionaladdresses.
Account has the maximumnumber of allowed IPaddresses.
AddressLimitExceeded
The limit on the number ofAmazon EBS volumesattached to one instance hasbeen exceeded.
AttachmentLimitExceeded
API Version 2010-08-31710
Amazon Elastic Compute Cloud API ReferenceOverview
NotesDescriptionError Code
You might be trying to run anAMI for which you do nothave permission.
User not authorized.AuthFailure
[email protected] you have questions.
The account is currentlyblocked.
Blocked
Request uses too manyfilters or too many total filtervalues.
FilterLimitExceeded
Do not reuse a client tokenwith different requests,unless the requests areidentical.
Request uses the sameclient token as a previous,but non-identical request.
IdempotentParameterMismatch
To attach to an instance, itmust be in the 'available'state.
Volume is in incorrect stateIncorrectState
Each AWS account has aconcurrent running instancelimit. For new accounts, thislimit is 20. If you need morethan 20 instances, pleasecomplete the Amazon EC2Instance Request Form andyour request will beconsidered.
Account has max allowedconcurrent runninginstances.
InstanceLimitExceeded
The returned message givesguidance on how to solve theproblem.
There is insufficient capacityavailable for the requestedinstance type.
InsufficientInstanceCapacity
Insufficient ReservedInstances capacity.
InsufficientReservedInstancesCapacity
If you are specifying auserId, check that it is inthe form of an AWS accountID.
The value of an item addedto, or removed from, animage attribute is invalid.
InvalidAMIAttributeItemValue
Specified AMI ID is not valid.InvalidAMIID.Malformed
Specified AMI ID does notexist.
InvalidAMIID.NotFound
Specified AMI ID has beenderegistered and is no longeravailable.
InvalidAMIID.Unavailable
The instance cannot detachfrom a volume to which it isnot attached.
InvalidAttachment.NotFound
API Version 2010-08-31711
Amazon Elastic Compute Cloud API ReferenceSummary of Client Error Codes
NotesDescriptionError Code
The device to which you aretrying to attach (i.e. /dev/sdh)is already in use on theinstance.
InvalidDevice.InUse
Attempt to create a duplicategroup.
InvalidGroup.Duplicate
Specified group cannot bedeleted because it is in use.
InvalidGroup.InUse
Specified group name doesnot exist.
InvalidGroup.NotFound
Specified group name is areserved name.
InvalidGroup.Reserved
Specified instance ID is notvalid.
InvalidInstanceID.Malformed
Specified instance ID doesnot exist.
InvalidInstanceID.NotFound
Specified IP address iscurrently in use.
InvalidIPAddress.InUse
Attempt to create a duplicatekey pair.
InvalidKeyPair.Duplicate
Format of the public keyyou've attempted to importis invalid.
InvalidKeyPair.Format
Specified key pair namedoes not exist.
InvalidKeyPair.NotFound
Specified AMI has anunparsable Manifest.
InvalidManifest
RunInstances was calledwithminCountandmaxCountset to 0 or minCount >maxCount.
InvalidParameterCombination
Requests that could causethis error include (forexample) supplying aninvalid image attribute to theDescribeImageAttributerequest or an invalidversion or encoding valuefor the userData in aRunInstances request.
The value supplied for aparameter was invalid.
InvalidParameterValue
API Version 2010-08-31712
Amazon Elastic Compute Cloud API ReferenceSummary of Client Error Codes
NotesDescriptionError Code
Attempt to authorize apermission that has alreadybeen authorized.
InvalidPermission.Duplicate
Specified permission isinvalid.
InvalidPermission.Malformed
Specified reservation ID isinvalid.
InvalidReservationID.Malformed
Specified reservation IDdoes not exist.
InvalidReservationID.NotFound
The snapshot ID that waspassed as an argument wasmalformed.
InvalidSnapshotID.Malformed
The specified snapshot doesnot exist.
InvalidSnapshot.NotFound
The user ID is neither in theform of an AWS account IDor one of the special valuesaccepted by the owner orexecutableBy flags in theDescribeImages call.
InvalidUserID.Malformed
Reserved Instances ID notfound.
InvalidReservedInstancesId
Reserved Instances OfferingID not found.
InvalidReservedInstancesOfferingId
The volume already exists inthe system.
InvalidVolumeID.Duplicate
The volume ID that waspassed as an argument wasmalformed.
InvalidVolumeID.Malformed
The volume specified doesnot exist.
InvalidVolume.NotFound
The specified volume ID andinstance ID are in differentAvailability Zones.
InvalidVolumeID.ZoneMismatch
The specified zone does notexist.
InvalidZone.NotFound
Please restart the instanceand try again. This willensure that the code is runon an instance with updatedcode.
The instance specified doesnot support EBS.
NonEBSInstance
[email protected] you have questions.
The account is pendingverification.
PendingVerification
API Version 2010-08-31713
Amazon Elastic Compute Cloud API ReferenceSummary of Client Error Codes
NotesDescriptionError Code
The limit on the number ofAmazon EBS snapshots inthe pending state has beenexceeded.
PendingSnapshotLimitExceeded
Your current quota does notallow you to purchase therequired number of reservedinstances.
ReservedInstancesLimitExceeded
The limit on the number ofAmazon EBS snapshots hasbeen exceeded.
SnapshotLimitExceeded
Requests that could causethis error include supplyinga misspelled parameter or aparameter that is notsupported for the specifiedAPI version.
An unknown or unrecognizedparameter was supplied.
UnknownParameter
The returned message givesguidance on how to solve theproblem.
The instance type or featureis not supported in yourrequested Availability Zone.
Unsupported
The limit on the number ofAmazon EBS volumes hasbeen exceeded.
VolumeLimitExceeded
Summary of Server Error CodesNotesDescriptionError Code
Reduce the number ofaddresses you arerequesting or wait foradditional capacity tobecome available.
Not enough available addresses tosatisfy your minimum request.
InsufficientAddressCapacity
Reduce the number ofinstances in your requestor wait for additionalcapacity to becomeavailable. The returnedmessage might also givespecific guidance on howto solve the problem.
Not enough available instances tosatisfy your minimum request.
InsufficientInstanceCapacity
Reduce the number ofReserved Instances inyour request or wait foradditional capacity tobecome available.
Not enough available ReservedInstances to satisfy your minimumrequest.
InsufficientReservedInstanceCapacity
API Version 2010-08-31714
Amazon Elastic Compute Cloud API ReferenceSummary of Server Error Codes
NotesDescriptionError Code
This error should notoccur. If this persists,please contact us withdetails by posting amessage on the AWSforums.
Internal Error.InternalError
The server is overloaded and cannothandle the request.
Unavailable
API Version 2010-08-31715
Amazon Elastic Compute Cloud API ReferenceSummary of Server Error Codes
Glossary
Amazon machine image (AMI) An Amazon Machine Image (AMI) is an encrypted machine imagestored in Amazon S3. It contains all the information necessary to bootinstances of your software.
Amazon EBS A type of storage that enables you to create volumes that can bemounted as devices by Amazon EC2 instances. Amazon EBS volumesbehave like raw unformatted external block devices. They have usersupplied device names and provide a block device interface.You canload a file system on top of Amazon EBS volumes, or use them justas you would use a block device.
Amazon EBS-backed AMI An instance launched from an AMI backed by Amazon EBS uses anAmazon EBS volume as its root device. See Amazon EBS.
Amazon S3-backed AMI An instance launched from an Amazon S3backed AMI uses aninstance store as its root device. See instance store.
Availability Zone A distinct location within a Region that is engineered to be insulatedfrom failures in other Availability Zones and provides inexpensive,low latency network connectivity to other Availability Zones in thesame Region.
compute unit An Amazon-generated measure that enables you to evaluate the CPUcapacity of different Amazon EC2 instance types.
EBS See Amazon EBS.
Elastic Block Store See Amazon EBS.
elastic IP address A static public IP address designed for dynamic cloud computing.Elastic IP addresses are associated with your account, not specificinstances. Any elastic IP addresses that you associate with youraccount remain associated with your account until you explicitlyrelease them. Unlike traditional static IP addresses, however, elasticIP addresses allow you to mask instance or Availability Zone failuresby rapidly remapping your public IP addresses to any instance in youraccount.
ephemeral store See instance store.
API Version 2010-08-31716
Amazon Elastic Compute Cloud API Reference
explicit launch permission Launch permission granted to a specific AWS account.
filter Criterion you specify to limit the results when you list or describe yourEC2 resources.
gibibyte (GiB) A contraction of giga binary byte, a gibibyte is 2^30 bytes or1,073,741,824 bytes. A gigabyte is 10^9 or 1,000,000,000 bytes.
group See security group.
image See Amazon machine image.
instance Once an AMI has been launched, the resulting running system isreferred to as an instance. All instances based on the same AMI startout identical and any information on them is lost when the instancesare terminated or fail.
instance store Every instance includes a fixed amount of storage space on whichyou can store data. This is not designed to be a permanent storagesolution. If you need a permanent storage system, use Amazon EBS.
instance type A specification that defines the memory, CPU, storage capacity, andhourly cost for an instance. Some instance types are designed forstandard applications while others are designed for CPU-intensiveapplications.
launch permission AMI attribute allowing AWS accounts to launch an AMI
Linux Amazon EC2 instances are available for many operating platforms,including Linux, Solaris, Windows, and others.
maximum price The maximum price you will pay to launch one or more Spot Instances.If your maximum price exceeds the Spot Price and your restrictionsare met, Amazon EC2 launches instances on your behalf.
paid AMI An AMI that you sell to other Amazon EC2 users. For moreinformation, refer to the Amazon DevPay Developer Guide.
private IP address All Amazon EC2 instances are assigned two IP addresses at launch:a private address (RFC 1918) and a public address that are directlymapped to each other through Network Address Translation (NAT).
public AMI An AMI that all AWS accounts have launch permissions for.
public data sets Sets of large public data sets that can be seamlessly integrated intoAWS cloud-based applications. Amazon stores the data sets at nocharge to the community and, like with all AWS services, you payonly for the compute and storage you use for their your applications.These data sets currently include data from the Human GenomeProject, the U.S. Census, Wikipedia, and other sources.
public IP address All Amazon EC2 instances are assigned two IP addresses at launch:a private address (RFC 1918) and a public address that are directlymapped to each other through Network Address Translation (NAT).
region A geographical area in which you can launch instances (e.g., US,EU).
reservation A collection of instances started as part of the same launch request.
API Version 2010-08-31717
Amazon Elastic Compute Cloud API Reference
Reserved Instance An additional Amazon EC2 pricing option. With Reserved Instances,you can make a low one-time payment for each instance to reserveand receive a significant discount on the hourly usage charge for thatinstance.
resource A general term that refers to the objects you work with in AmazonEC2. This includes instances, images, Amazon EBS volumes,snapshots, etc.
security group A security group is a named collection of access rules.These accessrules specify which ingress (i.e., incoming) network traffic should bedelivered to your instance. All other ingress traffic will be discarded.
shared AMI AMIs that developers build and make available for other AWSdevelopers to use.
Solaris Amazon EC2 instances are available for many operating platforms,including Linux, Solaris, Windows, and others.
snapshot Amazon EBS provides the ability to create snapshots or backups ofyour Amazon EBS volumes and store them in Amazon S3.You canuse these snapshots as the starting point for new Amazon EBSvolumes and to protect your data for long term durability.
Spot Instance A type of instance that you can bid on to take advantage of unusedAmazon EC2 capacity.
Spot Price The current price for Spot Instances. If your Spot Instance requestexceeds this price and your restrictions are met, Amazon EC2launches instances on your behalf.
supported AMIs These AMIs are similar to paid AMIs, except that you charge forsoftware or a service that customers use with their own AMIs.
tag Metadata of your choice (consisting of up to 10 key-value pairs) thatyou can optionally assign to EC2 resources.
tebibyte (TiB) A contraction of tera binary byte, a tebibyte is 2^40 bytes or1,099,511,627,776 bytes. A terabyte is 10^12 or 1,000,000,000,000bytes.
UNIX Amazon EC2 instances are available for many operating platforms,including Linux, Solaris, Windows, and others.
Windows Amazon EC2 instances are available for many operating platforms,including Linux, Solaris, Windows, and others.
API Version 2010-08-31718
Amazon Elastic Compute Cloud API Reference
Document Conventions
This section lists the common typographical and symbol use conventions for AWS technical publications.
Typographical ConventionsThis section describes common typographical use conventions.
Description/ExampleConvention
A call-out is a number in the body text to give you a visual reference. Thereference point is for further discussion elsewhere.
You can use this resource regularly.
Call-outs
Inline code samples (including XML) and commands are identified with aspecial font.
You can use the command java -version.
Code in text
Blocks of sample code are set apart from the body and marked accordingly.
# ls -l /var/www/html/index.html-rw-rw-r-- 1 root root 1872 Jun 21 09:33 /var/www/html/index.html# dateWed Jun 21 09:33:42 EDT 2006
Code blocks
Unusual or important words and phrases are marked with a special font.
You must sign up for an account before you can use the service.
Emphasis
References to a section in the same document are marked.
See Document Conventions (p. 719).
Internal cross references
A special font is used for expressions that are important to identify, but arenot code.
If the value is null, the returned response will be false.
Logical values,constants, and regularexpressions, abstracta
API Version 2010-08-31719
Amazon Elastic Compute Cloud API ReferenceTypographical Conventions
Description/ExampleConvention
Named AWS products and features are identified on first use.
Create an Amazon Machine Image (AMI).
Product and featurenames
In-text references to operations.
Use the GetHITResponse operation.
Operations
In-text references to parameters.
The operation accepts the parameter AccountID.
Parameters
In-text references to responses.
A container for one CollectionParent and one or moreCollectionItems.
Response elements
References to other AWS publications. If the reference is hyperlinked, it isalso underscored.
For detailed conceptual information, see the Amazon Mechanical TurkDeveloper Guide.
Technical publicationreferences
A special font marks text that the user types.
At the password prompt, type MyPassword.
User entered values
Denotes named items on the UI for easy identification.
On the File menu, click Properties.
User interface controlsand labels
When you see this style, you must change the value of the content when youcopy the text of a sample to a command line.
% ec2-register <your-s3-bucket>/image.manifest
See also Symbol Conventions (p. 721).
Variables
API Version 2010-08-31720
Amazon Elastic Compute Cloud API ReferenceTypographical Conventions
Symbol ConventionsThis section describes the common use of symbols.
Description/ExampleSymbolConvention
Within a code description, bar separators denote options fromwhich one must be chosen.
% data = hdfread (start | stride | edge)
(Parentheses | and| vertical | bars)
Mutuallyexclusiveparameters
Within a code description, square brackets denote completelyoptional commands or parameters.
% sed [-n, -quiet]
Use square brackets in XML examples to differentiate them fromtags.
<CustomerId>[ID]</CustomerId>
[square brackets]Optionalparameters
XML variabletext
Within a code sample, arrow brackets denote a variable thatmust be replaced with a valid value.
% ec2-register <your-s3-bucket>/image.manifest
<arrow brackets>Variables
API Version 2010-08-31721
Amazon Elastic Compute Cloud API ReferenceSymbol Conventions
IndexAactions, 6adding key pairs, 40, 192, 292, 471adding security groups, 44, 297adding tags, 52, 305AllocateAddress
Query, 16SOAP, 262
Amazon EBSdescribing snapshot attributes, 147, 417modifying resetting attributes, 226, 516modifying snapshot attributes, 200, 483
AMIscreating Amazon EBS root device-based, 38, 289deregistering, 72, 327describing attributes, 86, 344describing images, 91, 350registering, 208, 493resetting attributes, 222, 512
APIactions, 6data types, 6
API listQuery, 12SOAP, 258
AssociateAddressQuery, 17SOAP, 264
attaching volumes, 19, 266AttachVolume
Query, 19SOAP, 266
audience, 1AuthorizeSecurityGroupIngress
Query, 22SOAP, 269
authorizing security group ingress, 22, 269Availability Zones
describing, 77, 333
Bblock storage
create snapshot, 46, 63, 299, 317bundle task
canceling, 30, 280describing, 81, 337
BundleInstanceQuery, 25SOAP, 274
bundling Windows password, 25, 274
CCalls
Query, 12SOAP, 258
CancelBundleTaskQuery, 30SOAP, 280
canceling Windows bundling, 30, 280CancelSpotInstanceRequests
Query, 34SOAP, 284
changes to Amazon EC2, 4client error codes, 710confirming instances, 36, 287ConfirmProductInstance
Query, 36SOAP, 287
console outputgetting, 188, 467
CreateImageQuery, 38SOAP, 289
CreateKeyPairQuery, 40SOAP, 292
CreatePlacementGroupQUERY, 42SOAP, 295
CreateSecurityGroupQuery, 44SOAP, 297
CreateSnapshotQuery, 46SOAP, 299
CreateSpotDatafeedSubscriptionQuery, 49SOAP, 302
CreateTagsQuery, 52, 305
CreateVolumeQuery, 54SOAP, 308
creating EBS snapshots, 46, 63, 299, 317creating key pairs, 40, 292creating placement groups, 42, 295creating security groups, 44, 297creating volumes, 54, 308
Ddata types, 6DeleteKeyPair
Query, 58SOAP, 312
DeletePlacementGroupQUERY, 60SOAP, 314
DeleteSecurityGroup
API Version 2010-08-31722
Amazon Elastic Compute Cloud API Reference
Query, 61SOAP, 315
DeleteSnapshotQuery, 63SOAP, 317
DeleteSpotDatafeedSubscriptionQuery, 65SOAP, 319
DeleteTagsQuery, 67, 321
DeleteVolumeQuery, 70SOAP, 325
deletingkey pairs, 58, 312security groups, 61, 315
deleting placement groups, 60, 314deleting tags, 67, 321deleting volumes, 70, 325DeregisterImage
Query, 72SOAP, 327
deregistering AMIs, 72, 327DescribeAddresses
Query, 74SOAP, 329
DescribeAvailabilityZonesQuery, 77SOAP, 333
DescribeBundleTasksQuery, 81SOAP, 337
DescribeImageAttributeQuery, 86SOAP, 344
DescribeImagesQuery, 91SOAP, 350
DescribeInstanceAttributeQuery, 101SOAP, 362
DescribeInstancesQuery, 105SOAP, 367
DescribeKeyPairsQuery, 121SOAP, 384
DescribePlacementGroupsQUERY, 125SOAP, 389
DescribeRegionsQuery, 128SOAP, 393
DescribeReservedInstancesQuery, 131SOAP, 397
DescribeReservedInstancesOfferingsQuery, 136
SOAP, 404DescribeSecurityGroups
Query, 141SOAP, 410
DescribeSnapshotAttributeQuery, 147SOAP, 417
DescribeSnapshotsQuery, 149SOAP, 420
DescribeSpotDatafeedSubscriptionQuery, 155SOAP, 428
DescribeSpotInstanceRequestsQuery, 157SOAP, 430
DescribeSpotPriceHistoryQuery, 167SOAP, 442
DescribeTagsQuery, 171, 447
DescribeVolumesQuery, 177SOAP, 455
describing AMI attributes, 86, 344describing Availability Zones, 77, 333describing elastic IP addresses, 74, 329describing images, 91, 350describing instance attributes, 101, 362describing instances, 105, 367describing key pairs, 121, 384describing placement groups, 125, 389describing Regions, 128, 393describing Reserved Instance offerings, 136, 404describing Reserved Instances, 131, 397describing security groups, 141, 410describing snapshots, 149, 420describing tags, 171, 447describing volumes, 177, 455describing Windows bundling tasks, 81, 337detaching volumes, 183, 462DetachVolume
Query, 183SOAP, 462
DisassociateAddressQuery, 186SOAP, 465
disassociating elastic IP addresses, 186, 465
Eelastic block storage
create snapshot, 46, 63, 299, 317elastic IP addresses
associating, 17, 264describing, 74, 329disassociating, 186, 465releasing, 206, 212, 491, 498
API Version 2010-08-31723
Amazon Elastic Compute Cloud API Reference
error codes, 710
Ffirewall, 44, 297function list
Query, 12SOAP, 258
GGetConsoleOutput
Query, 188SOAP, 467
GetPasswordDataQuery, 190SOAP, 469
getting console output, 188, 467getting password, 190, 469glossary, 716groups
creating, 44, 297describing, 141, 410revoking access, 228, 231, 518, 522
Iimage attributes
describing, 86, 344images
creating Amazon EBS root device-based, 38, 289deregistering, 72, 327describing, 91, 350modifying attributes, 195, 474registering, 208, 493resetting attributes, 222, 512
importing key pairs, 192, 471ImportKeyPair
Query, 192SOAP, 471
instancebundling Windows, 25, 274
instancesaccessing, 16, 262confirming, 36, 287describing, 105, 367describing attributes, 101, 362modifying attributes, 198, 479monitoring, 202, 486
disabling, 254, 550rebooting, 206, 491resetting attributes, 224, 224, 514, 514spot
canceling, 34, 284create datafeed, 49, 302delete datafeed, 65, 319describe datafeed, 155, 428describing, 157, 430history, 167, 442
request, 214, 500starting, 244, 538stopping, 247, 542terminating, 251, 546
instances attributesdescribing, 101, 362
IP addressesassociating, 17, 264describing, 74, 329disassociating, 186, 465releasing, 212, 498
Kkey pairs
creating, 40, 292deleting, 58, 312describing, 121, 384importing, 192, 471
killing instances, 251, 546
MModifyImageAttribute
Query, 195SOAP, 474
modifying image attributes, 195, 474modifying instance attributes, 198, 479ModifyInstanceAttribute
Query, 198SOAP, 479
ModifySnapshotAttributeQuery, 200SOAP, 483
monitoring instances, 202, 486disabling, 254, 550
MonitorInstancesQuery, 202SOAP, 486
Nnew features, 4
Ooperation list
Query, 12SOAP, 258
Ppassword
getting Windows, 190, 469placement groups
creating, 42, 295deleting, 60, 314describing, 125, 389
PurchaseReservedInstancesOfferingQuery, 204
API Version 2010-08-31724
Amazon Elastic Compute Cloud API Reference
SOAP, 489purchasing Reserved Instances, 204, 489
QQuery
AllocateAddress, 16AssociateAddress, 17AttachVolume, 19AuthorizeSecurityGroupIngress, 22BundleInstance, 25CancelBundleTask, 30CancelSpotInstanceRequests, 34ConfirmProductInstance, 36CreateImage, 38CreateKeyPair, 40CreateSecurityGroup, 44CreateSnapshot, 46CreateSpotDatafeedSubscription, 49CreateTags, 52CreateVolume, 54DeleteKeyPair, 58DeleteSecurityGroup, 61DeleteSnapshot, 63DeleteSpotDatafeedSubscription, 65DeleteTags, 67DeleteVolume, 70DeregisterImage, 72DescribeAddresses, 74DescribeAvailabilityZones, 77DescribeBundleTasks, 81DescribeImageAttribute, 86DescribeImages, 91DescribeInstanceAttribute, 101DescribeInstances, 105DescribeKeyPairs, 121DescribeRegions, 128DescribeReservedInstances, 131DescribeReservedInstancesOfferings, 136DescribeSecurityGroups, 141DescribeSnapshotAttribute, 147DescribeSnapshots, 149DescribeSpotDatafeedSubscription, 155DescribeSpotInstanceRequests, 157DescribeSpotPriceHistory, 167DescribeTags, 171DescribeVolumes, 177DetachVolume, 183DisassociateAddress, 186GetConsoleOutput, 188GetPasswordData, 190ImportKeyPair, 192list of operations, 12ModifyImageAttribute, 195ModifyInstanceAttribute, 198ModifySnapshotAttribute, 200MonitorInstances, 202PurchaseReservedInstancesOffering, 204
RebootInstances, 206RegisterImage, 208ReleaseAddress, 212RequestSpotInstances, 214ResetImageAttribute, 222ResetInstanceAttribute, 224ResetSnapshotAttribute, 226RevokeSecurityGroupIngress, 228RunInstances, 231StartInstances, 244StopInstances, 247TerminateInstances, 251UnmonitorInstances, 254
QUERYCreatePlacementGroup, 42DeletePlacementGroup, 60DescribePlacementGroups, 125
Rrebooting instances, 206, 491RebootInstances
Query, 206SOAP, 491
Regionsdescribing, 128, 393
RegisterImageQuery, 208SOAP, 493
registering AMIs, 208, 493ReleaseAddress
Query, 212SOAP, 498
releasing elastic IP addresses, 212, 498Remote Desktop, 16, 262RequestSpotInstances
Query, 214SOAP, 500
required knowledge, 1Reserved Instances
describing, 131, 397describing offerings, 136, 404purchasing, 204, 489
ResetImageAttributeQuery, 222SOAP, 512
ResetInstanceAttributeQuery, 224SOAP, 514
ResetSnapshotAttributeQuery, 226SOAP, 516
resetting image attributes, 222, 512resetting instance attributes, 224, 514resources, 2RevokeSecurityGroupIngress
Query, 228SOAP, 518
API Version 2010-08-31725
Amazon Elastic Compute Cloud API Reference
revoking access, 228, 231, 518, 522RunInstances
Query, 231SOAP, 522
Ssecurity groups
authorizing ingress, 22, 269creating, 44, 297deleting, 61, 315describing, 141, 410revoking access, 228, 231, 518, 522
server error codes, 710shutting down instances, 251, 546snapshots
describing, 149, 420describing attributes, 147, 417modifying attributes, 200, 483resetting attributes, 226, 516
SOAPAllocateAddress, 262AssociateAddress, 264AttachVolume, 266AuthorizeSecurityGroupIngress, 269BundleInstance, 274CancelBundleTask, 280CancelSpotInstanceRequests, 284ConfirmProductInstance, 287CreateImage, 289CreateKeyPair, 292CreatePlacementGroup, 295CreateSecurityGroup, 297CreateSnapshot, 299CreateSpotDatafeedSubscription, 302CreateTags, 305CreateVolume, 308DeleteKeyPair, 312DeletePlacementGroup, 314DeleteSecurityGroup, 315DeleteSnapshot, 317DeleteSpotDatafeedSubscription, 319DeleteTags, 321DeleteVolume, 325DeregisterImage, 327DescribeAddresses, 329DescribeAvailabilityZones, 333DescribeBundleTasks, 337DescribeImageAttribute, 344DescribeImages, 350DescribeInstanceAttribute, 362DescribeInstances, 367DescribeKeyPairs, 384DescribePlacementGroups, 389DescribeRegions, 393DescribeReservedInstances, 397DescribeReservedInstancesOfferings, 404DescribeSecurityGroups, 410
DescribeSnapshotAttribute, 417DescribeSnapshots, 420DescribeSpotDatafeedSubscription, 428DescribeSpotInstanceRequests, 430DescribeSpotPriceHistory, 442DescribeTags, 447DescribeVolumes, 455DetachVolume, 462DisassociateAddress, 465GetConsoleOutput, 467GetPasswordData, 469ImportKeyPair, 471list of operations, 258ModifyImageAttribute, 474ModifyInstanceAttribute, 479ModifySnapshotAttribute, 483MonitorInstances, 486PurchaseReservedInstancesOffering, 489RebootInstances, 491RegisterImage, 493ReleaseAddress, 498RequestSpotInstances, 500ResetImageAttribute, 512ResetInstanceAttribute, 514ResetSnapshotAttribute, 516RevokeSecurityGroupIngress, 518RunInstances, 522StartInstances, 538StopInstances, 542TerminateInstances, 546UnmonitorInstances, 550
Spot Instancescanceling, 34, 284create datafeed, 49, 302delete datafeed, 65, 319describe datafeed, 155, 428describing, 157, 430describing history, 167, 442requesting, 214, 500
starting instances, 244, 538StartInstances
Query, 244SOAP, 538
StopInstancesQuery, 247SOAP, 542
stopping instances, 247, 542
Ttags
adding to a resource, 52, 305deleting from a resource, 67, 321describing, 171, 447
TerminateInstancesQuery, 251SOAP, 546
terminating instances, 251, 546
API Version 2010-08-31726
Amazon Elastic Compute Cloud API Reference
UUnmonitorInstances
Query, 254SOAP, 550
Vverifying instances, 36, 287volumes
attaching, 19, 266creating, 54, 308deleting, 70, 325describing, 177, 455detaching, 183, 462
WWindows
bundling instance, 25, 274canceling bundle task, 30, 280describing bundle tasks, 81, 337getting password, 190, 469
Zzones
describing, 77, 333
API Version 2010-08-31727
Amazon Elastic Compute Cloud API Reference