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 |
Retrieves metadata for all runs of a given workflow.
Synopsis
- data GetWorkflowRuns = GetWorkflowRuns' {}
- newGetWorkflowRuns :: Text -> GetWorkflowRuns
- getWorkflowRuns_includeGraph :: Lens' GetWorkflowRuns (Maybe Bool)
- getWorkflowRuns_nextToken :: Lens' GetWorkflowRuns (Maybe Text)
- getWorkflowRuns_maxResults :: Lens' GetWorkflowRuns (Maybe Natural)
- getWorkflowRuns_name :: Lens' GetWorkflowRuns Text
- data GetWorkflowRunsResponse = GetWorkflowRunsResponse' {
- runs :: Maybe (NonEmpty WorkflowRun)
- nextToken :: Maybe Text
- httpStatus :: Int
- newGetWorkflowRunsResponse :: Int -> GetWorkflowRunsResponse
- getWorkflowRunsResponse_runs :: Lens' GetWorkflowRunsResponse (Maybe (NonEmpty WorkflowRun))
- getWorkflowRunsResponse_nextToken :: Lens' GetWorkflowRunsResponse (Maybe Text)
- getWorkflowRunsResponse_httpStatus :: Lens' GetWorkflowRunsResponse Int
Creating a Request
data GetWorkflowRuns Source #
See: newGetWorkflowRuns
smart constructor.
GetWorkflowRuns' | |
|
Instances
Create a value of GetWorkflowRuns
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:includeGraph:GetWorkflowRuns'
, getWorkflowRuns_includeGraph
- Specifies whether to include the workflow graph in response or not.
$sel:nextToken:GetWorkflowRuns'
, getWorkflowRuns_nextToken
- The maximum size of the response.
$sel:maxResults:GetWorkflowRuns'
, getWorkflowRuns_maxResults
- The maximum number of workflow runs to be included in the response.
$sel:name:GetWorkflowRuns'
, getWorkflowRuns_name
- Name of the workflow whose metadata of runs should be returned.
Request Lenses
getWorkflowRuns_includeGraph :: Lens' GetWorkflowRuns (Maybe Bool) Source #
Specifies whether to include the workflow graph in response or not.
getWorkflowRuns_nextToken :: Lens' GetWorkflowRuns (Maybe Text) Source #
The maximum size of the response.
getWorkflowRuns_maxResults :: Lens' GetWorkflowRuns (Maybe Natural) Source #
The maximum number of workflow runs to be included in the response.
getWorkflowRuns_name :: Lens' GetWorkflowRuns Text Source #
Name of the workflow whose metadata of runs should be returned.
Destructuring the Response
data GetWorkflowRunsResponse Source #
See: newGetWorkflowRunsResponse
smart constructor.
GetWorkflowRunsResponse' | |
|
Instances
newGetWorkflowRunsResponse Source #
Create a value of GetWorkflowRunsResponse
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:runs:GetWorkflowRunsResponse'
, getWorkflowRunsResponse_runs
- A list of workflow run metadata objects.
$sel:nextToken:GetWorkflowRuns'
, getWorkflowRunsResponse_nextToken
- A continuation token, if not all requested workflow runs have been
returned.
$sel:httpStatus:GetWorkflowRunsResponse'
, getWorkflowRunsResponse_httpStatus
- The response's http status code.
Response Lenses
getWorkflowRunsResponse_runs :: Lens' GetWorkflowRunsResponse (Maybe (NonEmpty WorkflowRun)) Source #
A list of workflow run metadata objects.
getWorkflowRunsResponse_nextToken :: Lens' GetWorkflowRunsResponse (Maybe Text) Source #
A continuation token, if not all requested workflow runs have been returned.
getWorkflowRunsResponse_httpStatus :: Lens' GetWorkflowRunsResponse Int Source #
The response's http status code.