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 |
Returns a list of the agreements for the server that's identified by
the ServerId
that you supply. If you want to limit the results to a
certain number, supply a value for the MaxResults
parameter. If you
ran the command previously and received a value for NextToken
, you can
supply that value to continue listing agreements from where you left
off.
This operation returns paginated results.
Synopsis
- data ListAgreements = ListAgreements' {}
- newListAgreements :: Text -> ListAgreements
- listAgreements_maxResults :: Lens' ListAgreements (Maybe Natural)
- listAgreements_nextToken :: Lens' ListAgreements (Maybe Text)
- listAgreements_serverId :: Lens' ListAgreements Text
- data ListAgreementsResponse = ListAgreementsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- agreements :: [ListedAgreement]
- newListAgreementsResponse :: Int -> ListAgreementsResponse
- listAgreementsResponse_nextToken :: Lens' ListAgreementsResponse (Maybe Text)
- listAgreementsResponse_httpStatus :: Lens' ListAgreementsResponse Int
- listAgreementsResponse_agreements :: Lens' ListAgreementsResponse [ListedAgreement]
Creating a Request
data ListAgreements Source #
See: newListAgreements
smart constructor.
ListAgreements' | |
|
Instances
Create a value of ListAgreements
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:maxResults:ListAgreements'
, listAgreements_maxResults
- The maximum number of agreements to return.
ListAgreements
, listAgreements_nextToken
- When you can get additional results from the ListAgreements
call, a
NextToken
parameter is returned in the output. You can then pass in a
subsequent command to the NextToken
parameter to continue listing
additional agreements.
ListAgreements
, listAgreements_serverId
- The identifier of the server for which you want a list of agreements.
Request Lenses
listAgreements_maxResults :: Lens' ListAgreements (Maybe Natural) Source #
The maximum number of agreements to return.
listAgreements_nextToken :: Lens' ListAgreements (Maybe Text) Source #
When you can get additional results from the ListAgreements
call, a
NextToken
parameter is returned in the output. You can then pass in a
subsequent command to the NextToken
parameter to continue listing
additional agreements.
listAgreements_serverId :: Lens' ListAgreements Text Source #
The identifier of the server for which you want a list of agreements.
Destructuring the Response
data ListAgreementsResponse Source #
See: newListAgreementsResponse
smart constructor.
ListAgreementsResponse' | |
|
Instances
newListAgreementsResponse Source #
Create a value of ListAgreementsResponse
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:
ListAgreements
, listAgreementsResponse_nextToken
- Returns a token that you can use to call ListAgreements
again and
receive additional results, if there are any.
$sel:httpStatus:ListAgreementsResponse'
, listAgreementsResponse_httpStatus
- The response's http status code.
$sel:agreements:ListAgreementsResponse'
, listAgreementsResponse_agreements
- Returns an array, where each item contains the details of an agreement.
Response Lenses
listAgreementsResponse_nextToken :: Lens' ListAgreementsResponse (Maybe Text) Source #
Returns a token that you can use to call ListAgreements
again and
receive additional results, if there are any.
listAgreementsResponse_httpStatus :: Lens' ListAgreementsResponse Int Source #
The response's http status code.
listAgreementsResponse_agreements :: Lens' ListAgreementsResponse [ListedAgreement] Source #
Returns an array, where each item contains the details of an agreement.