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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a list of the file shares for a specific S3 File Gateway, or the list of file shares that belong to the calling user account. This operation is only supported for S3 File Gateways.

This operation returns paginated results.

Synopsis

data ListFileShares = ListFileShares' {
- gatewayARN :: Maybe Text
- marker :: Maybe Text
- limit :: Maybe Natural
}
newListFileShares :: ListFileShares
listFileShares_gatewayARN :: Lens' ListFileShares (Maybe Text)
listFileShares_marker :: Lens' ListFileShares (Maybe Text)
listFileShares_limit :: Lens' ListFileShares (Maybe Natural)
data ListFileSharesResponse = ListFileSharesResponse' {
- fileShareInfoList :: Maybe [FileShareInfo]
- marker :: Maybe Text
- nextMarker :: Maybe Text
- httpStatus :: Int
}
newListFileSharesResponse :: Int -> ListFileSharesResponse
listFileSharesResponse_fileShareInfoList :: Lens' ListFileSharesResponse (Maybe [FileShareInfo])
listFileSharesResponse_marker :: Lens' ListFileSharesResponse (Maybe Text)
listFileSharesResponse_nextMarker :: Lens' ListFileSharesResponse (Maybe Text)
listFileSharesResponse_httpStatus :: Lens' ListFileSharesResponse Int

Creating a Request

data ListFileShares Source #

ListFileShareInput

See: newListFileShares smart constructor.

Constructors

ListFileShares'

Fields

gatewayARN :: 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.
marker :: 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.
limit :: 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.

Instances

Instances details

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

newListFileShares :: ListFileShares Source #

Create a value of ListFileShares 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:gatewayARN:ListFileShares', listFileShares_gatewayARN - 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.

$sel:marker:ListFileShares', listFileShares_marker - 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.

$sel:limit:ListFileShares', listFileShares_limit - The maximum number of file shares to return in the response. The value must be an integer with a value greater than zero. Optional.

Request Lenses

listFileShares_gatewayARN :: Lens' ListFileShares (Maybe Text) Source #

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.

listFileShares_marker :: Lens' ListFileShares (Maybe Text) Source #

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.

listFileShares_limit :: Lens' ListFileShares (Maybe Natural) Source #

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

data ListFileSharesResponse Source #

ListFileShareOutput

See: newListFileSharesResponse smart constructor.

Constructors

ListFileSharesResponse'

Fields

fileShareInfoList :: Maybe [FileShareInfo]
An array of information about the S3 File Gateway's file shares.
marker :: Maybe Text
If the request includes Marker, the response returns that value in this field.
nextMarker :: 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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newListFileSharesResponse Source #

Arguments

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

Create a value of ListFileSharesResponse 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:fileShareInfoList:ListFileSharesResponse', listFileSharesResponse_fileShareInfoList - An array of information about the S3 File Gateway's file shares.

$sel:marker:ListFileShares', listFileSharesResponse_marker - If the request includes Marker, the response returns that value in this field.

$sel:nextMarker:ListFileSharesResponse', listFileSharesResponse_nextMarker - 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.

$sel:httpStatus:ListFileSharesResponse', listFileSharesResponse_httpStatus - The response's http status code.

Response Lenses

listFileSharesResponse_fileShareInfoList :: Lens' ListFileSharesResponse (Maybe [FileShareInfo]) Source #

An array of information about the S3 File Gateway's file shares.

listFileSharesResponse_marker :: Lens' ListFileSharesResponse (Maybe Text) Source #

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

listFileSharesResponse_nextMarker :: Lens' ListFileSharesResponse (Maybe Text) Source #

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.

listFileSharesResponse_httpStatus :: Lens' ListFileSharesResponse Int Source #

The response's http status code.