Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

Get a list of key phrase detection jobs that you have submitted.

This operation returns paginated results.

Creating a Request

data ListKeyPhrasesDetectionJobs

See: newListKeyPhrasesDetectionJobs smart constructor.

Constructors

ListKeyPhrasesDetectionJobs'

Fields

• filter' :: Maybe KeyPhrasesDetectionJobFilter

  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 ListKeyPhrasesDetectionJobs

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

Methods

toJSON :: ListKeyPhrasesDetectionJobs -> Value

toEncoding :: ListKeyPhrasesDetectionJobs -> Encoding

toJSONList :: [ListKeyPhrasesDetectionJobs] -> Value

toEncodingList :: [ListKeyPhrasesDetectionJobs] -> Encoding

ToHeaders ListKeyPhrasesDetectionJobs

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

Methods

toHeaders :: ListKeyPhrasesDetectionJobs -> [Header]

ToPath ListKeyPhrasesDetectionJobs

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

Methods

toPath :: ListKeyPhrasesDetectionJobs -> ByteString

ToQuery ListKeyPhrasesDetectionJobs

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

Methods

toQuery :: ListKeyPhrasesDetectionJobs -> QueryString

AWSPager ListKeyPhrasesDetectionJobs

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

Methods

page :: ListKeyPhrasesDetectionJobs -> AWSResponse ListKeyPhrasesDetectionJobs -> Maybe ListKeyPhrasesDetectionJobs

AWSRequest ListKeyPhrasesDetectionJobs

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

Associated Types

type AWSResponse ListKeyPhrasesDetectionJobs

Methods

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

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

Generic ListKeyPhrasesDetectionJobs

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

Associated Types

type Rep ListKeyPhrasesDetectionJobs :: Type -> Type

Methods

from :: ListKeyPhrasesDetectionJobs -> Rep ListKeyPhrasesDetectionJobs x

to :: Rep ListKeyPhrasesDetectionJobs x -> ListKeyPhrasesDetectionJobs

Read ListKeyPhrasesDetectionJobs

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

Methods

readsPrec :: Int -> ReadS ListKeyPhrasesDetectionJobs

readList :: ReadS [ListKeyPhrasesDetectionJobs]

readPrec :: ReadPrec ListKeyPhrasesDetectionJobs

readListPrec :: ReadPrec [ListKeyPhrasesDetectionJobs]

Show ListKeyPhrasesDetectionJobs

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

Methods

showsPrec :: Int -> ListKeyPhrasesDetectionJobs -> ShowS

show :: ListKeyPhrasesDetectionJobs -> String

showList :: [ListKeyPhrasesDetectionJobs] -> ShowS

NFData ListKeyPhrasesDetectionJobs

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

Methods

rnf :: ListKeyPhrasesDetectionJobs -> ()

Eq ListKeyPhrasesDetectionJobs

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

Methods

(==) :: ListKeyPhrasesDetectionJobs -> ListKeyPhrasesDetectionJobs -> Bool

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

Hashable ListKeyPhrasesDetectionJobs

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

Methods

hashWithSalt :: Int -> ListKeyPhrasesDetectionJobs -> Int

hash :: ListKeyPhrasesDetectionJobs -> Int

type AWSResponse ListKeyPhrasesDetectionJobs

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

type AWSResponse ListKeyPhrasesDetectionJobs = ListKeyPhrasesDetectionJobsResponse

type Rep ListKeyPhrasesDetectionJobs

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

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

newListKeyPhrasesDetectionJobs :: ListKeyPhrasesDetectionJobs

Create a value of ListKeyPhrasesDetectionJobs 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':ListKeyPhrasesDetectionJobs', listKeyPhrasesDetectionJobs_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:ListKeyPhrasesDetectionJobs', listKeyPhrasesDetectionJobs_maxResults - The maximum number of results to return in each page. The default is 100.

ListKeyPhrasesDetectionJobs, listKeyPhrasesDetectionJobs_nextToken - Identifies the next page of results to return.

Request Lenses

listKeyPhrasesDetectionJobs_filter :: Lens' ListKeyPhrasesDetectionJobs (Maybe KeyPhrasesDetectionJobFilter)

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.

listKeyPhrasesDetectionJobs_maxResults :: Lens' ListKeyPhrasesDetectionJobs (Maybe Natural)

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

listKeyPhrasesDetectionJobs_nextToken :: Lens' ListKeyPhrasesDetectionJobs (Maybe Text)

Identifies the next page of results to return.

Destructuring the Response

data ListKeyPhrasesDetectionJobsResponse

See: newListKeyPhrasesDetectionJobsResponse smart constructor.

Constructors

ListKeyPhrasesDetectionJobsResponse'

Fields

• keyPhrasesDetectionJobPropertiesList :: Maybe [KeyPhrasesDetectionJobProperties]

  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 ListKeyPhrasesDetectionJobsResponse

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

Associated Types

type Rep ListKeyPhrasesDetectionJobsResponse :: Type -> Type

Methods

from :: ListKeyPhrasesDetectionJobsResponse -> Rep ListKeyPhrasesDetectionJobsResponse x

to :: Rep ListKeyPhrasesDetectionJobsResponse x -> ListKeyPhrasesDetectionJobsResponse

Read ListKeyPhrasesDetectionJobsResponse

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

Methods

readsPrec :: Int -> ReadS ListKeyPhrasesDetectionJobsResponse

readList :: ReadS [ListKeyPhrasesDetectionJobsResponse]

readPrec :: ReadPrec ListKeyPhrasesDetectionJobsResponse

readListPrec :: ReadPrec [ListKeyPhrasesDetectionJobsResponse]

Show ListKeyPhrasesDetectionJobsResponse

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

Methods

showsPrec :: Int -> ListKeyPhrasesDetectionJobsResponse -> ShowS

show :: ListKeyPhrasesDetectionJobsResponse -> String

showList :: [ListKeyPhrasesDetectionJobsResponse] -> ShowS

NFData ListKeyPhrasesDetectionJobsResponse

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

Methods

rnf :: ListKeyPhrasesDetectionJobsResponse -> ()

Eq ListKeyPhrasesDetectionJobsResponse

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

Methods

(==) :: ListKeyPhrasesDetectionJobsResponse -> ListKeyPhrasesDetectionJobsResponse -> Bool

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

type Rep ListKeyPhrasesDetectionJobsResponse

Defined in Amazonka.Comprehend.ListKeyPhrasesDetectionJobs

type Rep ListKeyPhrasesDetectionJobsResponse = D1 ('MetaData "ListKeyPhrasesDetectionJobsResponse" "Amazonka.Comprehend.ListKeyPhrasesDetectionJobs" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "ListKeyPhrasesDetectionJobsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyPhrasesDetectionJobPropertiesList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [KeyPhrasesDetectionJobProperties])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListKeyPhrasesDetectionJobsResponse

Arguments

:: Int

$sel:httpStatus:ListKeyPhrasesDetectionJobsResponse'

-> ListKeyPhrasesDetectionJobsResponse

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

ListKeyPhrasesDetectionJobs, listKeyPhrasesDetectionJobsResponse_nextToken - Identifies the next page of results to return.

$sel:httpStatus:ListKeyPhrasesDetectionJobsResponse', listKeyPhrasesDetectionJobsResponse_httpStatus - The response's http status code.

Response Lenses

listKeyPhrasesDetectionJobsResponse_keyPhrasesDetectionJobPropertiesList :: Lens' ListKeyPhrasesDetectionJobsResponse (Maybe [KeyPhrasesDetectionJobProperties])

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

listKeyPhrasesDetectionJobsResponse_nextToken :: Lens' ListKeyPhrasesDetectionJobsResponse (Maybe Text)

Identifies the next page of results to return.

listKeyPhrasesDetectionJobsResponse_httpStatus :: Lens' ListKeyPhrasesDetectionJobsResponse Int

The response's http status code.