Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.EC2.DescribeLocalGateways

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes one or more local gateways. By default, all local gateways are described. Alternatively, you can filter the results.

This operation returns paginated results.

Synopsis

data DescribeLocalGateways = DescribeLocalGateways' {
- dryRun :: Maybe Bool
- filters :: Maybe [Filter]
- localGatewayIds :: Maybe [Text]
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
}
newDescribeLocalGateways :: DescribeLocalGateways
describeLocalGateways_dryRun :: Lens' DescribeLocalGateways (Maybe Bool)
describeLocalGateways_filters :: Lens' DescribeLocalGateways (Maybe [Filter])
describeLocalGateways_localGatewayIds :: Lens' DescribeLocalGateways (Maybe [Text])
describeLocalGateways_maxResults :: Lens' DescribeLocalGateways (Maybe Natural)
describeLocalGateways_nextToken :: Lens' DescribeLocalGateways (Maybe Text)
data DescribeLocalGatewaysResponse = DescribeLocalGatewaysResponse' {
- localGateways :: Maybe [LocalGateway]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newDescribeLocalGatewaysResponse :: Int -> DescribeLocalGatewaysResponse
describeLocalGatewaysResponse_localGateways :: Lens' DescribeLocalGatewaysResponse (Maybe [LocalGateway])
describeLocalGatewaysResponse_nextToken :: Lens' DescribeLocalGatewaysResponse (Maybe Text)
describeLocalGatewaysResponse_httpStatus :: Lens' DescribeLocalGatewaysResponse Int

Creating a Request

data DescribeLocalGateways Source #

See: newDescribeLocalGateways smart constructor.

Constructors

DescribeLocalGateways'

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.
- outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
- owner-id - The ID of the Amazon Web Services account that owns the local gateway.
- state - The state of the association.
localGatewayIds :: Maybe [Text]
The IDs of the local gateways.
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 DescribeLocalGateways Source #
Instance details Defined in Amazonka.EC2.DescribeLocalGateways Methods toHeaders :: DescribeLocalGateways -> [Header] #
ToPath DescribeLocalGateways Source #
Instance details Defined in Amazonka.EC2.DescribeLocalGateways Methods toPath :: DescribeLocalGateways -> ByteString #
ToQuery DescribeLocalGateways Source #
Instance details Defined in Amazonka.EC2.DescribeLocalGateways Methods toQuery :: DescribeLocalGateways -> QueryString #
AWSPager DescribeLocalGateways Source #
Instance details Defined in Amazonka.EC2.DescribeLocalGateways Methods page :: DescribeLocalGateways -> AWSResponse DescribeLocalGateways -> Maybe DescribeLocalGateways #
AWSRequest DescribeLocalGateways Source #
Instance details Defined in Amazonka.EC2.DescribeLocalGateways Associated Types type AWSResponse DescribeLocalGateways # Methods request :: (Service -> Service) -> DescribeLocalGateways -> Request DescribeLocalGateways # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeLocalGateways -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeLocalGateways))) #
Generic DescribeLocalGateways Source #
Instance details Defined in Amazonka.EC2.DescribeLocalGateways Associated Types type Rep DescribeLocalGateways :: Type -> Type # Methods from :: DescribeLocalGateways -> Rep DescribeLocalGateways x # to :: Rep DescribeLocalGateways x -> DescribeLocalGateways #
Read DescribeLocalGateways Source #
Instance details Defined in Amazonka.EC2.DescribeLocalGateways Methods readsPrec :: Int -> ReadS DescribeLocalGateways # readList :: ReadS [DescribeLocalGateways] # readPrec :: ReadPrec DescribeLocalGateways # readListPrec :: ReadPrec [DescribeLocalGateways] #
Show DescribeLocalGateways Source #
Instance details Defined in Amazonka.EC2.DescribeLocalGateways Methods showsPrec :: Int -> DescribeLocalGateways -> ShowS # show :: DescribeLocalGateways -> String # showList :: [DescribeLocalGateways] -> ShowS #
NFData DescribeLocalGateways Source #
Instance details Defined in Amazonka.EC2.DescribeLocalGateways Methods rnf :: DescribeLocalGateways -> () #
Eq DescribeLocalGateways Source #
Instance details Defined in Amazonka.EC2.DescribeLocalGateways Methods (==) :: DescribeLocalGateways -> DescribeLocalGateways -> Bool # (/=) :: DescribeLocalGateways -> DescribeLocalGateways -> Bool #
Hashable DescribeLocalGateways Source #
Instance details Defined in Amazonka.EC2.DescribeLocalGateways Methods hashWithSalt :: Int -> DescribeLocalGateways -> Int # hash :: DescribeLocalGateways -> Int #
type AWSResponse DescribeLocalGateways Source #
Instance details Defined in Amazonka.EC2.DescribeLocalGateways type AWSResponse DescribeLocalGateways = DescribeLocalGatewaysResponse
type Rep DescribeLocalGateways Source #
Instance details Defined in Amazonka.EC2.DescribeLocalGateways type Rep DescribeLocalGateways = D1 ('MetaData "DescribeLocalGateways" "Amazonka.EC2.DescribeLocalGateways" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeLocalGateways'" '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 "localGatewayIds") '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))))))

newDescribeLocalGateways :: DescribeLocalGateways Source #

Create a value of DescribeLocalGateways 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:DescribeLocalGateways', describeLocalGateways_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:DescribeLocalGateways', describeLocalGateways_filters - One or more filters.

local-gateway-id - The ID of a local gateway.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The ID of the Amazon Web Services account that owns the local gateway.
state - The state of the association.

$sel:localGatewayIds:DescribeLocalGateways', describeLocalGateways_localGatewayIds - The IDs of the local gateways.

$sel:maxResults:DescribeLocalGateways', describeLocalGateways_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.

DescribeLocalGateways, describeLocalGateways_nextToken - The token for the next page of results.

Request Lenses

describeLocalGateways_dryRun :: Lens' DescribeLocalGateways (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.

describeLocalGateways_filters :: Lens' DescribeLocalGateways (Maybe [Filter]) Source #

One or more filters.

local-gateway-id - The ID of a local gateway.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The ID of the Amazon Web Services account that owns the local gateway.
state - The state of the association.

describeLocalGateways_localGatewayIds :: Lens' DescribeLocalGateways (Maybe [Text]) Source #

The IDs of the local gateways.

describeLocalGateways_maxResults :: Lens' DescribeLocalGateways (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.

describeLocalGateways_nextToken :: Lens' DescribeLocalGateways (Maybe Text) Source #

The token for the next page of results.

Destructuring the Response

data DescribeLocalGatewaysResponse Source #

See: newDescribeLocalGatewaysResponse smart constructor.

Constructors

DescribeLocalGatewaysResponse'
Fields localGateways :: Maybe [LocalGateway] Information about the local gateways. nextToken :: Maybe Text The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeLocalGatewaysResponse Source #
Instance details Defined in Amazonka.EC2.DescribeLocalGateways Associated Types type Rep DescribeLocalGatewaysResponse :: Type -> Type # Methods from :: DescribeLocalGatewaysResponse -> Rep DescribeLocalGatewaysResponse x # to :: Rep DescribeLocalGatewaysResponse x -> DescribeLocalGatewaysResponse #
Read DescribeLocalGatewaysResponse Source #
Instance details Defined in Amazonka.EC2.DescribeLocalGateways Methods readsPrec :: Int -> ReadS DescribeLocalGatewaysResponse # readList :: ReadS [DescribeLocalGatewaysResponse] # readPrec :: ReadPrec DescribeLocalGatewaysResponse # readListPrec :: ReadPrec [DescribeLocalGatewaysResponse] #
Show DescribeLocalGatewaysResponse Source #
Instance details Defined in Amazonka.EC2.DescribeLocalGateways Methods showsPrec :: Int -> DescribeLocalGatewaysResponse -> ShowS # show :: DescribeLocalGatewaysResponse -> String # showList :: [DescribeLocalGatewaysResponse] -> ShowS #
NFData DescribeLocalGatewaysResponse Source #
Instance details Defined in Amazonka.EC2.DescribeLocalGateways Methods rnf :: DescribeLocalGatewaysResponse -> () #
Eq DescribeLocalGatewaysResponse Source #
Instance details Defined in Amazonka.EC2.DescribeLocalGateways Methods (==) :: DescribeLocalGatewaysResponse -> DescribeLocalGatewaysResponse -> Bool # (/=) :: DescribeLocalGatewaysResponse -> DescribeLocalGatewaysResponse -> Bool #
type Rep DescribeLocalGatewaysResponse Source #
Instance details Defined in Amazonka.EC2.DescribeLocalGateways type Rep DescribeLocalGatewaysResponse = D1 ('MetaData "DescribeLocalGatewaysResponse" "Amazonka.EC2.DescribeLocalGateways" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeLocalGatewaysResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "localGateways") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LocalGateway])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeLocalGatewaysResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeLocalGatewaysResponse'`
-> DescribeLocalGatewaysResponse

Create a value of DescribeLocalGatewaysResponse 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:localGateways:DescribeLocalGatewaysResponse', describeLocalGatewaysResponse_localGateways - Information about the local gateways.

DescribeLocalGateways, describeLocalGatewaysResponse_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:httpStatus:DescribeLocalGatewaysResponse', describeLocalGatewaysResponse_httpStatus - The response's http status code.

Response Lenses

describeLocalGatewaysResponse_localGateways :: Lens' DescribeLocalGatewaysResponse (Maybe [LocalGateway]) Source #

Information about the local gateways.

describeLocalGatewaysResponse_nextToken :: Lens' DescribeLocalGatewaysResponse (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.

describeLocalGatewaysResponse_httpStatus :: Lens' DescribeLocalGatewaysResponse Int Source #

The response's http status code.