libZSservicesZSamazonka-comprehendZSamazonka-comprehend
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Comprehend.ListEntitiesDetectionJobs

Description

Gets a list of the entity detection jobs that you have submitted.

This operation returns paginated results.

Synopsis

Creating a Request

data ListEntitiesDetectionJobs Source #

See: newListEntitiesDetectionJobs smart constructor.

Constructors

ListEntitiesDetectionJobs' 

Fields

Instances

Instances details
Eq ListEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Methods

(==) :: ListEntitiesDetectionJobs -> ListEntitiesDetectionJobs -> Bool #

(/=) :: ListEntitiesDetectionJobs -> ListEntitiesDetectionJobs -> Bool #

Read ListEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Methods

readsPrec :: Int -> ReadS ListEntitiesDetectionJobs #

readList :: ReadS [ListEntitiesDetectionJobs] #

readPrec :: ReadPrec ListEntitiesDetectionJobs #

readListPrec :: ReadPrec [ListEntitiesDetectionJobs] #

Show ListEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Methods

showsPrec :: Int -> ListEntitiesDetectionJobs -> ShowS #

show :: ListEntitiesDetectionJobs -> String #

showList :: [ListEntitiesDetectionJobs] -> ShowS #

Generic ListEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Associated Types

type Rep ListEntitiesDetectionJobs :: Type -> Type #

Methods

from :: ListEntitiesDetectionJobs -> Rep ListEntitiesDetectionJobs x #

to :: Rep ListEntitiesDetectionJobs x -> ListEntitiesDetectionJobs #

NFData ListEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Methods

rnf :: ListEntitiesDetectionJobs -> () #

Hashable ListEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Methods

hashWithSalt :: Int -> ListEntitiesDetectionJobs -> Int #

hash :: ListEntitiesDetectionJobs -> Int #

ToJSON ListEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Methods

toJSON :: ListEntitiesDetectionJobs -> Value #

toEncoding :: ListEntitiesDetectionJobs -> Encoding #

toJSONList :: [ListEntitiesDetectionJobs] -> Value #

toEncodingList :: [ListEntitiesDetectionJobs] -> Encoding #

AWSPager ListEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Methods

page :: ListEntitiesDetectionJobs -> AWSResponse ListEntitiesDetectionJobs -> Maybe ListEntitiesDetectionJobs #

AWSRequest ListEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Associated Types

type AWSResponse ListEntitiesDetectionJobs #

Methods

request :: ListEntitiesDetectionJobs -> Request ListEntitiesDetectionJobs #

response :: MonadResource m => Logger -> Service -> Proxy ListEntitiesDetectionJobs -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListEntitiesDetectionJobs))) #

ToHeaders ListEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Methods

toHeaders :: ListEntitiesDetectionJobs -> [Header] #

ToPath ListEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Methods

toPath :: ListEntitiesDetectionJobs -> ByteString #

ToQuery ListEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Methods

toQuery :: ListEntitiesDetectionJobs -> QueryString #

type Rep ListEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

type Rep ListEntitiesDetectionJobs = D1 ('MetaData "ListEntitiesDetectionJobs" "Amazonka.Comprehend.ListEntitiesDetectionJobs" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ListEntitiesDetectionJobs'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EntitiesDetectionJobFilter)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListEntitiesDetectionJobs Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

type AWSResponse ListEntitiesDetectionJobs = ListEntitiesDetectionJobsResponse

newListEntitiesDetectionJobs :: ListEntitiesDetectionJobs Source #

Create a value of ListEntitiesDetectionJobs 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:ListEntitiesDetectionJobs', listEntitiesDetectionJobs_nextToken - Identifies the next page of results to return.

$sel:filter':ListEntitiesDetectionJobs', listEntitiesDetectionJobs_filter - Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.

$sel:maxResults:ListEntitiesDetectionJobs', listEntitiesDetectionJobs_maxResults - The maximum number of results to return in each page. The default is 100.

Request Lenses

listEntitiesDetectionJobs_nextToken :: Lens' ListEntitiesDetectionJobs (Maybe Text) Source #

Identifies the next page of results to return.

listEntitiesDetectionJobs_filter :: Lens' ListEntitiesDetectionJobs (Maybe EntitiesDetectionJobFilter) Source #

Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.

listEntitiesDetectionJobs_maxResults :: Lens' ListEntitiesDetectionJobs (Maybe Natural) Source #

The maximum number of results to return in each page. The default is 100.

Destructuring the Response

data ListEntitiesDetectionJobsResponse Source #

See: newListEntitiesDetectionJobsResponse smart constructor.

Constructors

ListEntitiesDetectionJobsResponse' 

Fields

Instances

Instances details
Eq ListEntitiesDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Methods

(==) :: ListEntitiesDetectionJobsResponse -> ListEntitiesDetectionJobsResponse -> Bool #

(/=) :: ListEntitiesDetectionJobsResponse -> ListEntitiesDetectionJobsResponse -> Bool #

Read ListEntitiesDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Methods

readsPrec :: Int -> ReadS ListEntitiesDetectionJobsResponse #

readList :: ReadS [ListEntitiesDetectionJobsResponse] #

readPrec :: ReadPrec ListEntitiesDetectionJobsResponse #

readListPrec :: ReadPrec [ListEntitiesDetectionJobsResponse] #

Show ListEntitiesDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Methods

showsPrec :: Int -> ListEntitiesDetectionJobsResponse -> ShowS #

show :: ListEntitiesDetectionJobsResponse -> String #

showList :: [ListEntitiesDetectionJobsResponse] -> ShowS #

Generic ListEntitiesDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Associated Types

type Rep ListEntitiesDetectionJobsResponse :: Type -> Type #

Methods

from :: ListEntitiesDetectionJobsResponse -> Rep ListEntitiesDetectionJobsResponse x #

to :: Rep ListEntitiesDetectionJobsResponse x -> ListEntitiesDetectionJobsResponse #

NFData ListEntitiesDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Methods

rnf :: ListEntitiesDetectionJobsResponse -> () #

type Rep ListEntitiesDetectionJobsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

type Rep ListEntitiesDetectionJobsResponse = D1 ('MetaData "ListEntitiesDetectionJobsResponse" "Amazonka.Comprehend.ListEntitiesDetectionJobs" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ListEntitiesDetectionJobsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "entitiesDetectionJobPropertiesList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EntitiesDetectionJobProperties])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListEntitiesDetectionJobsResponse Source #

Arguments

:: Int

$sel:httpStatus:ListEntitiesDetectionJobsResponse'

-> ListEntitiesDetectionJobsResponse 

Create a value of ListEntitiesDetectionJobsResponse 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:entitiesDetectionJobPropertiesList:ListEntitiesDetectionJobsResponse', listEntitiesDetectionJobsResponse_entitiesDetectionJobPropertiesList - A list containing the properties of each job that is returned.

$sel:nextToken:ListEntitiesDetectionJobs', listEntitiesDetectionJobsResponse_nextToken - Identifies the next page of results to return.

$sel:httpStatus:ListEntitiesDetectionJobsResponse', listEntitiesDetectionJobsResponse_httpStatus - The response's http status code.

Response Lenses

listEntitiesDetectionJobsResponse_entitiesDetectionJobPropertiesList :: Lens' ListEntitiesDetectionJobsResponse (Maybe [EntitiesDetectionJobProperties]) Source #

A list containing the properties of each job that is returned.

listEntitiesDetectionJobsResponse_nextToken :: Lens' ListEntitiesDetectionJobsResponse (Maybe Text) Source #

Identifies the next page of results to return.

listEntitiesDetectionJobsResponse_httpStatus :: Lens' ListEntitiesDetectionJobsResponse Int Source #

The response's http status code.