| 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.Synthetics.GetCanaryRuns
Description
Retrieves a list of runs for a specified canary.
Synopsis
- data GetCanaryRuns = GetCanaryRuns' {}
- newGetCanaryRuns :: Text -> GetCanaryRuns
- getCanaryRuns_nextToken :: Lens' GetCanaryRuns (Maybe Text)
- getCanaryRuns_maxResults :: Lens' GetCanaryRuns (Maybe Natural)
- getCanaryRuns_name :: Lens' GetCanaryRuns Text
- data GetCanaryRunsResponse = GetCanaryRunsResponse' {
- nextToken :: Maybe Text
- canaryRuns :: Maybe [CanaryRun]
- httpStatus :: Int
- newGetCanaryRunsResponse :: Int -> GetCanaryRunsResponse
- getCanaryRunsResponse_nextToken :: Lens' GetCanaryRunsResponse (Maybe Text)
- getCanaryRunsResponse_canaryRuns :: Lens' GetCanaryRunsResponse (Maybe [CanaryRun])
- getCanaryRunsResponse_httpStatus :: Lens' GetCanaryRunsResponse Int
Creating a Request
data GetCanaryRuns Source #
See: newGetCanaryRuns smart constructor.
Constructors
| GetCanaryRuns' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> GetCanaryRuns |
Create a value of GetCanaryRuns 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:GetCanaryRuns', getCanaryRuns_nextToken - A token that indicates that there is more data available. You can use
this token in a subsequent GetCanaryRuns operation to retrieve the
next set of results.
$sel:maxResults:GetCanaryRuns', getCanaryRuns_maxResults - Specify this parameter to limit how many runs are returned each time you
use the GetCanaryRuns operation. If you omit this parameter, the
default of 100 is used.
$sel:name:GetCanaryRuns', getCanaryRuns_name - The name of the canary that you want to see runs for.
Request Lenses
getCanaryRuns_nextToken :: Lens' GetCanaryRuns (Maybe Text) Source #
A token that indicates that there is more data available. You can use
this token in a subsequent GetCanaryRuns operation to retrieve the
next set of results.
getCanaryRuns_maxResults :: Lens' GetCanaryRuns (Maybe Natural) Source #
Specify this parameter to limit how many runs are returned each time you
use the GetCanaryRuns operation. If you omit this parameter, the
default of 100 is used.
getCanaryRuns_name :: Lens' GetCanaryRuns Text Source #
The name of the canary that you want to see runs for.
Destructuring the Response
data GetCanaryRunsResponse Source #
See: newGetCanaryRunsResponse smart constructor.
Constructors
| GetCanaryRunsResponse' | |
Fields
| |
Instances
newGetCanaryRunsResponse Source #
Create a value of GetCanaryRunsResponse 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:GetCanaryRuns', getCanaryRunsResponse_nextToken - A token that indicates that there is more data available. You can use
this token in a subsequent GetCanaryRuns operation to retrieve the
next set of results.
$sel:canaryRuns:GetCanaryRunsResponse', getCanaryRunsResponse_canaryRuns - An array of structures. Each structure contains the details of one of
the retrieved canary runs.
$sel:httpStatus:GetCanaryRunsResponse', getCanaryRunsResponse_httpStatus - The response's http status code.
Response Lenses
getCanaryRunsResponse_nextToken :: Lens' GetCanaryRunsResponse (Maybe Text) Source #
A token that indicates that there is more data available. You can use
this token in a subsequent GetCanaryRuns operation to retrieve the
next set of results.
getCanaryRunsResponse_canaryRuns :: Lens' GetCanaryRunsResponse (Maybe [CanaryRun]) Source #
An array of structures. Each structure contains the details of one of the retrieved canary runs.
getCanaryRunsResponse_httpStatus :: Lens' GetCanaryRunsResponse Int Source #
The response's http status code.