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

Amazonka.FSx.DescribeFileSystemAliases

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system. A history of all DNS aliases that have been associated with and disassociated from the file system is available in the list of AdministrativeAction provided in the DescribeFileSystems operation response.

Synopsis

Creating a Request

data DescribeFileSystemAliases Source #

The request object for DescribeFileSystemAliases operation.

See: newDescribeFileSystemAliases smart constructor.

Constructors

DescribeFileSystemAliases'

Fields

clientRequestToken :: Maybe Text
maxResults :: Maybe Natural
Maximum number of DNS aliases to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.
nextToken :: Maybe Text
Opaque pagination token returned from a previous DescribeFileSystemAliases operation (String). If a token is included in the request, the action continues the list from where the previous returning call left off.
fileSystemId :: Text
The ID of the file system to return the associated DNS aliases for (String).

Instances

Instances details

ToJSON DescribeFileSystemAliases Source #
Instance details Defined in Amazonka.FSx.DescribeFileSystemAliases Methods toJSON :: DescribeFileSystemAliases -> Value # toEncoding :: DescribeFileSystemAliases -> Encoding # toJSONList :: [DescribeFileSystemAliases] -> Value # toEncodingList :: [DescribeFileSystemAliases] -> Encoding #
ToHeaders DescribeFileSystemAliases Source #
Instance details Defined in Amazonka.FSx.DescribeFileSystemAliases Methods toHeaders :: DescribeFileSystemAliases -> [Header] #
ToPath DescribeFileSystemAliases Source #
Instance details Defined in Amazonka.FSx.DescribeFileSystemAliases Methods toPath :: DescribeFileSystemAliases -> ByteString #
ToQuery DescribeFileSystemAliases Source #
Instance details Defined in Amazonka.FSx.DescribeFileSystemAliases Methods toQuery :: DescribeFileSystemAliases -> QueryString #
AWSRequest DescribeFileSystemAliases Source #
Instance details Defined in Amazonka.FSx.DescribeFileSystemAliases Associated Types type AWSResponse DescribeFileSystemAliases # Methods request :: (Service -> Service) -> DescribeFileSystemAliases -> Request DescribeFileSystemAliases # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeFileSystemAliases -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeFileSystemAliases))) #
Generic DescribeFileSystemAliases Source #
Instance details Defined in Amazonka.FSx.DescribeFileSystemAliases Associated Types type Rep DescribeFileSystemAliases :: Type -> Type # Methods from :: DescribeFileSystemAliases -> Rep DescribeFileSystemAliases x # to :: Rep DescribeFileSystemAliases x -> DescribeFileSystemAliases #
Read DescribeFileSystemAliases Source #
Instance details Defined in Amazonka.FSx.DescribeFileSystemAliases Methods readsPrec :: Int -> ReadS DescribeFileSystemAliases # readList :: ReadS [DescribeFileSystemAliases] # readPrec :: ReadPrec DescribeFileSystemAliases # readListPrec :: ReadPrec [DescribeFileSystemAliases] #
Show DescribeFileSystemAliases Source #
Instance details Defined in Amazonka.FSx.DescribeFileSystemAliases Methods showsPrec :: Int -> DescribeFileSystemAliases -> ShowS # show :: DescribeFileSystemAliases -> String # showList :: [DescribeFileSystemAliases] -> ShowS #
NFData DescribeFileSystemAliases Source #
Instance details Defined in Amazonka.FSx.DescribeFileSystemAliases Methods rnf :: DescribeFileSystemAliases -> () #
Eq DescribeFileSystemAliases Source #
Instance details Defined in Amazonka.FSx.DescribeFileSystemAliases Methods (==) :: DescribeFileSystemAliases -> DescribeFileSystemAliases -> Bool # (/=) :: DescribeFileSystemAliases -> DescribeFileSystemAliases -> Bool #
Hashable DescribeFileSystemAliases Source #
Instance details Defined in Amazonka.FSx.DescribeFileSystemAliases Methods hashWithSalt :: Int -> DescribeFileSystemAliases -> Int # hash :: DescribeFileSystemAliases -> Int #
type AWSResponse DescribeFileSystemAliases Source #
Instance details Defined in Amazonka.FSx.DescribeFileSystemAliases type AWSResponse DescribeFileSystemAliases = DescribeFileSystemAliasesResponse
type Rep DescribeFileSystemAliases Source #
Instance details Defined in Amazonka.FSx.DescribeFileSystemAliases type Rep DescribeFileSystemAliases = D1 ('MetaData "DescribeFileSystemAliases" "Amazonka.FSx.DescribeFileSystemAliases" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "DescribeFileSystemAliases'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientRequestToken") '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)) :*: S1 ('MetaSel ('Just "fileSystemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDescribeFileSystemAliases Source #

Arguments

:: Text	`DescribeFileSystemAliases`
-> DescribeFileSystemAliases

Create a value of DescribeFileSystemAliases 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:clientRequestToken:DescribeFileSystemAliases', describeFileSystemAliases_clientRequestToken - Undocumented member.

$sel:maxResults:DescribeFileSystemAliases', describeFileSystemAliases_maxResults - Maximum number of DNS aliases to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

DescribeFileSystemAliases, describeFileSystemAliases_nextToken - Opaque pagination token returned from a previous DescribeFileSystemAliases operation (String). If a token is included in the request, the action continues the list from where the previous returning call left off.

DescribeFileSystemAliases, describeFileSystemAliases_fileSystemId - The ID of the file system to return the associated DNS aliases for (String).

Request Lenses

describeFileSystemAliases_clientRequestToken :: Lens' DescribeFileSystemAliases (Maybe Text) Source #

Undocumented member.

describeFileSystemAliases_maxResults :: Lens' DescribeFileSystemAliases (Maybe Natural) Source #

Maximum number of DNS aliases to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

describeFileSystemAliases_nextToken :: Lens' DescribeFileSystemAliases (Maybe Text) Source #

Opaque pagination token returned from a previous DescribeFileSystemAliases operation (String). If a token is included in the request, the action continues the list from where the previous returning call left off.

describeFileSystemAliases_fileSystemId :: Lens' DescribeFileSystemAliases Text Source #

The ID of the file system to return the associated DNS aliases for (String).

Destructuring the Response

data DescribeFileSystemAliasesResponse Source #

The response object for DescribeFileSystemAliases operation.

See: newDescribeFileSystemAliasesResponse smart constructor.

Constructors

DescribeFileSystemAliasesResponse'
Fields aliases :: Maybe [Alias] An array of one or more DNS aliases currently associated with the specified file system. nextToken :: Maybe Text Present if there are more DNS aliases than returned in the response (String). You can use the `NextToken` value in a later request to fetch additional descriptions. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeFileSystemAliasesResponse Source #
Instance details Defined in Amazonka.FSx.DescribeFileSystemAliases Associated Types type Rep DescribeFileSystemAliasesResponse :: Type -> Type # Methods from :: DescribeFileSystemAliasesResponse -> Rep DescribeFileSystemAliasesResponse x # to :: Rep DescribeFileSystemAliasesResponse x -> DescribeFileSystemAliasesResponse #
Read DescribeFileSystemAliasesResponse Source #
Instance details Defined in Amazonka.FSx.DescribeFileSystemAliases Methods readsPrec :: Int -> ReadS DescribeFileSystemAliasesResponse # readList :: ReadS [DescribeFileSystemAliasesResponse] # readPrec :: ReadPrec DescribeFileSystemAliasesResponse # readListPrec :: ReadPrec [DescribeFileSystemAliasesResponse] #
Show DescribeFileSystemAliasesResponse Source #
Instance details Defined in Amazonka.FSx.DescribeFileSystemAliases Methods showsPrec :: Int -> DescribeFileSystemAliasesResponse -> ShowS # show :: DescribeFileSystemAliasesResponse -> String # showList :: [DescribeFileSystemAliasesResponse] -> ShowS #
NFData DescribeFileSystemAliasesResponse Source #
Instance details Defined in Amazonka.FSx.DescribeFileSystemAliases Methods rnf :: DescribeFileSystemAliasesResponse -> () #
Eq DescribeFileSystemAliasesResponse Source #
Instance details Defined in Amazonka.FSx.DescribeFileSystemAliases Methods (==) :: DescribeFileSystemAliasesResponse -> DescribeFileSystemAliasesResponse -> Bool # (/=) :: DescribeFileSystemAliasesResponse -> DescribeFileSystemAliasesResponse -> Bool #
type Rep DescribeFileSystemAliasesResponse Source #
Instance details Defined in Amazonka.FSx.DescribeFileSystemAliases type Rep DescribeFileSystemAliasesResponse = D1 ('MetaData "DescribeFileSystemAliasesResponse" "Amazonka.FSx.DescribeFileSystemAliases" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "DescribeFileSystemAliasesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "aliases") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Alias])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeFileSystemAliasesResponse Source #

Arguments

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

Create a value of DescribeFileSystemAliasesResponse 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:

DescribeFileSystemAliasesResponse, describeFileSystemAliasesResponse_aliases - An array of one or more DNS aliases currently associated with the specified file system.

DescribeFileSystemAliases, describeFileSystemAliasesResponse_nextToken - Present if there are more DNS aliases than returned in the response (String). You can use the NextToken value in a later request to fetch additional descriptions.

$sel:httpStatus:DescribeFileSystemAliasesResponse', describeFileSystemAliasesResponse_httpStatus - The response's http status code.

Response Lenses

describeFileSystemAliasesResponse_aliases :: Lens' DescribeFileSystemAliasesResponse (Maybe [Alias]) Source #

An array of one or more DNS aliases currently associated with the specified file system.

describeFileSystemAliasesResponse_nextToken :: Lens' DescribeFileSystemAliasesResponse (Maybe Text) Source #

Present if there are more DNS aliases than returned in the response (String). You can use the NextToken value in a later request to fetch additional descriptions.

describeFileSystemAliasesResponse_httpStatus :: Lens' DescribeFileSystemAliasesResponse Int Source #

The response's http status code.