| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.DirectoryService.DescribeTrusts
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.
This operation returns paginated results.
Synopsis
- data DescribeTrusts = DescribeTrusts' {}
- newDescribeTrusts :: DescribeTrusts
- describeTrusts_directoryId :: Lens' DescribeTrusts (Maybe Text)
- describeTrusts_nextToken :: Lens' DescribeTrusts (Maybe Text)
- describeTrusts_trustIds :: Lens' DescribeTrusts (Maybe [Text])
- describeTrusts_limit :: Lens' DescribeTrusts (Maybe Natural)
- data DescribeTrustsResponse = DescribeTrustsResponse' {}
- newDescribeTrustsResponse :: Int -> DescribeTrustsResponse
- describeTrustsResponse_nextToken :: Lens' DescribeTrustsResponse (Maybe Text)
- describeTrustsResponse_trusts :: Lens' DescribeTrustsResponse (Maybe [Trust])
- describeTrustsResponse_httpStatus :: Lens' DescribeTrustsResponse Int
Creating a Request
data DescribeTrusts Source #
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
| |
Instances
newDescribeTrusts :: DescribeTrusts Source #
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:
$sel:directoryId:DescribeTrusts', describeTrusts_directoryId - The Directory ID of the Amazon Web Services directory that is a part of
the requested trust relationship.
$sel:nextToken: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.
$sel:limit:DescribeTrusts', describeTrusts_limit - The maximum number of objects to return.
Request Lenses
describeTrusts_directoryId :: Lens' DescribeTrusts (Maybe Text) Source #
The Directory ID of the Amazon Web Services directory that is a part of the requested trust relationship.
describeTrusts_nextToken :: Lens' DescribeTrusts (Maybe Text) Source #
The DescribeTrustsResult.NextToken value from a previous call to DescribeTrusts. Pass null if this is the first call.
describeTrusts_trustIds :: Lens' DescribeTrusts (Maybe [Text]) Source #
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.
describeTrusts_limit :: Lens' DescribeTrusts (Maybe Natural) Source #
The maximum number of objects to return.
Destructuring the Response
data DescribeTrustsResponse Source #
The result of a DescribeTrust request.
See: newDescribeTrustsResponse smart constructor.
Constructors
| DescribeTrustsResponse' | |
Fields
| |
Instances
newDescribeTrustsResponse Source #
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:
$sel:nextToken: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) Source #
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]) Source #
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 Source #
The response's http status code.