libZSservicesZSamazonka-dsZSamazonka-ds
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.DirectoryService.DescribeSharedDirectories

Description

Returns the shared directories in your account.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeSharedDirectories Source #

See: newDescribeSharedDirectories smart constructor.

Constructors

DescribeSharedDirectories' 

Fields

  • sharedDirectoryIds :: Maybe [Text]

    A list of identifiers of all shared directories in your account.

  • nextToken :: Maybe Text

    The DescribeSharedDirectoriesResult.NextToken value from a previous call to DescribeSharedDirectories. Pass null if this is the first call.

  • limit :: Maybe Natural

    The number of shared directories to return in the response object.

  • ownerDirectoryId :: Text

    Returns the identifier of the directory in the directory owner account.

Instances

Instances details
Eq DescribeSharedDirectories Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeSharedDirectories

Methods

(==) :: DescribeSharedDirectories -> DescribeSharedDirectories -> Bool #

(/=) :: DescribeSharedDirectories -> DescribeSharedDirectories -> Bool #

Read DescribeSharedDirectories Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeSharedDirectories

Methods

readsPrec :: Int -> ReadS DescribeSharedDirectories #

readList :: ReadS [DescribeSharedDirectories] #

readPrec :: ReadPrec DescribeSharedDirectories #

readListPrec :: ReadPrec [DescribeSharedDirectories] #

Show DescribeSharedDirectories Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeSharedDirectories

Methods

showsPrec :: Int -> DescribeSharedDirectories -> ShowS #

show :: DescribeSharedDirectories -> String #

showList :: [DescribeSharedDirectories] -> ShowS #

Generic DescribeSharedDirectories Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeSharedDirectories

Associated Types

type Rep DescribeSharedDirectories :: Type -> Type #

Methods

from :: DescribeSharedDirectories -> Rep DescribeSharedDirectories x #

to :: Rep DescribeSharedDirectories x -> DescribeSharedDirectories #

NFData DescribeSharedDirectories Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeSharedDirectories

Methods

rnf :: DescribeSharedDirectories -> () #

Hashable DescribeSharedDirectories Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeSharedDirectories

Methods

hashWithSalt :: Int -> DescribeSharedDirectories -> Int #

hash :: DescribeSharedDirectories -> Int #

ToJSON DescribeSharedDirectories Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeSharedDirectories

Methods

toJSON :: DescribeSharedDirectories -> Value #

toEncoding :: DescribeSharedDirectories -> Encoding #

toJSONList :: [DescribeSharedDirectories] -> Value #

toEncodingList :: [DescribeSharedDirectories] -> Encoding #

AWSPager DescribeSharedDirectories Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeSharedDirectories

Methods

page :: DescribeSharedDirectories -> AWSResponse DescribeSharedDirectories -> Maybe DescribeSharedDirectories #

AWSRequest DescribeSharedDirectories Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeSharedDirectories

Associated Types

type AWSResponse DescribeSharedDirectories #

Methods

request :: DescribeSharedDirectories -> Request DescribeSharedDirectories #

response :: MonadResource m => Logger -> Service -> Proxy DescribeSharedDirectories -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeSharedDirectories))) #

ToHeaders DescribeSharedDirectories Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeSharedDirectories

Methods

toHeaders :: DescribeSharedDirectories -> [Header] #

ToPath DescribeSharedDirectories Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeSharedDirectories

Methods

toPath :: DescribeSharedDirectories -> ByteString #

ToQuery DescribeSharedDirectories Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeSharedDirectories

Methods

toQuery :: DescribeSharedDirectories -> QueryString #

type Rep DescribeSharedDirectories Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeSharedDirectories

type Rep DescribeSharedDirectories = D1 ('MetaData "DescribeSharedDirectories" "Amazonka.DirectoryService.DescribeSharedDirectories" "libZSservicesZSamazonka-dsZSamazonka-ds" 'False) (C1 ('MetaCons "DescribeSharedDirectories'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sharedDirectoryIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "ownerDirectoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse DescribeSharedDirectories Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeSharedDirectories

type AWSResponse DescribeSharedDirectories = DescribeSharedDirectoriesResponse

newDescribeSharedDirectories Source #

Arguments

:: Text

$sel:ownerDirectoryId:DescribeSharedDirectories'

-> DescribeSharedDirectories 

Create a value of DescribeSharedDirectories 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:sharedDirectoryIds:DescribeSharedDirectories', describeSharedDirectories_sharedDirectoryIds - A list of identifiers of all shared directories in your account.

$sel:nextToken:DescribeSharedDirectories', describeSharedDirectories_nextToken - The DescribeSharedDirectoriesResult.NextToken value from a previous call to DescribeSharedDirectories. Pass null if this is the first call.

$sel:limit:DescribeSharedDirectories', describeSharedDirectories_limit - The number of shared directories to return in the response object.

$sel:ownerDirectoryId:DescribeSharedDirectories', describeSharedDirectories_ownerDirectoryId - Returns the identifier of the directory in the directory owner account.

Request Lenses

describeSharedDirectories_sharedDirectoryIds :: Lens' DescribeSharedDirectories (Maybe [Text]) Source #

A list of identifiers of all shared directories in your account.

describeSharedDirectories_nextToken :: Lens' DescribeSharedDirectories (Maybe Text) Source #

The DescribeSharedDirectoriesResult.NextToken value from a previous call to DescribeSharedDirectories. Pass null if this is the first call.

describeSharedDirectories_limit :: Lens' DescribeSharedDirectories (Maybe Natural) Source #

The number of shared directories to return in the response object.

describeSharedDirectories_ownerDirectoryId :: Lens' DescribeSharedDirectories Text Source #

Returns the identifier of the directory in the directory owner account.

Destructuring the Response

data DescribeSharedDirectoriesResponse Source #

See: newDescribeSharedDirectoriesResponse smart constructor.

Constructors

DescribeSharedDirectoriesResponse' 

Fields

  • sharedDirectories :: Maybe [SharedDirectory]

    A list of all shared directories in your account.

  • nextToken :: Maybe Text

    If not null, token that indicates that more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeSharedDirectories to retrieve the next set of items.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq DescribeSharedDirectoriesResponse Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeSharedDirectories

Methods

(==) :: DescribeSharedDirectoriesResponse -> DescribeSharedDirectoriesResponse -> Bool #

(/=) :: DescribeSharedDirectoriesResponse -> DescribeSharedDirectoriesResponse -> Bool #

Show DescribeSharedDirectoriesResponse Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeSharedDirectories

Methods

showsPrec :: Int -> DescribeSharedDirectoriesResponse -> ShowS #

show :: DescribeSharedDirectoriesResponse -> String #

showList :: [DescribeSharedDirectoriesResponse] -> ShowS #

Generic DescribeSharedDirectoriesResponse Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeSharedDirectories

Associated Types

type Rep DescribeSharedDirectoriesResponse :: Type -> Type #

Methods

from :: DescribeSharedDirectoriesResponse -> Rep DescribeSharedDirectoriesResponse x #

to :: Rep DescribeSharedDirectoriesResponse x -> DescribeSharedDirectoriesResponse #

NFData DescribeSharedDirectoriesResponse Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeSharedDirectories

Methods

rnf :: DescribeSharedDirectoriesResponse -> () #

type Rep DescribeSharedDirectoriesResponse Source # 
Instance details

Defined in Amazonka.DirectoryService.DescribeSharedDirectories

type Rep DescribeSharedDirectoriesResponse = D1 ('MetaData "DescribeSharedDirectoriesResponse" "Amazonka.DirectoryService.DescribeSharedDirectories" "libZSservicesZSamazonka-dsZSamazonka-ds" 'False) (C1 ('MetaCons "DescribeSharedDirectoriesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sharedDirectories") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SharedDirectory])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeSharedDirectoriesResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeSharedDirectoriesResponse'

-> DescribeSharedDirectoriesResponse 

Create a value of DescribeSharedDirectoriesResponse 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:sharedDirectories:DescribeSharedDirectoriesResponse', describeSharedDirectoriesResponse_sharedDirectories - A list of all shared directories in your account.

$sel:nextToken:DescribeSharedDirectories', describeSharedDirectoriesResponse_nextToken - If not null, token that indicates that more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeSharedDirectories to retrieve the next set of items.

$sel:httpStatus:DescribeSharedDirectoriesResponse', describeSharedDirectoriesResponse_httpStatus - The response's http status code.

Response Lenses

describeSharedDirectoriesResponse_sharedDirectories :: Lens' DescribeSharedDirectoriesResponse (Maybe [SharedDirectory]) Source #

A list of all shared directories in your account.

describeSharedDirectoriesResponse_nextToken :: Lens' DescribeSharedDirectoriesResponse (Maybe Text) Source #

If not null, token that indicates that more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeSharedDirectories to retrieve the next set of items.

describeSharedDirectoriesResponse_httpStatus :: Lens' DescribeSharedDirectoriesResponse Int Source #

The response's http status code.