amazonka-ec2-1.5.0: Amazon Elastic Compute Cloud SDK.

Copyright(c) 2013-2017 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.EC2.DescribeInstances

Contents

Description

Describes one or more of your instances.

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 instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.

This operation returns paginated results.

Synopsis

Creating a Request

describeInstances :: DescribeInstances Source #

Creates a value of DescribeInstances with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • diiFilters - One or more filters. * affinity - The affinity setting for an instance running on a Dedicated Host (default | host ). * architecture - The instance architecture (i386 | x86_64 ). * availability-zone - The Availability Zone of the instance. * block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z . * block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination. * block-device-mapping.device-name - The device name specified in the block device mapping (for example, devsdh or xvdh ). * block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached ). * block-device-mapping.volume-id - The volume ID of the EBS volume. * client-token - The idempotency token you provided when you launched the instance. * dns-name - The public DNS name of the instance. * group-id - The ID of the security group for the instance. EC2-Classic only. * group-name - The name of the security group for the instance. EC2-Classic only. * host-id - The ID of the Dedicated Host on which the instance is running, if applicable. * hypervisor - The hypervisor type of the instance (ovm | xen ). * iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN. * image-id - The ID of the image used to launch the instance. * instance-id - The ID of the instance. * instance-lifecycle - Indicates whether this is a Spot Instance or a Scheduled Instance (spot | scheduled ). * instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped). * instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped ). * instance-type - The type of instance (for example, t2.micro ). * instance.group-id - The ID of the security group for the instance. * instance.group-name - The name of the security group for the instance. * ip-address - The public IPv4 address of the instance. * kernel-id - The kernel ID. * key-name - The name of the key pair used when the instance was launched. * launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on). * launch-time - The time when the instance was launched. * monitoring-state - Indicates whether detailed monitoring is enabled (disabled | enabled ). * network-interface.addresses.private-ip-address - The private IPv4 address associated with the network interface. * network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address. * network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address (IPv4) with a network interface. * network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address associated with the network interface. * network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface. * network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface. * network-interface.association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface. * network-interface.association.association-id - The association ID returned when the network interface was associated with an IPv4 address. * network-interface.attachment.attachment-id - The ID of the interface attachment. * network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached. * network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached. * network-interface.attachment.device-index - The device index to which the network interface is attached. * network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached ). * network-interface.attachment.attach-time - The time that the network interface was attached to an instance. * network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated. * network-interface.availability-zone - The Availability Zone for the network interface. * network-interface.description - The description of the network interface. * network-interface.group-id - The ID of a security group associated with the network interface. * network-interface.group-name - The name of a security group associated with the network interface. * network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network interface. * network-interface.mac-address - The MAC address of the network interface. * network-interface.network-interface-id - The ID of the network interface. * network-interface.owner-id - The ID of the owner of the network interface. * network-interface.private-dns-name - The private DNS name of the network interface. * network-interface.requester-id - The requester ID for the network interface. * network-interface.requester-managed - Indicates whether the network interface is being managed by AWS. * network-interface.status - The status of the network interface (available ) | in-use ). * network-interface.source-dest-check - Whether the network interface performs sourcedestination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC. * network-interface.subnet-id - The ID of the subnet for the network interface. * network-interface.vpc-id - The ID of the VPC for the network interface. * owner-id - The AWS account ID of the instance owner. * placement-group-name - The name of the placement group for the instance. * platform - The platform. Use windows if you have Windows instances; otherwise, leave blank. * private-dns-name - The private IPv4 DNS name of the instance. * private-ip-address - The private IPv4 address of the instance. * product-code - The product code associated with the AMI used to launch the instance. * product-code.type - The type of product code (devpay | marketplace ). * ramdisk-id - The RAM disk ID. * reason - The reason for the current state of the instance (for example, shows "User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code filter. * requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on). * reservation-id - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID. * root-device-name - The device name of the root device volume (for example, @devsda1 ). * root-device-type - The type of the root device volume (ebs | instance-store ). * source-dest-check@ - Indicates whether the instance performs sourcedestination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC. * spot-instance-request-id - The ID of the Spot Instance request. * state-reason-code - The reason code for the state change. * state-reason-message - A message that describes the state change. * subnet-id - The ID of the subnet for the instance. * tag :key =value - The keyvalue combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value. * tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of the tag's key). If you want to list only resources where Purpose is X, see the tag :key =value/ filter. * tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter. * tenancy - The tenancy of an instance (dedicated | default | host ). * virtualization-type - The virtualization type of the instance (paravirtual | hvm ). * vpc-id - The ID of the VPC that the instance is running in.
  • diiNextToken - The token to request the next page of results.
  • diiInstanceIds - One or more instance IDs. Default: Describes all your instances.
  • diiDryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .
  • diiMaxResults - The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter or tag filters in the same call.

data DescribeInstances Source #

Contains the parameters for DescribeInstances.

See: describeInstances smart constructor.

Instances

Eq DescribeInstances Source # 
Data DescribeInstances Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeInstances -> c DescribeInstances #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeInstances #

toConstr :: DescribeInstances -> Constr #

dataTypeOf :: DescribeInstances -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeInstances) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeInstances) #

gmapT :: (forall b. Data b => b -> b) -> DescribeInstances -> DescribeInstances #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeInstances -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeInstances -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeInstances -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeInstances -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeInstances -> m DescribeInstances #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeInstances -> m DescribeInstances #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeInstances -> m DescribeInstances #

Read DescribeInstances Source # 
Show DescribeInstances Source # 
Generic DescribeInstances Source # 
Hashable DescribeInstances Source # 
NFData DescribeInstances Source # 

Methods

rnf :: DescribeInstances -> () #

AWSPager DescribeInstances Source # 
AWSRequest DescribeInstances Source # 
ToQuery DescribeInstances Source # 
ToPath DescribeInstances Source # 
ToHeaders DescribeInstances Source # 
type Rep DescribeInstances Source # 
type Rep DescribeInstances = D1 (MetaData "DescribeInstances" "Network.AWS.EC2.DescribeInstances" "amazonka-ec2-1.5.0-8IdXK3SzsETDMW2aFpANS9" False) (C1 (MetaCons "DescribeInstances'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_diiFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Filter]))) (S1 (MetaSel (Just Symbol "_diiNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_diiInstanceIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) ((:*:) (S1 (MetaSel (Just Symbol "_diiDryRun") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_diiMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)))))))
type Rs DescribeInstances Source # 

Request Lenses

diiFilters :: Lens' DescribeInstances [Filter] Source #

One or more filters. * affinity - The affinity setting for an instance running on a Dedicated Host (default | host ). * architecture - The instance architecture (i386 | x86_64 ). * availability-zone - The Availability Zone of the instance. * block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z . * block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination. * block-device-mapping.device-name - The device name specified in the block device mapping (for example, devsdh or xvdh ). * block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached ). * block-device-mapping.volume-id - The volume ID of the EBS volume. * client-token - The idempotency token you provided when you launched the instance. * dns-name - The public DNS name of the instance. * group-id - The ID of the security group for the instance. EC2-Classic only. * group-name - The name of the security group for the instance. EC2-Classic only. * host-id - The ID of the Dedicated Host on which the instance is running, if applicable. * hypervisor - The hypervisor type of the instance (ovm | xen ). * iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN. * image-id - The ID of the image used to launch the instance. * instance-id - The ID of the instance. * instance-lifecycle - Indicates whether this is a Spot Instance or a Scheduled Instance (spot | scheduled ). * instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped). * instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped ). * instance-type - The type of instance (for example, t2.micro ). * instance.group-id - The ID of the security group for the instance. * instance.group-name - The name of the security group for the instance. * ip-address - The public IPv4 address of the instance. * kernel-id - The kernel ID. * key-name - The name of the key pair used when the instance was launched. * launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on). * launch-time - The time when the instance was launched. * monitoring-state - Indicates whether detailed monitoring is enabled (disabled | enabled ). * network-interface.addresses.private-ip-address - The private IPv4 address associated with the network interface. * network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address. * network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address (IPv4) with a network interface. * network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address associated with the network interface. * network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface. * network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface. * network-interface.association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface. * network-interface.association.association-id - The association ID returned when the network interface was associated with an IPv4 address. * network-interface.attachment.attachment-id - The ID of the interface attachment. * network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached. * network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached. * network-interface.attachment.device-index - The device index to which the network interface is attached. * network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached ). * network-interface.attachment.attach-time - The time that the network interface was attached to an instance. * network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated. * network-interface.availability-zone - The Availability Zone for the network interface. * network-interface.description - The description of the network interface. * network-interface.group-id - The ID of a security group associated with the network interface. * network-interface.group-name - The name of a security group associated with the network interface. * network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network interface. * network-interface.mac-address - The MAC address of the network interface. * network-interface.network-interface-id - The ID of the network interface. * network-interface.owner-id - The ID of the owner of the network interface. * network-interface.private-dns-name - The private DNS name of the network interface. * network-interface.requester-id - The requester ID for the network interface. * network-interface.requester-managed - Indicates whether the network interface is being managed by AWS. * network-interface.status - The status of the network interface (available ) | in-use ). * network-interface.source-dest-check - Whether the network interface performs sourcedestination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC. * network-interface.subnet-id - The ID of the subnet for the network interface. * network-interface.vpc-id - The ID of the VPC for the network interface. * owner-id - The AWS account ID of the instance owner. * placement-group-name - The name of the placement group for the instance. * platform - The platform. Use windows if you have Windows instances; otherwise, leave blank. * private-dns-name - The private IPv4 DNS name of the instance. * private-ip-address - The private IPv4 address of the instance. * product-code - The product code associated with the AMI used to launch the instance. * product-code.type - The type of product code (devpay | marketplace ). * ramdisk-id - The RAM disk ID. * reason - The reason for the current state of the instance (for example, shows "User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code filter. * requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on). * reservation-id - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID. * root-device-name - The device name of the root device volume (for example, @devsda1 ). * root-device-type - The type of the root device volume (ebs | instance-store ). * source-dest-check@ - Indicates whether the instance performs sourcedestination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC. * spot-instance-request-id - The ID of the Spot Instance request. * state-reason-code - The reason code for the state change. * state-reason-message - A message that describes the state change. * subnet-id - The ID of the subnet for the instance. * tag :key =value - The keyvalue combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value. * tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of the tag's key). If you want to list only resources where Purpose is X, see the tag :key =value/ filter. * tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter. * tenancy - The tenancy of an instance (dedicated | default | host ). * virtualization-type - The virtualization type of the instance (paravirtual | hvm ). * vpc-id - The ID of the VPC that the instance is running in.

diiNextToken :: Lens' DescribeInstances (Maybe Text) Source #

The token to request the next page of results.

diiInstanceIds :: Lens' DescribeInstances [Text] Source #

One or more instance IDs. Default: Describes all your instances.

diiDryRun :: Lens' DescribeInstances (Maybe Bool) Source #

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .

diiMaxResults :: Lens' DescribeInstances (Maybe Int) Source #

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter or tag filters in the same call.

Destructuring the Response

describeInstancesResponse Source #

Creates a value of DescribeInstancesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data DescribeInstancesResponse Source #

Contains the output of DescribeInstances.

See: describeInstancesResponse smart constructor.

Instances

Eq DescribeInstancesResponse Source # 
Data DescribeInstancesResponse Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeInstancesResponse -> c DescribeInstancesResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeInstancesResponse #

toConstr :: DescribeInstancesResponse -> Constr #

dataTypeOf :: DescribeInstancesResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeInstancesResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeInstancesResponse) #

gmapT :: (forall b. Data b => b -> b) -> DescribeInstancesResponse -> DescribeInstancesResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeInstancesResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeInstancesResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeInstancesResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeInstancesResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeInstancesResponse -> m DescribeInstancesResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeInstancesResponse -> m DescribeInstancesResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeInstancesResponse -> m DescribeInstancesResponse #

Read DescribeInstancesResponse Source # 
Show DescribeInstancesResponse Source # 
Generic DescribeInstancesResponse Source # 
NFData DescribeInstancesResponse Source # 
type Rep DescribeInstancesResponse Source # 
type Rep DescribeInstancesResponse = D1 (MetaData "DescribeInstancesResponse" "Network.AWS.EC2.DescribeInstances" "amazonka-ec2-1.5.0-8IdXK3SzsETDMW2aFpANS9" False) (C1 (MetaCons "DescribeInstancesResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dirsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_dirsReservations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Reservation]))) (S1 (MetaSel (Just Symbol "_dirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

dirsNextToken :: Lens' DescribeInstancesResponse (Maybe Text) Source #

The token to use to retrieve the next page of results. This value is null when there are no more results to return.