amazonka-ds-1.6.0: Amazon Directory Service SDK.

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

Network.AWS.DirectoryService.DescribeTrusts

Contents

Description

Obtains information about the trust relationships for this account.

If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account.

Synopsis

Creating a Request

describeTrusts :: DescribeTrusts #

Creates a value of DescribeTrusts with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • dtDirectoryId - The Directory ID of the AWS directory that is a part of the requested trust relationship.
  • dtNextToken - The DescribeTrustsResult.NextToken value from a previous call to DescribeTrusts . Pass null if this is the first call.
  • dtTrustIds - A list of identifiers of the trust relationships for which to obtain the information. If this member is null, all trust relationships that belong to the current account are returned. An empty list results in an InvalidParameterException being thrown.
  • dtLimit - The maximum number of objects to return.

data DescribeTrusts #

Describes the trust relationships for a particular Microsoft AD in the AWS cloud. If no input parameters are are provided, such as directory ID or trust ID, this request describes all the trust relationships.

See: describeTrusts smart constructor.

Instances

Eq DescribeTrusts # 
Data DescribeTrusts # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeTrusts -> c DescribeTrusts #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeTrusts #

toConstr :: DescribeTrusts -> Constr #

dataTypeOf :: DescribeTrusts -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeTrusts) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeTrusts) #

gmapT :: (forall b. Data b => b -> b) -> DescribeTrusts -> DescribeTrusts #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeTrusts -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeTrusts -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeTrusts -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeTrusts -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeTrusts -> m DescribeTrusts #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeTrusts -> m DescribeTrusts #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeTrusts -> m DescribeTrusts #

Read DescribeTrusts # 
Show DescribeTrusts # 
Generic DescribeTrusts # 

Associated Types

type Rep DescribeTrusts :: * -> * #

Hashable DescribeTrusts # 
ToJSON DescribeTrusts # 
NFData DescribeTrusts # 

Methods

rnf :: DescribeTrusts -> () #

AWSRequest DescribeTrusts # 
ToHeaders DescribeTrusts # 
ToPath DescribeTrusts # 
ToQuery DescribeTrusts # 
type Rep DescribeTrusts # 
type Rep DescribeTrusts = D1 * (MetaData "DescribeTrusts" "Network.AWS.DirectoryService.DescribeTrusts" "amazonka-ds-1.6.0-GmQtRfGRD6LI91OTzfkXGW" False) (C1 * (MetaCons "DescribeTrusts'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_dtDirectoryId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dtNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dtTrustIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) (S1 * (MetaSel (Just Symbol "_dtLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))))))
type Rs DescribeTrusts # 

Request Lenses

dtDirectoryId :: Lens' DescribeTrusts (Maybe Text) #

The Directory ID of the AWS directory that is a part of the requested trust relationship.

dtNextToken :: Lens' DescribeTrusts (Maybe Text) #

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

dtTrustIds :: Lens' DescribeTrusts [Text] #

A list of identifiers of the trust relationships for which to obtain the information. If this member is null, all trust relationships that belong to the current account are returned. An empty list results in an InvalidParameterException being thrown.

dtLimit :: Lens' DescribeTrusts (Maybe Natural) #

The maximum number of objects to return.

Destructuring the Response

describeTrustsResponse #

Creates a value of DescribeTrustsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • dtrsNextToken - If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeTrusts to retrieve the next set of items.
  • dtrsTrusts - The list of Trust objects that were retrieved. It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.
  • dtrsResponseStatus - -- | The response status code.

data DescribeTrustsResponse #

The result of a DescribeTrust request.

See: describeTrustsResponse smart constructor.

Instances

Eq DescribeTrustsResponse # 
Data DescribeTrustsResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeTrustsResponse -> c DescribeTrustsResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeTrustsResponse #

toConstr :: DescribeTrustsResponse -> Constr #

dataTypeOf :: DescribeTrustsResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeTrustsResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeTrustsResponse) #

gmapT :: (forall b. Data b => b -> b) -> DescribeTrustsResponse -> DescribeTrustsResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeTrustsResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeTrustsResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeTrustsResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeTrustsResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeTrustsResponse -> m DescribeTrustsResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeTrustsResponse -> m DescribeTrustsResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeTrustsResponse -> m DescribeTrustsResponse #

Read DescribeTrustsResponse # 
Show DescribeTrustsResponse # 
Generic DescribeTrustsResponse # 
NFData DescribeTrustsResponse # 

Methods

rnf :: DescribeTrustsResponse -> () #

type Rep DescribeTrustsResponse # 
type Rep DescribeTrustsResponse = D1 * (MetaData "DescribeTrustsResponse" "Network.AWS.DirectoryService.DescribeTrusts" "amazonka-ds-1.6.0-GmQtRfGRD6LI91OTzfkXGW" False) (C1 * (MetaCons "DescribeTrustsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dtrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dtrsTrusts") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Trust]))) (S1 * (MetaSel (Just Symbol "_dtrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

dtrsNextToken :: Lens' DescribeTrustsResponse (Maybe Text) #

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

dtrsTrusts :: Lens' DescribeTrustsResponse [Trust] #

The list of Trust objects that were retrieved. It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.

dtrsResponseStatus :: Lens' DescribeTrustsResponse Int #

  • - | The response status code.