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

Amazonka.DataBrew.ListJobs

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists all of the DataBrew jobs that are defined.

This operation returns paginated results.

Synopsis

data ListJobs = ListJobs' {
- datasetName :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- projectName :: Maybe Text
}
newListJobs :: ListJobs
listJobs_datasetName :: Lens' ListJobs (Maybe Text)
listJobs_maxResults :: Lens' ListJobs (Maybe Natural)
listJobs_nextToken :: Lens' ListJobs (Maybe Text)
listJobs_projectName :: Lens' ListJobs (Maybe Text)
data ListJobsResponse = ListJobsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- jobs :: [Job]
}
newListJobsResponse :: Int -> ListJobsResponse
listJobsResponse_nextToken :: Lens' ListJobsResponse (Maybe Text)
listJobsResponse_httpStatus :: Lens' ListJobsResponse Int
listJobsResponse_jobs :: Lens' ListJobsResponse [Job]

Creating a Request

data ListJobs Source #

See: newListJobs smart constructor.

Constructors

ListJobs'

Fields

datasetName :: Maybe Text
The name of a dataset. Using this parameter indicates to return only those jobs that act on the specified dataset.
maxResults :: Maybe Natural
The maximum number of results to return in this request.
nextToken :: Maybe Text
A token generated by DataBrew that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the NextToken value from the response object of the previous page call.
projectName :: Maybe Text
The name of a project. Using this parameter indicates to return only those jobs that are associated with the specified project.

Instances

Instances details

ToHeaders ListJobs Source #
Instance details Defined in Amazonka.DataBrew.ListJobs Methods toHeaders :: ListJobs -> [Header] #
ToPath ListJobs Source #
Instance details Defined in Amazonka.DataBrew.ListJobs Methods toPath :: ListJobs -> ByteString #
ToQuery ListJobs Source #
Instance details Defined in Amazonka.DataBrew.ListJobs Methods toQuery :: ListJobs -> QueryString #
AWSPager ListJobs Source #
Instance details Defined in Amazonka.DataBrew.ListJobs Methods page :: ListJobs -> AWSResponse ListJobs -> Maybe ListJobs #
AWSRequest ListJobs Source #
Instance details Defined in Amazonka.DataBrew.ListJobs Associated Types type AWSResponse ListJobs # Methods request :: (Service -> Service) -> ListJobs -> Request ListJobs # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListJobs -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListJobs))) #
Generic ListJobs Source #
Instance details Defined in Amazonka.DataBrew.ListJobs Associated Types type Rep ListJobs :: Type -> Type # Methods from :: ListJobs -> Rep ListJobs x # to :: Rep ListJobs x -> ListJobs #
Read ListJobs Source #
Instance details Defined in Amazonka.DataBrew.ListJobs Methods readsPrec :: Int -> ReadS ListJobs # readList :: ReadS [ListJobs] # readPrec :: ReadPrec ListJobs # readListPrec :: ReadPrec [ListJobs] #
Show ListJobs Source #
Instance details Defined in Amazonka.DataBrew.ListJobs Methods showsPrec :: Int -> ListJobs -> ShowS # show :: ListJobs -> String # showList :: [ListJobs] -> ShowS #
NFData ListJobs Source #
Instance details Defined in Amazonka.DataBrew.ListJobs Methods rnf :: ListJobs -> () #
Eq ListJobs Source #
Instance details Defined in Amazonka.DataBrew.ListJobs Methods (==) :: ListJobs -> ListJobs -> Bool # (/=) :: ListJobs -> ListJobs -> Bool #
Hashable ListJobs Source #
Instance details Defined in Amazonka.DataBrew.ListJobs Methods hashWithSalt :: Int -> ListJobs -> Int # hash :: ListJobs -> Int #
type AWSResponse ListJobs Source #
Instance details Defined in Amazonka.DataBrew.ListJobs type AWSResponse ListJobs = ListJobsResponse
type Rep ListJobs Source #
Instance details Defined in Amazonka.DataBrew.ListJobs type Rep ListJobs = D1 ('MetaData "ListJobs" "Amazonka.DataBrew.ListJobs" "amazonka-databrew-2.0-GJMXoRzRb387Yq6XNY29RM" 'False) (C1 ('MetaCons "ListJobs'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "datasetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "projectName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListJobs :: ListJobs Source #

Create a value of ListJobs 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:

ListJobs, listJobs_datasetName - The name of a dataset. Using this parameter indicates to return only those jobs that act on the specified dataset.

$sel:maxResults:ListJobs', listJobs_maxResults - The maximum number of results to return in this request.

ListJobs, listJobs_nextToken - A token generated by DataBrew that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the NextToken value from the response object of the previous page call.

ListJobs, listJobs_projectName - The name of a project. Using this parameter indicates to return only those jobs that are associated with the specified project.

Request Lenses

listJobs_datasetName :: Lens' ListJobs (Maybe Text) Source #

The name of a dataset. Using this parameter indicates to return only those jobs that act on the specified dataset.

listJobs_maxResults :: Lens' ListJobs (Maybe Natural) Source #

The maximum number of results to return in this request.

listJobs_nextToken :: Lens' ListJobs (Maybe Text) Source #

A token generated by DataBrew that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the NextToken value from the response object of the previous page call.

listJobs_projectName :: Lens' ListJobs (Maybe Text) Source #

The name of a project. Using this parameter indicates to return only those jobs that are associated with the specified project.

Destructuring the Response

data ListJobsResponse Source #

See: newListJobsResponse smart constructor.

Constructors

ListJobsResponse'
Fields nextToken :: Maybe Text A token that you can use in a subsequent call to retrieve the next set of results. httpStatus :: Int The response's http status code. jobs :: [Job] A list of jobs that are defined.

Instances

Instances details

Generic ListJobsResponse Source #
Instance details Defined in Amazonka.DataBrew.ListJobs Associated Types type Rep ListJobsResponse :: Type -> Type # Methods from :: ListJobsResponse -> Rep ListJobsResponse x # to :: Rep ListJobsResponse x -> ListJobsResponse #
Read ListJobsResponse Source #
Instance details Defined in Amazonka.DataBrew.ListJobs Methods readsPrec :: Int -> ReadS ListJobsResponse # readList :: ReadS [ListJobsResponse] # readPrec :: ReadPrec ListJobsResponse # readListPrec :: ReadPrec [ListJobsResponse] #
Show ListJobsResponse Source #
Instance details Defined in Amazonka.DataBrew.ListJobs Methods showsPrec :: Int -> ListJobsResponse -> ShowS # show :: ListJobsResponse -> String # showList :: [ListJobsResponse] -> ShowS #
NFData ListJobsResponse Source #
Instance details Defined in Amazonka.DataBrew.ListJobs Methods rnf :: ListJobsResponse -> () #
Eq ListJobsResponse Source #
Instance details Defined in Amazonka.DataBrew.ListJobs Methods (==) :: ListJobsResponse -> ListJobsResponse -> Bool # (/=) :: ListJobsResponse -> ListJobsResponse -> Bool #
type Rep ListJobsResponse Source #
Instance details Defined in Amazonka.DataBrew.ListJobs type Rep ListJobsResponse = D1 ('MetaData "ListJobsResponse" "Amazonka.DataBrew.ListJobs" "amazonka-databrew-2.0-GJMXoRzRb387Yq6XNY29RM" 'False) (C1 ('MetaCons "ListJobsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "jobs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Job]))))

newListJobsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListJobsResponse'`
-> ListJobsResponse

Create a value of ListJobsResponse 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:

ListJobs, listJobsResponse_nextToken - A token that you can use in a subsequent call to retrieve the next set of results.

$sel:httpStatus:ListJobsResponse', listJobsResponse_httpStatus - The response's http status code.

$sel:jobs:ListJobsResponse', listJobsResponse_jobs - A list of jobs that are defined.

Response Lenses

listJobsResponse_nextToken :: Lens' ListJobsResponse (Maybe Text) Source #

A token that you can use in a subsequent call to retrieve the next set of results.

listJobsResponse_httpStatus :: Lens' ListJobsResponse Int Source #

The response's http status code.

listJobsResponse_jobs :: Lens' ListJobsResponse [Job] Source #

A list of jobs that are defined.