Amazonka.StorageGateway.ListGateways

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.

Creating a Request

data ListGateways

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

• ListGatewaysInput$Limit
• ListGatewaysInput$Marker

See: newListGateways smart constructor.

Constructors

ListGateways'

Fields

• limit :: Maybe Natural

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

• marker :: Maybe Text

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

Instances

ToJSON ListGateways

Defined in Amazonka.StorageGateway.ListGateways

Methods

toJSON :: ListGateways -> Value

toEncoding :: ListGateways -> Encoding

toJSONList :: [ListGateways] -> Value

toEncodingList :: [ListGateways] -> Encoding

ToHeaders ListGateways

Defined in Amazonka.StorageGateway.ListGateways

Methods

toHeaders :: ListGateways -> [Header]

ToPath ListGateways

Defined in Amazonka.StorageGateway.ListGateways

Methods

toPath :: ListGateways -> ByteString

ToQuery ListGateways

Defined in Amazonka.StorageGateway.ListGateways

Methods

toQuery :: ListGateways -> QueryString

AWSPager ListGateways

Defined in Amazonka.StorageGateway.ListGateways

Methods

page :: ListGateways -> AWSResponse ListGateways -> Maybe ListGateways

AWSRequest ListGateways

Defined in Amazonka.StorageGateway.ListGateways

Associated Types

type AWSResponse ListGateways

Methods

request :: (Service -> Service) -> ListGateways -> Request ListGateways

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListGateways -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListGateways)))

Generic ListGateways

Defined in Amazonka.StorageGateway.ListGateways

Associated Types

type Rep ListGateways :: Type -> Type

Methods

from :: ListGateways -> Rep ListGateways x

to :: Rep ListGateways x -> ListGateways

Read ListGateways

Defined in Amazonka.StorageGateway.ListGateways

Methods

readsPrec :: Int -> ReadS ListGateways

readList :: ReadS [ListGateways]

readPrec :: ReadPrec ListGateways

readListPrec :: ReadPrec [ListGateways]

Show ListGateways

Defined in Amazonka.StorageGateway.ListGateways

Methods

showsPrec :: Int -> ListGateways -> ShowS

show :: ListGateways -> String

showList :: [ListGateways] -> ShowS

NFData ListGateways

Defined in Amazonka.StorageGateway.ListGateways

Methods

rnf :: ListGateways -> ()

Eq ListGateways

Defined in Amazonka.StorageGateway.ListGateways

Methods

(==) :: ListGateways -> ListGateways -> Bool

(/=) :: ListGateways -> ListGateways -> Bool

Hashable ListGateways

Defined in Amazonka.StorageGateway.ListGateways

Methods

hashWithSalt :: Int -> ListGateways -> Int

hash :: ListGateways -> Int

type AWSResponse ListGateways

Defined in Amazonka.StorageGateway.ListGateways

type AWSResponse ListGateways = ListGatewaysResponse

type Rep ListGateways

Defined in Amazonka.StorageGateway.ListGateways

type Rep ListGateways = D1 ('MetaData "ListGateways" "Amazonka.StorageGateway.ListGateways" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "ListGateways'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListGateways :: ListGateways

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:limit:ListGateways', listGateways_limit - Specifies that the list of gateways returned be limited to the specified number of items.

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

Request Lenses

listGateways_limit :: Lens' ListGateways (Maybe Natural)

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

listGateways_marker :: Lens' ListGateways (Maybe Text)

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

Destructuring the Response

data ListGatewaysResponse

See: newListGatewaysResponse smart constructor.

Constructors

ListGatewaysResponse'

Fields

• gateways :: Maybe [GatewayInfo]

  An array of GatewayInfo objects.

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListGatewaysResponse

Defined in Amazonka.StorageGateway.ListGateways

Associated Types

type Rep ListGatewaysResponse :: Type -> Type

Methods

from :: ListGatewaysResponse -> Rep ListGatewaysResponse x

to :: Rep ListGatewaysResponse x -> ListGatewaysResponse

Read ListGatewaysResponse

Defined in Amazonka.StorageGateway.ListGateways

Methods

readsPrec :: Int -> ReadS ListGatewaysResponse

readList :: ReadS [ListGatewaysResponse]

readPrec :: ReadPrec ListGatewaysResponse

readListPrec :: ReadPrec [ListGatewaysResponse]

Show ListGatewaysResponse

Defined in Amazonka.StorageGateway.ListGateways

Methods

showsPrec :: Int -> ListGatewaysResponse -> ShowS

show :: ListGatewaysResponse -> String

showList :: [ListGatewaysResponse] -> ShowS

NFData ListGatewaysResponse

Defined in Amazonka.StorageGateway.ListGateways

Methods

rnf :: ListGatewaysResponse -> ()

Eq ListGatewaysResponse

Defined in Amazonka.StorageGateway.ListGateways

Methods

(==) :: ListGatewaysResponse -> ListGatewaysResponse -> Bool

(/=) :: ListGatewaysResponse -> ListGatewaysResponse -> Bool

type Rep ListGatewaysResponse

Defined in Amazonka.StorageGateway.ListGateways

type Rep ListGatewaysResponse = D1 ('MetaData "ListGatewaysResponse" "Amazonka.StorageGateway.ListGateways" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "ListGatewaysResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gateways") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GatewayInfo])) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListGatewaysResponse

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:gateways:ListGatewaysResponse', listGatewaysResponse_gateways - An array of GatewayInfo objects.

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:httpStatus:ListGatewaysResponse', listGatewaysResponse_httpStatus - The response's http status code.

Response Lenses

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

An array of GatewayInfo objects.

listGatewaysResponse_marker :: Lens' ListGatewaysResponse (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.

listGatewaysResponse_httpStatus :: Lens' ListGatewaysResponse Int

The response's http status code.