amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.GetSubnetCidrReservations

Description

Gets information about the subnet CIDR reservations.

Synopsis

Creating a Request

data GetSubnetCidrReservations Source #

See: newGetSubnetCidrReservations smart constructor.

Constructors

GetSubnetCidrReservations' 

Fields

  • dryRun :: 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.

  • filters :: Maybe [Filter]

    One or more filters.

    • reservationType - The type of reservation (prefix | explicit).
    • subnet-id - The ID of the subnet.
    • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
    • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
  • maxResults :: Maybe Natural

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

  • nextToken :: Maybe Text

    The token for the next page of results.

  • subnetId :: Text

    The ID of the subnet.

Instances

Instances details
ToHeaders GetSubnetCidrReservations Source # 
Instance details

Defined in Amazonka.EC2.GetSubnetCidrReservations

ToPath GetSubnetCidrReservations Source # 
Instance details

Defined in Amazonka.EC2.GetSubnetCidrReservations

ToQuery GetSubnetCidrReservations Source # 
Instance details

Defined in Amazonka.EC2.GetSubnetCidrReservations

AWSRequest GetSubnetCidrReservations Source # 
Instance details

Defined in Amazonka.EC2.GetSubnetCidrReservations

Generic GetSubnetCidrReservations Source # 
Instance details

Defined in Amazonka.EC2.GetSubnetCidrReservations

Associated Types

type Rep GetSubnetCidrReservations :: Type -> Type #

Read GetSubnetCidrReservations Source # 
Instance details

Defined in Amazonka.EC2.GetSubnetCidrReservations

Show GetSubnetCidrReservations Source # 
Instance details

Defined in Amazonka.EC2.GetSubnetCidrReservations

NFData GetSubnetCidrReservations Source # 
Instance details

Defined in Amazonka.EC2.GetSubnetCidrReservations

Eq GetSubnetCidrReservations Source # 
Instance details

Defined in Amazonka.EC2.GetSubnetCidrReservations

Hashable GetSubnetCidrReservations Source # 
Instance details

Defined in Amazonka.EC2.GetSubnetCidrReservations

type AWSResponse GetSubnetCidrReservations Source # 
Instance details

Defined in Amazonka.EC2.GetSubnetCidrReservations

type Rep GetSubnetCidrReservations Source # 
Instance details

Defined in Amazonka.EC2.GetSubnetCidrReservations

type Rep GetSubnetCidrReservations = D1 ('MetaData "GetSubnetCidrReservations" "Amazonka.EC2.GetSubnetCidrReservations" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "GetSubnetCidrReservations'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "subnetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newGetSubnetCidrReservations Source #

Create a value of GetSubnetCidrReservations with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dryRun:GetSubnetCidrReservations', getSubnetCidrReservations_dryRun - 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.

$sel:filters:GetSubnetCidrReservations', getSubnetCidrReservations_filters - One or more filters.

  • reservationType - The type of reservation (prefix | explicit).
  • subnet-id - The ID of the subnet.
  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

$sel:maxResults:GetSubnetCidrReservations', getSubnetCidrReservations_maxResults - The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

GetSubnetCidrReservations, getSubnetCidrReservations_nextToken - The token for the next page of results.

GetSubnetCidrReservations, getSubnetCidrReservations_subnetId - The ID of the subnet.

Request Lenses

getSubnetCidrReservations_dryRun :: Lens' GetSubnetCidrReservations (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.

getSubnetCidrReservations_filters :: Lens' GetSubnetCidrReservations (Maybe [Filter]) Source #

One or more filters.

  • reservationType - The type of reservation (prefix | explicit).
  • subnet-id - The ID of the subnet.
  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

getSubnetCidrReservations_maxResults :: Lens' GetSubnetCidrReservations (Maybe Natural) Source #

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Destructuring the Response

data GetSubnetCidrReservationsResponse Source #

See: newGetSubnetCidrReservationsResponse smart constructor.

Constructors

GetSubnetCidrReservationsResponse' 

Fields

Instances

Instances details
Generic GetSubnetCidrReservationsResponse Source # 
Instance details

Defined in Amazonka.EC2.GetSubnetCidrReservations

Associated Types

type Rep GetSubnetCidrReservationsResponse :: Type -> Type #

Read GetSubnetCidrReservationsResponse Source # 
Instance details

Defined in Amazonka.EC2.GetSubnetCidrReservations

Show GetSubnetCidrReservationsResponse Source # 
Instance details

Defined in Amazonka.EC2.GetSubnetCidrReservations

NFData GetSubnetCidrReservationsResponse Source # 
Instance details

Defined in Amazonka.EC2.GetSubnetCidrReservations

Eq GetSubnetCidrReservationsResponse Source # 
Instance details

Defined in Amazonka.EC2.GetSubnetCidrReservations

type Rep GetSubnetCidrReservationsResponse Source # 
Instance details

Defined in Amazonka.EC2.GetSubnetCidrReservations

type Rep GetSubnetCidrReservationsResponse = D1 ('MetaData "GetSubnetCidrReservationsResponse" "Amazonka.EC2.GetSubnetCidrReservations" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "GetSubnetCidrReservationsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "subnetIpv4CidrReservations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SubnetCidrReservation]))) :*: (S1 ('MetaSel ('Just "subnetIpv6CidrReservations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SubnetCidrReservation])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetSubnetCidrReservationsResponse Source #

Create a value of GetSubnetCidrReservationsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

$sel:subnetIpv4CidrReservations:GetSubnetCidrReservationsResponse', getSubnetCidrReservationsResponse_subnetIpv4CidrReservations - Information about the IPv4 subnet CIDR reservations.

$sel:subnetIpv6CidrReservations:GetSubnetCidrReservationsResponse', getSubnetCidrReservationsResponse_subnetIpv6CidrReservations - Information about the IPv6 subnet CIDR reservations.

$sel:httpStatus:GetSubnetCidrReservationsResponse', getSubnetCidrReservationsResponse_httpStatus - The response's http status code.

Response Lenses

getSubnetCidrReservationsResponse_nextToken :: Lens' GetSubnetCidrReservationsResponse (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.