Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

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

This operation returns paginated results.

Creating a Request

data ListPiiEntitiesDetectionJobs

See: newListPiiEntitiesDetectionJobs smart constructor.

Constructors

ListPiiEntitiesDetectionJobs'

Fields

• filter' :: Maybe PiiEntitiesDetectionJobFilter

  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.

• nextToken :: Maybe Text

  Identifies the next page of results to return.

Instances

ToJSON ListPiiEntitiesDetectionJobs

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

Methods

toJSON :: ListPiiEntitiesDetectionJobs -> Value

toEncoding :: ListPiiEntitiesDetectionJobs -> Encoding

toJSONList :: [ListPiiEntitiesDetectionJobs] -> Value

toEncodingList :: [ListPiiEntitiesDetectionJobs] -> Encoding

ToHeaders ListPiiEntitiesDetectionJobs

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

Methods

toHeaders :: ListPiiEntitiesDetectionJobs -> [Header]

ToPath ListPiiEntitiesDetectionJobs

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

Methods

toPath :: ListPiiEntitiesDetectionJobs -> ByteString

ToQuery ListPiiEntitiesDetectionJobs

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

Methods

toQuery :: ListPiiEntitiesDetectionJobs -> QueryString

AWSPager ListPiiEntitiesDetectionJobs

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

Methods

page :: ListPiiEntitiesDetectionJobs -> AWSResponse ListPiiEntitiesDetectionJobs -> Maybe ListPiiEntitiesDetectionJobs

AWSRequest ListPiiEntitiesDetectionJobs

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

Associated Types

type AWSResponse ListPiiEntitiesDetectionJobs

Methods

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

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

Generic ListPiiEntitiesDetectionJobs

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

Associated Types

type Rep ListPiiEntitiesDetectionJobs :: Type -> Type

Methods

from :: ListPiiEntitiesDetectionJobs -> Rep ListPiiEntitiesDetectionJobs x

to :: Rep ListPiiEntitiesDetectionJobs x -> ListPiiEntitiesDetectionJobs

Read ListPiiEntitiesDetectionJobs

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

Methods

readsPrec :: Int -> ReadS ListPiiEntitiesDetectionJobs

readList :: ReadS [ListPiiEntitiesDetectionJobs]

readPrec :: ReadPrec ListPiiEntitiesDetectionJobs

readListPrec :: ReadPrec [ListPiiEntitiesDetectionJobs]

Show ListPiiEntitiesDetectionJobs

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

Methods

showsPrec :: Int -> ListPiiEntitiesDetectionJobs -> ShowS

show :: ListPiiEntitiesDetectionJobs -> String

showList :: [ListPiiEntitiesDetectionJobs] -> ShowS

NFData ListPiiEntitiesDetectionJobs

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

Methods

rnf :: ListPiiEntitiesDetectionJobs -> ()

Eq ListPiiEntitiesDetectionJobs

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

Methods

(==) :: ListPiiEntitiesDetectionJobs -> ListPiiEntitiesDetectionJobs -> Bool

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

Hashable ListPiiEntitiesDetectionJobs

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

Methods

hashWithSalt :: Int -> ListPiiEntitiesDetectionJobs -> Int

hash :: ListPiiEntitiesDetectionJobs -> Int

type AWSResponse ListPiiEntitiesDetectionJobs

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

type AWSResponse ListPiiEntitiesDetectionJobs = ListPiiEntitiesDetectionJobsResponse

type Rep ListPiiEntitiesDetectionJobs

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

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

newListPiiEntitiesDetectionJobs :: ListPiiEntitiesDetectionJobs

Create a value of ListPiiEntitiesDetectionJobs 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':ListPiiEntitiesDetectionJobs', listPiiEntitiesDetectionJobs_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:ListPiiEntitiesDetectionJobs', listPiiEntitiesDetectionJobs_maxResults - The maximum number of results to return in each page.

ListPiiEntitiesDetectionJobs, listPiiEntitiesDetectionJobs_nextToken - Identifies the next page of results to return.

Request Lenses

listPiiEntitiesDetectionJobs_filter :: Lens' ListPiiEntitiesDetectionJobs (Maybe PiiEntitiesDetectionJobFilter)

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.

listPiiEntitiesDetectionJobs_maxResults :: Lens' ListPiiEntitiesDetectionJobs (Maybe Natural)

The maximum number of results to return in each page.

listPiiEntitiesDetectionJobs_nextToken :: Lens' ListPiiEntitiesDetectionJobs (Maybe Text)

Identifies the next page of results to return.

Destructuring the Response

data ListPiiEntitiesDetectionJobsResponse

See: newListPiiEntitiesDetectionJobsResponse smart constructor.

Constructors

ListPiiEntitiesDetectionJobsResponse'

Fields

• nextToken :: Maybe Text

  Identifies the next page of results to return.

• piiEntitiesDetectionJobPropertiesList :: Maybe [PiiEntitiesDetectionJobProperties]

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListPiiEntitiesDetectionJobsResponse

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

Associated Types

type Rep ListPiiEntitiesDetectionJobsResponse :: Type -> Type

Methods

from :: ListPiiEntitiesDetectionJobsResponse -> Rep ListPiiEntitiesDetectionJobsResponse x

to :: Rep ListPiiEntitiesDetectionJobsResponse x -> ListPiiEntitiesDetectionJobsResponse

Read ListPiiEntitiesDetectionJobsResponse

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

Methods

readsPrec :: Int -> ReadS ListPiiEntitiesDetectionJobsResponse

readList :: ReadS [ListPiiEntitiesDetectionJobsResponse]

readPrec :: ReadPrec ListPiiEntitiesDetectionJobsResponse

readListPrec :: ReadPrec [ListPiiEntitiesDetectionJobsResponse]

Show ListPiiEntitiesDetectionJobsResponse

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

Methods

showsPrec :: Int -> ListPiiEntitiesDetectionJobsResponse -> ShowS

show :: ListPiiEntitiesDetectionJobsResponse -> String

showList :: [ListPiiEntitiesDetectionJobsResponse] -> ShowS

NFData ListPiiEntitiesDetectionJobsResponse

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

Methods

rnf :: ListPiiEntitiesDetectionJobsResponse -> ()

Eq ListPiiEntitiesDetectionJobsResponse

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

Methods

(==) :: ListPiiEntitiesDetectionJobsResponse -> ListPiiEntitiesDetectionJobsResponse -> Bool

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

type Rep ListPiiEntitiesDetectionJobsResponse

Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

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

newListPiiEntitiesDetectionJobsResponse

Arguments

:: Int

$sel:httpStatus:ListPiiEntitiesDetectionJobsResponse'

-> ListPiiEntitiesDetectionJobsResponse

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

ListPiiEntitiesDetectionJobs, listPiiEntitiesDetectionJobsResponse_nextToken - Identifies the next page of results to return.

$sel:piiEntitiesDetectionJobPropertiesList:ListPiiEntitiesDetectionJobsResponse', listPiiEntitiesDetectionJobsResponse_piiEntitiesDetectionJobPropertiesList - A list containing the properties of each job that is returned.

$sel:httpStatus:ListPiiEntitiesDetectionJobsResponse', listPiiEntitiesDetectionJobsResponse_httpStatus - The response's http status code.

Response Lenses

listPiiEntitiesDetectionJobsResponse_nextToken :: Lens' ListPiiEntitiesDetectionJobsResponse (Maybe Text)

Identifies the next page of results to return.

listPiiEntitiesDetectionJobsResponse_piiEntitiesDetectionJobPropertiesList :: Lens' ListPiiEntitiesDetectionJobsResponse (Maybe [PiiEntitiesDetectionJobProperties])

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

listPiiEntitiesDetectionJobsResponse_httpStatus :: Lens' ListPiiEntitiesDetectionJobsResponse Int

The response's http status code.