Amazonka.Comprehend.ListEntitiesDetectionJobs

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

This operation returns paginated results.

Creating a Request

data ListEntitiesDetectionJobs

See: newListEntitiesDetectionJobs smart constructor.

Constructors

ListEntitiesDetectionJobs'

Fields

• filter' :: Maybe EntitiesDetectionJobFilter

  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.

• maxResults :: Maybe Natural

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

• nextToken :: Maybe Text

  Identifies the next page of results to return.

Instances

ToJSON ListEntitiesDetectionJobs

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Methods

toJSON :: ListEntitiesDetectionJobs -> Value

toEncoding :: ListEntitiesDetectionJobs -> Encoding

toJSONList :: [ListEntitiesDetectionJobs] -> Value

toEncodingList :: [ListEntitiesDetectionJobs] -> Encoding

ToHeaders ListEntitiesDetectionJobs

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Methods

toHeaders :: ListEntitiesDetectionJobs -> [Header]

ToPath ListEntitiesDetectionJobs

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Methods

toPath :: ListEntitiesDetectionJobs -> ByteString

ToQuery ListEntitiesDetectionJobs

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Methods

toQuery :: ListEntitiesDetectionJobs -> QueryString

AWSPager ListEntitiesDetectionJobs

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Methods

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

AWSRequest ListEntitiesDetectionJobs

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Associated Types

type AWSResponse ListEntitiesDetectionJobs

Methods

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

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

Generic ListEntitiesDetectionJobs

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Associated Types

type Rep ListEntitiesDetectionJobs :: Type -> Type

Methods

from :: ListEntitiesDetectionJobs -> Rep ListEntitiesDetectionJobs x

to :: Rep ListEntitiesDetectionJobs x -> ListEntitiesDetectionJobs

Read ListEntitiesDetectionJobs

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Methods

readsPrec :: Int -> ReadS ListEntitiesDetectionJobs

readList :: ReadS [ListEntitiesDetectionJobs]

readPrec :: ReadPrec ListEntitiesDetectionJobs

readListPrec :: ReadPrec [ListEntitiesDetectionJobs]

Show ListEntitiesDetectionJobs

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Methods

showsPrec :: Int -> ListEntitiesDetectionJobs -> ShowS

show :: ListEntitiesDetectionJobs -> String

showList :: [ListEntitiesDetectionJobs] -> ShowS

NFData ListEntitiesDetectionJobs

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Methods

rnf :: ListEntitiesDetectionJobs -> ()

Eq ListEntitiesDetectionJobs

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Methods

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

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

Hashable ListEntitiesDetectionJobs

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Methods

hashWithSalt :: Int -> ListEntitiesDetectionJobs -> Int

hash :: ListEntitiesDetectionJobs -> Int

type AWSResponse ListEntitiesDetectionJobs

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

type AWSResponse ListEntitiesDetectionJobs = ListEntitiesDetectionJobsResponse

type Rep ListEntitiesDetectionJobs

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

type Rep ListEntitiesDetectionJobs = D1 ('MetaData "ListEntitiesDetectionJobs" "Amazonka.Comprehend.ListEntitiesDetectionJobs" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "ListEntitiesDetectionJobs'" 'PrefixI 'True) (S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EntitiesDetectionJobFilter)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListEntitiesDetectionJobs :: ListEntitiesDetectionJobs

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: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.

ListEntitiesDetectionJobs, listEntitiesDetectionJobs_nextToken - Identifies the next page of results to return.

Request Lenses

listEntitiesDetectionJobs_filter :: Lens' ListEntitiesDetectionJobs (Maybe EntitiesDetectionJobFilter)

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)

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

listEntitiesDetectionJobs_nextToken :: Lens' ListEntitiesDetectionJobs (Maybe Text)

Identifies the next page of results to return.

Destructuring the Response

data ListEntitiesDetectionJobsResponse

See: newListEntitiesDetectionJobsResponse smart constructor.

Constructors

ListEntitiesDetectionJobsResponse'

Fields

• entitiesDetectionJobPropertiesList :: Maybe [EntitiesDetectionJobProperties]

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

• nextToken :: Maybe Text

  Identifies the next page of results to return.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListEntitiesDetectionJobsResponse

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Associated Types

type Rep ListEntitiesDetectionJobsResponse :: Type -> Type

Methods

from :: ListEntitiesDetectionJobsResponse -> Rep ListEntitiesDetectionJobsResponse x

to :: Rep ListEntitiesDetectionJobsResponse x -> ListEntitiesDetectionJobsResponse

Read ListEntitiesDetectionJobsResponse

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Methods

readsPrec :: Int -> ReadS ListEntitiesDetectionJobsResponse

readList :: ReadS [ListEntitiesDetectionJobsResponse]

readPrec :: ReadPrec ListEntitiesDetectionJobsResponse

readListPrec :: ReadPrec [ListEntitiesDetectionJobsResponse]

Show ListEntitiesDetectionJobsResponse

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Methods

showsPrec :: Int -> ListEntitiesDetectionJobsResponse -> ShowS

show :: ListEntitiesDetectionJobsResponse -> String

showList :: [ListEntitiesDetectionJobsResponse] -> ShowS

NFData ListEntitiesDetectionJobsResponse

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Methods

rnf :: ListEntitiesDetectionJobsResponse -> ()

Eq ListEntitiesDetectionJobsResponse

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

Methods

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

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

type Rep ListEntitiesDetectionJobsResponse

Defined in Amazonka.Comprehend.ListEntitiesDetectionJobs

type Rep ListEntitiesDetectionJobsResponse = D1 ('MetaData "ListEntitiesDetectionJobsResponse" "Amazonka.Comprehend.ListEntitiesDetectionJobs" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" '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

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.

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])

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

listEntitiesDetectionJobsResponse_nextToken :: Lens' ListEntitiesDetectionJobsResponse (Maybe Text)

Identifies the next page of results to return.

listEntitiesDetectionJobsResponse_httpStatus :: Lens' ListEntitiesDetectionJobsResponse Int

The response's http status code.