|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.amazonaws.AmazonWebServiceClient
com.amazonaws.services.ec2.AmazonEC2Client
public class AmazonEC2Client
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.
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(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. |
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. |
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)
|
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. |
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. |
DetachVolumeResult |
detachVolume(DetachVolumeRequest detachVolumeRequest)
Detach a previously attached volume from a running instance. |
void |
disassociateAddress(DisassociateAddressRequest disassociateAddressRequest)
The DisassociateAddress operation disassociates the specified elastic IP address from the instance to which it is assigned. |
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. |
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, removeRequestHandler, setConfiguration, setEndpoint, shutdown |
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, shutdown |
Constructor Detail |
---|
public AmazonEC2Client()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProvider
public AmazonEC2Client(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this
client connects to AmazonEC2
(ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProvider
public AmazonEC2Client(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.public AmazonEC2Client(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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.).public AmazonEC2Client(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.public AmazonEC2Client(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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.).Method Detail |
---|
public void rebootInstances(RebootInstancesRequest rebootInstancesRequest) throws AmazonServiceException, AmazonClientException
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.
rebootInstances
in interface AmazonEC2
rebootInstancesRequest
- Container for the necessary parameters
to execute the RebootInstances service method on AmazonEC2.
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.public DescribeReservedInstancesResult describeReservedInstances(DescribeReservedInstancesRequest describeReservedInstancesRequest) throws AmazonServiceException, AmazonClientException
The DescribeReservedInstances operation describes Reserved Instances that were purchased for use with your account.
describeReservedInstances
in interface AmazonEC2
describeReservedInstancesRequest
- Container for the necessary
parameters to execute the DescribeReservedInstances service method on
AmazonEC2.
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.public DescribeAvailabilityZonesResult describeAvailabilityZones(DescribeAvailabilityZonesRequest describeAvailabilityZonesRequest) 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.
describeAvailabilityZones
in interface AmazonEC2
describeAvailabilityZonesRequest
- Container for the necessary
parameters to execute the DescribeAvailabilityZones service method on
AmazonEC2.
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.public DetachVolumeResult detachVolume(DetachVolumeRequest detachVolumeRequest) throws AmazonServiceException, AmazonClientException
Detach a previously attached volume from a running instance.
detachVolume
in interface AmazonEC2
detachVolumeRequest
- Container for the necessary parameters to
execute the DetachVolume service method on AmazonEC2.
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.public void deleteKeyPair(DeleteKeyPairRequest deleteKeyPairRequest) throws AmazonServiceException, AmazonClientException
The DeleteKeyPair operation deletes a key pair.
deleteKeyPair
in interface AmazonEC2
deleteKeyPairRequest
- Container for the necessary parameters to
execute the DeleteKeyPair service method on AmazonEC2.
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.public UnmonitorInstancesResult unmonitorInstances(UnmonitorInstancesRequest unmonitorInstancesRequest) throws AmazonServiceException, AmazonClientException
Disables monitoring for a running instance.
unmonitorInstances
in interface AmazonEC2
unmonitorInstancesRequest
- Container for the necessary
parameters to execute the UnmonitorInstances service method on
AmazonEC2.
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.public CreateImageResult createImage(CreateImageRequest createImageRequest) throws AmazonServiceException, AmazonClientException
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.
createImage
in interface AmazonEC2
createImageRequest
- Container for the necessary parameters to
execute the CreateImage service method on AmazonEC2.
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.public void deleteSecurityGroup(DeleteSecurityGroupRequest deleteSecurityGroupRequest) 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.
deleteSecurityGroup
in interface AmazonEC2
deleteSecurityGroupRequest
- Container for the necessary
parameters to execute the DeleteSecurityGroup service method on
AmazonEC2.
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.public CreateInstanceExportTaskResult createInstanceExportTask(CreateInstanceExportTaskRequest createInstanceExportTaskRequest) throws AmazonServiceException, AmazonClientException
createInstanceExportTask
in interface AmazonEC2
createInstanceExportTaskRequest
- Container for the necessary
parameters to execute the CreateInstanceExportTask service method on
AmazonEC2.
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.public GetPasswordDataResult getPasswordData(GetPasswordDataRequest getPasswordDataRequest) throws AmazonServiceException, AmazonClientException
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.
getPasswordData
in interface AmazonEC2
getPasswordDataRequest
- Container for the necessary parameters
to execute the GetPasswordData service method on AmazonEC2.
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.public StopInstancesResult stopInstances(StopInstancesRequest stopInstancesRequest) throws AmazonServiceException, AmazonClientException
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.
stopInstances
in interface AmazonEC2
stopInstancesRequest
- Container for the necessary parameters to
execute the StopInstances service method on AmazonEC2.
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.public ImportKeyPairResult importKeyPair(ImportKeyPairRequest importKeyPairRequest) throws AmazonServiceException, AmazonClientException
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:
importKeyPair
in interface AmazonEC2
importKeyPairRequest
- Container for the necessary parameters to
execute the ImportKeyPair service method on AmazonEC2.
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.public CreateSecurityGroupResult createSecurityGroup(CreateSecurityGroupRequest createSecurityGroupRequest) throws AmazonServiceException, AmazonClientException
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.
createSecurityGroup
in interface AmazonEC2
createSecurityGroupRequest
- Container for the necessary
parameters to execute the CreateSecurityGroup service method on
AmazonEC2.
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.public DescribeSpotPriceHistoryResult describeSpotPriceHistory(DescribeSpotPriceHistoryRequest describeSpotPriceHistoryRequest) 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 .
describeSpotPriceHistory
in interface AmazonEC2
describeSpotPriceHistoryRequest
- Container for the necessary
parameters to execute the DescribeSpotPriceHistory service method on
AmazonEC2.
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.public DescribeRegionsResult describeRegions(DescribeRegionsRequest describeRegionsRequest) throws AmazonServiceException, AmazonClientException
The DescribeRegions operation describes regions zones that are currently available to the account.
describeRegions
in interface AmazonEC2
describeRegionsRequest
- Container for the necessary parameters
to execute the DescribeRegions service method on AmazonEC2.
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.public CreateReservedInstancesListingResult createReservedInstancesListing(CreateReservedInstancesListingRequest createReservedInstancesListingRequest) throws AmazonServiceException, AmazonClientException
createReservedInstancesListing
in interface AmazonEC2
createReservedInstancesListingRequest
- Container for the
necessary parameters to execute the CreateReservedInstancesListing
service method on AmazonEC2.
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.public void resetSnapshotAttribute(ResetSnapshotAttributeRequest resetSnapshotAttributeRequest) throws AmazonServiceException, AmazonClientException
Resets permission settings for the specified snapshot.
resetSnapshotAttribute
in interface AmazonEC2
resetSnapshotAttributeRequest
- Container for the necessary
parameters to execute the ResetSnapshotAttribute service method on
AmazonEC2.
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.public ImportVolumeResult importVolume(ImportVolumeRequest importVolumeRequest) throws AmazonServiceException, AmazonClientException
importVolume
in interface AmazonEC2
importVolumeRequest
- Container for the necessary parameters to
execute the ImportVolume service method on AmazonEC2.
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.public DescribeSecurityGroupsResult describeSecurityGroups(DescribeSecurityGroupsRequest describeSecurityGroupsRequest) 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.
describeSecurityGroups
in interface AmazonEC2
describeSecurityGroupsRequest
- Container for the necessary
parameters to execute the DescribeSecurityGroups service method on
AmazonEC2.
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.public void deregisterImage(DeregisterImageRequest deregisterImageRequest) throws AmazonServiceException, AmazonClientException
The DeregisterImage operation deregisters an AMI. Once deregistered, instances of the AMI can no longer be launched.
deregisterImage
in interface AmazonEC2
deregisterImageRequest
- Container for the necessary parameters
to execute the DeregisterImage service method on AmazonEC2.
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.public DescribeSpotDatafeedSubscriptionResult describeSpotDatafeedSubscription(DescribeSpotDatafeedSubscriptionRequest describeSpotDatafeedSubscriptionRequest) 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 .
describeSpotDatafeedSubscription
in interface AmazonEC2
describeSpotDatafeedSubscriptionRequest
- Container for the
necessary parameters to execute the DescribeSpotDatafeedSubscription
service method on AmazonEC2.
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.public void deleteTags(DeleteTagsRequest deleteTagsRequest) throws AmazonServiceException, AmazonClientException
Deletes tags from the specified Amazon EC2 resources.
deleteTags
in interface AmazonEC2
deleteTagsRequest
- Container for the necessary parameters to
execute the DeleteTags service method on AmazonEC2.
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.public void enableVolumeIO(EnableVolumeIORequest enableVolumeIORequest) throws AmazonServiceException, AmazonClientException
Enable IO on the volume after an event has occured.
enableVolumeIO
in interface AmazonEC2
enableVolumeIORequest
- Container for the necessary parameters to
execute the EnableVolumeIO service method on AmazonEC2.
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.public AttachVolumeResult attachVolume(AttachVolumeRequest attachVolumeRequest) throws AmazonServiceException, AmazonClientException
Attach a previously created volume to a running instance.
attachVolume
in interface AmazonEC2
attachVolumeRequest
- Container for the necessary parameters to
execute the AttachVolume service method on AmazonEC2.
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.public DescribeLicensesResult describeLicenses(DescribeLicensesRequest describeLicensesRequest) 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.
describeLicenses
in interface AmazonEC2
describeLicensesRequest
- Container for the necessary parameters
to execute the DescribeLicenses service method on AmazonEC2.
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.public DescribeVolumeStatusResult describeVolumeStatus(DescribeVolumeStatusRequest describeVolumeStatusRequest) throws AmazonServiceException, AmazonClientException
Describes the status of a volume.
describeVolumeStatus
in interface AmazonEC2
describeVolumeStatusRequest
- Container for the necessary
parameters to execute the DescribeVolumeStatus service method on
AmazonEC2.
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.public void activateLicense(ActivateLicenseRequest activateLicenseRequest) throws AmazonServiceException, AmazonClientException
Activates a specific number of licenses for a 90-day period. Activations can be done against a specific license ID.
activateLicense
in interface AmazonEC2
activateLicenseRequest
- Container for the necessary parameters
to execute the ActivateLicense service method on AmazonEC2.
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.public void resetImageAttribute(ResetImageAttributeRequest resetImageAttributeRequest) throws AmazonServiceException, AmazonClientException
The ResetImageAttribute operation resets an attribute of an AMI to its default value.
NOTE: The productCodes attribute cannot be reset.
resetImageAttribute
in interface AmazonEC2
resetImageAttributeRequest
- Container for the necessary
parameters to execute the ResetImageAttribute service method on
AmazonEC2.
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.public CreateSnapshotResult createSnapshot(CreateSnapshotRequest createSnapshotRequest) throws AmazonServiceException, AmazonClientException
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.
createSnapshot
in interface AmazonEC2
createSnapshotRequest
- Container for the necessary parameters to
execute the CreateSnapshot service method on AmazonEC2.
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.public void deleteVolume(DeleteVolumeRequest deleteVolumeRequest) throws AmazonServiceException, AmazonClientException
Deletes a previously created volume. Once successfully deleted, a new volume can be created with the same name.
deleteVolume
in interface AmazonEC2
deleteVolumeRequest
- Container for the necessary parameters to
execute the DeleteVolume service method on AmazonEC2.
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.public AssociateAddressResult associateAddress(AssociateAddressRequest associateAddressRequest) throws AmazonServiceException, AmazonClientException
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.
associateAddress
in interface AmazonEC2
associateAddressRequest
- Container for the necessary parameters
to execute the AssociateAddress service method on AmazonEC2.
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.public void cancelConversionTask(CancelConversionTaskRequest cancelConversionTaskRequest) throws AmazonServiceException, AmazonClientException
cancelConversionTask
in interface AmazonEC2
cancelConversionTaskRequest
- Container for the necessary
parameters to execute the CancelConversionTask service method on
AmazonEC2.
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.public void deactivateLicense(DeactivateLicenseRequest deactivateLicenseRequest) throws AmazonServiceException, AmazonClientException
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.
deactivateLicense
in interface AmazonEC2
deactivateLicenseRequest
- Container for the necessary parameters
to execute the DeactivateLicense service method on AmazonEC2.
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.public DescribeExportTasksResult describeExportTasks(DescribeExportTasksRequest describeExportTasksRequest) throws AmazonServiceException, AmazonClientException
describeExportTasks
in interface AmazonEC2
describeExportTasksRequest
- Container for the necessary
parameters to execute the DescribeExportTasks service method on
AmazonEC2.
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.public DescribeVolumesResult describeVolumes(DescribeVolumesRequest describeVolumesRequest) 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.
describeVolumes
in interface AmazonEC2
describeVolumesRequest
- Container for the necessary parameters
to execute the DescribeVolumes service method on AmazonEC2.
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.public DescribeReservedInstancesListingsResult describeReservedInstancesListings(DescribeReservedInstancesListingsRequest describeReservedInstancesListingsRequest) throws AmazonServiceException, AmazonClientException
describeReservedInstancesListings
in interface AmazonEC2
describeReservedInstancesListingsRequest
- Container for the
necessary parameters to execute the DescribeReservedInstancesListings
service method on AmazonEC2.
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.public void reportInstanceStatus(ReportInstanceStatusRequest reportInstanceStatusRequest) throws AmazonServiceException, AmazonClientException
reportInstanceStatus
in interface AmazonEC2
reportInstanceStatusRequest
- Container for the necessary
parameters to execute the ReportInstanceStatus service method on
AmazonEC2.
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.public MonitorInstancesResult monitorInstances(MonitorInstancesRequest monitorInstancesRequest) throws AmazonServiceException, AmazonClientException
Enables monitoring for a running instance.
monitorInstances
in interface AmazonEC2
monitorInstancesRequest
- Container for the necessary parameters
to execute the MonitorInstances service method on AmazonEC2.
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.public DescribeBundleTasksResult describeBundleTasks(DescribeBundleTasksRequest describeBundleTasksRequest) 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.
describeBundleTasks
in interface AmazonEC2
describeBundleTasksRequest
- Container for the necessary
parameters to execute the DescribeBundleTasks service method on
AmazonEC2.
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.public ImportInstanceResult importInstance(ImportInstanceRequest importInstanceRequest) throws AmazonServiceException, AmazonClientException
importInstance
in interface AmazonEC2
importInstanceRequest
- Container for the necessary parameters to
execute the ImportInstance service method on AmazonEC2.
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.public void revokeSecurityGroupIngress(RevokeSecurityGroupIngressRequest revokeSecurityGroupIngressRequest) 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.
revokeSecurityGroupIngress
in interface AmazonEC2
revokeSecurityGroupIngressRequest
- Container for the necessary
parameters to execute the RevokeSecurityGroupIngress service method on
AmazonEC2.
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.public GetConsoleOutputResult getConsoleOutput(GetConsoleOutputRequest getConsoleOutputRequest) throws AmazonServiceException, AmazonClientException
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.
getConsoleOutput
in interface AmazonEC2
getConsoleOutputRequest
- Container for the necessary parameters
to execute the GetConsoleOutput service method on AmazonEC2.
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.public void modifyImageAttribute(ModifyImageAttributeRequest modifyImageAttributeRequest) throws AmazonServiceException, AmazonClientException
The ModifyImageAttribute operation modifies an attribute of an AMI.
modifyImageAttribute
in interface AmazonEC2
modifyImageAttributeRequest
- Container for the necessary
parameters to execute the ModifyImageAttribute service method on
AmazonEC2.
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.public CreateSpotDatafeedSubscriptionResult createSpotDatafeedSubscription(CreateSpotDatafeedSubscriptionRequest createSpotDatafeedSubscriptionRequest) throws AmazonServiceException, AmazonClientException
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 .
createSpotDatafeedSubscription
in interface AmazonEC2
createSpotDatafeedSubscriptionRequest
- Container for the
necessary parameters to execute the CreateSpotDatafeedSubscription
service method on AmazonEC2.
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.public DescribeConversionTasksResult describeConversionTasks(DescribeConversionTasksRequest describeConversionTasksRequest) throws AmazonServiceException, AmazonClientException
describeConversionTasks
in interface AmazonEC2
describeConversionTasksRequest
- Container for the necessary
parameters to execute the DescribeConversionTasks service method on
AmazonEC2.
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.public DescribeInstanceAttributeResult describeInstanceAttribute(DescribeInstanceAttributeRequest describeInstanceAttributeRequest) throws AmazonServiceException, AmazonClientException
Returns information about an attribute of an instance. Only one attribute can be specified per call.
describeInstanceAttribute
in interface AmazonEC2
describeInstanceAttributeRequest
- Container for the necessary
parameters to execute the DescribeInstanceAttribute service method on
AmazonEC2.
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.public RunInstancesResult runInstances(RunInstancesRequest runInstancesRequest) throws AmazonServiceException, AmazonClientException
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.
runInstances
in interface AmazonEC2
runInstancesRequest
- Container for the necessary parameters to
execute the RunInstances service method on AmazonEC2.
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.public DescribePlacementGroupsResult describePlacementGroups(DescribePlacementGroupsRequest describePlacementGroupsRequest) throws AmazonServiceException, AmazonClientException
Returns information about one or more PlacementGroup instances in a user's account.
describePlacementGroups
in interface AmazonEC2
describePlacementGroupsRequest
- Container for the necessary
parameters to execute the DescribePlacementGroups service method on
AmazonEC2.
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.public DescribeInstancesResult describeInstances(DescribeInstancesRequest describeInstancesRequest) 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.
describeInstances
in interface AmazonEC2
describeInstancesRequest
- Container for the necessary parameters
to execute the DescribeInstances service method on AmazonEC2.
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.public void modifyVolumeAttribute(ModifyVolumeAttributeRequest modifyVolumeAttributeRequest) throws AmazonServiceException, AmazonClientException
modifyVolumeAttribute
in interface AmazonEC2
modifyVolumeAttributeRequest
- Container for the necessary
parameters to execute the ModifyVolumeAttribute service method on
AmazonEC2.
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.public DescribeImagesResult describeImages(DescribeImagesRequest describeImagesRequest) 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.
describeImages
in interface AmazonEC2
describeImagesRequest
- Container for the necessary parameters to
execute the DescribeImages service method on AmazonEC2.
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.public StartInstancesResult startInstances(StartInstancesRequest startInstancesRequest) throws AmazonServiceException, AmazonClientException
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.
startInstances
in interface AmazonEC2
startInstancesRequest
- Container for the necessary parameters to
execute the StartInstances service method on AmazonEC2.
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.public CancelReservedInstancesListingResult cancelReservedInstancesListing(CancelReservedInstancesListingRequest cancelReservedInstancesListingRequest) throws AmazonServiceException, AmazonClientException
cancelReservedInstancesListing
in interface AmazonEC2
cancelReservedInstancesListingRequest
- Container for the
necessary parameters to execute the CancelReservedInstancesListing
service method on AmazonEC2.
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.public void modifyInstanceAttribute(ModifyInstanceAttributeRequest modifyInstanceAttributeRequest) throws AmazonServiceException, AmazonClientException
Modifies an attribute of an instance.
modifyInstanceAttribute
in interface AmazonEC2
modifyInstanceAttributeRequest
- Container for the necessary
parameters to execute the ModifyInstanceAttribute service method on
AmazonEC2.
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.public void authorizeSecurityGroupIngress(AuthorizeSecurityGroupIngressRequest authorizeSecurityGroupIngressRequest) 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.
authorizeSecurityGroupIngress
in interface AmazonEC2
authorizeSecurityGroupIngressRequest
- Container for the
necessary parameters to execute the AuthorizeSecurityGroupIngress
service method on AmazonEC2.
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.public DescribeSpotInstanceRequestsResult describeSpotInstanceRequests(DescribeSpotInstanceRequestsRequest describeSpotInstanceRequestsRequest) 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?\
.
describeSpotInstanceRequests
in interface AmazonEC2
describeSpotInstanceRequestsRequest
- Container for the necessary
parameters to execute the DescribeSpotInstanceRequests service method
on AmazonEC2.
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.public void cancelExportTask(CancelExportTaskRequest cancelExportTaskRequest) throws AmazonServiceException, AmazonClientException
cancelExportTask
in interface AmazonEC2
cancelExportTaskRequest
- Container for the necessary parameters
to execute the CancelExportTask service method on AmazonEC2.
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.public RequestSpotInstancesResult requestSpotInstances(RequestSpotInstancesRequest requestSpotInstancesRequest) throws AmazonServiceException, AmazonClientException
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.
requestSpotInstances
in interface AmazonEC2
requestSpotInstancesRequest
- Container for the necessary
parameters to execute the RequestSpotInstances service method on
AmazonEC2.
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.public void createTags(CreateTagsRequest createTagsRequest) throws AmazonServiceException, AmazonClientException
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.
createTags
in interface AmazonEC2
createTagsRequest
- Container for the necessary parameters to
execute the CreateTags service method on AmazonEC2.
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.public DescribeVolumeAttributeResult describeVolumeAttribute(DescribeVolumeAttributeRequest describeVolumeAttributeRequest) throws AmazonServiceException, AmazonClientException
describeVolumeAttribute
in interface AmazonEC2
describeVolumeAttributeRequest
- Container for the necessary
parameters to execute the DescribeVolumeAttribute service method on
AmazonEC2.
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.public DescribeTagsResult describeTags(DescribeTagsRequest describeTagsRequest) throws AmazonServiceException, AmazonClientException
Describes the tags for the specified resources.
describeTags
in interface AmazonEC2
describeTagsRequest
- Container for the necessary parameters to
execute the DescribeTags service method on AmazonEC2.
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.public CancelBundleTaskResult cancelBundleTask(CancelBundleTaskRequest cancelBundleTaskRequest) throws AmazonServiceException, AmazonClientException
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.
cancelBundleTask
in interface AmazonEC2
cancelBundleTaskRequest
- Container for the necessary parameters
to execute the CancelBundleTask service method on AmazonEC2.
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.public CancelSpotInstanceRequestsResult cancelSpotInstanceRequests(CancelSpotInstanceRequestsRequest cancelSpotInstanceRequestsRequest) throws AmazonServiceException, AmazonClientException
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 .
cancelSpotInstanceRequests
in interface AmazonEC2
cancelSpotInstanceRequestsRequest
- Container for the necessary
parameters to execute the CancelSpotInstanceRequests service method on
AmazonEC2.
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.public PurchaseReservedInstancesOfferingResult purchaseReservedInstancesOffering(PurchaseReservedInstancesOfferingRequest purchaseReservedInstancesOfferingRequest) throws AmazonServiceException, AmazonClientException
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.
purchaseReservedInstancesOffering
in interface AmazonEC2
purchaseReservedInstancesOfferingRequest
- Container for the
necessary parameters to execute the PurchaseReservedInstancesOffering
service method on AmazonEC2.
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.public void modifySnapshotAttribute(ModifySnapshotAttributeRequest modifySnapshotAttributeRequest) throws AmazonServiceException, AmazonClientException
Adds or remove permission settings for the specified snapshot.
modifySnapshotAttribute
in interface AmazonEC2
modifySnapshotAttributeRequest
- Container for the necessary
parameters to execute the ModifySnapshotAttribute service method on
AmazonEC2.
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.public TerminateInstancesResult terminateInstances(TerminateInstancesRequest terminateInstancesRequest) throws AmazonServiceException, AmazonClientException
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).
terminateInstances
in interface AmazonEC2
terminateInstancesRequest
- Container for the necessary
parameters to execute the TerminateInstances service method on
AmazonEC2.
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.public void deleteSpotDatafeedSubscription(DeleteSpotDatafeedSubscriptionRequest deleteSpotDatafeedSubscriptionRequest) 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 .
deleteSpotDatafeedSubscription
in interface AmazonEC2
deleteSpotDatafeedSubscriptionRequest
- Container for the
necessary parameters to execute the DeleteSpotDatafeedSubscription
service method on AmazonEC2.
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.public DescribeSnapshotAttributeResult describeSnapshotAttribute(DescribeSnapshotAttributeRequest describeSnapshotAttributeRequest) throws AmazonServiceException, AmazonClientException
Returns information about an attribute of a snapshot. Only one attribute can be specified per call.
describeSnapshotAttribute
in interface AmazonEC2
describeSnapshotAttributeRequest
- Container for the necessary
parameters to execute the DescribeSnapshotAttribute service method on
AmazonEC2.
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.public DescribeAddressesResult describeAddresses(DescribeAddressesRequest describeAddressesRequest) throws AmazonServiceException, AmazonClientException
The DescribeAddresses operation lists elastic IP addresses assigned to your account.
describeAddresses
in interface AmazonEC2
describeAddressesRequest
- Container for the necessary parameters
to execute the DescribeAddresses service method on AmazonEC2.
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.public DescribeImageAttributeResult describeImageAttribute(DescribeImageAttributeRequest describeImageAttributeRequest) throws AmazonServiceException, AmazonClientException
The DescribeImageAttribute operation returns information about an attribute of an AMI. Only one attribute can be specified per call.
describeImageAttribute
in interface AmazonEC2
describeImageAttributeRequest
- Container for the necessary
parameters to execute the DescribeImageAttribute service method on
AmazonEC2.
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.public DescribeKeyPairsResult describeKeyPairs(DescribeKeyPairsRequest describeKeyPairsRequest) 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.
describeKeyPairs
in interface AmazonEC2
describeKeyPairsRequest
- Container for the necessary parameters
to execute the DescribeKeyPairs service method on AmazonEC2.
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.public ConfirmProductInstanceResult confirmProductInstance(ConfirmProductInstanceRequest confirmProductInstanceRequest) throws AmazonServiceException, AmazonClientException
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.
confirmProductInstance
in interface AmazonEC2
confirmProductInstanceRequest
- Container for the necessary
parameters to execute the ConfirmProductInstance service method on
AmazonEC2.
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.public CreateVolumeResult createVolume(CreateVolumeRequest createVolumeRequest) throws AmazonServiceException, AmazonClientException
Initializes an empty volume of a given size.
createVolume
in interface AmazonEC2
createVolumeRequest
- Container for the necessary parameters to
execute the CreateVolume service method on AmazonEC2.
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.public DescribeInstanceStatusResult describeInstanceStatus(DescribeInstanceStatusRequest describeInstanceStatusRequest) 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:
system-reboot
or instance-reboot
.
System reboot commonly occurs if certain maintenance or upgrade
operations require a reboot of the underlying host that supports an
instance. Instance reboot commonly occurs if the instance must be
rebooted, rather than the underlying host. Rebooting events include a
scheduled start and end time. instance-retirement
. Retirement commonly
occurs when the underlying host is degraded and must be replaced.
Retirement events include a scheduled start and end time. You're also
notified by email if one of your instances is set to retiring. The
email message indicates when your instance will be permanently
retired.
If your instance is permanently retired, it will not be restarted.
You can avoid retirement by manually restarting your instance when its
event code is instance-retirement
. This ensures that
your instance is started on a healthy host.
DescribeInstanceStatus
returns information only for
instances in the running state.
You can filter the results to return information only about instances that match criteria you specify. For example, you could get information about instances in a specific Availability Zone. You can specify multiple values for a filter (e.g., more than one Availability Zone). An instance must match at least one of the specified values for it to be included in the results.
You can specify multiple filters. An instance must match all the filters for it to be included in the results. If there's no match, no special message is returned; the response is simply empty.
You can use wildcards with the filter values: *
matches
zero or more characters, and ?
matches exactly one
character. You can escape special characters using a backslash before
the character. For example, a value of \*amazon\?\\
searches for the literal string *amazon?\
.
The following filters are available:
availability-zone
- Filter on an instance's
availability zone. instance-state-name
- Filter on the intended state
of the instance, e.g., running. instance-state-code
- Filter on the intended state
code of the instance, e.g., 16.
describeInstanceStatus
in interface AmazonEC2
describeInstanceStatusRequest
- Container for the necessary
parameters to execute the DescribeInstanceStatus service method on
AmazonEC2.
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.public DescribeReservedInstancesOfferingsResult describeReservedInstancesOfferings(DescribeReservedInstancesOfferingsRequest describeReservedInstancesOfferingsRequest) 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.
describeReservedInstancesOfferings
in interface AmazonEC2
describeReservedInstancesOfferingsRequest
- Container for the
necessary parameters to execute the DescribeReservedInstancesOfferings
service method on AmazonEC2.
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.public void deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest) throws AmazonServiceException, AmazonClientException
Deletes the snapshot identified by snapshotId
.
deleteSnapshot
in interface AmazonEC2
deleteSnapshotRequest
- Container for the necessary parameters to
execute the DeleteSnapshot service method on AmazonEC2.
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.public void disassociateAddress(DisassociateAddressRequest disassociateAddressRequest) 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.
disassociateAddress
in interface AmazonEC2
disassociateAddressRequest
- Container for the necessary
parameters to execute the DisassociateAddress service method on
AmazonEC2.
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.public void createPlacementGroup(CreatePlacementGroupRequest createPlacementGroupRequest) throws AmazonServiceException, AmazonClientException
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.
createPlacementGroup
in interface AmazonEC2
createPlacementGroupRequest
- Container for the necessary
parameters to execute the CreatePlacementGroup service method on
AmazonEC2.
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.public BundleInstanceResult bundleInstance(BundleInstanceRequest bundleInstanceRequest) throws AmazonServiceException, AmazonClientException
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.
bundleInstance
in interface AmazonEC2
bundleInstanceRequest
- Container for the necessary parameters to
execute the BundleInstance service method on AmazonEC2.
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.public void deletePlacementGroup(DeletePlacementGroupRequest deletePlacementGroupRequest) throws AmazonServiceException, AmazonClientException
Deletes a PlacementGroup from a user's account. Terminate all Amazon EC2 instances in the placement group before deletion.
deletePlacementGroup
in interface AmazonEC2
deletePlacementGroupRequest
- Container for the necessary
parameters to execute the DeletePlacementGroup service method on
AmazonEC2.
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.public AllocateAddressResult allocateAddress(AllocateAddressRequest allocateAddressRequest) throws AmazonServiceException, AmazonClientException
The AllocateAddress operation acquires an elastic IP address for use with your account.
allocateAddress
in interface AmazonEC2
allocateAddressRequest
- Container for the necessary parameters
to execute the AllocateAddress service method on AmazonEC2.
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.public void releaseAddress(ReleaseAddressRequest releaseAddressRequest) 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.
releaseAddress
in interface AmazonEC2
releaseAddressRequest
- Container for the necessary parameters to
execute the ReleaseAddress service method on AmazonEC2.
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.public void resetInstanceAttribute(ResetInstanceAttributeRequest resetInstanceAttributeRequest) throws AmazonServiceException, AmazonClientException
Resets an attribute of an instance to its default value.
resetInstanceAttribute
in interface AmazonEC2
resetInstanceAttributeRequest
- Container for the necessary
parameters to execute the ResetInstanceAttribute service method on
AmazonEC2.
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.public CreateKeyPairResult createKeyPair(CreateKeyPairRequest createKeyPairRequest) throws AmazonServiceException, AmazonClientException
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.
createKeyPair
in interface AmazonEC2
createKeyPairRequest
- Container for the necessary parameters to
execute the CreateKeyPair service method on AmazonEC2.
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.public DescribeSnapshotsResult describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest) 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.
describeSnapshots
in interface AmazonEC2
describeSnapshotsRequest
- Container for the necessary parameters
to execute the DescribeSnapshots service method on AmazonEC2.
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.public RegisterImageResult registerImage(RegisterImageRequest registerImageRequest) 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.
registerImage
in interface AmazonEC2
registerImageRequest
- Container for the necessary parameters to
execute the RegisterImage service method on AmazonEC2.
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.public DescribeReservedInstancesResult describeReservedInstances() throws AmazonServiceException, AmazonClientException
The DescribeReservedInstances operation describes Reserved Instances that were purchased for use with your account.
describeReservedInstances
in interface AmazonEC2
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.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.
describeAvailabilityZones
in interface AmazonEC2
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.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.
deleteSecurityGroup
in interface AmazonEC2
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.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 .
describeSpotPriceHistory
in interface AmazonEC2
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.public DescribeRegionsResult describeRegions() throws AmazonServiceException, AmazonClientException
The DescribeRegions operation describes regions zones that are currently available to the account.
describeRegions
in interface AmazonEC2
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.public ImportVolumeResult importVolume() throws AmazonServiceException, AmazonClientException
importVolume
in interface AmazonEC2
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.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.
describeSecurityGroups
in interface AmazonEC2
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.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 .
describeSpotDatafeedSubscription
in interface AmazonEC2
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.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.
describeLicenses
in interface AmazonEC2
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.public DescribeVolumeStatusResult describeVolumeStatus() throws AmazonServiceException, AmazonClientException
Describes the status of a volume.
describeVolumeStatus
in interface AmazonEC2
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.public DescribeExportTasksResult describeExportTasks() throws AmazonServiceException, AmazonClientException
describeExportTasks
in interface AmazonEC2
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.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.
describeVolumes
in interface AmazonEC2
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.public DescribeReservedInstancesListingsResult describeReservedInstancesListings() throws AmazonServiceException, AmazonClientException
describeReservedInstancesListings
in interface AmazonEC2
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.public void reportInstanceStatus() throws AmazonServiceException, AmazonClientException
reportInstanceStatus
in interface AmazonEC2
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.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.
describeBundleTasks
in interface AmazonEC2
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.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.
revokeSecurityGroupIngress
in interface AmazonEC2
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.public DescribeConversionTasksResult describeConversionTasks() throws AmazonServiceException, AmazonClientException
describeConversionTasks
in interface AmazonEC2
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.public DescribePlacementGroupsResult describePlacementGroups() throws AmazonServiceException, AmazonClientException
Returns information about one or more PlacementGroup instances in a user's account.
describePlacementGroups
in interface AmazonEC2
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.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.
describeInstances
in interface AmazonEC2
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.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.
describeImages
in interface AmazonEC2
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.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.
authorizeSecurityGroupIngress
in interface AmazonEC2
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.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?\
.
describeSpotInstanceRequests
in interface AmazonEC2
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.public DescribeTagsResult describeTags() throws AmazonServiceException, AmazonClientException
Describes the tags for the specified resources.
describeTags
in interface AmazonEC2
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.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 .
deleteSpotDatafeedSubscription
in interface AmazonEC2
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.public DescribeAddressesResult describeAddresses() throws AmazonServiceException, AmazonClientException
The DescribeAddresses operation lists elastic IP addresses assigned to your account.
describeAddresses
in interface AmazonEC2
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.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.
describeKeyPairs
in interface AmazonEC2
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.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:
system-reboot
or instance-reboot
.
System reboot commonly occurs if certain maintenance or upgrade
operations require a reboot of the underlying host that supports an
instance. Instance reboot commonly occurs if the instance must be
rebooted, rather than the underlying host. Rebooting events include a
scheduled start and end time. instance-retirement
. Retirement commonly
occurs when the underlying host is degraded and must be replaced.
Retirement events include a scheduled start and end time. You're also
notified by email if one of your instances is set to retiring. The
email message indicates when your instance will be permanently
retired.
If your instance is permanently retired, it will not be restarted.
You can avoid retirement by manually restarting your instance when its
event code is instance-retirement
. This ensures that
your instance is started on a healthy host.
DescribeInstanceStatus
returns information only for
instances in the running state.
You can filter the results to return information only about instances that match criteria you specify. For example, you could get information about instances in a specific Availability Zone. You can specify multiple values for a filter (e.g., more than one Availability Zone). An instance must match at least one of the specified values for it to be included in the results.
You can specify multiple filters. An instance must match all the filters for it to be included in the results. If there's no match, no special message is returned; the response is simply empty.
You can use wildcards with the filter values: *
matches
zero or more characters, and ?
matches exactly one
character. You can escape special characters using a backslash before
the character. For example, a value of \*amazon\?\\
searches for the literal string *amazon?\
.
The following filters are available:
availability-zone
- Filter on an instance's
availability zone. instance-state-name
- Filter on the intended state
of the instance, e.g., running. instance-state-code
- Filter on the intended state
code of the instance, e.g., 16.
describeInstanceStatus
in interface AmazonEC2
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.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.
describeReservedInstancesOfferings
in interface AmazonEC2
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.public AllocateAddressResult allocateAddress() throws AmazonServiceException, AmazonClientException
The AllocateAddress operation acquires an elastic IP address for use with your account.
allocateAddress
in interface AmazonEC2
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.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.
releaseAddress
in interface AmazonEC2
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.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.
describeSnapshots
in interface AmazonEC2
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.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.
registerImage
in interface AmazonEC2
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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
getCachedResponseMetadata
in interface AmazonEC2
request
- The originally executed request
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |