Amazonka.FSx.DescribeFileCaches

Returns the description of a specific Amazon File Cache resource, if a FileCacheIds value is provided for that cache. Otherwise, it returns descriptions of all caches owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

When retrieving all cache descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more cache descriptions remain, the operation returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

This operation is used in an iterative process to retrieve a list of your cache descriptions. DescribeFileCaches is called first without a NextTokenvalue. Then the operation continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.

When using this operation, keep the following in mind:

• The implementation might return fewer than MaxResults cache descriptions while still including a NextToken value.
• The order of caches returned in the response of one DescribeFileCaches call and the order of caches returned across the responses of a multicall iteration is unspecified.

Creating a Request

data DescribeFileCaches

See: newDescribeFileCaches smart constructor.

Constructors

DescribeFileCaches'

Fields

• fileCacheIds :: Maybe [Text]

  IDs of the caches whose descriptions you want to retrieve (String).

• maxResults :: Maybe Natural
• nextToken :: Maybe Text

Instances

ToJSON DescribeFileCaches

Defined in Amazonka.FSx.DescribeFileCaches

Methods

toJSON :: DescribeFileCaches -> Value

toEncoding :: DescribeFileCaches -> Encoding

toJSONList :: [DescribeFileCaches] -> Value

toEncodingList :: [DescribeFileCaches] -> Encoding

ToHeaders DescribeFileCaches

Defined in Amazonka.FSx.DescribeFileCaches

Methods

toHeaders :: DescribeFileCaches -> [Header]

ToPath DescribeFileCaches

Defined in Amazonka.FSx.DescribeFileCaches

Methods

toPath :: DescribeFileCaches -> ByteString

ToQuery DescribeFileCaches

Defined in Amazonka.FSx.DescribeFileCaches

Methods

toQuery :: DescribeFileCaches -> QueryString

AWSRequest DescribeFileCaches

Defined in Amazonka.FSx.DescribeFileCaches

Associated Types

type AWSResponse DescribeFileCaches

Methods

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

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

Generic DescribeFileCaches

Defined in Amazonka.FSx.DescribeFileCaches

Associated Types

type Rep DescribeFileCaches :: Type -> Type

Methods

from :: DescribeFileCaches -> Rep DescribeFileCaches x

to :: Rep DescribeFileCaches x -> DescribeFileCaches

Read DescribeFileCaches

Defined in Amazonka.FSx.DescribeFileCaches

Methods

readsPrec :: Int -> ReadS DescribeFileCaches

readList :: ReadS [DescribeFileCaches]

readPrec :: ReadPrec DescribeFileCaches

readListPrec :: ReadPrec [DescribeFileCaches]

Show DescribeFileCaches

Defined in Amazonka.FSx.DescribeFileCaches

Methods

showsPrec :: Int -> DescribeFileCaches -> ShowS

show :: DescribeFileCaches -> String

showList :: [DescribeFileCaches] -> ShowS

NFData DescribeFileCaches

Defined in Amazonka.FSx.DescribeFileCaches

Methods

rnf :: DescribeFileCaches -> ()

Eq DescribeFileCaches

Defined in Amazonka.FSx.DescribeFileCaches

Methods

(==) :: DescribeFileCaches -> DescribeFileCaches -> Bool

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

Hashable DescribeFileCaches

Defined in Amazonka.FSx.DescribeFileCaches

Methods

hashWithSalt :: Int -> DescribeFileCaches -> Int

hash :: DescribeFileCaches -> Int

type AWSResponse DescribeFileCaches

Defined in Amazonka.FSx.DescribeFileCaches

type AWSResponse DescribeFileCaches = DescribeFileCachesResponse

type Rep DescribeFileCaches

Defined in Amazonka.FSx.DescribeFileCaches

type Rep DescribeFileCaches = D1 ('MetaData "DescribeFileCaches" "Amazonka.FSx.DescribeFileCaches" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "DescribeFileCaches'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fileCacheIds") '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)))))

newDescribeFileCaches :: DescribeFileCaches

Create a value of DescribeFileCaches 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:fileCacheIds:DescribeFileCaches', describeFileCaches_fileCacheIds - IDs of the caches whose descriptions you want to retrieve (String).

$sel:maxResults:DescribeFileCaches', describeFileCaches_maxResults - Undocumented member.

DescribeFileCaches, describeFileCaches_nextToken - Undocumented member.

Request Lenses

describeFileCaches_fileCacheIds :: Lens' DescribeFileCaches (Maybe [Text])

IDs of the caches whose descriptions you want to retrieve (String).

describeFileCaches_maxResults :: Lens' DescribeFileCaches (Maybe Natural)

Undocumented member.

describeFileCaches_nextToken :: Lens' DescribeFileCaches (Maybe Text)

Undocumented member.

Destructuring the Response

data DescribeFileCachesResponse

See: newDescribeFileCachesResponse smart constructor.

Constructors

DescribeFileCachesResponse'

Fields

• fileCaches :: Maybe [FileCache]

  The response object for the DescribeFileCaches operation.

• nextToken :: Maybe Text
• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeFileCachesResponse

Defined in Amazonka.FSx.DescribeFileCaches

Associated Types

type Rep DescribeFileCachesResponse :: Type -> Type

Methods

from :: DescribeFileCachesResponse -> Rep DescribeFileCachesResponse x

to :: Rep DescribeFileCachesResponse x -> DescribeFileCachesResponse

Read DescribeFileCachesResponse

Defined in Amazonka.FSx.DescribeFileCaches

Methods

readsPrec :: Int -> ReadS DescribeFileCachesResponse

readList :: ReadS [DescribeFileCachesResponse]

readPrec :: ReadPrec DescribeFileCachesResponse

readListPrec :: ReadPrec [DescribeFileCachesResponse]

Show DescribeFileCachesResponse

Defined in Amazonka.FSx.DescribeFileCaches

Methods

showsPrec :: Int -> DescribeFileCachesResponse -> ShowS

show :: DescribeFileCachesResponse -> String

showList :: [DescribeFileCachesResponse] -> ShowS

NFData DescribeFileCachesResponse

Defined in Amazonka.FSx.DescribeFileCaches

Methods

rnf :: DescribeFileCachesResponse -> ()

Eq DescribeFileCachesResponse

Defined in Amazonka.FSx.DescribeFileCaches

Methods

(==) :: DescribeFileCachesResponse -> DescribeFileCachesResponse -> Bool

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

type Rep DescribeFileCachesResponse

Defined in Amazonka.FSx.DescribeFileCaches

type Rep DescribeFileCachesResponse = D1 ('MetaData "DescribeFileCachesResponse" "Amazonka.FSx.DescribeFileCaches" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "DescribeFileCachesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fileCaches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [FileCache])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeFileCachesResponse

Arguments

:: Int

$sel:httpStatus:DescribeFileCachesResponse'

-> DescribeFileCachesResponse

Create a value of DescribeFileCachesResponse 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:fileCaches:DescribeFileCachesResponse', describeFileCachesResponse_fileCaches - The response object for the DescribeFileCaches operation.

DescribeFileCaches, describeFileCachesResponse_nextToken - Undocumented member.

$sel:httpStatus:DescribeFileCachesResponse', describeFileCachesResponse_httpStatus - The response's http status code.

Response Lenses

describeFileCachesResponse_fileCaches :: Lens' DescribeFileCachesResponse (Maybe [FileCache])

The response object for the DescribeFileCaches operation.

describeFileCachesResponse_nextToken :: Lens' DescribeFileCachesResponse (Maybe Text)

Undocumented member.

describeFileCachesResponse_httpStatus :: Lens' DescribeFileCachesResponse Int

The response's http status code.