Network.AWS.StorageGateway.ListFileShares

Gets a list of the file shares for a specific file gateway, or the list of file shares that belong to the calling user account. This operation is only supported in the file gateway type.

Creating a Request

listFileShares :: ListFileShares

Creates a value of ListFileShares with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lfsGatewayARN - The Amazon resource Name (ARN) of the gateway whose file shares you want to list. If this field is not present, all file shares under your account are listed.
• lfsMarker - Opaque pagination token returned from a previous ListFileShares operation. If present, Marker specifies where to continue the list from after a previous call to ListFileShares. Optional.
• lfsLimit - The maximum number of file shares to return in the response. The value must be an integer with a value greater than zero. Optional.

data ListFileShares

ListFileShareInput

See: listFileShares smart constructor.

Instances

Eq ListFileShares

Defined in Network.AWS.StorageGateway.ListFileShares

Methods

(==) :: ListFileShares -> ListFileShares -> Bool

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

Data ListFileShares

Defined in Network.AWS.StorageGateway.ListFileShares

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListFileShares -> c ListFileShares

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListFileShares

toConstr :: ListFileShares -> Constr

dataTypeOf :: ListFileShares -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListFileShares)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListFileShares)

gmapT :: (forall b. Data b => b -> b) -> ListFileShares -> ListFileShares

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListFileShares -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListFileShares -> r

gmapQ :: (forall d. Data d => d -> u) -> ListFileShares -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListFileShares -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListFileShares -> m ListFileShares

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListFileShares -> m ListFileShares

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListFileShares -> m ListFileShares

Read ListFileShares

Defined in Network.AWS.StorageGateway.ListFileShares

Methods

readsPrec :: Int -> ReadS ListFileShares

readList :: ReadS [ListFileShares]

readPrec :: ReadPrec ListFileShares

readListPrec :: ReadPrec [ListFileShares]

Show ListFileShares

Defined in Network.AWS.StorageGateway.ListFileShares

Methods

showsPrec :: Int -> ListFileShares -> ShowS

show :: ListFileShares -> String

showList :: [ListFileShares] -> ShowS

Generic ListFileShares

Defined in Network.AWS.StorageGateway.ListFileShares

Associated Types

type Rep ListFileShares :: Type -> Type

Methods

from :: ListFileShares -> Rep ListFileShares x

to :: Rep ListFileShares x -> ListFileShares

Hashable ListFileShares

Defined in Network.AWS.StorageGateway.ListFileShares

Methods

hashWithSalt :: Int -> ListFileShares -> Int

hash :: ListFileShares -> Int

ToJSON ListFileShares

Defined in Network.AWS.StorageGateway.ListFileShares

Methods

toJSON :: ListFileShares -> Value

toEncoding :: ListFileShares -> Encoding

toJSONList :: [ListFileShares] -> Value

toEncodingList :: [ListFileShares] -> Encoding

AWSRequest ListFileShares

Defined in Network.AWS.StorageGateway.ListFileShares

Associated Types

type Rs ListFileShares :: Type

Methods

request :: ListFileShares -> Request ListFileShares

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy ListFileShares -> ClientResponse -> m (Response ListFileShares)

ToHeaders ListFileShares

Defined in Network.AWS.StorageGateway.ListFileShares

Methods

toHeaders :: ListFileShares -> [Header]

ToPath ListFileShares

Defined in Network.AWS.StorageGateway.ListFileShares

Methods

toPath :: ListFileShares -> ByteString

ToQuery ListFileShares

Defined in Network.AWS.StorageGateway.ListFileShares

Methods

toQuery :: ListFileShares -> QueryString

NFData ListFileShares

Defined in Network.AWS.StorageGateway.ListFileShares

Methods

rnf :: ListFileShares -> ()

type Rep ListFileShares

Defined in Network.AWS.StorageGateway.ListFileShares

type Rep ListFileShares = D1 (MetaData "ListFileShares" "Network.AWS.StorageGateway.ListFileShares" "amazonka-storagegateway-1.6.1-8r5RVaLfJcl46lpEVK6Ktc" False) (C1 (MetaCons "ListFileShares'" PrefixI True) (S1 (MetaSel (Just "_lfsGatewayARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_lfsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lfsLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)))))

type Rs ListFileShares

Defined in Network.AWS.StorageGateway.ListFileShares

type Rs ListFileShares = ListFileSharesResponse

Request Lenses

lfsGatewayARN :: Lens' ListFileShares (Maybe Text)

The Amazon resource Name (ARN) of the gateway whose file shares you want to list. If this field is not present, all file shares under your account are listed.

lfsMarker :: Lens' ListFileShares (Maybe Text)

Opaque pagination token returned from a previous ListFileShares operation. If present, Marker specifies where to continue the list from after a previous call to ListFileShares. Optional.

lfsLimit :: Lens' ListFileShares (Maybe Natural)

The maximum number of file shares to return in the response. The value must be an integer with a value greater than zero. Optional.

Destructuring the Response

listFileSharesResponse

Arguments

:: Int

lfsrsResponseStatus

-> ListFileSharesResponse

Creates a value of ListFileSharesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lfsrsFileShareInfoList - An array of information about the file gateway's file shares.
• lfsrsMarker - If the request includes Marker , the response returns that value in this field.
• lfsrsNextMarker - If a value is present, there are more file shares to return. In a subsequent request, use NextMarker as the value for Marker to retrieve the next set of file shares.
• lfsrsResponseStatus - -- | The response status code.

data ListFileSharesResponse

ListFileShareOutput

See: listFileSharesResponse smart constructor.

Instances

Eq ListFileSharesResponse

Defined in Network.AWS.StorageGateway.ListFileShares

Methods

(==) :: ListFileSharesResponse -> ListFileSharesResponse -> Bool

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

Data ListFileSharesResponse

Defined in Network.AWS.StorageGateway.ListFileShares

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListFileSharesResponse -> c ListFileSharesResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListFileSharesResponse

toConstr :: ListFileSharesResponse -> Constr

dataTypeOf :: ListFileSharesResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListFileSharesResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListFileSharesResponse)

gmapT :: (forall b. Data b => b -> b) -> ListFileSharesResponse -> ListFileSharesResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListFileSharesResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListFileSharesResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> ListFileSharesResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListFileSharesResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListFileSharesResponse -> m ListFileSharesResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListFileSharesResponse -> m ListFileSharesResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListFileSharesResponse -> m ListFileSharesResponse

Read ListFileSharesResponse

Defined in Network.AWS.StorageGateway.ListFileShares

Methods

readsPrec :: Int -> ReadS ListFileSharesResponse

readList :: ReadS [ListFileSharesResponse]

readPrec :: ReadPrec ListFileSharesResponse

readListPrec :: ReadPrec [ListFileSharesResponse]

Show ListFileSharesResponse

Defined in Network.AWS.StorageGateway.ListFileShares

Methods

showsPrec :: Int -> ListFileSharesResponse -> ShowS

show :: ListFileSharesResponse -> String

showList :: [ListFileSharesResponse] -> ShowS

Generic ListFileSharesResponse

Defined in Network.AWS.StorageGateway.ListFileShares

Associated Types

type Rep ListFileSharesResponse :: Type -> Type

Methods

from :: ListFileSharesResponse -> Rep ListFileSharesResponse x

to :: Rep ListFileSharesResponse x -> ListFileSharesResponse

NFData ListFileSharesResponse

Defined in Network.AWS.StorageGateway.ListFileShares

Methods

rnf :: ListFileSharesResponse -> ()

type Rep ListFileSharesResponse

Defined in Network.AWS.StorageGateway.ListFileShares

type Rep ListFileSharesResponse = D1 (MetaData "ListFileSharesResponse" "Network.AWS.StorageGateway.ListFileShares" "amazonka-storagegateway-1.6.1-8r5RVaLfJcl46lpEVK6Ktc" False) (C1 (MetaCons "ListFileSharesResponse'" PrefixI True) ((S1 (MetaSel (Just "_lfsrsFileShareInfoList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [FileShareInfo])) :*: S1 (MetaSel (Just "_lfsrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_lfsrsNextMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lfsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

lfsrsFileShareInfoList :: Lens' ListFileSharesResponse [FileShareInfo]

An array of information about the file gateway's file shares.

lfsrsMarker :: Lens' ListFileSharesResponse (Maybe Text)

If the request includes Marker , the response returns that value in this field.

lfsrsNextMarker :: Lens' ListFileSharesResponse (Maybe Text)

If a value is present, there are more file shares to return. In a subsequent request, use NextMarker as the value for Marker to retrieve the next set of file shares.

lfsrsResponseStatus :: Lens' ListFileSharesResponse Int

• - | The response status code.