Amazonka.Glue.GetWorkflowRuns

Retrieves metadata for all runs of a given workflow.

Creating a Request

data GetWorkflowRuns

See: newGetWorkflowRuns smart constructor.

Constructors

GetWorkflowRuns'

Fields

• includeGraph :: Maybe Bool

  Specifies whether to include the workflow graph in response or not.

• maxResults :: Maybe Natural

  The maximum number of workflow runs to be included in the response.

• nextToken :: Maybe Text

  The maximum size of the response.

• name :: Text

  Name of the workflow whose metadata of runs should be returned.

Instances

ToJSON GetWorkflowRuns

Defined in Amazonka.Glue.GetWorkflowRuns

Methods

toJSON :: GetWorkflowRuns -> Value

toEncoding :: GetWorkflowRuns -> Encoding

toJSONList :: [GetWorkflowRuns] -> Value

toEncodingList :: [GetWorkflowRuns] -> Encoding

ToHeaders GetWorkflowRuns

Defined in Amazonka.Glue.GetWorkflowRuns

Methods

toHeaders :: GetWorkflowRuns -> [Header]

ToPath GetWorkflowRuns

Defined in Amazonka.Glue.GetWorkflowRuns

Methods

toPath :: GetWorkflowRuns -> ByteString

ToQuery GetWorkflowRuns

Defined in Amazonka.Glue.GetWorkflowRuns

Methods

toQuery :: GetWorkflowRuns -> QueryString

AWSRequest GetWorkflowRuns

Defined in Amazonka.Glue.GetWorkflowRuns

Associated Types

type AWSResponse GetWorkflowRuns

Methods

request :: (Service -> Service) -> GetWorkflowRuns -> Request GetWorkflowRuns

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetWorkflowRuns -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetWorkflowRuns)))

Generic GetWorkflowRuns

Defined in Amazonka.Glue.GetWorkflowRuns

Associated Types

type Rep GetWorkflowRuns :: Type -> Type

Methods

from :: GetWorkflowRuns -> Rep GetWorkflowRuns x

to :: Rep GetWorkflowRuns x -> GetWorkflowRuns

Read GetWorkflowRuns

Defined in Amazonka.Glue.GetWorkflowRuns

Methods

readsPrec :: Int -> ReadS GetWorkflowRuns

readList :: ReadS [GetWorkflowRuns]

readPrec :: ReadPrec GetWorkflowRuns

readListPrec :: ReadPrec [GetWorkflowRuns]

Show GetWorkflowRuns

Defined in Amazonka.Glue.GetWorkflowRuns

Methods

showsPrec :: Int -> GetWorkflowRuns -> ShowS

show :: GetWorkflowRuns -> String

showList :: [GetWorkflowRuns] -> ShowS

NFData GetWorkflowRuns

Defined in Amazonka.Glue.GetWorkflowRuns

Methods

rnf :: GetWorkflowRuns -> ()

Eq GetWorkflowRuns

Defined in Amazonka.Glue.GetWorkflowRuns

Methods

(==) :: GetWorkflowRuns -> GetWorkflowRuns -> Bool

(/=) :: GetWorkflowRuns -> GetWorkflowRuns -> Bool

Hashable GetWorkflowRuns

Defined in Amazonka.Glue.GetWorkflowRuns

Methods

hashWithSalt :: Int -> GetWorkflowRuns -> Int

hash :: GetWorkflowRuns -> Int

type AWSResponse GetWorkflowRuns

Defined in Amazonka.Glue.GetWorkflowRuns

type AWSResponse GetWorkflowRuns = GetWorkflowRunsResponse

type Rep GetWorkflowRuns

Defined in Amazonka.Glue.GetWorkflowRuns

type Rep GetWorkflowRuns = D1 ('MetaData "GetWorkflowRuns" "Amazonka.Glue.GetWorkflowRuns" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "GetWorkflowRuns'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "includeGraph") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetWorkflowRuns

Arguments

:: Text

GetWorkflowRuns

-> GetWorkflowRuns

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:maxResults:GetWorkflowRuns', getWorkflowRuns_maxResults - The maximum number of workflow runs to be included in the response.

GetWorkflowRuns, getWorkflowRuns_nextToken - The maximum size of the response.

GetWorkflowRuns, getWorkflowRuns_name - Name of the workflow whose metadata of runs should be returned.

Request Lenses

getWorkflowRuns_includeGraph :: Lens' GetWorkflowRuns (Maybe Bool)

Specifies whether to include the workflow graph in response or not.

getWorkflowRuns_maxResults :: Lens' GetWorkflowRuns (Maybe Natural)

The maximum number of workflow runs to be included in the response.

getWorkflowRuns_nextToken :: Lens' GetWorkflowRuns (Maybe Text)

The maximum size of the response.

getWorkflowRuns_name :: Lens' GetWorkflowRuns Text

Name of the workflow whose metadata of runs should be returned.

Destructuring the Response

data GetWorkflowRunsResponse

See: newGetWorkflowRunsResponse smart constructor.

Constructors

GetWorkflowRunsResponse'

Fields

• nextToken :: Maybe Text

  A continuation token, if not all requested workflow runs have been returned.

• runs :: Maybe (NonEmpty WorkflowRun)

  A list of workflow run metadata objects.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetWorkflowRunsResponse

Defined in Amazonka.Glue.GetWorkflowRuns

Associated Types

type Rep GetWorkflowRunsResponse :: Type -> Type

Methods

from :: GetWorkflowRunsResponse -> Rep GetWorkflowRunsResponse x

to :: Rep GetWorkflowRunsResponse x -> GetWorkflowRunsResponse

Read GetWorkflowRunsResponse

Defined in Amazonka.Glue.GetWorkflowRuns

Methods

readsPrec :: Int -> ReadS GetWorkflowRunsResponse

readList :: ReadS [GetWorkflowRunsResponse]

readPrec :: ReadPrec GetWorkflowRunsResponse

readListPrec :: ReadPrec [GetWorkflowRunsResponse]

Show GetWorkflowRunsResponse

Defined in Amazonka.Glue.GetWorkflowRuns

Methods

showsPrec :: Int -> GetWorkflowRunsResponse -> ShowS

show :: GetWorkflowRunsResponse -> String

showList :: [GetWorkflowRunsResponse] -> ShowS

NFData GetWorkflowRunsResponse

Defined in Amazonka.Glue.GetWorkflowRuns

Methods

rnf :: GetWorkflowRunsResponse -> ()

Eq GetWorkflowRunsResponse

Defined in Amazonka.Glue.GetWorkflowRuns

Methods

(==) :: GetWorkflowRunsResponse -> GetWorkflowRunsResponse -> Bool

(/=) :: GetWorkflowRunsResponse -> GetWorkflowRunsResponse -> Bool

type Rep GetWorkflowRunsResponse

Defined in Amazonka.Glue.GetWorkflowRuns

type Rep GetWorkflowRunsResponse = D1 ('MetaData "GetWorkflowRunsResponse" "Amazonka.Glue.GetWorkflowRuns" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "GetWorkflowRunsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "runs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty WorkflowRun))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetWorkflowRunsResponse

Arguments

:: Int

$sel:httpStatus:GetWorkflowRunsResponse'

-> GetWorkflowRunsResponse

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:

GetWorkflowRuns, getWorkflowRunsResponse_nextToken - A continuation token, if not all requested workflow runs have been returned.

$sel:runs:GetWorkflowRunsResponse', getWorkflowRunsResponse_runs - A list of workflow run metadata objects.

$sel:httpStatus:GetWorkflowRunsResponse', getWorkflowRunsResponse_httpStatus - The response's http status code.

Response Lenses

getWorkflowRunsResponse_nextToken :: Lens' GetWorkflowRunsResponse (Maybe Text)

A continuation token, if not all requested workflow runs have been returned.

getWorkflowRunsResponse_runs :: Lens' GetWorkflowRunsResponse (Maybe (NonEmpty WorkflowRun))

A list of workflow run metadata objects.

getWorkflowRunsResponse_httpStatus :: Lens' GetWorkflowRunsResponse Int

The response's http status code.