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

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

Network.AWS.EC2.DescribeSubnets

Contents

Description

Describes one or more of your subnets.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide .

Synopsis

Creating a Request

describeSubnets :: DescribeSubnets #

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

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

  • dsSubnetIds - One or more subnet IDs. Default: Describes all your subnets.
  • dsFilters - One or more filters. * availabilityZone - The Availability Zone for the subnet. You can also use availability-zone as the filter name. * available-ip-address-count - The number of IPv4 addresses in the subnet that are available. * cidrBlock - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use cidr or cidr-block as the filter names. * defaultForAz - Indicates whether this is the default subnet for the Availability Zone. You can also use default-for-az as the filter name. * ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet. * ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated with the subnet. * ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet. * state - The state of the subnet (pending | available ). * subnet-id - The ID of the subnet. * tag :key =value - The keyvalue combination of a tag assigned to the resource. * 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 what the tag's key is). 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. * vpc-id - The ID of the VPC for the subnet.
  • dsDryRun - 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 .

data DescribeSubnets #

Contains the parameters for DescribeSubnets.

See: describeSubnets smart constructor.

Instances

Eq DescribeSubnets # 
Data DescribeSubnets # 

Methods

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

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

toConstr :: DescribeSubnets -> Constr #

dataTypeOf :: DescribeSubnets -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DescribeSubnets # 
Show DescribeSubnets # 
Generic DescribeSubnets # 
Hashable DescribeSubnets # 
NFData DescribeSubnets # 

Methods

rnf :: DescribeSubnets -> () #

AWSRequest DescribeSubnets # 
ToQuery DescribeSubnets # 
ToPath DescribeSubnets # 
ToHeaders DescribeSubnets # 
type Rep DescribeSubnets # 
type Rep DescribeSubnets = D1 (MetaData "DescribeSubnets" "Network.AWS.EC2.DescribeSubnets" "amazonka-ec2-1.4.5-C4CR35JggG2GhWFrIiKGhu" False) (C1 (MetaCons "DescribeSubnets'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dsSubnetIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) ((:*:) (S1 (MetaSel (Just Symbol "_dsFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Filter]))) (S1 (MetaSel (Just Symbol "_dsDryRun") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))))))
type Rs DescribeSubnets # 

Request Lenses

dsSubnetIds :: Lens' DescribeSubnets [Text] #

One or more subnet IDs. Default: Describes all your subnets.

dsFilters :: Lens' DescribeSubnets [Filter] #

One or more filters. * availabilityZone - The Availability Zone for the subnet. You can also use availability-zone as the filter name. * available-ip-address-count - The number of IPv4 addresses in the subnet that are available. * cidrBlock - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use cidr or cidr-block as the filter names. * defaultForAz - Indicates whether this is the default subnet for the Availability Zone. You can also use default-for-az as the filter name. * ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet. * ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated with the subnet. * ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet. * state - The state of the subnet (pending | available ). * subnet-id - The ID of the subnet. * tag :key =value - The keyvalue combination of a tag assigned to the resource. * 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 what the tag's key is). 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. * vpc-id - The ID of the VPC for the subnet.

dsDryRun :: Lens' DescribeSubnets (Maybe Bool) #

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 .

Destructuring the Response

describeSubnetsResponse #

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

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

data DescribeSubnetsResponse #

Contains the output of DescribeSubnets.

See: describeSubnetsResponse smart constructor.

Instances

Eq DescribeSubnetsResponse # 
Data DescribeSubnetsResponse # 

Methods

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

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

toConstr :: DescribeSubnetsResponse -> Constr #

dataTypeOf :: DescribeSubnetsResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DescribeSubnetsResponse # 
Show DescribeSubnetsResponse # 
Generic DescribeSubnetsResponse # 
NFData DescribeSubnetsResponse # 

Methods

rnf :: DescribeSubnetsResponse -> () #

type Rep DescribeSubnetsResponse # 
type Rep DescribeSubnetsResponse = D1 (MetaData "DescribeSubnetsResponse" "Network.AWS.EC2.DescribeSubnets" "amazonka-ec2-1.4.5-C4CR35JggG2GhWFrIiKGhu" False) (C1 (MetaCons "DescribeSubnetsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dsrsSubnets") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Subnet]))) (S1 (MetaSel (Just Symbol "_dsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

dsrsSubnets :: Lens' DescribeSubnetsResponse [Subnet] #

Information about one or more subnets.

dsrsResponseStatus :: Lens' DescribeSubnetsResponse Int #

  • - | The response status code.