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

Description

Describes the specified local gateway virtual interface groups.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeLocalGatewayVirtualInterfaceGroups Source #

Constructors

DescribeLocalGatewayVirtualInterfaceGroups' 

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.

    • local-gateway-id - The ID of a local gateway.
    • local-gateway-virtual-interface-group-id - The ID of the virtual interface group.
    • local-gateway-virtual-interface-id - The ID of the virtual interface.
    • owner-id - The ID of the Amazon Web Services account that owns the local gateway virtual interface group.
  • localGatewayVirtualInterfaceGroupIds :: Maybe [Text]

    The IDs of the virtual interface groups.

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

Instances

Instances details
ToHeaders DescribeLocalGatewayVirtualInterfaceGroups Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaceGroups

ToPath DescribeLocalGatewayVirtualInterfaceGroups Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaceGroups

ToQuery DescribeLocalGatewayVirtualInterfaceGroups Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaceGroups

AWSPager DescribeLocalGatewayVirtualInterfaceGroups Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaceGroups

AWSRequest DescribeLocalGatewayVirtualInterfaceGroups Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaceGroups

Generic DescribeLocalGatewayVirtualInterfaceGroups Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaceGroups

Read DescribeLocalGatewayVirtualInterfaceGroups Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaceGroups

Show DescribeLocalGatewayVirtualInterfaceGroups Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaceGroups

NFData DescribeLocalGatewayVirtualInterfaceGroups Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaceGroups

Eq DescribeLocalGatewayVirtualInterfaceGroups Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaceGroups

Hashable DescribeLocalGatewayVirtualInterfaceGroups Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaceGroups

type AWSResponse DescribeLocalGatewayVirtualInterfaceGroups Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaceGroups

type Rep DescribeLocalGatewayVirtualInterfaceGroups Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaceGroups

type Rep DescribeLocalGatewayVirtualInterfaceGroups = D1 ('MetaData "DescribeLocalGatewayVirtualInterfaceGroups" "Amazonka.EC2.DescribeLocalGatewayVirtualInterfaceGroups" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeLocalGatewayVirtualInterfaceGroups'" '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 "localGatewayVirtualInterfaceGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDescribeLocalGatewayVirtualInterfaceGroups :: DescribeLocalGatewayVirtualInterfaceGroups Source #

Create a value of DescribeLocalGatewayVirtualInterfaceGroups 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:DescribeLocalGatewayVirtualInterfaceGroups', describeLocalGatewayVirtualInterfaceGroups_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:DescribeLocalGatewayVirtualInterfaceGroups', describeLocalGatewayVirtualInterfaceGroups_filters - One or more filters.

  • local-gateway-id - The ID of a local gateway.
  • local-gateway-virtual-interface-group-id - The ID of the virtual interface group.
  • local-gateway-virtual-interface-id - The ID of the virtual interface.
  • owner-id - The ID of the Amazon Web Services account that owns the local gateway virtual interface group.

$sel:localGatewayVirtualInterfaceGroupIds:DescribeLocalGatewayVirtualInterfaceGroups', describeLocalGatewayVirtualInterfaceGroups_localGatewayVirtualInterfaceGroupIds - The IDs of the virtual interface groups.

$sel:maxResults:DescribeLocalGatewayVirtualInterfaceGroups', describeLocalGatewayVirtualInterfaceGroups_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.

DescribeLocalGatewayVirtualInterfaceGroups, describeLocalGatewayVirtualInterfaceGroups_nextToken - The token for the next page of results.

Request Lenses

describeLocalGatewayVirtualInterfaceGroups_dryRun :: Lens' DescribeLocalGatewayVirtualInterfaceGroups (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.

describeLocalGatewayVirtualInterfaceGroups_filters :: Lens' DescribeLocalGatewayVirtualInterfaceGroups (Maybe [Filter]) Source #

One or more filters.

  • local-gateway-id - The ID of a local gateway.
  • local-gateway-virtual-interface-group-id - The ID of the virtual interface group.
  • local-gateway-virtual-interface-id - The ID of the virtual interface.
  • owner-id - The ID of the Amazon Web Services account that owns the local gateway virtual interface group.

describeLocalGatewayVirtualInterfaceGroups_maxResults :: Lens' DescribeLocalGatewayVirtualInterfaceGroups (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 DescribeLocalGatewayVirtualInterfaceGroupsResponse Source #

Constructors

DescribeLocalGatewayVirtualInterfaceGroupsResponse' 

Fields

Instances

Instances details
Generic DescribeLocalGatewayVirtualInterfaceGroupsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaceGroups

Read DescribeLocalGatewayVirtualInterfaceGroupsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaceGroups

Show DescribeLocalGatewayVirtualInterfaceGroupsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaceGroups

NFData DescribeLocalGatewayVirtualInterfaceGroupsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaceGroups

Eq DescribeLocalGatewayVirtualInterfaceGroupsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaceGroups

type Rep DescribeLocalGatewayVirtualInterfaceGroupsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeLocalGatewayVirtualInterfaceGroups

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

Response Lenses

describeLocalGatewayVirtualInterfaceGroupsResponse_nextToken :: Lens' DescribeLocalGatewayVirtualInterfaceGroupsResponse (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.