Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Comprehend.ListPiiEntitiesDetectionJobs

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

Creating a Request

data ListPiiEntitiesDetectionJobs Source #

See: newListPiiEntitiesDetectionJobs smart constructor.

Constructors

ListPiiEntitiesDetectionJobs'
Fields nextToken :: Maybe Text Identifies the next page of results to return. 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.

Instances

Instances details

Eq ListPiiEntitiesDetectionJobs Source #
Instance details Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs Methods (==) :: ListPiiEntitiesDetectionJobs -> ListPiiEntitiesDetectionJobs -> Bool # (/=) :: ListPiiEntitiesDetectionJobs -> ListPiiEntitiesDetectionJobs -> Bool #
Read ListPiiEntitiesDetectionJobs Source #
Instance details Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs Methods readsPrec :: Int -> ReadS ListPiiEntitiesDetectionJobs # readList :: ReadS [ListPiiEntitiesDetectionJobs] # readPrec :: ReadPrec ListPiiEntitiesDetectionJobs # readListPrec :: ReadPrec [ListPiiEntitiesDetectionJobs] #
Show ListPiiEntitiesDetectionJobs Source #
Instance details Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs Methods showsPrec :: Int -> ListPiiEntitiesDetectionJobs -> ShowS # show :: ListPiiEntitiesDetectionJobs -> String # showList :: [ListPiiEntitiesDetectionJobs] -> ShowS #
Generic ListPiiEntitiesDetectionJobs Source #
Instance details Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs Associated Types type Rep ListPiiEntitiesDetectionJobs :: Type -> Type # Methods from :: ListPiiEntitiesDetectionJobs -> Rep ListPiiEntitiesDetectionJobs x # to :: Rep ListPiiEntitiesDetectionJobs x -> ListPiiEntitiesDetectionJobs #
NFData ListPiiEntitiesDetectionJobs Source #
Instance details Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs Methods rnf :: ListPiiEntitiesDetectionJobs -> () #
Hashable ListPiiEntitiesDetectionJobs Source #
Instance details Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs Methods hashWithSalt :: Int -> ListPiiEntitiesDetectionJobs -> Int # hash :: ListPiiEntitiesDetectionJobs -> Int #
ToJSON ListPiiEntitiesDetectionJobs Source #
Instance details Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs Methods toJSON :: ListPiiEntitiesDetectionJobs -> Value # toEncoding :: ListPiiEntitiesDetectionJobs -> Encoding # toJSONList :: [ListPiiEntitiesDetectionJobs] -> Value # toEncodingList :: [ListPiiEntitiesDetectionJobs] -> Encoding #
AWSRequest ListPiiEntitiesDetectionJobs Source #
Instance details Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs Associated Types type AWSResponse ListPiiEntitiesDetectionJobs # Methods request :: ListPiiEntitiesDetectionJobs -> Request ListPiiEntitiesDetectionJobs # response :: MonadResource m => Logger -> Service -> Proxy ListPiiEntitiesDetectionJobs -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListPiiEntitiesDetectionJobs))) #
ToHeaders ListPiiEntitiesDetectionJobs Source #
Instance details Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs Methods toHeaders :: ListPiiEntitiesDetectionJobs -> [Header] #
ToPath ListPiiEntitiesDetectionJobs Source #
Instance details Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs Methods toPath :: ListPiiEntitiesDetectionJobs -> ByteString #
ToQuery ListPiiEntitiesDetectionJobs Source #
Instance details Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs Methods toQuery :: ListPiiEntitiesDetectionJobs -> QueryString #
type Rep ListPiiEntitiesDetectionJobs Source #
Instance details Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs type Rep ListPiiEntitiesDetectionJobs = D1 ('MetaData "ListPiiEntitiesDetectionJobs" "Amazonka.Comprehend.ListPiiEntitiesDetectionJobs" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "ListPiiEntitiesDetectionJobs'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PiiEntitiesDetectionJobFilter)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListPiiEntitiesDetectionJobs Source #
Instance details Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs type AWSResponse ListPiiEntitiesDetectionJobs = ListPiiEntitiesDetectionJobsResponse

newListPiiEntitiesDetectionJobs :: ListPiiEntitiesDetectionJobs Source #

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:nextToken:ListPiiEntitiesDetectionJobs', listPiiEntitiesDetectionJobs_nextToken - Identifies the next page of results to return.

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

Request Lenses

listPiiEntitiesDetectionJobs_nextToken :: Lens' ListPiiEntitiesDetectionJobs (Maybe Text) Source #

Identifies the next page of results to return.

listPiiEntitiesDetectionJobs_filter :: Lens' ListPiiEntitiesDetectionJobs (Maybe PiiEntitiesDetectionJobFilter) 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.

listPiiEntitiesDetectionJobs_maxResults :: Lens' ListPiiEntitiesDetectionJobs (Maybe Natural) Source #

The maximum number of results to return in each page.

Destructuring the Response

data ListPiiEntitiesDetectionJobsResponse Source #

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

Instances details

Eq ListPiiEntitiesDetectionJobsResponse Source #
Instance details Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs Methods (==) :: ListPiiEntitiesDetectionJobsResponse -> ListPiiEntitiesDetectionJobsResponse -> Bool # (/=) :: ListPiiEntitiesDetectionJobsResponse -> ListPiiEntitiesDetectionJobsResponse -> Bool #
Read ListPiiEntitiesDetectionJobsResponse Source #
Instance details Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs Methods readsPrec :: Int -> ReadS ListPiiEntitiesDetectionJobsResponse # readList :: ReadS [ListPiiEntitiesDetectionJobsResponse] # readPrec :: ReadPrec ListPiiEntitiesDetectionJobsResponse # readListPrec :: ReadPrec [ListPiiEntitiesDetectionJobsResponse] #
Show ListPiiEntitiesDetectionJobsResponse Source #
Instance details Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs Methods showsPrec :: Int -> ListPiiEntitiesDetectionJobsResponse -> ShowS # show :: ListPiiEntitiesDetectionJobsResponse -> String # showList :: [ListPiiEntitiesDetectionJobsResponse] -> ShowS #
Generic ListPiiEntitiesDetectionJobsResponse Source #
Instance details Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs Associated Types type Rep ListPiiEntitiesDetectionJobsResponse :: Type -> Type # Methods from :: ListPiiEntitiesDetectionJobsResponse -> Rep ListPiiEntitiesDetectionJobsResponse x # to :: Rep ListPiiEntitiesDetectionJobsResponse x -> ListPiiEntitiesDetectionJobsResponse #
NFData ListPiiEntitiesDetectionJobsResponse Source #
Instance details Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs Methods rnf :: ListPiiEntitiesDetectionJobsResponse -> () #
type Rep ListPiiEntitiesDetectionJobsResponse Source #
Instance details Defined in Amazonka.Comprehend.ListPiiEntitiesDetectionJobs type Rep ListPiiEntitiesDetectionJobsResponse = D1 ('MetaData "ListPiiEntitiesDetectionJobsResponse" "Amazonka.Comprehend.ListPiiEntitiesDetectionJobs" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" '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 Source #

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:

$sel:nextToken: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) Source #

Identifies the next page of results to return.

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

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

listPiiEntitiesDetectionJobsResponse_httpStatus :: Lens' ListPiiEntitiesDetectionJobsResponse Int Source #

The response's http status code.