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.ComprehendMedical.ListPHIDetectionJobs

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a list of protected health information (PHI) detection jobs that you have submitted.

Synopsis

Creating a Request

data ListPHIDetectionJobs Source #

See: newListPHIDetectionJobs smart constructor.

Constructors

ListPHIDetectionJobs'

Fields

nextToken :: Maybe Text
Identifies the next page of results to return.
filter' :: Maybe ComprehendMedicalAsyncJobFilter
Filters the jobs that are returned. You can filter jobs based on their names, 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.

Instances

Instances details

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

newListPHIDetectionJobs :: ListPHIDetectionJobs Source #

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

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

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

Request Lenses

listPHIDetectionJobs_nextToken :: Lens' ListPHIDetectionJobs (Maybe Text) Source #

Identifies the next page of results to return.

listPHIDetectionJobs_filter :: Lens' ListPHIDetectionJobs (Maybe ComprehendMedicalAsyncJobFilter) Source #

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

listPHIDetectionJobs_maxResults :: Lens' ListPHIDetectionJobs (Maybe Natural) Source #

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

Destructuring the Response

data ListPHIDetectionJobsResponse Source #

See: newListPHIDetectionJobsResponse smart constructor.

Constructors

ListPHIDetectionJobsResponse'
Fields nextToken :: Maybe Text Identifies the next page of results to return. comprehendMedicalAsyncJobPropertiesList :: Maybe [ComprehendMedicalAsyncJobProperties] A list containing the properties of each job returned. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ListPHIDetectionJobsResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.ListPHIDetectionJobs Methods (==) :: ListPHIDetectionJobsResponse -> ListPHIDetectionJobsResponse -> Bool # (/=) :: ListPHIDetectionJobsResponse -> ListPHIDetectionJobsResponse -> Bool #
Read ListPHIDetectionJobsResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.ListPHIDetectionJobs Methods readsPrec :: Int -> ReadS ListPHIDetectionJobsResponse # readList :: ReadS [ListPHIDetectionJobsResponse] # readPrec :: ReadPrec ListPHIDetectionJobsResponse # readListPrec :: ReadPrec [ListPHIDetectionJobsResponse] #
Show ListPHIDetectionJobsResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.ListPHIDetectionJobs Methods showsPrec :: Int -> ListPHIDetectionJobsResponse -> ShowS # show :: ListPHIDetectionJobsResponse -> String # showList :: [ListPHIDetectionJobsResponse] -> ShowS #
Generic ListPHIDetectionJobsResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.ListPHIDetectionJobs Associated Types type Rep ListPHIDetectionJobsResponse :: Type -> Type # Methods from :: ListPHIDetectionJobsResponse -> Rep ListPHIDetectionJobsResponse x # to :: Rep ListPHIDetectionJobsResponse x -> ListPHIDetectionJobsResponse #
NFData ListPHIDetectionJobsResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.ListPHIDetectionJobs Methods rnf :: ListPHIDetectionJobsResponse -> () #
type Rep ListPHIDetectionJobsResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.ListPHIDetectionJobs type Rep ListPHIDetectionJobsResponse = D1 ('MetaData "ListPHIDetectionJobsResponse" "Amazonka.ComprehendMedical.ListPHIDetectionJobs" "libZSservicesZSamazonka-comprehendmedicalZSamazonka-comprehendmedical" 'False) (C1 ('MetaCons "ListPHIDetectionJobsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "comprehendMedicalAsyncJobPropertiesList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ComprehendMedicalAsyncJobProperties])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListPHIDetectionJobsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListPHIDetectionJobsResponse'`
-> ListPHIDetectionJobsResponse

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

$sel:comprehendMedicalAsyncJobPropertiesList:ListPHIDetectionJobsResponse', listPHIDetectionJobsResponse_comprehendMedicalAsyncJobPropertiesList - A list containing the properties of each job returned.

$sel:httpStatus:ListPHIDetectionJobsResponse', listPHIDetectionJobsResponse_httpStatus - The response's http status code.

Response Lenses

listPHIDetectionJobsResponse_nextToken :: Lens' ListPHIDetectionJobsResponse (Maybe Text) Source #

Identifies the next page of results to return.

listPHIDetectionJobsResponse_comprehendMedicalAsyncJobPropertiesList :: Lens' ListPHIDetectionJobsResponse (Maybe [ComprehendMedicalAsyncJobProperties]) Source #

A list containing the properties of each job returned.

listPHIDetectionJobsResponse_httpStatus :: Lens' ListPHIDetectionJobsResponse Int Source #

The response's http status code.