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.Glue.ListJobs

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the names of all job resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.

This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.

Synopsis

data ListJobs = ListJobs' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- tags :: Maybe (HashMap Text Text)
}
newListJobs :: ListJobs
listJobs_maxResults :: Lens' ListJobs (Maybe Natural)
listJobs_nextToken :: Lens' ListJobs (Maybe Text)
listJobs_tags :: Lens' ListJobs (Maybe (HashMap Text Text))
data ListJobsResponse = ListJobsResponse' {
- jobNames :: Maybe [Text]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListJobsResponse :: Int -> ListJobsResponse
listJobsResponse_jobNames :: Lens' ListJobsResponse (Maybe [Text])
listJobsResponse_nextToken :: Lens' ListJobsResponse (Maybe Text)
listJobsResponse_httpStatus :: Lens' ListJobsResponse Int

Creating a Request

data ListJobs Source #

See: newListJobs smart constructor.

Constructors

ListJobs'
Fields maxResults :: Maybe Natural The maximum size of a list to return. nextToken :: Maybe Text A continuation token, if this is a continuation request. tags :: Maybe (HashMap Text Text) Specifies to return only these tagged resources.

Instances

Instances details

ToJSON ListJobs Source #
Instance details Defined in Amazonka.Glue.ListJobs Methods toJSON :: ListJobs -> Value # toEncoding :: ListJobs -> Encoding # toJSONList :: [ListJobs] -> Value # toEncodingList :: [ListJobs] -> Encoding #
ToHeaders ListJobs Source #
Instance details Defined in Amazonka.Glue.ListJobs Methods toHeaders :: ListJobs -> [Header] #
ToPath ListJobs Source #
Instance details Defined in Amazonka.Glue.ListJobs Methods toPath :: ListJobs -> ByteString #
ToQuery ListJobs Source #
Instance details Defined in Amazonka.Glue.ListJobs Methods toQuery :: ListJobs -> QueryString #
AWSRequest ListJobs Source #
Instance details Defined in Amazonka.Glue.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.Glue.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.Glue.ListJobs Methods readsPrec :: Int -> ReadS ListJobs # readList :: ReadS [ListJobs] # readPrec :: ReadPrec ListJobs # readListPrec :: ReadPrec [ListJobs] #
Show ListJobs Source #
Instance details Defined in Amazonka.Glue.ListJobs Methods showsPrec :: Int -> ListJobs -> ShowS # show :: ListJobs -> String # showList :: [ListJobs] -> ShowS #
NFData ListJobs Source #
Instance details Defined in Amazonka.Glue.ListJobs Methods rnf :: ListJobs -> () #
Eq ListJobs Source #
Instance details Defined in Amazonka.Glue.ListJobs Methods (==) :: ListJobs -> ListJobs -> Bool # (/=) :: ListJobs -> ListJobs -> Bool #
Hashable ListJobs Source #
Instance details Defined in Amazonka.Glue.ListJobs Methods hashWithSalt :: Int -> ListJobs -> Int # hash :: ListJobs -> Int #
type AWSResponse ListJobs Source #
Instance details Defined in Amazonka.Glue.ListJobs type AWSResponse ListJobs = ListJobsResponse
type Rep ListJobs Source #
Instance details Defined in Amazonka.Glue.ListJobs type Rep ListJobs = D1 ('MetaData "ListJobs" "Amazonka.Glue.ListJobs" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "ListJobs'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text 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:

$sel:maxResults:ListJobs', listJobs_maxResults - The maximum size of a list to return.

ListJobs, listJobs_nextToken - A continuation token, if this is a continuation request.

$sel:tags:ListJobs', listJobs_tags - Specifies to return only these tagged resources.

Request Lenses

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

The maximum size of a list to return.

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

A continuation token, if this is a continuation request.

listJobs_tags :: Lens' ListJobs (Maybe (HashMap Text Text)) Source #

Specifies to return only these tagged resources.

Destructuring the Response

data ListJobsResponse Source #

See: newListJobsResponse smart constructor.

Constructors

ListJobsResponse'
Fields jobNames :: Maybe [Text] The names of all jobs in the account, or the jobs with the specified tags. nextToken :: Maybe Text A continuation token, if the returned list does not contain the last metric available. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListJobsResponse Source #
Instance details Defined in Amazonka.Glue.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.Glue.ListJobs Methods readsPrec :: Int -> ReadS ListJobsResponse # readList :: ReadS [ListJobsResponse] # readPrec :: ReadPrec ListJobsResponse # readListPrec :: ReadPrec [ListJobsResponse] #
Show ListJobsResponse Source #
Instance details Defined in Amazonka.Glue.ListJobs Methods showsPrec :: Int -> ListJobsResponse -> ShowS # show :: ListJobsResponse -> String # showList :: [ListJobsResponse] -> ShowS #
NFData ListJobsResponse Source #
Instance details Defined in Amazonka.Glue.ListJobs Methods rnf :: ListJobsResponse -> () #
Eq ListJobsResponse Source #
Instance details Defined in Amazonka.Glue.ListJobs Methods (==) :: ListJobsResponse -> ListJobsResponse -> Bool # (/=) :: ListJobsResponse -> ListJobsResponse -> Bool #
type Rep ListJobsResponse Source #
Instance details Defined in Amazonka.Glue.ListJobs type Rep ListJobsResponse = D1 ('MetaData "ListJobsResponse" "Amazonka.Glue.ListJobs" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "ListJobsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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:

$sel:jobNames:ListJobsResponse', listJobsResponse_jobNames - The names of all jobs in the account, or the jobs with the specified tags.

ListJobs, listJobsResponse_nextToken - A continuation token, if the returned list does not contain the last metric available.

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

Response Lenses

listJobsResponse_jobNames :: Lens' ListJobsResponse (Maybe [Text]) Source #

The names of all jobs in the account, or the jobs with the specified tags.

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

A continuation token, if the returned list does not contain the last metric available.

listJobsResponse_httpStatus :: Lens' ListJobsResponse Int Source #

The response's http status code.