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 |
Gets one or more outcomes. This is a paginated API. If you provide a
null maxResults
, this actions retrieves a maximum of 100 records per
page. If you provide a maxResults
, the value must be between 50 and
100. To get the next page results, provide the pagination token from the
GetOutcomesResult
as part of your request. A null pagination token
fetches the records from the beginning.
Synopsis
- data GetOutcomes = GetOutcomes' {}
- newGetOutcomes :: GetOutcomes
- getOutcomes_nextToken :: Lens' GetOutcomes (Maybe Text)
- getOutcomes_name :: Lens' GetOutcomes (Maybe Text)
- getOutcomes_maxResults :: Lens' GetOutcomes (Maybe Natural)
- data GetOutcomesResponse = GetOutcomesResponse' {}
- newGetOutcomesResponse :: Int -> GetOutcomesResponse
- getOutcomesResponse_outcomes :: Lens' GetOutcomesResponse (Maybe [Outcome])
- getOutcomesResponse_nextToken :: Lens' GetOutcomesResponse (Maybe Text)
- getOutcomesResponse_httpStatus :: Lens' GetOutcomesResponse Int
Creating a Request
data GetOutcomes Source #
See: newGetOutcomes
smart constructor.
Instances
newGetOutcomes :: GetOutcomes Source #
Create a value of GetOutcomes
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:GetOutcomes'
, getOutcomes_nextToken
- The next page token for the request.
$sel:name:GetOutcomes'
, getOutcomes_name
- The name of the outcome or outcomes to get.
$sel:maxResults:GetOutcomes'
, getOutcomes_maxResults
- The maximum number of objects to return for the request.
Request Lenses
getOutcomes_nextToken :: Lens' GetOutcomes (Maybe Text) Source #
The next page token for the request.
getOutcomes_name :: Lens' GetOutcomes (Maybe Text) Source #
The name of the outcome or outcomes to get.
getOutcomes_maxResults :: Lens' GetOutcomes (Maybe Natural) Source #
The maximum number of objects to return for the request.
Destructuring the Response
data GetOutcomesResponse Source #
See: newGetOutcomesResponse
smart constructor.
Instances
newGetOutcomesResponse Source #
Create a value of GetOutcomesResponse
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:outcomes:GetOutcomesResponse'
, getOutcomesResponse_outcomes
- The outcomes.
$sel:nextToken:GetOutcomes'
, getOutcomesResponse_nextToken
- The next page token for subsequent requests.
$sel:httpStatus:GetOutcomesResponse'
, getOutcomesResponse_httpStatus
- The response's http status code.
Response Lenses
getOutcomesResponse_outcomes :: Lens' GetOutcomesResponse (Maybe [Outcome]) Source #
The outcomes.
getOutcomesResponse_nextToken :: Lens' GetOutcomesResponse (Maybe Text) Source #
The next page token for subsequent requests.
getOutcomesResponse_httpStatus :: Lens' GetOutcomesResponse Int Source #
The response's http status code.