Amazonka.DirectoryService.DescribeTrusts

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.

This operation returns paginated results.

Creating a Request

data DescribeTrusts

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

See: newDescribeTrusts smart constructor.

Constructors

DescribeTrusts'

Fields

• directoryId :: Maybe Text

  The Directory ID of the Amazon Web Services directory that is a part of the requested trust relationship.

• limit :: Maybe Natural

  The maximum number of objects to return.

• nextToken :: Maybe Text

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

• trustIds :: Maybe [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.

Instances

ToJSON DescribeTrusts

Defined in Amazonka.DirectoryService.DescribeTrusts

Methods

toJSON :: DescribeTrusts -> Value

toEncoding :: DescribeTrusts -> Encoding

toJSONList :: [DescribeTrusts] -> Value

toEncodingList :: [DescribeTrusts] -> Encoding

ToHeaders DescribeTrusts

Defined in Amazonka.DirectoryService.DescribeTrusts

Methods

toHeaders :: DescribeTrusts -> [Header]

ToPath DescribeTrusts

Defined in Amazonka.DirectoryService.DescribeTrusts

Methods

toPath :: DescribeTrusts -> ByteString

ToQuery DescribeTrusts

Defined in Amazonka.DirectoryService.DescribeTrusts

Methods

toQuery :: DescribeTrusts -> QueryString

AWSPager DescribeTrusts

Defined in Amazonka.DirectoryService.DescribeTrusts

Methods

page :: DescribeTrusts -> AWSResponse DescribeTrusts -> Maybe DescribeTrusts

AWSRequest DescribeTrusts

Defined in Amazonka.DirectoryService.DescribeTrusts

Associated Types

type AWSResponse DescribeTrusts

Methods

request :: (Service -> Service) -> DescribeTrusts -> Request DescribeTrusts

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeTrusts -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeTrusts)))

Generic DescribeTrusts

Defined in Amazonka.DirectoryService.DescribeTrusts

Associated Types

type Rep DescribeTrusts :: Type -> Type

Methods

from :: DescribeTrusts -> Rep DescribeTrusts x

to :: Rep DescribeTrusts x -> DescribeTrusts

Read DescribeTrusts

Defined in Amazonka.DirectoryService.DescribeTrusts

Methods

readsPrec :: Int -> ReadS DescribeTrusts

readList :: ReadS [DescribeTrusts]

readPrec :: ReadPrec DescribeTrusts

readListPrec :: ReadPrec [DescribeTrusts]

Show DescribeTrusts

Defined in Amazonka.DirectoryService.DescribeTrusts

Methods

showsPrec :: Int -> DescribeTrusts -> ShowS

show :: DescribeTrusts -> String

showList :: [DescribeTrusts] -> ShowS

NFData DescribeTrusts

Defined in Amazonka.DirectoryService.DescribeTrusts

Methods

rnf :: DescribeTrusts -> ()

Eq DescribeTrusts

Defined in Amazonka.DirectoryService.DescribeTrusts

Methods

(==) :: DescribeTrusts -> DescribeTrusts -> Bool

(/=) :: DescribeTrusts -> DescribeTrusts -> Bool

Hashable DescribeTrusts

Defined in Amazonka.DirectoryService.DescribeTrusts

Methods

hashWithSalt :: Int -> DescribeTrusts -> Int

hash :: DescribeTrusts -> Int

type AWSResponse DescribeTrusts

Defined in Amazonka.DirectoryService.DescribeTrusts

type AWSResponse DescribeTrusts = DescribeTrustsResponse

type Rep DescribeTrusts

Defined in Amazonka.DirectoryService.DescribeTrusts

type Rep DescribeTrusts = D1 ('MetaData "DescribeTrusts" "Amazonka.DirectoryService.DescribeTrusts" "amazonka-ds-2.0-AgXI5fcN8ZxCoi4kNvhD3" 'False) (C1 ('MetaCons "DescribeTrusts'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "trustIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))

newDescribeTrusts :: DescribeTrusts

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

DescribeTrusts, describeTrusts_directoryId - The Directory ID of the Amazon Web Services directory that is a part of the requested trust relationship.

$sel:limit:DescribeTrusts', describeTrusts_limit - The maximum number of objects to return.

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

$sel:trustIds:DescribeTrusts', describeTrusts_trustIds - 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.

Request Lenses

describeTrusts_directoryId :: Lens' DescribeTrusts (Maybe Text)

The Directory ID of the Amazon Web Services directory that is a part of the requested trust relationship.

describeTrusts_limit :: Lens' DescribeTrusts (Maybe Natural)

The maximum number of objects to return.

describeTrusts_nextToken :: Lens' DescribeTrusts (Maybe Text)

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

describeTrusts_trustIds :: Lens' DescribeTrusts (Maybe [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.

Destructuring the Response

data DescribeTrustsResponse

The result of a DescribeTrust request.

See: newDescribeTrustsResponse smart constructor.

Constructors

DescribeTrustsResponse'

Fields

• nextToken :: 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.

• trusts :: Maybe [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.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeTrustsResponse

Defined in Amazonka.DirectoryService.DescribeTrusts

Associated Types

type Rep DescribeTrustsResponse :: Type -> Type

Methods

from :: DescribeTrustsResponse -> Rep DescribeTrustsResponse x

to :: Rep DescribeTrustsResponse x -> DescribeTrustsResponse

Read DescribeTrustsResponse

Defined in Amazonka.DirectoryService.DescribeTrusts

Methods

readsPrec :: Int -> ReadS DescribeTrustsResponse

readList :: ReadS [DescribeTrustsResponse]

readPrec :: ReadPrec DescribeTrustsResponse

readListPrec :: ReadPrec [DescribeTrustsResponse]

Show DescribeTrustsResponse

Defined in Amazonka.DirectoryService.DescribeTrusts

Methods

showsPrec :: Int -> DescribeTrustsResponse -> ShowS

show :: DescribeTrustsResponse -> String

showList :: [DescribeTrustsResponse] -> ShowS

NFData DescribeTrustsResponse

Defined in Amazonka.DirectoryService.DescribeTrusts

Methods

rnf :: DescribeTrustsResponse -> ()

Eq DescribeTrustsResponse

Defined in Amazonka.DirectoryService.DescribeTrusts

Methods

(==) :: DescribeTrustsResponse -> DescribeTrustsResponse -> Bool

(/=) :: DescribeTrustsResponse -> DescribeTrustsResponse -> Bool

type Rep DescribeTrustsResponse

Defined in Amazonka.DirectoryService.DescribeTrusts

type Rep DescribeTrustsResponse = D1 ('MetaData "DescribeTrustsResponse" "Amazonka.DirectoryService.DescribeTrusts" "amazonka-ds-2.0-AgXI5fcN8ZxCoi4kNvhD3" 'False) (C1 ('MetaCons "DescribeTrustsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "trusts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Trust])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeTrustsResponse

Arguments

:: Int

$sel:httpStatus:DescribeTrustsResponse'

-> DescribeTrustsResponse

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

DescribeTrusts, describeTrustsResponse_nextToken - 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.

$sel:trusts:DescribeTrustsResponse', describeTrustsResponse_trusts - 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.

$sel:httpStatus:DescribeTrustsResponse', describeTrustsResponse_httpStatus - The response's http status code.

Response Lenses

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

describeTrustsResponse_trusts :: Lens' DescribeTrustsResponse (Maybe [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.

describeTrustsResponse_httpStatus :: Lens' DescribeTrustsResponse Int

The response's http status code.