com.amazonaws.services.ec2
Class AmazonEC2Client

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceClient
      extended by com.amazonaws.services.ec2.AmazonEC2Client
All Implemented Interfaces:
AmazonEC2
Direct Known Subclasses:
AmazonEC2AsyncClient

public class AmazonEC2Client
extends AmazonWebServiceClient
implements AmazonEC2

Client for accessing AmazonEC2. All service calls made using this client are blocking, and will not return until the service call completes.

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. It provides you with complete control of your computing resources and lets you run on Amazon's proven computing environment. 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.

See our blog to learn more about Managing Credentials in Mobile Applications.


Constructor Summary
AmazonEC2Client()
          Constructs a new client to invoke service methods on AmazonEC2.
AmazonEC2Client(AWSCredentials awsCredentials)
          Constructs a new client to invoke service methods on AmazonEC2 using the specified AWS account credentials.
AmazonEC2Client(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
          Constructs a new client to invoke service methods on AmazonEC2 using the specified AWS account credentials and client configuration options.
AmazonEC2Client(AWSCredentialsProvider awsCredentialsProvider)
          Constructs a new client to invoke service methods on AmazonEC2 using the specified AWS account credentials provider.
AmazonEC2Client(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
          Constructs a new client to invoke service methods on AmazonEC2 using the specified AWS account credentials provider and client configuration options.
AmazonEC2Client(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)
          Constructs a new client to invoke service methods on AmazonEC2 using the specified AWS account credentials provider, client configuration options, and request metric collector.
AmazonEC2Client(ClientConfiguration clientConfiguration)
          Constructs a new client to invoke service methods on AmazonEC2.
 
Method Summary
 void activateLicense(ActivateLicenseRequest activateLicenseRequest)
           Activates a specific number of licenses for a 90-day period.
 AllocateAddressResult allocateAddress()
           The AllocateAddress operation acquires an elastic IP address for use with your account.
 AllocateAddressResult allocateAddress(AllocateAddressRequest allocateAddressRequest)
           The AllocateAddress operation acquires an elastic IP address for use with your account.
 AssociateAddressResult associateAddress(AssociateAddressRequest associateAddressRequest)
           The AssociateAddress operation associates an elastic IP address with an instance.
 AttachVolumeResult attachVolume(AttachVolumeRequest attachVolumeRequest)
           Attach a previously created volume to a running instance.
 void authorizeSecurityGroupIngress()
           The AuthorizeSecurityGroupIngress operation adds permissions to a security group.
 void authorizeSecurityGroupIngress(AuthorizeSecurityGroupIngressRequest authorizeSecurityGroupIngressRequest)
           The AuthorizeSecurityGroupIngress operation adds permissions to a security group.
 BundleInstanceResult bundleInstance(BundleInstanceRequest bundleInstanceRequest)
           The BundleInstance operation request that an instance is bundled the next time it boots.
 CancelBundleTaskResult cancelBundleTask(CancelBundleTaskRequest cancelBundleTaskRequest)
           CancelBundleTask operation cancels a pending or in-progress bundling task.
 void cancelConversionTask(CancelConversionTaskRequest cancelConversionTaskRequest)
           
 void cancelExportTask(CancelExportTaskRequest cancelExportTaskRequest)
           
 CancelReservedInstancesListingResult cancelReservedInstancesListing(CancelReservedInstancesListingRequest cancelReservedInstancesListingRequest)
           
 CancelSpotInstanceRequestsResult cancelSpotInstanceRequests(CancelSpotInstanceRequestsRequest cancelSpotInstanceRequestsRequest)
           Cancels one or more Spot Instance requests.
 ConfirmProductInstanceResult confirmProductInstance(ConfirmProductInstanceRequest confirmProductInstanceRequest)
           The ConfirmProductInstance operation returns true if the specified product code is attached to the specified instance.
 CopyImageResult copyImage(CopyImageRequest copyImageRequest)
           
 CopySnapshotResult copySnapshot(CopySnapshotRequest copySnapshotRequest)
           
 CreateImageResult createImage(CreateImageRequest createImageRequest)
           Creates an Amazon EBS-backed AMI from a "running" or "stopped" instance.
 CreateInstanceExportTaskResult createInstanceExportTask(CreateInstanceExportTaskRequest createInstanceExportTaskRequest)
           
 CreateKeyPairResult createKeyPair(CreateKeyPairRequest createKeyPairRequest)
           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.
 void createPlacementGroup(CreatePlacementGroupRequest createPlacementGroupRequest)
           Creates a PlacementGroup into which multiple Amazon EC2 instances can be launched.
 CreateReservedInstancesListingResult createReservedInstancesListing(CreateReservedInstancesListingRequest createReservedInstancesListingRequest)
           
 CreateSecurityGroupResult createSecurityGroup(CreateSecurityGroupRequest createSecurityGroupRequest)
           The CreateSecurityGroup operation creates a new security group.
 CreateSnapshotResult createSnapshot(CreateSnapshotRequest createSnapshotRequest)
           Create a snapshot of the volume identified by volume ID.
 CreateSpotDatafeedSubscriptionResult createSpotDatafeedSubscription(CreateSpotDatafeedSubscriptionRequest createSpotDatafeedSubscriptionRequest)
           Creates the data feed for Spot Instances, enabling you to view Spot Instance usage logs.
 void createTags(CreateTagsRequest createTagsRequest)
           Adds or overwrites tags for the specified resources.
 CreateVolumeResult createVolume(CreateVolumeRequest createVolumeRequest)
           Initializes an empty volume of a given size.
 void deactivateLicense(DeactivateLicenseRequest deactivateLicenseRequest)
           Deactivates a specific number of licenses.
 void deleteKeyPair(DeleteKeyPairRequest deleteKeyPairRequest)
           The DeleteKeyPair operation deletes a key pair.
 void deletePlacementGroup(DeletePlacementGroupRequest deletePlacementGroupRequest)
           Deletes a PlacementGroup from a user's account.
 void deleteSecurityGroup()
           The DeleteSecurityGroup operation deletes a security group.
 void deleteSecurityGroup(DeleteSecurityGroupRequest deleteSecurityGroupRequest)
           The DeleteSecurityGroup operation deletes a security group.
 void deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)
           Deletes the snapshot identified by snapshotId .
 void deleteSpotDatafeedSubscription()
           Deletes the data feed for Spot Instances.
 void deleteSpotDatafeedSubscription(DeleteSpotDatafeedSubscriptionRequest deleteSpotDatafeedSubscriptionRequest)
           Deletes the data feed for Spot Instances.
 void deleteTags(DeleteTagsRequest deleteTagsRequest)
           Deletes tags from the specified Amazon EC2 resources.
 void deleteVolume(DeleteVolumeRequest deleteVolumeRequest)
           Deletes a previously created volume.
 void deregisterImage(DeregisterImageRequest deregisterImageRequest)
           The DeregisterImage operation deregisters an AMI.
 DescribeAccountAttributesResult describeAccountAttributes()
           
 DescribeAccountAttributesResult describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest)
           
 DescribeAddressesResult describeAddresses()
           The DescribeAddresses operation lists elastic IP addresses assigned to your account.
 DescribeAddressesResult describeAddresses(DescribeAddressesRequest describeAddressesRequest)
           The DescribeAddresses operation lists elastic IP addresses assigned to your account.
 DescribeAvailabilityZonesResult describeAvailabilityZones()
           The DescribeAvailabilityZones operation describes availability zones that are currently available to the account and their states.
 DescribeAvailabilityZonesResult describeAvailabilityZones(DescribeAvailabilityZonesRequest describeAvailabilityZonesRequest)
           The DescribeAvailabilityZones operation describes availability zones that are currently available to the account and their states.
 DescribeBundleTasksResult describeBundleTasks()
           The DescribeBundleTasks operation describes in-progress and recent bundle tasks.
 DescribeBundleTasksResult describeBundleTasks(DescribeBundleTasksRequest describeBundleTasksRequest)
           The DescribeBundleTasks operation describes in-progress and recent bundle tasks.
 DescribeConversionTasksResult describeConversionTasks()
           
 DescribeConversionTasksResult describeConversionTasks(DescribeConversionTasksRequest describeConversionTasksRequest)
           
 DescribeExportTasksResult describeExportTasks()
           
 DescribeExportTasksResult describeExportTasks(DescribeExportTasksRequest describeExportTasksRequest)
           
 DescribeImageAttributeResult describeImageAttribute(DescribeImageAttributeRequest describeImageAttributeRequest)
           The DescribeImageAttribute operation returns information about an attribute of an AMI.
 DescribeImagesResult describeImages()
           The DescribeImages operation returns information about AMIs, AKIs, and ARIs available to the user.
 DescribeImagesResult describeImages(DescribeImagesRequest describeImagesRequest)
           The DescribeImages operation returns information about AMIs, AKIs, and ARIs available to the user.
 DescribeInstanceAttributeResult describeInstanceAttribute(DescribeInstanceAttributeRequest describeInstanceAttributeRequest)
           Returns information about an attribute of an instance.
 DescribeInstancesResult describeInstances()
           The DescribeInstances operation returns information about instances that you own.
 DescribeInstancesResult describeInstances(DescribeInstancesRequest describeInstancesRequest)
           The DescribeInstances operation returns information about instances that you own.
 DescribeInstanceStatusResult describeInstanceStatus()
           Describes the status of an Amazon Elastic Compute Cloud (Amazon EC2) instance.
 DescribeInstanceStatusResult describeInstanceStatus(DescribeInstanceStatusRequest describeInstanceStatusRequest)
           Describes the status of an Amazon Elastic Compute Cloud (Amazon EC2) instance.
 DescribeKeyPairsResult describeKeyPairs()
           The DescribeKeyPairs operation returns information about key pairs available to you.
 DescribeKeyPairsResult describeKeyPairs(DescribeKeyPairsRequest describeKeyPairsRequest)
           The DescribeKeyPairs operation returns information about key pairs available to you.
 DescribeLicensesResult describeLicenses()
           Provides details of a user's registered licenses.
 DescribeLicensesResult describeLicenses(DescribeLicensesRequest describeLicensesRequest)
           Provides details of a user's registered licenses.
 DescribePlacementGroupsResult describePlacementGroups()
           Returns information about one or more PlacementGroup instances in a user's account.
 DescribePlacementGroupsResult describePlacementGroups(DescribePlacementGroupsRequest describePlacementGroupsRequest)
           Returns information about one or more PlacementGroup instances in a user's account.
 DescribeRegionsResult describeRegions()
           The DescribeRegions operation describes regions zones that are currently available to the account.
 DescribeRegionsResult describeRegions(DescribeRegionsRequest describeRegionsRequest)
           The DescribeRegions operation describes regions zones that are currently available to the account.
 DescribeReservedInstancesResult describeReservedInstances()
           The DescribeReservedInstances operation describes Reserved Instances that were purchased for use with your account.
 DescribeReservedInstancesResult describeReservedInstances(DescribeReservedInstancesRequest describeReservedInstancesRequest)
           The DescribeReservedInstances operation describes Reserved Instances that were purchased for use with your account.
 DescribeReservedInstancesListingsResult describeReservedInstancesListings()
           
 DescribeReservedInstancesListingsResult describeReservedInstancesListings(DescribeReservedInstancesListingsRequest describeReservedInstancesListingsRequest)
           
 DescribeReservedInstancesModificationsResult describeReservedInstancesModifications()
           The DescribeReservedInstancesModifications operation describes modifications made to Reserved Instances in your account.
 DescribeReservedInstancesModificationsResult describeReservedInstancesModifications(DescribeReservedInstancesModificationsRequest describeReservedInstancesModificationsRequest)
           The DescribeReservedInstancesModifications operation describes modifications made to Reserved Instances in your account.
 DescribeReservedInstancesOfferingsResult describeReservedInstancesOfferings()
           The DescribeReservedInstancesOfferings operation describes Reserved Instance offerings that are available for purchase.
 DescribeReservedInstancesOfferingsResult describeReservedInstancesOfferings(DescribeReservedInstancesOfferingsRequest describeReservedInstancesOfferingsRequest)
           The DescribeReservedInstancesOfferings operation describes Reserved Instance offerings that are available for purchase.
 DescribeSecurityGroupsResult describeSecurityGroups()
           The DescribeSecurityGroups operation returns information about security groups that you own.
 DescribeSecurityGroupsResult describeSecurityGroups(DescribeSecurityGroupsRequest describeSecurityGroupsRequest)
           The DescribeSecurityGroups operation returns information about security groups that you own.
 DescribeSnapshotAttributeResult describeSnapshotAttribute(DescribeSnapshotAttributeRequest describeSnapshotAttributeRequest)
           Returns information about an attribute of a snapshot.
 DescribeSnapshotsResult describeSnapshots()
           Returns information about the Amazon EBS snapshots available to you.
 DescribeSnapshotsResult describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest)
           Returns information about the Amazon EBS snapshots available to you.
 DescribeSpotDatafeedSubscriptionResult describeSpotDatafeedSubscription()
           Describes the data feed for Spot Instances.
 DescribeSpotDatafeedSubscriptionResult describeSpotDatafeedSubscription(DescribeSpotDatafeedSubscriptionRequest describeSpotDatafeedSubscriptionRequest)
           Describes the data feed for Spot Instances.
 DescribeSpotInstanceRequestsResult describeSpotInstanceRequests()
           Describes Spot Instance requests.
 DescribeSpotInstanceRequestsResult describeSpotInstanceRequests(DescribeSpotInstanceRequestsRequest describeSpotInstanceRequestsRequest)
           Describes Spot Instance requests.
 DescribeSpotPriceHistoryResult describeSpotPriceHistory()
           Describes the Spot Price history.
 DescribeSpotPriceHistoryResult describeSpotPriceHistory(DescribeSpotPriceHistoryRequest describeSpotPriceHistoryRequest)
           Describes the Spot Price history.
 DescribeSubnetsResult describeSubnets()
           Gives you information about your subnets.
 DescribeSubnetsResult describeSubnets(DescribeSubnetsRequest describeSubnetsRequest)
           Gives you information about your subnets.
 DescribeTagsResult describeTags()
           Describes the tags for the specified resources.
 DescribeTagsResult describeTags(DescribeTagsRequest describeTagsRequest)
           Describes the tags for the specified resources.
 DescribeVolumeAttributeResult describeVolumeAttribute(DescribeVolumeAttributeRequest describeVolumeAttributeRequest)
           
 DescribeVolumesResult describeVolumes()
           Describes the status of the indicated volume or, in lieu of any specified, all volumes belonging to the caller.
 DescribeVolumesResult describeVolumes(DescribeVolumesRequest describeVolumesRequest)
           Describes the status of the indicated volume or, in lieu of any specified, all volumes belonging to the caller.
 DescribeVolumeStatusResult describeVolumeStatus()
           Describes the status of a volume.
 DescribeVolumeStatusResult describeVolumeStatus(DescribeVolumeStatusRequest describeVolumeStatusRequest)
           Describes the status of a volume.
 DescribeVpcsResult describeVpcs()
           Gives you information about your VPCs.
 DescribeVpcsResult describeVpcs(DescribeVpcsRequest describeVpcsRequest)
           Gives you information about your VPCs.
 DetachVolumeResult detachVolume(DetachVolumeRequest detachVolumeRequest)
           Detach a previously attached volume from a running instance.
 void disassociateAddress()
           The DisassociateAddress operation disassociates the specified elastic IP address from the instance to which it is assigned.
 void disassociateAddress(DisassociateAddressRequest disassociateAddressRequest)
           The DisassociateAddress operation disassociates the specified elastic IP address from the instance to which it is assigned.
<X extends AmazonWebServiceRequest>
DryRunResult<X>
dryRun(DryRunSupportedRequest<X> request)
          Checks whether you have the required permissions for the provided AmazonEC2 operation, without actually running it.
 void enableVolumeIO(EnableVolumeIORequest enableVolumeIORequest)
           Enable IO on the volume after an event has occured.
 ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
          Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
 GetConsoleOutputResult getConsoleOutput(GetConsoleOutputRequest getConsoleOutputRequest)
           The GetConsoleOutput operation retrieves console output for the specified instance.
 GetPasswordDataResult getPasswordData(GetPasswordDataRequest getPasswordDataRequest)
           Retrieves the encrypted administrator password for the instances running Windows.
 ImportInstanceResult importInstance(ImportInstanceRequest importInstanceRequest)
           
 ImportKeyPairResult importKeyPair(ImportKeyPairRequest importKeyPairRequest)
           Imports the public key from an RSA key pair created with a third-party tool.
 ImportVolumeResult importVolume()
           
 ImportVolumeResult importVolume(ImportVolumeRequest importVolumeRequest)
           
 void modifyImageAttribute(ModifyImageAttributeRequest modifyImageAttributeRequest)
           The ModifyImageAttribute operation modifies an attribute of an AMI.
 void modifyInstanceAttribute(ModifyInstanceAttributeRequest modifyInstanceAttributeRequest)
           Modifies an attribute of an instance.
 ModifyReservedInstancesResult modifyReservedInstances(ModifyReservedInstancesRequest modifyReservedInstancesRequest)
           The ModifyReservedInstances operation modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances.
 void modifySnapshotAttribute(ModifySnapshotAttributeRequest modifySnapshotAttributeRequest)
           Adds or remove permission settings for the specified snapshot.
 void modifyVolumeAttribute(ModifyVolumeAttributeRequest modifyVolumeAttributeRequest)
           
 MonitorInstancesResult monitorInstances(MonitorInstancesRequest monitorInstancesRequest)
           Enables monitoring for a running instance.
 PurchaseReservedInstancesOfferingResult purchaseReservedInstancesOffering(PurchaseReservedInstancesOfferingRequest purchaseReservedInstancesOfferingRequest)
           The PurchaseReservedInstancesOffering operation purchases a Reserved Instance for use with your account.
 void rebootInstances(RebootInstancesRequest rebootInstancesRequest)
           The RebootInstances operation requests a reboot of one or more instances.
 RegisterImageResult registerImage()
           The RegisterImage operation registers an AMI with Amazon EC2.
 RegisterImageResult registerImage(RegisterImageRequest registerImageRequest)
           The RegisterImage operation registers an AMI with Amazon EC2.
 void releaseAddress()
           The ReleaseAddress operation releases an elastic IP address associated with your account.
 void releaseAddress(ReleaseAddressRequest releaseAddressRequest)
           The ReleaseAddress operation releases an elastic IP address associated with your account.
 void reportInstanceStatus()
           
 void reportInstanceStatus(ReportInstanceStatusRequest reportInstanceStatusRequest)
           
 RequestSpotInstancesResult requestSpotInstances(RequestSpotInstancesRequest requestSpotInstancesRequest)
           Creates a Spot Instance request.
 void resetImageAttribute(ResetImageAttributeRequest resetImageAttributeRequest)
           The ResetImageAttribute operation resets an attribute of an AMI to its default value.
 void resetInstanceAttribute(ResetInstanceAttributeRequest resetInstanceAttributeRequest)
           Resets an attribute of an instance to its default value.
 void resetSnapshotAttribute(ResetSnapshotAttributeRequest resetSnapshotAttributeRequest)
           Resets permission settings for the specified snapshot.
 void revokeSecurityGroupIngress()
           The RevokeSecurityGroupIngress operation revokes permissions from a security group.
 void revokeSecurityGroupIngress(RevokeSecurityGroupIngressRequest revokeSecurityGroupIngressRequest)
           The RevokeSecurityGroupIngress operation revokes permissions from a security group.
 RunInstancesResult runInstances(RunInstancesRequest runInstancesRequest)
           The RunInstances operation launches a specified number of instances.
 StartInstancesResult startInstances(StartInstancesRequest startInstancesRequest)
           Starts an instance that uses an Amazon EBS volume as its root device.
 StopInstancesResult stopInstances(StopInstancesRequest stopInstancesRequest)
           Stops an instance that uses an Amazon EBS volume as its root device.
 TerminateInstancesResult terminateInstances(TerminateInstancesRequest terminateInstancesRequest)
           The TerminateInstances operation shuts down one or more instances.
 UnmonitorInstancesResult unmonitorInstances(UnmonitorInstancesRequest unmonitorInstancesRequest)
           Disables monitoring for a running instance.
 
Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, getRequestMetricsCollector, getServiceName, getTimeOffset, removeRequestHandler, removeRequestHandler, setConfiguration, setEndpoint, setEndpoint, setRegion, setTimeOffset, shutdown, withTimeOffset
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.amazonaws.services.ec2.AmazonEC2
setEndpoint, setRegion, shutdown
 

Constructor Detail

AmazonEC2Client

public AmazonEC2Client()
Constructs a new client to invoke service methods on AmazonEC2. A credentials provider chain will be used that searches for credentials in this order:

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:
DefaultAWSCredentialsProviderChain

AmazonEC2Client

public AmazonEC2Client(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonEC2. A credentials provider chain will be used that searches for credentials in this order:

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
clientConfiguration - The client configuration options controlling how this client connects to AmazonEC2 (ex: proxy settings, retry counts, etc.).
See Also:
DefaultAWSCredentialsProviderChain

AmazonEC2Client

public AmazonEC2Client(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on AmazonEC2 using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonEC2Client

public AmazonEC2Client(AWSCredentials awsCredentials,
                       ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonEC2 using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
clientConfiguration - The client configuration options controlling how this client connects to AmazonEC2 (ex: proxy settings, retry counts, etc.).

AmazonEC2Client

public AmazonEC2Client(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on AmazonEC2 using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonEC2Client

public AmazonEC2Client(AWSCredentialsProvider awsCredentialsProvider,
                       ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonEC2 using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
clientConfiguration - The client configuration options controlling how this client connects to AmazonEC2 (ex: proxy settings, retry counts, etc.).

AmazonEC2Client

public AmazonEC2Client(AWSCredentialsProvider awsCredentialsProvider,
                       ClientConfiguration clientConfiguration,
                       com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on AmazonEC2 using the specified AWS account credentials provider, client configuration options, and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
clientConfiguration - The client configuration options controlling how this client connects to AmazonEC2 (ex: proxy settings, retry counts, etc.).
requestMetricCollector - optional request metric collector
Method Detail

rebootInstances

public void rebootInstances(RebootInstancesRequest rebootInstancesRequest)

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.

Specified by:
rebootInstances in interface AmazonEC2
Parameters:
rebootInstancesRequest - Container for the necessary parameters to execute the RebootInstances service method on AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeReservedInstances

public DescribeReservedInstancesResult describeReservedInstances(DescribeReservedInstancesRequest describeReservedInstancesRequest)

The DescribeReservedInstances operation describes Reserved Instances that were purchased for use with your account.

Specified by:
describeReservedInstances in interface AmazonEC2
Parameters:
describeReservedInstancesRequest - Container for the necessary parameters to execute the DescribeReservedInstances service method on AmazonEC2.
Returns:
The response from the DescribeReservedInstances service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeAvailabilityZones

public DescribeAvailabilityZonesResult describeAvailabilityZones(DescribeAvailabilityZonesRequest describeAvailabilityZonesRequest)

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.

Specified by:
describeAvailabilityZones in interface AmazonEC2
Parameters:
describeAvailabilityZonesRequest - Container for the necessary parameters to execute the DescribeAvailabilityZones service method on AmazonEC2.
Returns:
The response from the DescribeAvailabilityZones service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

detachVolume

public DetachVolumeResult detachVolume(DetachVolumeRequest detachVolumeRequest)

Detach a previously attached volume from a running instance.

Specified by:
detachVolume in interface AmazonEC2
Parameters:
detachVolumeRequest - Container for the necessary parameters to execute the DetachVolume service method on AmazonEC2.
Returns:
The response from the DetachVolume service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

deleteKeyPair

public void deleteKeyPair(DeleteKeyPairRequest deleteKeyPairRequest)

The DeleteKeyPair operation deletes a key pair.

Specified by:
deleteKeyPair in interface AmazonEC2
Parameters:
deleteKeyPairRequest - Container for the necessary parameters to execute the DeleteKeyPair service method on AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

unmonitorInstances

public UnmonitorInstancesResult unmonitorInstances(UnmonitorInstancesRequest unmonitorInstancesRequest)

Disables monitoring for a running instance.

Specified by:
unmonitorInstances in interface AmazonEC2
Parameters:
unmonitorInstancesRequest - Container for the necessary parameters to execute the UnmonitorInstances service method on AmazonEC2.
Returns:
The response from the UnmonitorInstances service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

createImage

public CreateImageResult createImage(CreateImageRequest createImageRequest)

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.

Specified by:
createImage in interface AmazonEC2
Parameters:
createImageRequest - Container for the necessary parameters to execute the CreateImage service method on AmazonEC2.
Returns:
The response from the CreateImage service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

deleteSecurityGroup

public void deleteSecurityGroup(DeleteSecurityGroupRequest deleteSecurityGroupRequest)

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.

Specified by:
deleteSecurityGroup in interface AmazonEC2
Parameters:
deleteSecurityGroupRequest - Container for the necessary parameters to execute the DeleteSecurityGroup service method on AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

createInstanceExportTask

public CreateInstanceExportTaskResult createInstanceExportTask(CreateInstanceExportTaskRequest createInstanceExportTaskRequest)
Specified by:
createInstanceExportTask in interface AmazonEC2
Parameters:
createInstanceExportTaskRequest - Container for the necessary parameters to execute the CreateInstanceExportTask service method on AmazonEC2.
Returns:
The response from the CreateInstanceExportTask service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

getPasswordData

public GetPasswordDataResult getPasswordData(GetPasswordDataRequest getPasswordDataRequest)

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.

Specified by:
getPasswordData in interface AmazonEC2
Parameters:
getPasswordDataRequest - Container for the necessary parameters to execute the GetPasswordData service method on AmazonEC2.
Returns:
The response from the GetPasswordData service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

stopInstances

public StopInstancesResult stopInstances(StopInstancesRequest stopInstancesRequest)

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.

Specified by:
stopInstances in interface AmazonEC2
Parameters:
stopInstancesRequest - Container for the necessary parameters to execute the StopInstances service method on AmazonEC2.
Returns:
The response from the StopInstances service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

importKeyPair

public ImportKeyPairResult importKeyPair(ImportKeyPairRequest importKeyPairRequest)

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:

Specified by:
importKeyPair in interface AmazonEC2
Parameters:
importKeyPairRequest - Container for the necessary parameters to execute the ImportKeyPair service method on AmazonEC2.
Returns:
The response from the ImportKeyPair service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

createSecurityGroup

public CreateSecurityGroupResult createSecurityGroup(CreateSecurityGroupRequest createSecurityGroupRequest)

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.

Specified by:
createSecurityGroup in interface AmazonEC2
Parameters:
createSecurityGroupRequest - Container for the necessary parameters to execute the CreateSecurityGroup service method on AmazonEC2.
Returns:
The response from the CreateSecurityGroup service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeSpotPriceHistory

public DescribeSpotPriceHistoryResult describeSpotPriceHistory(DescribeSpotPriceHistoryRequest describeSpotPriceHistoryRequest)

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 .

Specified by:
describeSpotPriceHistory in interface AmazonEC2
Parameters:
describeSpotPriceHistoryRequest - Container for the necessary parameters to execute the DescribeSpotPriceHistory service method on AmazonEC2.
Returns:
The response from the DescribeSpotPriceHistory service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeRegions

public DescribeRegionsResult describeRegions(DescribeRegionsRequest describeRegionsRequest)

The DescribeRegions operation describes regions zones that are currently available to the account.

Specified by:
describeRegions in interface AmazonEC2
Parameters:
describeRegionsRequest - Container for the necessary parameters to execute the DescribeRegions service method on AmazonEC2.
Returns:
The response from the DescribeRegions service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

createReservedInstancesListing

public CreateReservedInstancesListingResult createReservedInstancesListing(CreateReservedInstancesListingRequest createReservedInstancesListingRequest)
Specified by:
createReservedInstancesListing in interface AmazonEC2
Parameters:
createReservedInstancesListingRequest - Container for the necessary parameters to execute the CreateReservedInstancesListing service method on AmazonEC2.
Returns:
The response from the CreateReservedInstancesListing service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

resetSnapshotAttribute

public void resetSnapshotAttribute(ResetSnapshotAttributeRequest resetSnapshotAttributeRequest)

Resets permission settings for the specified snapshot.

Specified by:
resetSnapshotAttribute in interface AmazonEC2
Parameters:
resetSnapshotAttributeRequest - Container for the necessary parameters to execute the ResetSnapshotAttribute service method on AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

importVolume

public ImportVolumeResult importVolume(ImportVolumeRequest importVolumeRequest)
Specified by:
importVolume in interface AmazonEC2
Parameters:
importVolumeRequest - Container for the necessary parameters to execute the ImportVolume service method on AmazonEC2.
Returns:
The response from the ImportVolume service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeSecurityGroups

public DescribeSecurityGroupsResult describeSecurityGroups(DescribeSecurityGroupsRequest describeSecurityGroupsRequest)

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.

Specified by:
describeSecurityGroups in interface AmazonEC2
Parameters:
describeSecurityGroupsRequest - Container for the necessary parameters to execute the DescribeSecurityGroups service method on AmazonEC2.
Returns:
The response from the DescribeSecurityGroups service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

deregisterImage

public void deregisterImage(DeregisterImageRequest deregisterImageRequest)

The DeregisterImage operation deregisters an AMI. Once deregistered, instances of the AMI can no longer be launched.

Specified by:
deregisterImage in interface AmazonEC2
Parameters:
deregisterImageRequest - Container for the necessary parameters to execute the DeregisterImage service method on AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeSpotDatafeedSubscription

public DescribeSpotDatafeedSubscriptionResult describeSpotDatafeedSubscription(DescribeSpotDatafeedSubscriptionRequest describeSpotDatafeedSubscriptionRequest)

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 .

Specified by:
describeSpotDatafeedSubscription in interface AmazonEC2
Parameters:
describeSpotDatafeedSubscriptionRequest - Container for the necessary parameters to execute the DescribeSpotDatafeedSubscription service method on AmazonEC2.
Returns:
The response from the DescribeSpotDatafeedSubscription service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

deleteTags

public void deleteTags(DeleteTagsRequest deleteTagsRequest)

Deletes tags from the specified Amazon EC2 resources.

Specified by:
deleteTags in interface AmazonEC2
Parameters:
deleteTagsRequest - Container for the necessary parameters to execute the DeleteTags service method on AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeAccountAttributes

public DescribeAccountAttributesResult describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest)
Specified by:
describeAccountAttributes in interface AmazonEC2
Parameters:
describeAccountAttributesRequest - Container for the necessary parameters to execute the DescribeAccountAttributes service method on AmazonEC2.
Returns:
The response from the DescribeAccountAttributes service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

enableVolumeIO

public void enableVolumeIO(EnableVolumeIORequest enableVolumeIORequest)

Enable IO on the volume after an event has occured.

Specified by:
enableVolumeIO in interface AmazonEC2
Parameters:
enableVolumeIORequest - Container for the necessary parameters to execute the EnableVolumeIO service method on AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

attachVolume

public AttachVolumeResult attachVolume(AttachVolumeRequest attachVolumeRequest)

Attach a previously created volume to a running instance.

Specified by:
attachVolume in interface AmazonEC2
Parameters:
attachVolumeRequest - Container for the necessary parameters to execute the AttachVolume service method on AmazonEC2.
Returns:
The response from the AttachVolume service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeLicenses

public DescribeLicensesResult describeLicenses(DescribeLicensesRequest describeLicensesRequest)

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.

Specified by:
describeLicenses in interface AmazonEC2
Parameters:
describeLicensesRequest - Container for the necessary parameters to execute the DescribeLicenses service method on AmazonEC2.
Returns:
The response from the DescribeLicenses service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeVolumeStatus

public DescribeVolumeStatusResult describeVolumeStatus(DescribeVolumeStatusRequest describeVolumeStatusRequest)

Describes the status of a volume.

Specified by:
describeVolumeStatus in interface AmazonEC2
Parameters:
describeVolumeStatusRequest - Container for the necessary parameters to execute the DescribeVolumeStatus service method on AmazonEC2.
Returns:
The response from the DescribeVolumeStatus service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

activateLicense

public void activateLicense(ActivateLicenseRequest activateLicenseRequest)

Activates a specific number of licenses for a 90-day period. Activations can be done against a specific license ID.

Specified by:
activateLicense in interface AmazonEC2
Parameters:
activateLicenseRequest - Container for the necessary parameters to execute the ActivateLicense service method on AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

resetImageAttribute

public void resetImageAttribute(ResetImageAttributeRequest resetImageAttributeRequest)

The ResetImageAttribute operation resets an attribute of an AMI to its default value.

NOTE: The productCodes attribute cannot be reset.

Specified by:
resetImageAttribute in interface AmazonEC2
Parameters:
resetImageAttributeRequest - Container for the necessary parameters to execute the ResetImageAttribute service method on AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

createSnapshot

public CreateSnapshotResult createSnapshot(CreateSnapshotRequest createSnapshotRequest)

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.

Specified by:
createSnapshot in interface AmazonEC2
Parameters:
createSnapshotRequest - Container for the necessary parameters to execute the CreateSnapshot service method on AmazonEC2.
Returns:
The response from the CreateSnapshot service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

deleteVolume

public void deleteVolume(DeleteVolumeRequest deleteVolumeRequest)

Deletes a previously created volume. Once successfully deleted, a new volume can be created with the same name.

Specified by:
deleteVolume in interface AmazonEC2
Parameters:
deleteVolumeRequest - Container for the necessary parameters to execute the DeleteVolume service method on AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

modifyReservedInstances

public ModifyReservedInstancesResult modifyReservedInstances(ModifyReservedInstancesRequest modifyReservedInstancesRequest)

The ModifyReservedInstances operation modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances.

Specified by:
modifyReservedInstances in interface AmazonEC2
Parameters:
modifyReservedInstancesRequest - Container for the necessary parameters to execute the ModifyReservedInstances service method on AmazonEC2.
Returns:
The response from the ModifyReservedInstances service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeVpcs

public DescribeVpcsResult describeVpcs(DescribeVpcsRequest describeVpcsRequest)

Gives you information about your VPCs. You can filter the results to return information only about VPCs that match criteria you specify.

For example, you could ask to get information about a particular VPC or VPCs (or all your VPCs) only if the VPC's state is available. You can specify multiple filters (e.g., the VPC uses one of several sets of DHCP options, and the VPC's state is available). The result includes information for a particular VPC only if the VPC matches all your filters.

If there's no match, no special message is returned; the response is simply empty. The following table shows the available filters.

Specified by:
describeVpcs in interface AmazonEC2
Parameters:
describeVpcsRequest - Container for the necessary parameters to execute the DescribeVpcs service method on AmazonEC2.
Returns:
The response from the DescribeVpcs service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

cancelConversionTask

public void cancelConversionTask(CancelConversionTaskRequest cancelConversionTaskRequest)
Specified by:
cancelConversionTask in interface AmazonEC2
Parameters:
cancelConversionTaskRequest - Container for the necessary parameters to execute the CancelConversionTask service method on AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

associateAddress

public AssociateAddressResult associateAddress(AssociateAddressRequest associateAddressRequest)

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.

Specified by:
associateAddress in interface AmazonEC2
Parameters:
associateAddressRequest - Container for the necessary parameters to execute the AssociateAddress service method on AmazonEC2.
Returns:
The response from the AssociateAddress service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

deactivateLicense

public void deactivateLicense(DeactivateLicenseRequest deactivateLicenseRequest)

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.

Specified by:
deactivateLicense in interface AmazonEC2
Parameters:
deactivateLicenseRequest - Container for the necessary parameters to execute the DeactivateLicense service method on AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeExportTasks

public DescribeExportTasksResult describeExportTasks(DescribeExportTasksRequest describeExportTasksRequest)
Specified by:
describeExportTasks in interface AmazonEC2
Parameters:
describeExportTasksRequest - Container for the necessary parameters to execute the DescribeExportTasks service method on AmazonEC2.
Returns:
The response from the DescribeExportTasks service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeVolumes

public DescribeVolumesResult describeVolumes(DescribeVolumesRequest describeVolumesRequest)

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.

Specified by:
describeVolumes in interface AmazonEC2
Parameters:
describeVolumesRequest - Container for the necessary parameters to execute the DescribeVolumes service method on AmazonEC2.
Returns:
The response from the DescribeVolumes service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeReservedInstancesListings

public DescribeReservedInstancesListingsResult describeReservedInstancesListings(DescribeReservedInstancesListingsRequest describeReservedInstancesListingsRequest)
Specified by:
describeReservedInstancesListings in interface AmazonEC2
Parameters:
describeReservedInstancesListingsRequest - Container for the necessary parameters to execute the DescribeReservedInstancesListings service method on AmazonEC2.
Returns:
The response from the DescribeReservedInstancesListings service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

reportInstanceStatus

public void reportInstanceStatus(ReportInstanceStatusRequest reportInstanceStatusRequest)
Specified by:
reportInstanceStatus in interface AmazonEC2
Parameters:
reportInstanceStatusRequest - Container for the necessary parameters to execute the ReportInstanceStatus service method on AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

monitorInstances

public MonitorInstancesResult monitorInstances(MonitorInstancesRequest monitorInstancesRequest)

Enables monitoring for a running instance.

Specified by:
monitorInstances in interface AmazonEC2
Parameters:
monitorInstancesRequest - Container for the necessary parameters to execute the MonitorInstances service method on AmazonEC2.
Returns:
The response from the MonitorInstances service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeBundleTasks

public DescribeBundleTasksResult describeBundleTasks(DescribeBundleTasksRequest describeBundleTasksRequest)

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.

Specified by:
describeBundleTasks in interface AmazonEC2
Parameters:
describeBundleTasksRequest - Container for the necessary parameters to execute the DescribeBundleTasks service method on AmazonEC2.
Returns:
The response from the DescribeBundleTasks service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

importInstance

public ImportInstanceResult importInstance(ImportInstanceRequest importInstanceRequest)
Specified by:
importInstance in interface AmazonEC2
Parameters:
importInstanceRequest - Container for the necessary parameters to execute the ImportInstance service method on AmazonEC2.
Returns:
The response from the ImportInstance service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

revokeSecurityGroupIngress

public void revokeSecurityGroupIngress(RevokeSecurityGroupIngressRequest revokeSecurityGroupIngressRequest)

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.

Specified by:
revokeSecurityGroupIngress in interface AmazonEC2
Parameters:
revokeSecurityGroupIngressRequest - Container for the necessary parameters to execute the RevokeSecurityGroupIngress service method on AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

getConsoleOutput

public GetConsoleOutputResult getConsoleOutput(GetConsoleOutputRequest getConsoleOutputRequest)

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.

Specified by:
getConsoleOutput in interface AmazonEC2
Parameters:
getConsoleOutputRequest - Container for the necessary parameters to execute the GetConsoleOutput service method on AmazonEC2.
Returns:
The response from the GetConsoleOutput service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

modifyImageAttribute

public void modifyImageAttribute(ModifyImageAttributeRequest modifyImageAttributeRequest)

The ModifyImageAttribute operation modifies an attribute of an AMI.

Specified by:
modifyImageAttribute in interface AmazonEC2
Parameters:
modifyImageAttributeRequest - Container for the necessary parameters to execute the ModifyImageAttribute service method on AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

createSpotDatafeedSubscription

public CreateSpotDatafeedSubscriptionResult createSpotDatafeedSubscription(CreateSpotDatafeedSubscriptionRequest createSpotDatafeedSubscriptionRequest)

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 .

Specified by:
createSpotDatafeedSubscription in interface AmazonEC2
Parameters:
createSpotDatafeedSubscriptionRequest - Container for the necessary parameters to execute the CreateSpotDatafeedSubscription service method on AmazonEC2.
Returns:
The response from the CreateSpotDatafeedSubscription service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeConversionTasks

public DescribeConversionTasksResult describeConversionTasks(DescribeConversionTasksRequest describeConversionTasksRequest)
Specified by:
describeConversionTasks in interface AmazonEC2
Parameters:
describeConversionTasksRequest - Container for the necessary parameters to execute the DescribeConversionTasks service method on AmazonEC2.
Returns:
The response from the DescribeConversionTasks service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeInstanceAttribute

public DescribeInstanceAttributeResult describeInstanceAttribute(DescribeInstanceAttributeRequest describeInstanceAttributeRequest)

Returns information about an attribute of an instance. Only one attribute can be specified per call.

Specified by:
describeInstanceAttribute in interface AmazonEC2
Parameters:
describeInstanceAttributeRequest - Container for the necessary parameters to execute the DescribeInstanceAttribute service method on AmazonEC2.
Returns:
The response from the DescribeInstanceAttribute service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describePlacementGroups

public DescribePlacementGroupsResult describePlacementGroups(DescribePlacementGroupsRequest describePlacementGroupsRequest)

Returns information about one or more PlacementGroup instances in a user's account.

Specified by:
describePlacementGroups in interface AmazonEC2
Parameters:
describePlacementGroupsRequest - Container for the necessary parameters to execute the DescribePlacementGroups service method on AmazonEC2.
Returns:
The response from the DescribePlacementGroups service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeSubnets

public DescribeSubnetsResult describeSubnets(DescribeSubnetsRequest describeSubnetsRequest)

Gives you information about your subnets. You can filter the results to return information only about subnets that match criteria you specify.

For example, you could ask to get information about a particular subnet (or all) only if the subnet's state is available. You can specify multiple filters (e.g., the subnet is in a particular VPC, and the subnet's state is available).

The result includes information for a particular subnet only if the subnet matches all your filters. If there's no match, no special message is returned; the response is simply empty. The following table shows the available filters.

Specified by:
describeSubnets in interface AmazonEC2
Parameters:
describeSubnetsRequest - Container for the necessary parameters to execute the DescribeSubnets service method on AmazonEC2.
Returns:
The response from the DescribeSubnets service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

runInstances

public RunInstancesResult runInstances(RunInstancesRequest runInstancesRequest)

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.

Specified by:
runInstances in interface AmazonEC2
Parameters:
runInstancesRequest - Container for the necessary parameters to execute the RunInstances service method on AmazonEC2.
Returns:
The response from the RunInstances service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeInstances

public DescribeInstancesResult describeInstances(DescribeInstancesRequest describeInstancesRequest)

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.

Specified by:
describeInstances in interface AmazonEC2
Parameters:
describeInstancesRequest - Container for the necessary parameters to execute the DescribeInstances service method on AmazonEC2.
Returns:
The response from the DescribeInstances service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

modifyVolumeAttribute

public void modifyVolumeAttribute(ModifyVolumeAttributeRequest modifyVolumeAttributeRequest)
Specified by:
modifyVolumeAttribute in interface AmazonEC2
Parameters:
modifyVolumeAttributeRequest - Container for the necessary parameters to execute the ModifyVolumeAttribute service method on AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeImages

public DescribeImagesResult describeImages(DescribeImagesRequest describeImagesRequest)

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:

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.

Specified by:
describeImages in interface AmazonEC2
Parameters:
describeImagesRequest - Container for the necessary parameters to execute the DescribeImages service method on AmazonEC2.
Returns:
The response from the DescribeImages service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

startInstances

public StartInstancesResult startInstances(StartInstancesRequest startInstancesRequest)

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.

Specified by:
startInstances in interface AmazonEC2
Parameters:
startInstancesRequest - Container for the necessary parameters to execute the StartInstances service method on AmazonEC2.
Returns:
The response from the StartInstances service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

cancelReservedInstancesListing

public CancelReservedInstancesListingResult cancelReservedInstancesListing(CancelReservedInstancesListingRequest cancelReservedInstancesListingRequest)
Specified by:
cancelReservedInstancesListing in interface AmazonEC2
Parameters:
cancelReservedInstancesListingRequest - Container for the necessary parameters to execute the CancelReservedInstancesListing service method on AmazonEC2.
Returns:
The response from the CancelReservedInstancesListing service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

modifyInstanceAttribute

public void modifyInstanceAttribute(ModifyInstanceAttributeRequest modifyInstanceAttributeRequest)

Modifies an attribute of an instance.

Specified by:
modifyInstanceAttribute in interface AmazonEC2
Parameters:
modifyInstanceAttributeRequest - Container for the necessary parameters to execute the ModifyInstanceAttribute service method on AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

authorizeSecurityGroupIngress

public void authorizeSecurityGroupIngress(AuthorizeSecurityGroupIngressRequest authorizeSecurityGroupIngressRequest)

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.

Specified by:
authorizeSecurityGroupIngress in interface AmazonEC2
Parameters:
authorizeSecurityGroupIngressRequest - Container for the necessary parameters to execute the AuthorizeSecurityGroupIngress service method on AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeSpotInstanceRequests

public DescribeSpotInstanceRequestsResult describeSpotInstanceRequests(DescribeSpotInstanceRequestsRequest describeSpotInstanceRequestsRequest)

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?\ .

Specified by:
describeSpotInstanceRequests in interface AmazonEC2
Parameters:
describeSpotInstanceRequestsRequest - Container for the necessary parameters to execute the DescribeSpotInstanceRequests service method on AmazonEC2.
Returns:
The response from the DescribeSpotInstanceRequests service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

cancelExportTask

public void cancelExportTask(CancelExportTaskRequest cancelExportTaskRequest)
Specified by:
cancelExportTask in interface AmazonEC2
Parameters:
cancelExportTaskRequest - Container for the necessary parameters to execute the CancelExportTask service method on AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

copyImage

public CopyImageResult copyImage(CopyImageRequest copyImageRequest)
Specified by:
copyImage in interface AmazonEC2
Parameters:
copyImageRequest - Container for the necessary parameters to execute the CopyImage service method on AmazonEC2.
Returns:
The response from the CopyImage service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

requestSpotInstances

public RequestSpotInstancesResult requestSpotInstances(RequestSpotInstancesRequest requestSpotInstancesRequest)

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.

Specified by:
requestSpotInstances in interface AmazonEC2
Parameters:
requestSpotInstancesRequest - Container for the necessary parameters to execute the RequestSpotInstances service method on AmazonEC2.
Returns:
The response from the RequestSpotInstances service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

createTags

public void createTags(CreateTagsRequest createTagsRequest)

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.

Specified by:
createTags in interface AmazonEC2
Parameters:
createTagsRequest - Container for the necessary parameters to execute the CreateTags service method on AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeVolumeAttribute

public DescribeVolumeAttributeResult describeVolumeAttribute(DescribeVolumeAttributeRequest describeVolumeAttributeRequest)
Specified by:
describeVolumeAttribute in interface AmazonEC2
Parameters:
describeVolumeAttributeRequest - Container for the necessary parameters to execute the DescribeVolumeAttribute service method on AmazonEC2.
Returns:
The response from the DescribeVolumeAttribute service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeTags

public DescribeTagsResult describeTags(DescribeTagsRequest describeTagsRequest)

Describes the tags for the specified resources.

Specified by:
describeTags in interface AmazonEC2
Parameters:
describeTagsRequest - Container for the necessary parameters to execute the DescribeTags service method on AmazonEC2.
Returns:
The response from the DescribeTags service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

cancelBundleTask

public CancelBundleTaskResult cancelBundleTask(CancelBundleTaskRequest cancelBundleTaskRequest)

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.

Specified by:
cancelBundleTask in interface AmazonEC2
Parameters:
cancelBundleTaskRequest - Container for the necessary parameters to execute the CancelBundleTask service method on AmazonEC2.
Returns:
The response from the CancelBundleTask service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

cancelSpotInstanceRequests

public CancelSpotInstanceRequestsResult cancelSpotInstanceRequests(CancelSpotInstanceRequestsRequest cancelSpotInstanceRequestsRequest)

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 .

Specified by:
cancelSpotInstanceRequests in interface AmazonEC2
Parameters:
cancelSpotInstanceRequestsRequest - Container for the necessary parameters to execute the CancelSpotInstanceRequests service method on AmazonEC2.
Returns:
The response from the CancelSpotInstanceRequests service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

purchaseReservedInstancesOffering

public PurchaseReservedInstancesOfferingResult purchaseReservedInstancesOffering(PurchaseReservedInstancesOfferingRequest purchaseReservedInstancesOfferingRequest)

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.

Specified by:
purchaseReservedInstancesOffering in interface AmazonEC2
Parameters:
purchaseReservedInstancesOfferingRequest - Container for the necessary parameters to execute the PurchaseReservedInstancesOffering service method on AmazonEC2.
Returns:
The response from the PurchaseReservedInstancesOffering service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

modifySnapshotAttribute

public void modifySnapshotAttribute(ModifySnapshotAttributeRequest modifySnapshotAttributeRequest)

Adds or remove permission settings for the specified snapshot.

Specified by:
modifySnapshotAttribute in interface AmazonEC2
Parameters:
modifySnapshotAttributeRequest - Container for the necessary parameters to execute the ModifySnapshotAttribute service method on AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeReservedInstancesModifications

public DescribeReservedInstancesModificationsResult describeReservedInstancesModifications(DescribeReservedInstancesModificationsRequest describeReservedInstancesModificationsRequest)

The DescribeReservedInstancesModifications operation describes modifications made to Reserved Instances in your account.

Specified by:
describeReservedInstancesModifications in interface AmazonEC2
Parameters:
describeReservedInstancesModificationsRequest - Container for the necessary parameters to execute the DescribeReservedInstancesModifications service method on AmazonEC2.
Returns:
The response from the DescribeReservedInstancesModifications service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

terminateInstances

public TerminateInstancesResult terminateInstances(TerminateInstancesRequest terminateInstancesRequest)

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).

Specified by:
terminateInstances in interface AmazonEC2
Parameters:
terminateInstancesRequest - Container for the necessary parameters to execute the TerminateInstances service method on AmazonEC2.
Returns:
The response from the TerminateInstances service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

deleteSpotDatafeedSubscription

public void deleteSpotDatafeedSubscription(DeleteSpotDatafeedSubscriptionRequest deleteSpotDatafeedSubscriptionRequest)

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 .

Specified by:
deleteSpotDatafeedSubscription in interface AmazonEC2
Parameters:
deleteSpotDatafeedSubscriptionRequest - Container for the necessary parameters to execute the DeleteSpotDatafeedSubscription service method on AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeSnapshotAttribute

public DescribeSnapshotAttributeResult describeSnapshotAttribute(DescribeSnapshotAttributeRequest describeSnapshotAttributeRequest)

Returns information about an attribute of a snapshot. Only one attribute can be specified per call.

Specified by:
describeSnapshotAttribute in interface AmazonEC2
Parameters:
describeSnapshotAttributeRequest - Container for the necessary parameters to execute the DescribeSnapshotAttribute service method on AmazonEC2.
Returns:
The response from the DescribeSnapshotAttribute service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeAddresses

public DescribeAddressesResult describeAddresses(DescribeAddressesRequest describeAddressesRequest)

The DescribeAddresses operation lists elastic IP addresses assigned to your account.

Specified by:
describeAddresses in interface AmazonEC2
Parameters:
describeAddressesRequest - Container for the necessary parameters to execute the DescribeAddresses service method on AmazonEC2.
Returns:
The response from the DescribeAddresses service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeImageAttribute

public DescribeImageAttributeResult describeImageAttribute(DescribeImageAttributeRequest describeImageAttributeRequest)

The DescribeImageAttribute operation returns information about an attribute of an AMI. Only one attribute can be specified per call.

Specified by:
describeImageAttribute in interface AmazonEC2
Parameters:
describeImageAttributeRequest - Container for the necessary parameters to execute the DescribeImageAttribute service method on AmazonEC2.
Returns:
The response from the DescribeImageAttribute service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeKeyPairs

public DescribeKeyPairsResult describeKeyPairs(DescribeKeyPairsRequest describeKeyPairsRequest)

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.

Specified by:
describeKeyPairs in interface AmazonEC2
Parameters:
describeKeyPairsRequest - Container for the necessary parameters to execute the DescribeKeyPairs service method on AmazonEC2.
Returns:
The response from the DescribeKeyPairs service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

confirmProductInstance

public ConfirmProductInstanceResult confirmProductInstance(ConfirmProductInstanceRequest confirmProductInstanceRequest)

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.

Specified by:
confirmProductInstance in interface AmazonEC2
Parameters:
confirmProductInstanceRequest - Container for the necessary parameters to execute the ConfirmProductInstance service method on AmazonEC2.
Returns:
The response from the ConfirmProductInstance service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

createVolume

public CreateVolumeResult createVolume(CreateVolumeRequest createVolumeRequest)

Initializes an empty volume of a given size.

Specified by:
createVolume in interface AmazonEC2
Parameters:
createVolumeRequest - Container for the necessary parameters to execute the CreateVolume service method on AmazonEC2.
Returns:
The response from the CreateVolume service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeInstanceStatus

public DescribeInstanceStatusResult describeInstanceStatus(DescribeInstanceStatusRequest describeInstanceStatusRequest)

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:

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:

Specified by:
describeInstanceStatus in interface AmazonEC2
Parameters:
describeInstanceStatusRequest - Container for the necessary parameters to execute the DescribeInstanceStatus service method on AmazonEC2.
Returns:
The response from the DescribeInstanceStatus service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeReservedInstancesOfferings

public DescribeReservedInstancesOfferingsResult describeReservedInstancesOfferings(DescribeReservedInstancesOfferingsRequest describeReservedInstancesOfferingsRequest)

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.

Specified by:
describeReservedInstancesOfferings in interface AmazonEC2
Parameters:
describeReservedInstancesOfferingsRequest - Container for the necessary parameters to execute the DescribeReservedInstancesOfferings service method on AmazonEC2.
Returns:
The response from the DescribeReservedInstancesOfferings service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

deleteSnapshot

public void deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)

Deletes the snapshot identified by snapshotId .

Specified by:
deleteSnapshot in interface AmazonEC2
Parameters:
deleteSnapshotRequest - Container for the necessary parameters to execute the DeleteSnapshot service method on AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

disassociateAddress

public void disassociateAddress(DisassociateAddressRequest disassociateAddressRequest)

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.

Specified by:
disassociateAddress in interface AmazonEC2
Parameters:
disassociateAddressRequest - Container for the necessary parameters to execute the DisassociateAddress service method on AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

createPlacementGroup

public void createPlacementGroup(CreatePlacementGroupRequest createPlacementGroupRequest)

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.

Specified by:
createPlacementGroup in interface AmazonEC2
Parameters:
createPlacementGroupRequest - Container for the necessary parameters to execute the CreatePlacementGroup service method on AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

bundleInstance

public BundleInstanceResult bundleInstance(BundleInstanceRequest bundleInstanceRequest)

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.

Specified by:
bundleInstance in interface AmazonEC2
Parameters:
bundleInstanceRequest - Container for the necessary parameters to execute the BundleInstance service method on AmazonEC2.
Returns:
The response from the BundleInstance service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

deletePlacementGroup

public void deletePlacementGroup(DeletePlacementGroupRequest deletePlacementGroupRequest)

Deletes a PlacementGroup from a user's account. Terminate all Amazon EC2 instances in the placement group before deletion.

Specified by:
deletePlacementGroup in interface AmazonEC2
Parameters:
deletePlacementGroupRequest - Container for the necessary parameters to execute the DeletePlacementGroup service method on AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

copySnapshot

public CopySnapshotResult copySnapshot(CopySnapshotRequest copySnapshotRequest)
Specified by:
copySnapshot in interface AmazonEC2
Parameters:
copySnapshotRequest - Container for the necessary parameters to execute the CopySnapshot service method on AmazonEC2.
Returns:
The response from the CopySnapshot service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

allocateAddress

public AllocateAddressResult allocateAddress(AllocateAddressRequest allocateAddressRequest)

The AllocateAddress operation acquires an elastic IP address for use with your account.

Specified by:
allocateAddress in interface AmazonEC2
Parameters:
allocateAddressRequest - Container for the necessary parameters to execute the AllocateAddress service method on AmazonEC2.
Returns:
The response from the AllocateAddress service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

releaseAddress

public void releaseAddress(ReleaseAddressRequest releaseAddressRequest)

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.

Specified by:
releaseAddress in interface AmazonEC2
Parameters:
releaseAddressRequest - Container for the necessary parameters to execute the ReleaseAddress service method on AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

resetInstanceAttribute

public void resetInstanceAttribute(ResetInstanceAttributeRequest resetInstanceAttributeRequest)

Resets an attribute of an instance to its default value.

Specified by:
resetInstanceAttribute in interface AmazonEC2
Parameters:
resetInstanceAttributeRequest - Container for the necessary parameters to execute the ResetInstanceAttribute service method on AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

createKeyPair

public CreateKeyPairResult createKeyPair(CreateKeyPairRequest createKeyPairRequest)

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.

Specified by:
createKeyPair in interface AmazonEC2
Parameters:
createKeyPairRequest - Container for the necessary parameters to execute the CreateKeyPair service method on AmazonEC2.
Returns:
The response from the CreateKeyPair service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeSnapshots

public DescribeSnapshotsResult describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest)

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.

Specified by:
describeSnapshots in interface AmazonEC2
Parameters:
describeSnapshotsRequest - Container for the necessary parameters to execute the DescribeSnapshots service method on AmazonEC2.
Returns:
The response from the DescribeSnapshots service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

registerImage

public RegisterImageResult registerImage(RegisterImageRequest registerImageRequest)

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.

Specified by:
registerImage in interface AmazonEC2
Parameters:
registerImageRequest - Container for the necessary parameters to execute the RegisterImage service method on AmazonEC2.
Returns:
The response from the RegisterImage service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeReservedInstances

public DescribeReservedInstancesResult describeReservedInstances()
                                                          throws AmazonServiceException,
                                                                 AmazonClientException

The DescribeReservedInstances operation describes Reserved Instances that were purchased for use with your account.

Specified by:
describeReservedInstances in interface AmazonEC2
Returns:
The response from the DescribeReservedInstances service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeAvailabilityZones

public DescribeAvailabilityZonesResult describeAvailabilityZones()
                                                          throws AmazonServiceException,
                                                                 AmazonClientException

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.

Specified by:
describeAvailabilityZones in interface AmazonEC2
Returns:
The response from the DescribeAvailabilityZones service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

deleteSecurityGroup

public void deleteSecurityGroup()
                         throws AmazonServiceException,
                                AmazonClientException

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.

Specified by:
deleteSecurityGroup in interface AmazonEC2
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeSpotPriceHistory

public DescribeSpotPriceHistoryResult describeSpotPriceHistory()
                                                        throws AmazonServiceException,
                                                               AmazonClientException

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 .

Specified by:
describeSpotPriceHistory in interface AmazonEC2
Returns:
The response from the DescribeSpotPriceHistory service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeRegions

public DescribeRegionsResult describeRegions()
                                      throws AmazonServiceException,
                                             AmazonClientException

The DescribeRegions operation describes regions zones that are currently available to the account.

Specified by:
describeRegions in interface AmazonEC2
Returns:
The response from the DescribeRegions service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

importVolume

public ImportVolumeResult importVolume()
                                throws AmazonServiceException,
                                       AmazonClientException
Specified by:
importVolume in interface AmazonEC2
Returns:
The response from the ImportVolume service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeSecurityGroups

public DescribeSecurityGroupsResult describeSecurityGroups()
                                                    throws AmazonServiceException,
                                                           AmazonClientException

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.

Specified by:
describeSecurityGroups in interface AmazonEC2
Returns:
The response from the DescribeSecurityGroups service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeSpotDatafeedSubscription

public DescribeSpotDatafeedSubscriptionResult describeSpotDatafeedSubscription()
                                                                        throws AmazonServiceException,
                                                                               AmazonClientException

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 .

Specified by:
describeSpotDatafeedSubscription in interface AmazonEC2
Returns:
The response from the DescribeSpotDatafeedSubscription service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeAccountAttributes

public DescribeAccountAttributesResult describeAccountAttributes()
                                                          throws AmazonServiceException,
                                                                 AmazonClientException
Specified by:
describeAccountAttributes in interface AmazonEC2
Returns:
The response from the DescribeAccountAttributes service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeLicenses

public DescribeLicensesResult describeLicenses()
                                        throws AmazonServiceException,
                                               AmazonClientException

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.

Specified by:
describeLicenses in interface AmazonEC2
Returns:
The response from the DescribeLicenses service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeVolumeStatus

public DescribeVolumeStatusResult describeVolumeStatus()
                                                throws AmazonServiceException,
                                                       AmazonClientException

Describes the status of a volume.

Specified by:
describeVolumeStatus in interface AmazonEC2
Returns:
The response from the DescribeVolumeStatus service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeVpcs

public DescribeVpcsResult describeVpcs()
                                throws AmazonServiceException,
                                       AmazonClientException

Gives you information about your VPCs. You can filter the results to return information only about VPCs that match criteria you specify.

For example, you could ask to get information about a particular VPC or VPCs (or all your VPCs) only if the VPC's state is available. You can specify multiple filters (e.g., the VPC uses one of several sets of DHCP options, and the VPC's state is available). The result includes information for a particular VPC only if the VPC matches all your filters.

If there's no match, no special message is returned; the response is simply empty. The following table shows the available filters.

Specified by:
describeVpcs in interface AmazonEC2
Returns:
The response from the DescribeVpcs service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeExportTasks

public DescribeExportTasksResult describeExportTasks()
                                              throws AmazonServiceException,
                                                     AmazonClientException
Specified by:
describeExportTasks in interface AmazonEC2
Returns:
The response from the DescribeExportTasks service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeVolumes

public DescribeVolumesResult describeVolumes()
                                      throws AmazonServiceException,
                                             AmazonClientException

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.

Specified by:
describeVolumes in interface AmazonEC2
Returns:
The response from the DescribeVolumes service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeReservedInstancesListings

public DescribeReservedInstancesListingsResult describeReservedInstancesListings()
                                                                          throws AmazonServiceException,
                                                                                 AmazonClientException
Specified by:
describeReservedInstancesListings in interface AmazonEC2
Returns:
The response from the DescribeReservedInstancesListings service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

reportInstanceStatus

public void reportInstanceStatus()
                          throws AmazonServiceException,
                                 AmazonClientException
Specified by:
reportInstanceStatus in interface AmazonEC2
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeBundleTasks

public DescribeBundleTasksResult describeBundleTasks()
                                              throws AmazonServiceException,
                                                     AmazonClientException

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.

Specified by:
describeBundleTasks in interface AmazonEC2
Returns:
The response from the DescribeBundleTasks service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

revokeSecurityGroupIngress

public void revokeSecurityGroupIngress()
                                throws AmazonServiceException,
                                       AmazonClientException

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.

Specified by:
revokeSecurityGroupIngress in interface AmazonEC2
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeConversionTasks

public DescribeConversionTasksResult describeConversionTasks()
                                                      throws AmazonServiceException,
                                                             AmazonClientException
Specified by:
describeConversionTasks in interface AmazonEC2
Returns:
The response from the DescribeConversionTasks service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describePlacementGroups

public DescribePlacementGroupsResult describePlacementGroups()
                                                      throws AmazonServiceException,
                                                             AmazonClientException

Returns information about one or more PlacementGroup instances in a user's account.

Specified by:
describePlacementGroups in interface AmazonEC2
Returns:
The response from the DescribePlacementGroups service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeSubnets

public DescribeSubnetsResult describeSubnets()
                                      throws AmazonServiceException,
                                             AmazonClientException

Gives you information about your subnets. You can filter the results to return information only about subnets that match criteria you specify.

For example, you could ask to get information about a particular subnet (or all) only if the subnet's state is available. You can specify multiple filters (e.g., the subnet is in a particular VPC, and the subnet's state is available).

The result includes information for a particular subnet only if the subnet matches all your filters. If there's no match, no special message is returned; the response is simply empty. The following table shows the available filters.

Specified by:
describeSubnets in interface AmazonEC2
Returns:
The response from the DescribeSubnets service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeInstances

public DescribeInstancesResult describeInstances()
                                          throws AmazonServiceException,
                                                 AmazonClientException

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.

Specified by:
describeInstances in interface AmazonEC2
Returns:
The response from the DescribeInstances service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeImages

public DescribeImagesResult describeImages()
                                    throws AmazonServiceException,
                                           AmazonClientException

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:

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.

Specified by:
describeImages in interface AmazonEC2
Returns:
The response from the DescribeImages service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

authorizeSecurityGroupIngress

public void authorizeSecurityGroupIngress()
                                   throws AmazonServiceException,
                                          AmazonClientException

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.

Specified by:
authorizeSecurityGroupIngress in interface AmazonEC2
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeSpotInstanceRequests

public DescribeSpotInstanceRequestsResult describeSpotInstanceRequests()
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

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?\ .

Specified by:
describeSpotInstanceRequests in interface AmazonEC2
Returns:
The response from the DescribeSpotInstanceRequests service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeTags

public DescribeTagsResult describeTags()
                                throws AmazonServiceException,
                                       AmazonClientException

Describes the tags for the specified resources.

Specified by:
describeTags in interface AmazonEC2
Returns:
The response from the DescribeTags service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeReservedInstancesModifications

public DescribeReservedInstancesModificationsResult describeReservedInstancesModifications()
                                                                                    throws AmazonServiceException,
                                                                                           AmazonClientException

The DescribeReservedInstancesModifications operation describes modifications made to Reserved Instances in your account.

Specified by:
describeReservedInstancesModifications in interface AmazonEC2
Returns:
The response from the DescribeReservedInstancesModifications service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

deleteSpotDatafeedSubscription

public void deleteSpotDatafeedSubscription()
                                    throws AmazonServiceException,
                                           AmazonClientException

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 .

Specified by:
deleteSpotDatafeedSubscription in interface AmazonEC2
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeAddresses

public DescribeAddressesResult describeAddresses()
                                          throws AmazonServiceException,
                                                 AmazonClientException

The DescribeAddresses operation lists elastic IP addresses assigned to your account.

Specified by:
describeAddresses in interface AmazonEC2
Returns:
The response from the DescribeAddresses service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeKeyPairs

public DescribeKeyPairsResult describeKeyPairs()
                                        throws AmazonServiceException,
                                               AmazonClientException

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.

Specified by:
describeKeyPairs in interface AmazonEC2
Returns:
The response from the DescribeKeyPairs service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeInstanceStatus

public DescribeInstanceStatusResult describeInstanceStatus()
                                                    throws AmazonServiceException,
                                                           AmazonClientException

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:

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:

Specified by:
describeInstanceStatus in interface AmazonEC2
Returns:
The response from the DescribeInstanceStatus service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeReservedInstancesOfferings

public DescribeReservedInstancesOfferingsResult describeReservedInstancesOfferings()
                                                                            throws AmazonServiceException,
                                                                                   AmazonClientException

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.

Specified by:
describeReservedInstancesOfferings in interface AmazonEC2
Returns:
The response from the DescribeReservedInstancesOfferings service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

disassociateAddress

public void disassociateAddress()
                         throws AmazonServiceException,
                                AmazonClientException

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.

Specified by:
disassociateAddress in interface AmazonEC2
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

allocateAddress

public AllocateAddressResult allocateAddress()
                                      throws AmazonServiceException,
                                             AmazonClientException

The AllocateAddress operation acquires an elastic IP address for use with your account.

Specified by:
allocateAddress in interface AmazonEC2
Returns:
The response from the AllocateAddress service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

releaseAddress

public void releaseAddress()
                    throws AmazonServiceException,
                           AmazonClientException

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.

Specified by:
releaseAddress in interface AmazonEC2
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

describeSnapshots

public DescribeSnapshotsResult describeSnapshots()
                                          throws AmazonServiceException,
                                                 AmazonClientException

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.

Specified by:
describeSnapshots in interface AmazonEC2
Returns:
The response from the DescribeSnapshots service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

registerImage

public RegisterImageResult registerImage()
                                  throws AmazonServiceException,
                                         AmazonClientException

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.

Specified by:
registerImage in interface AmazonEC2
Returns:
The response from the RegisterImage service method, as returned by AmazonEC2.
Throws:
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.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

dryRun

public <X extends AmazonWebServiceRequest> DryRunResult<X> dryRun(DryRunSupportedRequest<X> request)
                                                       throws AmazonServiceException,
                                                              AmazonClientException
Checks whether you have the required permissions for the provided AmazonEC2 operation, without actually running it. The returned DryRunResult object contains the information of whether the dry-run was successful. This method will throw exception when the service response does not clearly indicate whether you have the permission.

Specified by:
dryRun in interface AmazonEC2
Parameters:
request - The request object for any AmazonEC2 operation supported with dry-run.
Returns:
A DryRunResult object that contains the information of whether the dry-run was successful.
Throws:
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. Or if the service response does not clearly indicate whether you have the permission.
AmazonServiceException - If an error response is returned by AmazonEC2 indicating either a problem with the data in the request, or a server side issue.

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:
getCachedResponseMetadata in interface AmazonEC2
Parameters:
request - The originally executed request
Returns:
The response metadata for the specified request, or null if none is available.


Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.