amazonka-fsx-2.0: Amazon FSx SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.FSx.DescribeFileCaches

Description

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

Creating a Request

data DescribeFileCaches Source #

See: newDescribeFileCaches smart constructor.

Constructors

DescribeFileCaches' 

Fields

Instances

Instances details
ToJSON DescribeFileCaches Source # 
Instance details

Defined in Amazonka.FSx.DescribeFileCaches

ToHeaders DescribeFileCaches Source # 
Instance details

Defined in Amazonka.FSx.DescribeFileCaches

ToPath DescribeFileCaches Source # 
Instance details

Defined in Amazonka.FSx.DescribeFileCaches

ToQuery DescribeFileCaches Source # 
Instance details

Defined in Amazonka.FSx.DescribeFileCaches

AWSRequest DescribeFileCaches Source # 
Instance details

Defined in Amazonka.FSx.DescribeFileCaches

Associated Types

type AWSResponse DescribeFileCaches #

Generic DescribeFileCaches Source # 
Instance details

Defined in Amazonka.FSx.DescribeFileCaches

Associated Types

type Rep DescribeFileCaches :: Type -> Type #

Read DescribeFileCaches Source # 
Instance details

Defined in Amazonka.FSx.DescribeFileCaches

Show DescribeFileCaches Source # 
Instance details

Defined in Amazonka.FSx.DescribeFileCaches

NFData DescribeFileCaches Source # 
Instance details

Defined in Amazonka.FSx.DescribeFileCaches

Methods

rnf :: DescribeFileCaches -> () #

Eq DescribeFileCaches Source # 
Instance details

Defined in Amazonka.FSx.DescribeFileCaches

Hashable DescribeFileCaches Source # 
Instance details

Defined in Amazonka.FSx.DescribeFileCaches

type AWSResponse DescribeFileCaches Source # 
Instance details

Defined in Amazonka.FSx.DescribeFileCaches

type Rep DescribeFileCaches Source # 
Instance details

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

Destructuring the Response

data DescribeFileCachesResponse Source #

See: newDescribeFileCachesResponse smart constructor.

Constructors

DescribeFileCachesResponse' 

Fields

Instances

Instances details
Generic DescribeFileCachesResponse Source # 
Instance details

Defined in Amazonka.FSx.DescribeFileCaches

Associated Types

type Rep DescribeFileCachesResponse :: Type -> Type #

Read DescribeFileCachesResponse Source # 
Instance details

Defined in Amazonka.FSx.DescribeFileCaches

Show DescribeFileCachesResponse Source # 
Instance details

Defined in Amazonka.FSx.DescribeFileCaches

NFData DescribeFileCachesResponse Source # 
Instance details

Defined in Amazonka.FSx.DescribeFileCaches

Eq DescribeFileCachesResponse Source # 
Instance details

Defined in Amazonka.FSx.DescribeFileCaches

type Rep DescribeFileCachesResponse Source # 
Instance details

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