Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.StorageGateway.ListGateways

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists gateways owned by an Amazon Web Services account in an Amazon Web Services Region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN).

By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response.

If you have more gateways than are returned in a response (that is, the response returns only a truncated list of your gateways), the response contains a marker that you can specify in your next request to fetch the next page of gateways.

This operation returns paginated results.

Synopsis

Creating a Request

data ListGateways Source #

A JSON object containing zero or more of the following fields:

ListGatewaysInput$Limit
ListGatewaysInput$Marker

See: newListGateways smart constructor.

Constructors

ListGateways'
Fields marker :: Maybe Text An opaque string that indicates the position at which to begin the returned list of gateways. limit :: Maybe Natural Specifies that the list of gateways returned be limited to the specified number of items.

Instances

Instances details

Eq ListGateways Source #
Instance details Defined in Amazonka.StorageGateway.ListGateways Methods (==) :: ListGateways -> ListGateways -> Bool # (/=) :: ListGateways -> ListGateways -> Bool #
Read ListGateways Source #
Instance details Defined in Amazonka.StorageGateway.ListGateways Methods readsPrec :: Int -> ReadS ListGateways # readList :: ReadS [ListGateways] # readPrec :: ReadPrec ListGateways # readListPrec :: ReadPrec [ListGateways] #
Show ListGateways Source #
Instance details Defined in Amazonka.StorageGateway.ListGateways Methods showsPrec :: Int -> ListGateways -> ShowS # show :: ListGateways -> String # showList :: [ListGateways] -> ShowS #
Generic ListGateways Source #
Instance details Defined in Amazonka.StorageGateway.ListGateways Associated Types type Rep ListGateways :: Type -> Type # Methods from :: ListGateways -> Rep ListGateways x # to :: Rep ListGateways x -> ListGateways #
NFData ListGateways Source #
Instance details Defined in Amazonka.StorageGateway.ListGateways Methods rnf :: ListGateways -> () #
Hashable ListGateways Source #
Instance details Defined in Amazonka.StorageGateway.ListGateways Methods hashWithSalt :: Int -> ListGateways -> Int # hash :: ListGateways -> Int #
ToJSON ListGateways Source #
Instance details Defined in Amazonka.StorageGateway.ListGateways Methods toJSON :: ListGateways -> Value # toEncoding :: ListGateways -> Encoding # toJSONList :: [ListGateways] -> Value # toEncodingList :: [ListGateways] -> Encoding #
AWSPager ListGateways Source #
Instance details Defined in Amazonka.StorageGateway.ListGateways Methods page :: ListGateways -> AWSResponse ListGateways -> Maybe ListGateways #
AWSRequest ListGateways Source #
Instance details Defined in Amazonka.StorageGateway.ListGateways Associated Types type AWSResponse ListGateways # Methods request :: ListGateways -> Request ListGateways # response :: MonadResource m => Logger -> Service -> Proxy ListGateways -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListGateways))) #
ToHeaders ListGateways Source #
Instance details Defined in Amazonka.StorageGateway.ListGateways Methods toHeaders :: ListGateways -> [Header] #
ToPath ListGateways Source #
Instance details Defined in Amazonka.StorageGateway.ListGateways Methods toPath :: ListGateways -> ByteString #
ToQuery ListGateways Source #
Instance details Defined in Amazonka.StorageGateway.ListGateways Methods toQuery :: ListGateways -> QueryString #
type Rep ListGateways Source #
Instance details Defined in Amazonka.StorageGateway.ListGateways type Rep ListGateways = D1 ('MetaData "ListGateways" "Amazonka.StorageGateway.ListGateways" "libZSservicesZSamazonka-storagegatewayZSamazonka-storagegateway" 'False) (C1 ('MetaCons "ListGateways'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))
type AWSResponse ListGateways Source #
Instance details Defined in Amazonka.StorageGateway.ListGateways type AWSResponse ListGateways = ListGatewaysResponse

newListGateways :: ListGateways Source #

Create a value of ListGateways 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:marker:ListGateways', listGateways_marker - An opaque string that indicates the position at which to begin the returned list of gateways.

$sel:limit:ListGateways', listGateways_limit - Specifies that the list of gateways returned be limited to the specified number of items.

Request Lenses

listGateways_marker :: Lens' ListGateways (Maybe Text) Source #

An opaque string that indicates the position at which to begin the returned list of gateways.

listGateways_limit :: Lens' ListGateways (Maybe Natural) Source #

Specifies that the list of gateways returned be limited to the specified number of items.

Destructuring the Response

data ListGatewaysResponse Source #

See: newListGatewaysResponse smart constructor.

Constructors

ListGatewaysResponse'
Fields marker :: Maybe Text Use the marker in your next request to fetch the next set of gateways in the list. If there are no more gateways to list, this field does not appear in the response. gateways :: Maybe [GatewayInfo] An array of GatewayInfo objects. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ListGatewaysResponse Source #
Instance details Defined in Amazonka.StorageGateway.ListGateways Methods (==) :: ListGatewaysResponse -> ListGatewaysResponse -> Bool # (/=) :: ListGatewaysResponse -> ListGatewaysResponse -> Bool #
Read ListGatewaysResponse Source #
Instance details Defined in Amazonka.StorageGateway.ListGateways Methods readsPrec :: Int -> ReadS ListGatewaysResponse # readList :: ReadS [ListGatewaysResponse] # readPrec :: ReadPrec ListGatewaysResponse # readListPrec :: ReadPrec [ListGatewaysResponse] #
Show ListGatewaysResponse Source #
Instance details Defined in Amazonka.StorageGateway.ListGateways Methods showsPrec :: Int -> ListGatewaysResponse -> ShowS # show :: ListGatewaysResponse -> String # showList :: [ListGatewaysResponse] -> ShowS #
Generic ListGatewaysResponse Source #
Instance details Defined in Amazonka.StorageGateway.ListGateways Associated Types type Rep ListGatewaysResponse :: Type -> Type # Methods from :: ListGatewaysResponse -> Rep ListGatewaysResponse x # to :: Rep ListGatewaysResponse x -> ListGatewaysResponse #
NFData ListGatewaysResponse Source #
Instance details Defined in Amazonka.StorageGateway.ListGateways Methods rnf :: ListGatewaysResponse -> () #
type Rep ListGatewaysResponse Source #
Instance details Defined in Amazonka.StorageGateway.ListGateways type Rep ListGatewaysResponse = D1 ('MetaData "ListGatewaysResponse" "Amazonka.StorageGateway.ListGateways" "libZSservicesZSamazonka-storagegatewayZSamazonka-storagegateway" 'False) (C1 ('MetaCons "ListGatewaysResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "gateways") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GatewayInfo])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListGatewaysResponse Source #

Arguments

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

Create a value of ListGatewaysResponse 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:marker:ListGateways', listGatewaysResponse_marker - Use the marker in your next request to fetch the next set of gateways in the list. If there are no more gateways to list, this field does not appear in the response.

$sel:gateways:ListGatewaysResponse', listGatewaysResponse_gateways - An array of GatewayInfo objects.

$sel:httpStatus:ListGatewaysResponse', listGatewaysResponse_httpStatus - The response's http status code.

Response Lenses

listGatewaysResponse_marker :: Lens' ListGatewaysResponse (Maybe Text) Source #

Use the marker in your next request to fetch the next set of gateways in the list. If there are no more gateways to list, this field does not appear in the response.

listGatewaysResponse_gateways :: Lens' ListGatewaysResponse (Maybe [GatewayInfo]) Source #

An array of GatewayInfo objects.

listGatewaysResponse_httpStatus :: Lens' ListGatewaysResponse Int Source #

The response's http status code.