Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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
NextToken
value. 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 aNextToken
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.
Synopsis
- data DescribeFileCaches = DescribeFileCaches' {
- fileCacheIds :: Maybe [Text]
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- newDescribeFileCaches :: DescribeFileCaches
- describeFileCaches_fileCacheIds :: Lens' DescribeFileCaches (Maybe [Text])
- describeFileCaches_maxResults :: Lens' DescribeFileCaches (Maybe Natural)
- describeFileCaches_nextToken :: Lens' DescribeFileCaches (Maybe Text)
- data DescribeFileCachesResponse = DescribeFileCachesResponse' {
- fileCaches :: Maybe [FileCache]
- nextToken :: Maybe Text
- httpStatus :: Int
- newDescribeFileCachesResponse :: Int -> DescribeFileCachesResponse
- describeFileCachesResponse_fileCaches :: Lens' DescribeFileCachesResponse (Maybe [FileCache])
- describeFileCachesResponse_nextToken :: Lens' DescribeFileCachesResponse (Maybe Text)
- describeFileCachesResponse_httpStatus :: Lens' DescribeFileCachesResponse Int
Creating a Request
data DescribeFileCaches Source #
See: newDescribeFileCaches
smart constructor.
DescribeFileCaches' | |
|
Instances
newDescribeFileCaches :: DescribeFileCaches Source #
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]) Source #
IDs of the caches whose descriptions you want to retrieve (String).
describeFileCaches_maxResults :: Lens' DescribeFileCaches (Maybe Natural) Source #
Undocumented member.
describeFileCaches_nextToken :: Lens' DescribeFileCaches (Maybe Text) Source #
Undocumented member.
Destructuring the Response
data DescribeFileCachesResponse Source #
See: newDescribeFileCachesResponse
smart constructor.
DescribeFileCachesResponse' | |
|
Instances
newDescribeFileCachesResponse Source #
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]) Source #
The response object for the DescribeFileCaches
operation.
describeFileCachesResponse_nextToken :: Lens' DescribeFileCachesResponse (Maybe Text) Source #
Undocumented member.
describeFileCachesResponse_httpStatus :: Lens' DescribeFileCachesResponse Int Source #
The response's http status code.