AmazonEC2Client Class Reference
| Inherits from | AmazonWebServiceClient : AmazonAbstractWebServiceClient : NSObject |
| Declared in | AmazonEC2Client.h |
Overview
Amazon EC2
Amazon Elastic Compute Cloud (Amazon EC2) is a web service that provides resizable compute capacity in the cloud. It is designed to make web-scale computing easier for developers.
Amazon EC2's simple web service interface allows you to obtain and configure capacity with minimal friction.  Amazon EC2 reduces the time required to obtain and boot new server instances to minutes, allowing you to quickly scale capacity, both up and down, as your computing requirements change. Amazon EC2 changes the economics of computing by allowing you to pay only for capacity that you actually use. Amazon EC2 provides developers the tools to build failure resilient applications and isolate themselves from common failure scenarios.
Visit http://aws.amazon.com/ec2/ for more information.
Tasks
-
– rebootInstances:
The RebootInstances operation requests a reboot of one or more instances. This operation is asynchronous; it only queues a request to reboot the specified instance(s). The operation will succeed if the instances are valid and belong to the user. Requests to reboot terminated instances are ignored.
-
– describeReservedInstances:
The DescribeReservedInstances operation describes Reserved Instances that were purchased for use with your account.
-
– describeAvailabilityZones:
The DescribeAvailabilityZones operation describes availability zones that are currently available to the account and their states.
Availability zones are not the same across accounts. The availability zone us-east-1a for account A is not necessarily the same as us-east-1a for account B. Zone assignments are mapped independently for each account.
-
– detachVolume:
Detach a previously attached volume from a running instance.
-
– deleteKeyPair:
The DeleteKeyPair operation deletes a key pair.
-
– unmonitorInstances:
Disables monitoring for a running instance.
-
– createImage:
Creates an Amazon EBS-backed AMI from a "running" or "stopped" instance. AMIs that use an Amazon EBS root device boot faster than AMIs that use instance stores. They can be up to 1 TiB in size, use storage that persists on instance failure, and can be stopped and started.
-
– deleteSecurityGroup:
The DeleteSecurityGroup operation deletes a security group.
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 is returned. 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.
-
– createInstanceExportTask:
Container for the necessary parameters to execute the CreateInstanceExportTask service method on AmazonEC2.
-
– getPasswordData:
Retrieves 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 generated for rebundled AMIs or after the password is changed on an instance. The password is encrypted using the key pair that you provided.
-
– stopInstances:
Stops 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. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you 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. Stopping an instance does not preserve data stored in RAM. Performing this operation on an instance that uses an instance store as its root device returns an error.
-
– importKeyPair:
Imports the public key from an RSA key pair created with a third-party tool. This operation differs from CreateKeyPair as the private key is never transferred between the caller and AWS servers.
RSA key pairs are easily created on Microsoft Windows and Linux OS systems using the ssh-keygen command line tool provided with the standard OpenSSH installation. Standard library support for RSA key pair creation is also available for Java, Ruby, Python, and many other programming languages.
The following formats are supported:
-
– createSecurityGroup:
The CreateSecurityGroup operation creates a new security group.
Every instance is launched in a security group. If no security group is specified during launch, the instances are launched in the default security group. Instances within the same security group have unrestricted network access to each other. Instances will reject network access attempts from other instances in a different security group. As the owner of instances you can grant or revoke specific permissions using the AuthorizeSecurityGroupIngress and RevokeSecurityGroupIngress operations.
-
– describeSpotPriceHistory:
Describes the Spot Price history.
Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current spot instance requests.
For conceptual information about Spot Instances, refer to the Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide .
-
– describeRegions:
The DescribeRegions operation describes regions zones that are currently available to the account.
-
– createReservedInstancesListing:
Container for the necessary parameters to execute the CreateReservedInstancesListing service method on AmazonEC2.
-
– resetSnapshotAttribute:
Resets permission settings for the specified snapshot.
-
– importVolume:
Container for the necessary parameters to execute the ImportVolume service method on AmazonEC2.
-
– describeSecurityGroups:
The DescribeSecurityGroups operation returns information about security groups that you own.
If you specify security group names, information about those security group is returned. Otherwise, information for all security group is returned. If you specify a group that does not exist, a fault is returned.
-
– deregisterImage:
The DeregisterImage operation deregisters an AMI. Once deregistered, instances of the AMI can no longer be launched.
-
– describeSpotDatafeedSubscription:
Describes the data feed for Spot Instances.
For conceptual information about Spot Instances, refer to the Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide .
-
– deleteTags:
Deletes tags from the specified Amazon EC2 resources.
-
– enableVolumeIO:
Enable IO on the volume after an event has occured.
-
– attachVolume:
Attach a previously created volume to a running instance.
-
– describeLicenses:
Provides details of a user's registered licenses. Zero or more IDs may be specified on the call. When one or more license IDs are specified, only data for the specified IDs are returned.
-
– describeVolumeStatus:
Describes the status of a volume.
-
– activateLicense:
Activates a specific number of licenses for a 90-day period. Activations can be done against a specific license ID.
-
– resetImageAttribute:
The ResetImageAttribute operation resets an attribute of an AMI to its default value.
NOTE: The productCodes attribute cannot be reset.
-
– createSnapshot:
Create a snapshot of the volume identified by volume ID. A volume does not have to be detached at the time the snapshot is taken.
NOTE: Snapshot creation requires that the system is in a consistent state. For instance, this means that if taking a snapshot of a database, the tables must be read-only locked to ensure that the snapshot will not contain a corrupted version of the database. Therefore, be careful when using this API to ensure that the system remains in the consistent state until the create snapshot status has returned.
-
– deleteVolume:
Deletes a previously created volume. Once successfully deleted, a new volume can be created with the same name.
-
– associateAddress:
The AssociateAddress operation associates an elastic IP address with an instance.
If the IP address is currently assigned to another instance, the IP address is assigned to the new instance. This is an idempotent operation. If you enter it more than once, Amazon EC2 does not return an error.
-
– cancelConversionTask:
Container for the necessary parameters to execute the CancelConversionTask service method on AmazonEC2.
-
– deactivateLicense:
Deactivates a specific number of licenses. Deactivations can be done against a specific license ID after they have persisted for at least a 90-day period.
-
– describeExportTasks:
Container for the necessary parameters to execute the DescribeExportTasks service method on AmazonEC2.
-
– describeVolumes:
Describes the status of the indicated volume or, in lieu of any specified, all volumes belonging to the caller. Volumes that have been deleted are not described.
-
– describeReservedInstancesListings:
Container for the necessary parameters to execute the DescribeReservedInstancesListings service method on AmazonEC2.
-
– reportInstanceStatus:
Container for the necessary parameters to execute the ReportInstanceStatus service method on AmazonEC2.
-
– monitorInstances:
Enables monitoring for a running instance.
-
– describeBundleTasks:
The DescribeBundleTasks operation describes in-progress and recent bundle tasks. Complete and failed tasks are removed from the list a short time after completion. If no bundle ids are given, all bundle tasks are returned.
-
– importInstance:
Container for the necessary parameters to execute the ImportInstance service method on AmazonEC2.
-
– revokeSecurityGroupIngress:
The RevokeSecurityGroupIngress operation revokes permissions from a security group. The permissions used to revoke must be specified using the same values used to grant the permissions.
Permissions are specified by IP protocol (TCP, UDP, or ICMP), the source of the request (by IP range or an Amazon EC2 user-group pair), the source and destination port ranges (for TCP and UDP), and the ICMP codes and types (for ICMP).
Permission changes are quickly propagated to instances within the security group. However, depending on the number of instances in the group, a small delay might occur.
-
– getConsoleOutput:
The GetConsoleOutput operation retrieves 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 after the most recent post.
-
– modifyImageAttribute:
The ModifyImageAttribute operation modifies an attribute of an AMI.
-
– createSpotDatafeedSubscription:
Creates the data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per account.
For conceptual information about Spot Instances, refer to the Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide .
-
– describeConversionTasks:
Container for the necessary parameters to execute the DescribeConversionTasks service method on AmazonEC2.
-
– describeInstanceAttribute:
Returns information about an attribute of an instance. Only one attribute can be specified per call.
-
– runInstances:
The RunInstances operation launches a specified number of instances.
If Amazon EC2 cannot launch the minimum number AMIs you request, no instances launch. If there is insufficient capacity to launch the maximum number of AMIs you request, Amazon EC2 launches as many as possible to satisfy the requested maximum values.
Every instance is launched in a security group. If you do not specify a security group at launch, the instances start in your default security group. For more information on creating security groups, see CreateSecurityGroup.
An optional instance type can be specified. For information about instance types, see Instance Types.
You can provide an optional key pair ID for each image in the launch request (for more information, see CreateKeyPair). All instances that are created from images that use this key pair will have access to the associated public key at boot. You can use this key to provide secure access to an instance of an image on a per-instance basis. Amazon EC2 public images 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.pub file on a logical device that is exposed to the instance as /dev/sda2 (the ephemeral store). The format of this file is suitable for use as an entry within ~/.ssh/authorized_keys (the OpenSSH format). This can 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 the launch request have access to this data For more information, see Instance Metadata.
NOTE: If any of the AMIs have a product code attached for which the user has not subscribed, the RunInstances call will fail.
IMPORTANT: We strongly recommend using the 2.6.18 Xen stock kernel with the c1.medium and c1.xlarge instances. Although the default Amazon EC2 kernels will work, the new kernels provide greater stability and performance for these instance types. For more information about kernels, see Kernels, RAM Disks, and Block Device Mappings.
-
– describePlacementGroups:
Returns information about one or more PlacementGroup instances in a user's account.
-
– describeInstances:
The DescribeInstances operation returns information about instances that you own.
If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an invalid instance ID, a fault is returned. If you specify an instance that you do not own, it will not be included in the returned results.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
-
– modifyVolumeAttribute:
Container for the necessary parameters to execute the ModifyVolumeAttribute service method on AmazonEC2.
-
– describeImages:
The DescribeImages operation returns information about AMIs, AKIs, and ARIs available to the user. Information returned includes image type, product codes, architecture, and kernel and RAM disk IDs. Images available to the user include public images available for any user to launch, private images owned by the user making the request, and private images owned by other users for which the user has explicit launch permissions.
Launch permissions fall into three categories:
-
– startInstances:
Starts 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. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time.
NOTE: Performing this operation on an instance that uses an instance store as its root device returns an error.
-
– cancelReservedInstancesListing:
Container for the necessary parameters to execute the CancelReservedInstancesListing service method on AmazonEC2.
-
– modifyInstanceAttribute:
Modifies an attribute of an instance.
-
– authorizeSecurityGroupIngress:
The AuthorizeSecurityGroupIngress operation adds permissions to a security group.
Permissions are specified by the IP protocol (TCP, UDP or ICMP), the source of the request (by IP range or an Amazon EC2 user-group pair), the source and destination port ranges (for TCP and UDP), and the ICMP codes and types (for ICMP). When authorizing ICMP, -1 can be used as a wildcard in the type and code fields.
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.
-
– describeSpotInstanceRequests:
Describes Spot Instance requests. Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current spot instance requests. For conceptual information about Spot Instances, refer to the Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide .
You can filter the results to return information only about Spot Instance requests that match criteria you specify. For example, you could get information about requests where the Spot Price you specified is a certain 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 specified values 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 type is m1.small ). The result includes information for a particular request 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: an asterisk matches zero or more characters, and ? matches exactly one character. You can escape special characters using a backslash before the character. For example, a value of *amazon\?\ searches for the literal string *amazon?\ .
-
– cancelExportTask:
Container for the necessary parameters to execute the CancelExportTask service method on AmazonEC2.
-
– requestSpotInstances:
Creates a Spot Instance request.
Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current spot instance requests.
For conceptual information about Spot Instances, refer to the Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide.
-
– createTags:
Adds or overwrites tags for the specified resources. Each resource can have a maximum of 10 tags. Each tag consists of a key-value pair. Tag keys must be unique per resource.
-
– describeVolumeAttribute:
Container for the necessary parameters to execute the DescribeVolumeAttribute service method on AmazonEC2.
-
– describeTags:
Describes the tags for the specified resources.
-
– cancelBundleTask:
CancelBundleTask operation cancels a pending or in-progress bundling task. This is an asynchronous call and it make take a while for the task to be canceled. If a task is canceled while it is storing items, there may be parts of the incomplete AMI stored in S3. It is up to the caller to clean up these parts from S3.
-
– cancelSpotInstanceRequests:
Cancels one or more Spot Instance requests.
Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current spot instance requests.
For conceptual information about Spot Instances, refer to the Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide .
-
– purchaseReservedInstancesOffering:
The PurchaseReservedInstancesOffering operation purchases a Reserved Instance for use with your account. With Amazon EC2 Reserved Instances, you purchase the right to launch Amazon EC2 instances for a period of time (without getting insufficient capacity errors) and pay a lower usage rate for the actual time used.
-
– modifySnapshotAttribute:
Adds or remove permission settings for the specified snapshot.
-
– terminateInstances:
The TerminateInstances operation shuts down one or more instances. This operation is idempotent; if you terminate an instance more than once, each call will succeed.
Terminated instances will remain visible after termination (approximately one hour).
-
– deleteSpotDatafeedSubscription:
Deletes the data feed for Spot Instances.
For conceptual information about Spot Instances, refer to the Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide .
-
– describeSnapshotAttribute:
Returns information about an attribute of a snapshot. Only one attribute can be specified per call.
-
– describeAddresses:
The DescribeAddresses operation lists elastic IP addresses assigned to your account.
-
– describeImageAttribute:
The DescribeImageAttribute operation returns information about an attribute of an AMI. Only one attribute can be specified per call.
-
– describeKeyPairs:
The DescribeKeyPairs operation returns information about key pairs available to you. If you specify key pairs, information about those key pairs is returned. Otherwise, information for all registered key pairs is returned.
-
– confirmProductInstance:
The ConfirmProductInstance operation returns true if the specified product code is attached to the specified instance. The operation returns false if the product code is not attached to the instance.
The ConfirmProductInstance operation can only be executed by the owner of the AMI. This feature is useful when an AMI owner is providing support and wants to verify whether a user's instance is eligible.
-
– createVolume:
Initializes an empty volume of a given size.
-
– describeInstanceStatus:
Describes the status of an Amazon Elastic Compute Cloud (Amazon EC2) instance. Instance status provides information about two types of scheduled events for an instance that may require your attention:
-
– describeReservedInstancesOfferings:
The DescribeReservedInstancesOfferings operation describes Reserved Instance offerings that are available for purchase. With Amazon EC2 Reserved Instances, you purchase the right to launch Amazon EC2 instances for a period of time (without getting insufficient capacity errors) and pay a lower usage rate for the actual time used.
-
– deleteSnapshot:
Deletes the snapshot identified by snapshotId .
-
– disassociateAddress:
The DisassociateAddress operation disassociates the specified elastic IP address from the instance to which it is assigned. This is an idempotent operation. If you enter it more than once, Amazon EC2 does not return an error.
-
– createPlacementGroup:
Creates a PlacementGroup into which multiple Amazon EC2 instances can be launched. Users must give the group a name unique within the scope of the user account.
-
– bundleInstance:
The BundleInstance operation request that an instance is bundled the next time it boots. The bundling process creates a new image from a running instance and stores the AMI data in S3. Once bundled, the image must be registered in the normal way using the RegisterImage API.
-
– deletePlacementGroup:
Deletes a PlacementGroup from a user's account. Terminate all Amazon EC2 instances in the placement group before deletion.
-
– allocateAddress:
The AllocateAddress operation acquires an elastic IP address for use with your account.
-
– releaseAddress:
The ReleaseAddress operation releases an elastic IP address associated with your account.
NOTE: Releasing an IP address automatically disassociates it from any instance with which it is associated. For more information, see DisassociateAddress.
IMPORTANT: After releasing an elastic IP address, it is released to the IP address pool and might no longer be available to your account. Make sure to update your DNS records and any servers or devices that communicate with the address. If you run this operation on an elastic IP address that is already released, the address might be assigned to another account which will cause Amazon EC2 to return an error.
-
– resetInstanceAttribute:
Resets an attribute of an instance to its default value.
-
– createKeyPair:
The CreateKeyPair operation creates a new 2048 bit RSA key pair and returns a unique ID that can be used to reference this key pair when launching new instances. For more information, see RunInstances.
-
– describeSnapshots:
Returns information about the Amazon EBS snapshots available to you. Snapshots available to you include public snapshots available for any AWS account to launch, private snapshots you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions.
-
– registerImage:
The RegisterImage operation registers an AMI with Amazon EC2. Images must be registered before they can be launched. For more information, see RunInstances.
Each AMI is associated with an unique ID which is provided by the Amazon EC2 service through the RegisterImage operation. During registration, Amazon EC2 retrieves the specified image manifest from Amazon S3 and verifies that the image is owned by the user registering the image.
The image manifest is retrieved once and stored within the Amazon EC2. Any modifications to an image in Amazon S3 invalidates this registration. If you make changes to an image, deregister the previous image and register the new image. For more information, see DeregisterImage.
Instance Methods
activateLicense:
Activates a specific number of licenses for a 90-day period. Activations can be done against a specific license ID.
- (EC2ActivateLicenseResponse *)activateLicense:(EC2ActivateLicenseRequest *)activateLicenseRequest
Parameters
- activateLicenseRequest
Container for the necessary parameters to execute the ActivateLicense service method on AmazonEC2.
Discussion
Activates a specific number of licenses for a 90-day period. Activations can be done against a specific license ID.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
allocateAddress:
The AllocateAddress operation acquires an elastic IP address for use with your account.
- (EC2AllocateAddressResponse *)allocateAddress:(EC2AllocateAddressRequest *)allocateAddressRequest
Parameters
- allocateAddressRequest
Container for the necessary parameters to execute the AllocateAddress service method on AmazonEC2.
Return Value
The response from the AllocateAddress service method, as returned by AmazonEC2.
Discussion
The AllocateAddress operation acquires an elastic IP address for use with your account.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
associateAddress:
The AssociateAddress operation associates an elastic IP address with an instance.
If the IP address is currently assigned to another instance, the IP address is assigned to the new instance. This is an idempotent operation. If you enter it more than once, Amazon EC2 does not return an error.
- (EC2AssociateAddressResponse *)associateAddress:(EC2AssociateAddressRequest *)associateAddressRequest
Parameters
- associateAddressRequest
Container for the necessary parameters to execute the AssociateAddress service method on AmazonEC2.
Return Value
The response from the AssociateAddress service method, as returned by AmazonEC2.
Discussion
The AssociateAddress operation associates an elastic IP address with an instance.
If the IP address is currently assigned to another instance, the IP address is assigned to the new instance. This is an idempotent operation. If you enter it more than once, Amazon EC2 does not return an error.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
attachVolume:
Attach a previously created volume to a running instance.
- (EC2AttachVolumeResponse *)attachVolume:(EC2AttachVolumeRequest *)attachVolumeRequest
Parameters
- attachVolumeRequest
Container for the necessary parameters to execute the AttachVolume service method on AmazonEC2.
Return Value
The response from the AttachVolume service method, as returned by AmazonEC2.
Discussion
Attach a previously created volume to a running instance.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
authorizeSecurityGroupIngress:
The AuthorizeSecurityGroupIngress operation adds permissions to a security group.
Permissions are specified by the IP protocol (TCP, UDP or ICMP), the source of the request (by IP range or an Amazon EC2 user-group pair), the source and destination port ranges (for TCP and UDP), and the ICMP codes and types (for ICMP). When authorizing ICMP, -1 can be used as a wildcard in the type and code fields.
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.
- (EC2AuthorizeSecurityGroupIngressResponse *)authorizeSecurityGroupIngress:(EC2AuthorizeSecurityGroupIngressRequest *)authorizeSecurityGroupIngressRequest
Parameters
- authorizeSecurityGroupIngressRequest
Container for the necessary parameters to execute the AuthorizeSecurityGroupIngress service method on AmazonEC2.
Discussion
The AuthorizeSecurityGroupIngress operation adds permissions to a security group.
Permissions are specified by the IP protocol (TCP, UDP or ICMP), the source of the request (by IP range or an Amazon EC2 user-group pair), the source and destination port ranges (for TCP and UDP), and the ICMP codes and types (for ICMP). When authorizing ICMP, -1 can be used as a wildcard in the type and code fields.
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.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
bundleInstance:
The BundleInstance operation request that an instance is bundled the next time it boots. The bundling process creates a new image from a running instance and stores the AMI data in S3. Once bundled, the image must be registered in the normal way using the RegisterImage API.
- (EC2BundleInstanceResponse *)bundleInstance:(EC2BundleInstanceRequest *)bundleInstanceRequest
Parameters
- bundleInstanceRequest
Container for the necessary parameters to execute the BundleInstance service method on AmazonEC2.
Return Value
The response from the BundleInstance service method, as returned by AmazonEC2.
Discussion
The BundleInstance operation request that an instance is bundled the next time it boots. The bundling process creates a new image from a running instance and stores the AMI data in S3. Once bundled, the image must be registered in the normal way using the RegisterImage API.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
cancelBundleTask:
CancelBundleTask operation cancels a pending or in-progress bundling task. This is an asynchronous call and it make take a while for the task to be canceled. If a task is canceled while it is storing items, there may be parts of the incomplete AMI stored in S3. It is up to the caller to clean up these parts from S3.
- (EC2CancelBundleTaskResponse *)cancelBundleTask:(EC2CancelBundleTaskRequest *)cancelBundleTaskRequest
Parameters
- cancelBundleTaskRequest
Container for the necessary parameters to execute the CancelBundleTask service method on AmazonEC2.
Return Value
The response from the CancelBundleTask service method, as returned by AmazonEC2.
Discussion
CancelBundleTask operation cancels a pending or in-progress bundling task. This is an asynchronous call and it make take a while for the task to be canceled. If a task is canceled while it is storing items, there may be parts of the incomplete AMI stored in S3. It is up to the caller to clean up these parts from S3.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
cancelConversionTask:
Container for the necessary parameters to execute the CancelConversionTask service method on AmazonEC2.
- (EC2CancelConversionTaskResponse *)cancelConversionTask:(EC2CancelConversionTaskRequest *)cancelConversionTaskRequest
Parameters
- cancelConversionTaskRequest
Container for the necessary parameters to execute the CancelConversionTask service method on AmazonEC2.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
cancelExportTask:
Container for the necessary parameters to execute the CancelExportTask service method on AmazonEC2.
- (EC2CancelExportTaskResponse *)cancelExportTask:(EC2CancelExportTaskRequest *)cancelExportTaskRequest
Parameters
- cancelExportTaskRequest
Container for the necessary parameters to execute the CancelExportTask service method on AmazonEC2.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
cancelReservedInstancesListing:
Container for the necessary parameters to execute the CancelReservedInstancesListing service method on AmazonEC2.
- (EC2CancelReservedInstancesListingResponse *)cancelReservedInstancesListing:(EC2CancelReservedInstancesListingRequest *)cancelReservedInstancesListingRequest
Parameters
- cancelReservedInstancesListingRequest
Container for the necessary parameters to execute the CancelReservedInstancesListing service method on AmazonEC2.
Return Value
The response from the CancelReservedInstancesListing service method, as returned by AmazonEC2.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
cancelSpotInstanceRequests:
Cancels one or more Spot Instance requests.
Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current spot instance requests.
For conceptual information about Spot Instances, refer to the Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide .
- (EC2CancelSpotInstanceRequestsResponse *)cancelSpotInstanceRequests:(EC2CancelSpotInstanceRequestsRequest *)cancelSpotInstanceRequestsRequest
Parameters
- cancelSpotInstanceRequestsRequest
Container for the necessary parameters to execute the CancelSpotInstanceRequests service method on AmazonEC2.
Return Value
The response from the CancelSpotInstanceRequests service method, as returned by AmazonEC2.
Discussion
Cancels one or more Spot Instance requests.
Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current spot instance requests.
For conceptual information about Spot Instances, refer to the Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide .
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
confirmProductInstance:
The ConfirmProductInstance operation returns true if the specified product code is attached to the specified instance. The operation returns false if the product code is not attached to the instance.
The ConfirmProductInstance operation can only be executed by the owner of the AMI. This feature is useful when an AMI owner is providing support and wants to verify whether a user's instance is eligible.
- (EC2ConfirmProductInstanceResponse *)confirmProductInstance:(EC2ConfirmProductInstanceRequest *)confirmProductInstanceRequest
Parameters
- confirmProductInstanceRequest
Container for the necessary parameters to execute the ConfirmProductInstance service method on AmazonEC2.
Return Value
The response from the ConfirmProductInstance service method, as returned by AmazonEC2.
Discussion
The ConfirmProductInstance operation returns true if the specified product code is attached to the specified instance. The operation returns false if the product code is not attached to the instance.
The ConfirmProductInstance operation can only be executed by the owner of the AMI. This feature is useful when an AMI owner is providing support and wants to verify whether a user's instance is eligible.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
createImage:
Creates an Amazon EBS-backed AMI from a "running" or "stopped" instance. AMIs that use an Amazon EBS root device boot faster than AMIs that use instance stores. They can be up to 1 TiB in size, use storage that persists on instance failure, and can be stopped and started.
- (EC2CreateImageResponse *)createImage:(EC2CreateImageRequest *)createImageRequest
Parameters
- createImageRequest
Container for the necessary parameters to execute the CreateImage service method on AmazonEC2.
Return Value
The response from the CreateImage service method, as returned by AmazonEC2.
Discussion
Creates an Amazon EBS-backed AMI from a "running" or "stopped" instance. AMIs that use an Amazon EBS root device boot faster than AMIs that use instance stores. They can be up to 1 TiB in size, use storage that persists on instance failure, and can be stopped and started.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
createInstanceExportTask:
Container for the necessary parameters to execute the CreateInstanceExportTask service method on AmazonEC2.
- (EC2CreateInstanceExportTaskResponse *)createInstanceExportTask:(EC2CreateInstanceExportTaskRequest *)createInstanceExportTaskRequest
Parameters
- createInstanceExportTaskRequest
Container for the necessary parameters to execute the CreateInstanceExportTask service method on AmazonEC2.
Return Value
The response from the CreateInstanceExportTask service method, as returned by AmazonEC2.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
createKeyPair:
The CreateKeyPair operation creates a new 2048 bit RSA key pair and returns a unique ID that can be used to reference this key pair when launching new instances. For more information, see RunInstances.
- (EC2CreateKeyPairResponse *)createKeyPair:(EC2CreateKeyPairRequest *)createKeyPairRequest
Parameters
- createKeyPairRequest
Container for the necessary parameters to execute the CreateKeyPair service method on AmazonEC2.
Return Value
The response from the CreateKeyPair service method, as returned by AmazonEC2.
Discussion
The CreateKeyPair operation creates a new 2048 bit RSA key pair and returns a unique ID that can be used to reference this key pair when launching new instances. For more information, see RunInstances.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
createPlacementGroup:
Creates a PlacementGroup into which multiple Amazon EC2 instances can be launched. Users must give the group a name unique within the scope of the user account.
- (EC2CreatePlacementGroupResponse *)createPlacementGroup:(EC2CreatePlacementGroupRequest *)createPlacementGroupRequest
Parameters
- createPlacementGroupRequest
Container for the necessary parameters to execute the CreatePlacementGroup service method on AmazonEC2.
Discussion
Creates a PlacementGroup into which multiple Amazon EC2 instances can be launched. Users must give the group a name unique within the scope of the user account.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
createReservedInstancesListing:
Container for the necessary parameters to execute the CreateReservedInstancesListing service method on AmazonEC2.
- (EC2CreateReservedInstancesListingResponse *)createReservedInstancesListing:(EC2CreateReservedInstancesListingRequest *)createReservedInstancesListingRequest
Parameters
- createReservedInstancesListingRequest
Container for the necessary parameters to execute the CreateReservedInstancesListing service method on AmazonEC2.
Return Value
The response from the CreateReservedInstancesListing service method, as returned by AmazonEC2.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
createSecurityGroup:
The CreateSecurityGroup operation creates a new security group.
Every instance is launched in a security group. If no security group is specified during launch, the instances are launched in the default security group. Instances within the same security group have unrestricted network access to each other. Instances will reject network access attempts from other instances in a different security group. As the owner of instances you can grant or revoke specific permissions using the AuthorizeSecurityGroupIngress and RevokeSecurityGroupIngress operations.
- (EC2CreateSecurityGroupResponse *)createSecurityGroup:(EC2CreateSecurityGroupRequest *)createSecurityGroupRequest
Parameters
- createSecurityGroupRequest
Container for the necessary parameters to execute the CreateSecurityGroup service method on AmazonEC2.
Return Value
The response from the CreateSecurityGroup service method, as returned by AmazonEC2.
Discussion
The CreateSecurityGroup operation creates a new security group.
Every instance is launched in a security group. If no security group is specified during launch, the instances are launched in the default security group. Instances within the same security group have unrestricted network access to each other. Instances will reject network access attempts from other instances in a different security group. As the owner of instances you can grant or revoke specific permissions using the AuthorizeSecurityGroupIngress and RevokeSecurityGroupIngress operations.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
createSnapshot:
Create a snapshot of the volume identified by volume ID. A volume does not have to be detached at the time the snapshot is taken.
NOTE: Snapshot creation requires that the system is in a consistent state. For instance, this means that if taking a snapshot of a database, the tables must be read-only locked to ensure that the snapshot will not contain a corrupted version of the database. Therefore, be careful when using this API to ensure that the system remains in the consistent state until the create snapshot status has returned.
- (EC2CreateSnapshotResponse *)createSnapshot:(EC2CreateSnapshotRequest *)createSnapshotRequest
Parameters
- createSnapshotRequest
Container for the necessary parameters to execute the CreateSnapshot service method on AmazonEC2.
Return Value
The response from the CreateSnapshot service method, as returned by AmazonEC2.
Discussion
Create a snapshot of the volume identified by volume ID. A volume does not have to be detached at the time the snapshot is taken.
NOTE: Snapshot creation requires that the system is in a consistent state. For instance, this means that if taking a snapshot of a database, the tables must be read-only locked to ensure that the snapshot will not contain a corrupted version of the database. Therefore, be careful when using this API to ensure that the system remains in the consistent state until the create snapshot status has returned.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
createSpotDatafeedSubscription:
Creates the data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per account.
For conceptual information about Spot Instances, refer to the Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide .
- (EC2CreateSpotDatafeedSubscriptionResponse *)createSpotDatafeedSubscription:(EC2CreateSpotDatafeedSubscriptionRequest *)createSpotDatafeedSubscriptionRequest
Parameters
- createSpotDatafeedSubscriptionRequest
Container for the necessary parameters to execute the CreateSpotDatafeedSubscription service method on AmazonEC2.
Return Value
The response from the CreateSpotDatafeedSubscription service method, as returned by AmazonEC2.
Discussion
Creates the data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per account.
For conceptual information about Spot Instances, refer to the Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide .
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
createTags:
Adds or overwrites tags for the specified resources. Each resource can have a maximum of 10 tags. Each tag consists of a key-value pair. Tag keys must be unique per resource.
- (EC2CreateTagsResponse *)createTags:(EC2CreateTagsRequest *)createTagsRequest
Parameters
- createTagsRequest
Container for the necessary parameters to execute the CreateTags service method on AmazonEC2.
Discussion
Adds or overwrites tags for the specified resources. Each resource can have a maximum of 10 tags. Each tag consists of a key-value pair. Tag keys must be unique per resource.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
createVolume:
Initializes an empty volume of a given size.
- (EC2CreateVolumeResponse *)createVolume:(EC2CreateVolumeRequest *)createVolumeRequest
Parameters
- createVolumeRequest
Container for the necessary parameters to execute the CreateVolume service method on AmazonEC2.
Return Value
The response from the CreateVolume service method, as returned by AmazonEC2.
Discussion
Initializes an empty volume of a given size.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
deactivateLicense:
Deactivates a specific number of licenses. Deactivations can be done against a specific license ID after they have persisted for at least a 90-day period.
- (EC2DeactivateLicenseResponse *)deactivateLicense:(EC2DeactivateLicenseRequest *)deactivateLicenseRequest
Parameters
- deactivateLicenseRequest
Container for the necessary parameters to execute the DeactivateLicense service method on AmazonEC2.
Discussion
Deactivates a specific number of licenses. Deactivations can be done against a specific license ID after they have persisted for at least a 90-day period.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
deleteKeyPair:
The DeleteKeyPair operation deletes a key pair.
- (EC2DeleteKeyPairResponse *)deleteKeyPair:(EC2DeleteKeyPairRequest *)deleteKeyPairRequest
Parameters
- deleteKeyPairRequest
Container for the necessary parameters to execute the DeleteKeyPair service method on AmazonEC2.
Discussion
The DeleteKeyPair operation deletes a key pair.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
deletePlacementGroup:
Deletes a PlacementGroup from a user's account. Terminate all Amazon EC2 instances in the placement group before deletion.
- (EC2DeletePlacementGroupResponse *)deletePlacementGroup:(EC2DeletePlacementGroupRequest *)deletePlacementGroupRequest
Parameters
- deletePlacementGroupRequest
Container for the necessary parameters to execute the DeletePlacementGroup service method on AmazonEC2.
Discussion
Deletes a PlacementGroup from a user's account. Terminate all Amazon EC2 instances in the placement group before deletion.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
deleteSecurityGroup:
The DeleteSecurityGroup operation deletes a security group.
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 is returned. 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.
- (EC2DeleteSecurityGroupResponse *)deleteSecurityGroup:(EC2DeleteSecurityGroupRequest *)deleteSecurityGroupRequest
Parameters
- deleteSecurityGroupRequest
Container for the necessary parameters to execute the DeleteSecurityGroup service method on AmazonEC2.
Discussion
The DeleteSecurityGroup operation deletes a security group.
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 is returned. 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.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
deleteSnapshot:
Deletes the snapshot identified by snapshotId .
- (EC2DeleteSnapshotResponse *)deleteSnapshot:(EC2DeleteSnapshotRequest *)deleteSnapshotRequest
Parameters
- deleteSnapshotRequest
Container for the necessary parameters to execute the DeleteSnapshot service method on AmazonEC2.
Discussion
Deletes the snapshot identified by snapshotId .
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
deleteSpotDatafeedSubscription:
Deletes the data feed for Spot Instances.
For conceptual information about Spot Instances, refer to the Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide .
- (EC2DeleteSpotDatafeedSubscriptionResponse *)deleteSpotDatafeedSubscription:(EC2DeleteSpotDatafeedSubscriptionRequest *)deleteSpotDatafeedSubscriptionRequest
Parameters
- deleteSpotDatafeedSubscriptionRequest
Container for the necessary parameters to execute the DeleteSpotDatafeedSubscription service method on AmazonEC2.
Discussion
Deletes the data feed for Spot Instances.
For conceptual information about Spot Instances, refer to the Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide .
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
deleteTags:
Deletes tags from the specified Amazon EC2 resources.
- (EC2DeleteTagsResponse *)deleteTags:(EC2DeleteTagsRequest *)deleteTagsRequest
Parameters
- deleteTagsRequest
Container for the necessary parameters to execute the DeleteTags service method on AmazonEC2.
Discussion
Deletes tags from the specified Amazon EC2 resources.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
deleteVolume:
Deletes a previously created volume. Once successfully deleted, a new volume can be created with the same name.
- (EC2DeleteVolumeResponse *)deleteVolume:(EC2DeleteVolumeRequest *)deleteVolumeRequest
Parameters
- deleteVolumeRequest
Container for the necessary parameters to execute the DeleteVolume service method on AmazonEC2.
Discussion
Deletes a previously created volume. Once successfully deleted, a new volume can be created with the same name.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
deregisterImage:
The DeregisterImage operation deregisters an AMI. Once deregistered, instances of the AMI can no longer be launched.
- (EC2DeregisterImageResponse *)deregisterImage:(EC2DeregisterImageRequest *)deregisterImageRequest
Parameters
- deregisterImageRequest
Container for the necessary parameters to execute the DeregisterImage service method on AmazonEC2.
Discussion
The DeregisterImage operation deregisters an AMI. Once deregistered, instances of the AMI can no longer be launched.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
describeAddresses:
The DescribeAddresses operation lists elastic IP addresses assigned to your account.
- (EC2DescribeAddressesResponse *)describeAddresses:(EC2DescribeAddressesRequest *)describeAddressesRequest
Parameters
- describeAddressesRequest
Container for the necessary parameters to execute the DescribeAddresses service method on AmazonEC2.
Return Value
The response from the DescribeAddresses service method, as returned by AmazonEC2.
Discussion
The DescribeAddresses operation lists elastic IP addresses assigned to your account.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
describeAvailabilityZones:
The DescribeAvailabilityZones operation describes availability zones that are currently available to the account and their states.
Availability zones are not the same across accounts. The availability zone us-east-1a for account A is not necessarily the same as us-east-1a for account B. Zone assignments are mapped independently for each account.
- (EC2DescribeAvailabilityZonesResponse *)describeAvailabilityZones:(EC2DescribeAvailabilityZonesRequest *)describeAvailabilityZonesRequest
Parameters
- describeAvailabilityZonesRequest
Container for the necessary parameters to execute the DescribeAvailabilityZones service method on AmazonEC2.
Return Value
The response from the DescribeAvailabilityZones service method, as returned by AmazonEC2.
Discussion
The DescribeAvailabilityZones operation describes availability zones that are currently available to the account and their states.
Availability zones are not the same across accounts. The availability zone us-east-1a for account A is not necessarily the same as us-east-1a for account B. Zone assignments are mapped independently for each account.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
describeBundleTasks:
The DescribeBundleTasks operation describes in-progress and recent bundle tasks. Complete and failed tasks are removed from the list a short time after completion. If no bundle ids are given, all bundle tasks are returned.
- (EC2DescribeBundleTasksResponse *)describeBundleTasks:(EC2DescribeBundleTasksRequest *)describeBundleTasksRequest
Parameters
- describeBundleTasksRequest
Container for the necessary parameters to execute the DescribeBundleTasks service method on AmazonEC2.
Return Value
The response from the DescribeBundleTasks service method, as returned by AmazonEC2.
Discussion
The DescribeBundleTasks operation describes in-progress and recent bundle tasks. Complete and failed tasks are removed from the list a short time after completion. If no bundle ids are given, all bundle tasks are returned.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
describeConversionTasks:
Container for the necessary parameters to execute the DescribeConversionTasks service method on AmazonEC2.
- (EC2DescribeConversionTasksResponse *)describeConversionTasks:(EC2DescribeConversionTasksRequest *)describeConversionTasksRequest
Parameters
- describeConversionTasksRequest
Container for the necessary parameters to execute the DescribeConversionTasks service method on AmazonEC2.
Return Value
The response from the DescribeConversionTasks service method, as returned by AmazonEC2.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
describeExportTasks:
Container for the necessary parameters to execute the DescribeExportTasks service method on AmazonEC2.
- (EC2DescribeExportTasksResponse *)describeExportTasks:(EC2DescribeExportTasksRequest *)describeExportTasksRequest
Parameters
- describeExportTasksRequest
Container for the necessary parameters to execute the DescribeExportTasks service method on AmazonEC2.
Return Value
The response from the DescribeExportTasks service method, as returned by AmazonEC2.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
describeImageAttribute:
The DescribeImageAttribute operation returns information about an attribute of an AMI. Only one attribute can be specified per call.
- (EC2DescribeImageAttributeResponse *)describeImageAttribute:(EC2DescribeImageAttributeRequest *)describeImageAttributeRequest
Parameters
- describeImageAttributeRequest
Container for the necessary parameters to execute the DescribeImageAttribute service method on AmazonEC2.
Return Value
The response from the DescribeImageAttribute service method, as returned by AmazonEC2.
Discussion
The DescribeImageAttribute operation returns information about an attribute of an AMI. Only one attribute can be specified per call.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
describeImages:
The DescribeImages operation returns information about AMIs, AKIs, and ARIs available to the user. Information returned includes image type, product codes, architecture, and kernel and RAM disk IDs. Images available to the user include public images available for any user to launch, private images owned by the user making the request, and private images owned by other users for which the user has explicit launch permissions.
Launch permissions fall into three categories:
- (EC2DescribeImagesResponse *)describeImages:(EC2DescribeImagesRequest *)describeImagesRequest
Parameters
- describeImagesRequest
Container for the necessary parameters to execute the DescribeImages service method on AmazonEC2.
Return Value
The response from the DescribeImages service method, as returned by AmazonEC2.
Discussion
The DescribeImages operation returns information about AMIs, AKIs, and ARIs available to the user. Information returned includes image type, product codes, architecture, and kernel and RAM disk IDs. Images available to the user include public images available for any user to launch, private images owned by the user making the request, and private images owned by other users for which the user has explicit launch permissions.
Launch permissions fall into three categories:
- Public: The owner of the AMI granted launch permissions for the AMI to the all group. All users have launch permissions for these AMIs.
- Explicit: The owner of the AMI granted launch permissions to a specific user.
- Implicit: A user has implicit launch permissions for all AMIs he or she owns.
The list of AMIs returned can be modified by specifying AMI IDs, AMI owners, or users with launch permissions. If no options are specified, Amazon EC2 returns all AMIs for which the user has launch permissions.
If you specify one or more AMI IDs, only AMIs that have the specified IDs are returned. If you specify an invalid AMI ID, a fault is returned. If you specify an AMI ID for which you do not have access, it will not be included in the returned results.
If you specify one or more AMI owners, only AMIs from the specified owners and for which you have access are returned. The results can include the account IDs of the specified owners, amazon for AMIs owned by Amazon or self for AMIs that you own.
If you specify a list of executable users, only users that have launch permissions for the AMIs are returned. You can specify account IDs (if you own the AMI(s)), self for AMIs for which you own or have explicit permissions, or all for public AMIs.
NOTE: Deregistered images are included in the returned results for an unspecified interval after deregistration.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
describeInstanceAttribute:
Returns information about an attribute of an instance. Only one attribute can be specified per call.
- (EC2DescribeInstanceAttributeResponse *)describeInstanceAttribute:(EC2DescribeInstanceAttributeRequest *)describeInstanceAttributeRequest
Parameters
- describeInstanceAttributeRequest
Container for the necessary parameters to execute the DescribeInstanceAttribute service method on AmazonEC2.
Return Value
The response from the DescribeInstanceAttribute service method, as returned by AmazonEC2.
Discussion
Returns information about an attribute of an instance. Only one attribute can be specified per call.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
describeInstanceStatus:
Describes the status of an Amazon Elastic Compute Cloud (Amazon EC2) instance. Instance status provides information about two types of scheduled events for an instance that may require your attention:
- (EC2DescribeInstanceStatusResponse *)describeInstanceStatus:(EC2DescribeInstanceStatusRequest *)describeInstanceStatusRequest
Parameters
- describeInstanceStatusRequest
Container for the necessary parameters to execute the DescribeInstanceStatus service method on AmazonEC2.
Return Value
The response from the DescribeInstanceStatus service method, as returned by AmazonEC2.
Discussion
Describes the status of an Amazon Elastic Compute Cloud (Amazon EC2) instance. Instance status provides information about two types of scheduled events for an instance that may require your attention:
- Scheduled Reboot: When Amazon EC2 determines that an instance must be rebooted, the instance's status will return one of two event codes: system-reboot or instance-reboot . System reboot commonly occurs if certain maintenance or upgrade operations require a reboot of the underlying host that supports an instance. Instance reboot commonly occurs if the instance must be rebooted, rather than the underlying host. Rebooting events include a scheduled start and end time.
- Scheduled Retirement: When Amazon EC2 determines that an instance must be shut down, the instance's status will return an event code called instance-retirement . Retirement commonly occurs when the underlying host is degraded and must be replaced. Retirement events include a scheduled start and end time. You're also notified by email if one of your instances is set to retiring. The email message indicates when your instance will be permanently retired.
If your instance is permanently retired, it will not be restarted. You can avoid retirement by manually restarting your instance when its event code is instance-retirement . This ensures that your instance is started on a healthy host.
DescribeInstanceStatus returns information only for instances in the running state.
You can filter the results to return information only about instances that match criteria you specify. For example, you could get information about instances in a specific Availability Zone. You can specify multiple values for a filter (e.g., more than one Availability Zone). An instance must match at least one of the specified values for it to be included in the results.
You can specify multiple filters. An instance must match all the filters for it to be included in the results. 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 exactly one 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 filters are available:
- availability-zone - Filter on an instance's availability zone.
- instance-state-name - Filter on the intended state of the instance, e.g., running.
- instance-state-code - Filter on the intended state code of the instance, e.g., 16.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
describeInstances:
The DescribeInstances operation returns information about instances that you own.
If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an invalid instance ID, a fault is returned. If you specify an instance that you do not own, it will not be included in the returned results.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
- (EC2DescribeInstancesResponse *)describeInstances:(EC2DescribeInstancesRequest *)describeInstancesRequest
Parameters
- describeInstancesRequest
Container for the necessary parameters to execute the DescribeInstances service method on AmazonEC2.
Return Value
The response from the DescribeInstances service method, as returned by AmazonEC2.
Discussion
The DescribeInstances operation returns information about instances that you own.
If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an invalid instance ID, a fault is returned. If you specify an instance that you do not own, it will not be included in the returned results.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
describeKeyPairs:
The DescribeKeyPairs operation returns information about key pairs available to you. If you specify key pairs, information about those key pairs is returned. Otherwise, information for all registered key pairs is returned.
- (EC2DescribeKeyPairsResponse *)describeKeyPairs:(EC2DescribeKeyPairsRequest *)describeKeyPairsRequest
Parameters
- describeKeyPairsRequest
Container for the necessary parameters to execute the DescribeKeyPairs service method on AmazonEC2.
Return Value
The response from the DescribeKeyPairs service method, as returned by AmazonEC2.
Discussion
The DescribeKeyPairs operation returns information about key pairs available to you. If you specify key pairs, information about those key pairs is returned. Otherwise, information for all registered key pairs is returned.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
describeLicenses:
Provides details of a user's registered licenses. Zero or more IDs may be specified on the call. When one or more license IDs are specified, only data for the specified IDs are returned.
- (EC2DescribeLicensesResponse *)describeLicenses:(EC2DescribeLicensesRequest *)describeLicensesRequest
Parameters
- describeLicensesRequest
Container for the necessary parameters to execute the DescribeLicenses service method on AmazonEC2.
Return Value
The response from the DescribeLicenses service method, as returned by AmazonEC2.
Discussion
Provides details of a user's registered licenses. Zero or more IDs may be specified on the call. When one or more license IDs are specified, only data for the specified IDs are returned.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
describePlacementGroups:
Returns information about one or more PlacementGroup instances in a user's account.
- (EC2DescribePlacementGroupsResponse *)describePlacementGroups:(EC2DescribePlacementGroupsRequest *)describePlacementGroupsRequest
Parameters
- describePlacementGroupsRequest
Container for the necessary parameters to execute the DescribePlacementGroups service method on AmazonEC2.
Return Value
The response from the DescribePlacementGroups service method, as returned by AmazonEC2.
Discussion
Returns information about one or more PlacementGroup instances in a user's account.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
describeRegions:
The DescribeRegions operation describes regions zones that are currently available to the account.
- (EC2DescribeRegionsResponse *)describeRegions:(EC2DescribeRegionsRequest *)describeRegionsRequest
Parameters
- describeRegionsRequest
Container for the necessary parameters to execute the DescribeRegions service method on AmazonEC2.
Return Value
The response from the DescribeRegions service method, as returned by AmazonEC2.
Discussion
The DescribeRegions operation describes regions zones that are currently available to the account.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
describeReservedInstances:
The DescribeReservedInstances operation describes Reserved Instances that were purchased for use with your account.
- (EC2DescribeReservedInstancesResponse *)describeReservedInstances:(EC2DescribeReservedInstancesRequest *)describeReservedInstancesRequest
Parameters
- describeReservedInstancesRequest
Container for the necessary parameters to execute the DescribeReservedInstances service method on AmazonEC2.
Return Value
The response from the DescribeReservedInstances service method, as returned by AmazonEC2.
Discussion
The DescribeReservedInstances operation describes Reserved Instances that were purchased for use with your account.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
describeReservedInstancesListings:
Container for the necessary parameters to execute the DescribeReservedInstancesListings service method on AmazonEC2.
- (EC2DescribeReservedInstancesListingsResponse *)describeReservedInstancesListings:(EC2DescribeReservedInstancesListingsRequest *)describeReservedInstancesListingsRequest
Parameters
- describeReservedInstancesListingsRequest
Container for the necessary parameters to execute the DescribeReservedInstancesListings service method on AmazonEC2.
Return Value
The response from the DescribeReservedInstancesListings service method, as returned by AmazonEC2.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
describeReservedInstancesOfferings:
The DescribeReservedInstancesOfferings operation describes Reserved Instance offerings that are available for purchase. With Amazon EC2 Reserved Instances, you purchase the right to launch Amazon EC2 instances for a period of time (without getting insufficient capacity errors) and pay a lower usage rate for the actual time used.
- (EC2DescribeReservedInstancesOfferingsResponse *)describeReservedInstancesOfferings:(EC2DescribeReservedInstancesOfferingsRequest *)describeReservedInstancesOfferingsRequest
Parameters
- describeReservedInstancesOfferingsRequest
Container for the necessary parameters to execute the DescribeReservedInstancesOfferings service method on AmazonEC2.
Return Value
The response from the DescribeReservedInstancesOfferings service method, as returned by AmazonEC2.
Discussion
The DescribeReservedInstancesOfferings operation describes Reserved Instance offerings that are available for purchase. With Amazon EC2 Reserved Instances, you purchase the right to launch Amazon EC2 instances for a period of time (without getting insufficient capacity errors) and pay a lower usage rate for the actual time used.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
describeSecurityGroups:
The DescribeSecurityGroups operation returns information about security groups that you own.
If you specify security group names, information about those security group is returned. Otherwise, information for all security group is returned. If you specify a group that does not exist, a fault is returned.
- (EC2DescribeSecurityGroupsResponse *)describeSecurityGroups:(EC2DescribeSecurityGroupsRequest *)describeSecurityGroupsRequest
Parameters
- describeSecurityGroupsRequest
Container for the necessary parameters to execute the DescribeSecurityGroups service method on AmazonEC2.
Return Value
The response from the DescribeSecurityGroups service method, as returned by AmazonEC2.
Discussion
The DescribeSecurityGroups operation returns information about security groups that you own.
If you specify security group names, information about those security group is returned. Otherwise, information for all security group is returned. If you specify a group that does not exist, a fault is returned.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
describeSnapshotAttribute:
Returns information about an attribute of a snapshot. Only one attribute can be specified per call.
- (EC2DescribeSnapshotAttributeResponse *)describeSnapshotAttribute:(EC2DescribeSnapshotAttributeRequest *)describeSnapshotAttributeRequest
Parameters
- describeSnapshotAttributeRequest
Container for the necessary parameters to execute the DescribeSnapshotAttribute service method on AmazonEC2.
Return Value
The response from the DescribeSnapshotAttribute service method, as returned by AmazonEC2.
Discussion
Returns information about an attribute of a snapshot. Only one attribute can be specified per call.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
describeSnapshots:
Returns information about the Amazon EBS snapshots available to you. Snapshots available to you include public snapshots available for any AWS account to launch, private snapshots you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions.
- (EC2DescribeSnapshotsResponse *)describeSnapshots:(EC2DescribeSnapshotsRequest *)describeSnapshotsRequest
Parameters
- describeSnapshotsRequest
Container for the necessary parameters to execute the DescribeSnapshots service method on AmazonEC2.
Return Value
The response from the DescribeSnapshots service method, as returned by AmazonEC2.
Discussion
Returns information about the Amazon EBS snapshots available to you. Snapshots available to you include public snapshots available for any AWS account to launch, private snapshots you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
describeSpotDatafeedSubscription:
Describes the data feed for Spot Instances.
For conceptual information about Spot Instances, refer to the Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide .
- (EC2DescribeSpotDatafeedSubscriptionResponse *)describeSpotDatafeedSubscription:(EC2DescribeSpotDatafeedSubscriptionRequest *)describeSpotDatafeedSubscriptionRequest
Parameters
- describeSpotDatafeedSubscriptionRequest
Container for the necessary parameters to execute the DescribeSpotDatafeedSubscription service method on AmazonEC2.
Return Value
The response from the DescribeSpotDatafeedSubscription service method, as returned by AmazonEC2.
Discussion
Describes the data feed for Spot Instances.
For conceptual information about Spot Instances, refer to the Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide .
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
describeSpotInstanceRequests:
Describes Spot Instance requests. Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current spot instance requests. For conceptual information about Spot Instances, refer to the Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide .
You can filter the results to return information only about Spot Instance requests that match criteria you specify. For example, you could get information about requests where the Spot Price you specified is a certain 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 specified values 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 type is m1.small ). The result includes information for a particular request 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: an asterisk matches zero or more characters, and ? matches exactly one character. You can escape special characters using a backslash before the character. For example, a value of *amazon\?\ searches for the literal string *amazon?\ .
- (EC2DescribeSpotInstanceRequestsResponse *)describeSpotInstanceRequests:(EC2DescribeSpotInstanceRequestsRequest *)describeSpotInstanceRequestsRequest
Parameters
- describeSpotInstanceRequestsRequest
Container for the necessary parameters to execute the DescribeSpotInstanceRequests service method on AmazonEC2.
Return Value
The response from the DescribeSpotInstanceRequests service method, as returned by AmazonEC2.
Discussion
Describes Spot Instance requests. Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current spot instance requests. For conceptual information about Spot Instances, refer to the Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide .
You can filter the results to return information only about Spot Instance requests that match criteria you specify. For example, you could get information about requests where the Spot Price you specified is a certain 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 specified values 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 type is m1.small ). The result includes information for a particular request 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: an asterisk matches zero or more characters, and ? matches exactly one character. You can escape special characters using a backslash before the character. For example, a value of \*amazon\?\\ searches for the literal string *amazon?\ .
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
describeSpotPriceHistory:
Describes the Spot Price history.
Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current spot instance requests.
For conceptual information about Spot Instances, refer to the Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide .
- (EC2DescribeSpotPriceHistoryResponse *)describeSpotPriceHistory:(EC2DescribeSpotPriceHistoryRequest *)describeSpotPriceHistoryRequest
Parameters
- describeSpotPriceHistoryRequest
Container for the necessary parameters to execute the DescribeSpotPriceHistory service method on AmazonEC2.
Return Value
The response from the DescribeSpotPriceHistory service method, as returned by AmazonEC2.
Discussion
Describes the Spot Price history.
Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current spot instance requests.
For conceptual information about Spot Instances, refer to the Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide .
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
describeTags:
Describes the tags for the specified resources.
- (EC2DescribeTagsResponse *)describeTags:(EC2DescribeTagsRequest *)describeTagsRequest
Parameters
- describeTagsRequest
Container for the necessary parameters to execute the DescribeTags service method on AmazonEC2.
Return Value
The response from the DescribeTags service method, as returned by AmazonEC2.
Discussion
Describes the tags for the specified resources.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
describeVolumeAttribute:
Container for the necessary parameters to execute the DescribeVolumeAttribute service method on AmazonEC2.
- (EC2DescribeVolumeAttributeResponse *)describeVolumeAttribute:(EC2DescribeVolumeAttributeRequest *)describeVolumeAttributeRequest
Parameters
- describeVolumeAttributeRequest
Container for the necessary parameters to execute the DescribeVolumeAttribute service method on AmazonEC2.
Return Value
The response from the DescribeVolumeAttribute service method, as returned by AmazonEC2.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
describeVolumeStatus:
Describes the status of a volume.
- (EC2DescribeVolumeStatusResponse *)describeVolumeStatus:(EC2DescribeVolumeStatusRequest *)describeVolumeStatusRequest
Parameters
- describeVolumeStatusRequest
Container for the necessary parameters to execute the DescribeVolumeStatus service method on AmazonEC2.
Return Value
The response from the DescribeVolumeStatus service method, as returned by AmazonEC2.
Discussion
Describes the status of a volume.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
describeVolumes:
Describes the status of the indicated volume or, in lieu of any specified, all volumes belonging to the caller. Volumes that have been deleted are not described.
- (EC2DescribeVolumesResponse *)describeVolumes:(EC2DescribeVolumesRequest *)describeVolumesRequest
Parameters
- describeVolumesRequest
Container for the necessary parameters to execute the DescribeVolumes service method on AmazonEC2.
Return Value
The response from the DescribeVolumes service method, as returned by AmazonEC2.
Discussion
Describes the status of the indicated volume or, in lieu of any specified, all volumes belonging to the caller. Volumes that have been deleted are not described.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
detachVolume:
Detach a previously attached volume from a running instance.
- (EC2DetachVolumeResponse *)detachVolume:(EC2DetachVolumeRequest *)detachVolumeRequest
Parameters
- detachVolumeRequest
Container for the necessary parameters to execute the DetachVolume service method on AmazonEC2.
Return Value
The response from the DetachVolume service method, as returned by AmazonEC2.
Discussion
Detach a previously attached volume from a running instance.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
disassociateAddress:
The DisassociateAddress operation disassociates the specified elastic IP address from the instance to which it is assigned. This is an idempotent operation. If you enter it more than once, Amazon EC2 does not return an error.
- (EC2DisassociateAddressResponse *)disassociateAddress:(EC2DisassociateAddressRequest *)disassociateAddressRequest
Parameters
- disassociateAddressRequest
Container for the necessary parameters to execute the DisassociateAddress service method on AmazonEC2.
Discussion
The DisassociateAddress operation disassociates the specified elastic IP address from the instance to which it is assigned. This is an idempotent operation. If you enter it more than once, Amazon EC2 does not return an error.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
enableVolumeIO:
Enable IO on the volume after an event has occured.
- (EC2EnableVolumeIOResponse *)enableVolumeIO:(EC2EnableVolumeIORequest *)enableVolumeIORequest
Parameters
- enableVolumeIORequest
Container for the necessary parameters to execute the EnableVolumeIO service method on AmazonEC2.
Discussion
Enable IO on the volume after an event has occured.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
getConsoleOutput:
The GetConsoleOutput operation retrieves 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 after the most recent post.
- (EC2GetConsoleOutputResponse *)getConsoleOutput:(EC2GetConsoleOutputRequest *)getConsoleOutputRequest
Parameters
- getConsoleOutputRequest
Container for the necessary parameters to execute the GetConsoleOutput service method on AmazonEC2.
Return Value
The response from the GetConsoleOutput service method, as returned by AmazonEC2.
Discussion
The GetConsoleOutput operation retrieves 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 after the most recent post.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
getPasswordData:
Retrieves 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 generated for rebundled AMIs or after the password is changed on an instance. The password is encrypted using the key pair that you provided.
- (EC2GetPasswordDataResponse *)getPasswordData:(EC2GetPasswordDataRequest *)getPasswordDataRequest
Parameters
- getPasswordDataRequest
Container for the necessary parameters to execute the GetPasswordData service method on AmazonEC2.
Return Value
The response from the GetPasswordData service method, as returned by AmazonEC2.
Discussion
Retrieves 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 generated for rebundled AMIs or after the password is changed on an instance. The password is encrypted using the key pair that you provided.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
importInstance:
Container for the necessary parameters to execute the ImportInstance service method on AmazonEC2.
- (EC2ImportInstanceResponse *)importInstance:(EC2ImportInstanceRequest *)importInstanceRequest
Parameters
- importInstanceRequest
Container for the necessary parameters to execute the ImportInstance service method on AmazonEC2.
Return Value
The response from the ImportInstance service method, as returned by AmazonEC2.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
importKeyPair:
Imports the public key from an RSA key pair created with a third-party tool. This operation differs from CreateKeyPair as the private key is never transferred between the caller and AWS servers.
RSA key pairs are easily created on Microsoft Windows and Linux OS systems using the ssh-keygen command line tool provided with the standard OpenSSH installation. Standard library support for RSA key pair creation is also available for Java, Ruby, Python, and many other programming languages.
The following formats are supported:
- (EC2ImportKeyPairResponse *)importKeyPair:(EC2ImportKeyPairRequest *)importKeyPairRequest
Parameters
- importKeyPairRequest
Container for the necessary parameters to execute the ImportKeyPair service method on AmazonEC2.
Return Value
The response from the ImportKeyPair service method, as returned by AmazonEC2.
Discussion
Imports the public key from an RSA key pair created with a third-party tool. This operation differs from CreateKeyPair as the private key is never transferred between the caller and AWS servers.
RSA key pairs are easily created on Microsoft Windows and Linux OS systems using the ssh-keygen command line tool provided with the standard OpenSSH installation. Standard library support for RSA key pair creation is also available for Java, Ruby, Python, and many other programming languages.
The following formats are supported:
- OpenSSH public key format,
- Base64 encoded DER format.
- SSH public key file format as specified in RFC4716 .
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
importVolume:
Container for the necessary parameters to execute the ImportVolume service method on AmazonEC2.
- (EC2ImportVolumeResponse *)importVolume:(EC2ImportVolumeRequest *)importVolumeRequest
Parameters
- importVolumeRequest
Container for the necessary parameters to execute the ImportVolume service method on AmazonEC2.
Return Value
The response from the ImportVolume service method, as returned by AmazonEC2.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
modifyImageAttribute:
The ModifyImageAttribute operation modifies an attribute of an AMI.
- (EC2ModifyImageAttributeResponse *)modifyImageAttribute:(EC2ModifyImageAttributeRequest *)modifyImageAttributeRequest
Parameters
- modifyImageAttributeRequest
Container for the necessary parameters to execute the ModifyImageAttribute service method on AmazonEC2.
Discussion
The ModifyImageAttribute operation modifies an attribute of an AMI.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
modifyInstanceAttribute:
Modifies an attribute of an instance.
- (EC2ModifyInstanceAttributeResponse *)modifyInstanceAttribute:(EC2ModifyInstanceAttributeRequest *)modifyInstanceAttributeRequest
Parameters
- modifyInstanceAttributeRequest
Container for the necessary parameters to execute the ModifyInstanceAttribute service method on AmazonEC2.
Discussion
Modifies an attribute of an instance.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
modifySnapshotAttribute:
Adds or remove permission settings for the specified snapshot.
- (EC2ModifySnapshotAttributeResponse *)modifySnapshotAttribute:(EC2ModifySnapshotAttributeRequest *)modifySnapshotAttributeRequest
Parameters
- modifySnapshotAttributeRequest
Container for the necessary parameters to execute the ModifySnapshotAttribute service method on AmazonEC2.
Discussion
Adds or remove permission settings for the specified snapshot.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
modifyVolumeAttribute:
Container for the necessary parameters to execute the ModifyVolumeAttribute service method on AmazonEC2.
- (EC2ModifyVolumeAttributeResponse *)modifyVolumeAttribute:(EC2ModifyVolumeAttributeRequest *)modifyVolumeAttributeRequest
Parameters
- modifyVolumeAttributeRequest
Container for the necessary parameters to execute the ModifyVolumeAttribute service method on AmazonEC2.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
monitorInstances:
Enables monitoring for a running instance.
- (EC2MonitorInstancesResponse *)monitorInstances:(EC2MonitorInstancesRequest *)monitorInstancesRequest
Parameters
- monitorInstancesRequest
Container for the necessary parameters to execute the MonitorInstances service method on AmazonEC2.
Return Value
The response from the MonitorInstances service method, as returned by AmazonEC2.
Discussion
Enables monitoring for a running instance.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
purchaseReservedInstancesOffering:
The PurchaseReservedInstancesOffering operation purchases a Reserved Instance for use with your account. With Amazon EC2 Reserved Instances, you purchase the right to launch Amazon EC2 instances for a period of time (without getting insufficient capacity errors) and pay a lower usage rate for the actual time used.
- (EC2PurchaseReservedInstancesOfferingResponse *)purchaseReservedInstancesOffering:(EC2PurchaseReservedInstancesOfferingRequest *)purchaseReservedInstancesOfferingRequest
Parameters
- purchaseReservedInstancesOfferingRequest
Container for the necessary parameters to execute the PurchaseReservedInstancesOffering service method on AmazonEC2.
Return Value
The response from the PurchaseReservedInstancesOffering service method, as returned by AmazonEC2.
Discussion
The PurchaseReservedInstancesOffering operation purchases a Reserved Instance for use with your account. With Amazon EC2 Reserved Instances, you purchase the right to launch Amazon EC2 instances for a period of time (without getting insufficient capacity errors) and pay a lower usage rate for the actual time used.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
rebootInstances:
The RebootInstances operation requests a reboot of one or more instances. This operation is asynchronous; it only queues a request to reboot the specified instance(s). The operation will succeed if the instances are valid and belong to the user. Requests to reboot terminated instances are ignored.
- (EC2RebootInstancesResponse *)rebootInstances:(EC2RebootInstancesRequest *)rebootInstancesRequest
Parameters
- rebootInstancesRequest
Container for the necessary parameters to execute the RebootInstances service method on AmazonEC2.
Discussion
The RebootInstances operation requests a reboot of one or more instances. This operation is asynchronous; it only queues a request to reboot the specified instance(s). The operation will succeed if the instances are valid and belong to the user. Requests to reboot terminated instances are ignored.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
registerImage:
The RegisterImage operation registers an AMI with Amazon EC2. Images must be registered before they can be launched. For more information, see RunInstances.
Each AMI is associated with an unique ID which is provided by the Amazon EC2 service through the RegisterImage operation. During registration, Amazon EC2 retrieves the specified image manifest from Amazon S3 and verifies that the image is owned by the user registering the image.
The image manifest is retrieved once and stored within the Amazon EC2. Any modifications to an image in Amazon S3 invalidates this registration. If you make changes to an image, deregister the previous image and register the new image. For more information, see DeregisterImage.
- (EC2RegisterImageResponse *)registerImage:(EC2RegisterImageRequest *)registerImageRequest
Parameters
- registerImageRequest
Container for the necessary parameters to execute the RegisterImage service method on AmazonEC2.
Return Value
The response from the RegisterImage service method, as returned by AmazonEC2.
Discussion
The RegisterImage operation registers an AMI with Amazon EC2. Images must be registered before they can be launched. For more information, see RunInstances.
Each AMI is associated with an unique ID which is provided by the Amazon EC2 service through the RegisterImage operation. During registration, Amazon EC2 retrieves the specified image manifest from Amazon S3 and verifies that the image is owned by the user registering the image.
The image manifest is retrieved once and stored within the Amazon EC2. Any modifications to an image in Amazon S3 invalidates this registration. If you make changes to an image, deregister the previous image and register the new image. For more information, see DeregisterImage.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
releaseAddress:
The ReleaseAddress operation releases an elastic IP address associated with your account.
NOTE: Releasing an IP address automatically disassociates it from any instance with which it is associated. For more information, see DisassociateAddress.
IMPORTANT: After releasing an elastic IP address, it is released to the IP address pool and might no longer be available to your account. Make sure to update your DNS records and any servers or devices that communicate with the address. If you run this operation on an elastic IP address that is already released, the address might be assigned to another account which will cause Amazon EC2 to return an error.
- (EC2ReleaseAddressResponse *)releaseAddress:(EC2ReleaseAddressRequest *)releaseAddressRequest
Parameters
- releaseAddressRequest
Container for the necessary parameters to execute the ReleaseAddress service method on AmazonEC2.
Discussion
The ReleaseAddress operation releases an elastic IP address associated with your account.
NOTE: Releasing an IP address automatically disassociates it from any instance with which it is associated. For more information, see DisassociateAddress.
IMPORTANT: After releasing an elastic IP address, it is released to the IP address pool and might no longer be available to your account. Make sure to update your DNS records and any servers or devices that communicate with the address. If you run this operation on an elastic IP address that is already released, the address might be assigned to another account which will cause Amazon EC2 to return an error.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
reportInstanceStatus:
Container for the necessary parameters to execute the ReportInstanceStatus service method on AmazonEC2.
- (EC2ReportInstanceStatusResponse *)reportInstanceStatus:(EC2ReportInstanceStatusRequest *)reportInstanceStatusRequest
Parameters
- reportInstanceStatusRequest
Container for the necessary parameters to execute the ReportInstanceStatus service method on AmazonEC2.
Exceptions
- AmazonClientException
If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. For more information see AmazonClientException.
- AmazonServiceException
If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue. For more information see AmazonServiceException.
Declared In
AmazonEC2Client.h
requestSpotInstances:
Creates a Spot Instance request.
Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current spot instance requests.
For conceptual information about Spot Instances, refer to the Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide.
- (EC2RequestSpotInstancesResponse *)requestSpotInstances:(EC2RequestSpotInstancesRequest *)requestSpotInstancesRequest
Parameters
- requestSpotInstancesRequest
Container for the necessary parameters to execute the RequestSpotInstances service method on AmazonEC2.
Return Value
The response from the RequestSpotInstances service method, as returned by AmazonEC2.
Discussion
Creates a Spot Instance request.