libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SageMaker.ListCandidatesForAutoMLJob

Description

List the candidates created for the job.

This operation returns paginated results.

Synopsis

Creating a Request

data ListCandidatesForAutoMLJob Source #

See: newListCandidatesForAutoMLJob smart constructor.

Constructors

ListCandidatesForAutoMLJob' 

Fields

Instances

Instances details
Eq ListCandidatesForAutoMLJob Source # 
Instance details

Defined in Amazonka.SageMaker.ListCandidatesForAutoMLJob

Methods

(==) :: ListCandidatesForAutoMLJob -> ListCandidatesForAutoMLJob -> Bool #

(/=) :: ListCandidatesForAutoMLJob -> ListCandidatesForAutoMLJob -> Bool #

Read ListCandidatesForAutoMLJob Source # 
Instance details

Defined in Amazonka.SageMaker.ListCandidatesForAutoMLJob

Methods

readsPrec :: Int -> ReadS ListCandidatesForAutoMLJob #

readList :: ReadS [ListCandidatesForAutoMLJob] #

readPrec :: ReadPrec ListCandidatesForAutoMLJob #

readListPrec :: ReadPrec [ListCandidatesForAutoMLJob] #

Show ListCandidatesForAutoMLJob Source # 
Instance details

Defined in Amazonka.SageMaker.ListCandidatesForAutoMLJob

Methods

showsPrec :: Int -> ListCandidatesForAutoMLJob -> ShowS #

show :: ListCandidatesForAutoMLJob -> String #

showList :: [ListCandidatesForAutoMLJob] -> ShowS #

Generic ListCandidatesForAutoMLJob Source # 
Instance details

Defined in Amazonka.SageMaker.ListCandidatesForAutoMLJob

Associated Types

type Rep ListCandidatesForAutoMLJob :: Type -> Type #

Methods

from :: ListCandidatesForAutoMLJob -> Rep ListCandidatesForAutoMLJob x #

to :: Rep ListCandidatesForAutoMLJob x -> ListCandidatesForAutoMLJob #

NFData ListCandidatesForAutoMLJob Source # 
Instance details

Defined in Amazonka.SageMaker.ListCandidatesForAutoMLJob

Methods

rnf :: ListCandidatesForAutoMLJob -> () #

Hashable ListCandidatesForAutoMLJob Source # 
Instance details

Defined in Amazonka.SageMaker.ListCandidatesForAutoMLJob

Methods

hashWithSalt :: Int -> ListCandidatesForAutoMLJob -> Int #

hash :: ListCandidatesForAutoMLJob -> Int #

ToJSON ListCandidatesForAutoMLJob Source # 
Instance details

Defined in Amazonka.SageMaker.ListCandidatesForAutoMLJob

Methods

toJSON :: ListCandidatesForAutoMLJob -> Value #

toEncoding :: ListCandidatesForAutoMLJob -> Encoding #

toJSONList :: [ListCandidatesForAutoMLJob] -> Value #

toEncodingList :: [ListCandidatesForAutoMLJob] -> Encoding #

AWSPager ListCandidatesForAutoMLJob Source # 
Instance details

Defined in Amazonka.SageMaker.ListCandidatesForAutoMLJob

Methods

page :: ListCandidatesForAutoMLJob -> AWSResponse ListCandidatesForAutoMLJob -> Maybe ListCandidatesForAutoMLJob #

AWSRequest ListCandidatesForAutoMLJob Source # 
Instance details

Defined in Amazonka.SageMaker.ListCandidatesForAutoMLJob

Associated Types

type AWSResponse ListCandidatesForAutoMLJob #

Methods

request :: ListCandidatesForAutoMLJob -> Request ListCandidatesForAutoMLJob #

response :: MonadResource m => Logger -> Service -> Proxy ListCandidatesForAutoMLJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListCandidatesForAutoMLJob))) #

ToHeaders ListCandidatesForAutoMLJob Source # 
Instance details

Defined in Amazonka.SageMaker.ListCandidatesForAutoMLJob

Methods

toHeaders :: ListCandidatesForAutoMLJob -> [Header] #

ToPath ListCandidatesForAutoMLJob Source # 
Instance details

Defined in Amazonka.SageMaker.ListCandidatesForAutoMLJob

Methods

toPath :: ListCandidatesForAutoMLJob -> ByteString #

ToQuery ListCandidatesForAutoMLJob Source # 
Instance details

Defined in Amazonka.SageMaker.ListCandidatesForAutoMLJob

Methods

toQuery :: ListCandidatesForAutoMLJob -> QueryString #

type Rep ListCandidatesForAutoMLJob Source # 
Instance details

Defined in Amazonka.SageMaker.ListCandidatesForAutoMLJob

type Rep ListCandidatesForAutoMLJob = D1 ('MetaData "ListCandidatesForAutoMLJob" "Amazonka.SageMaker.ListCandidatesForAutoMLJob" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "ListCandidatesForAutoMLJob'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "candidateNameEquals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoMLSortOrder)))) :*: ((S1 ('MetaSel ('Just "statusEquals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CandidateStatus)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CandidateSortBy)) :*: S1 ('MetaSel ('Just "autoMLJobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse ListCandidatesForAutoMLJob Source # 
Instance details

Defined in Amazonka.SageMaker.ListCandidatesForAutoMLJob

type AWSResponse ListCandidatesForAutoMLJob = ListCandidatesForAutoMLJobResponse

newListCandidatesForAutoMLJob Source #

Arguments

:: Text

$sel:autoMLJobName:ListCandidatesForAutoMLJob'

-> ListCandidatesForAutoMLJob 

Create a value of ListCandidatesForAutoMLJob 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:candidateNameEquals:ListCandidatesForAutoMLJob', listCandidatesForAutoMLJob_candidateNameEquals - List the candidates for the job and filter by candidate name.

$sel:nextToken:ListCandidatesForAutoMLJob', listCandidatesForAutoMLJob_nextToken - If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

$sel:sortOrder:ListCandidatesForAutoMLJob', listCandidatesForAutoMLJob_sortOrder - The sort order for the results. The default is Ascending.

$sel:statusEquals:ListCandidatesForAutoMLJob', listCandidatesForAutoMLJob_statusEquals - List the candidates for the job and filter by status.

$sel:maxResults:ListCandidatesForAutoMLJob', listCandidatesForAutoMLJob_maxResults - List the job's candidates up to a specified limit.

$sel:sortBy:ListCandidatesForAutoMLJob', listCandidatesForAutoMLJob_sortBy - The parameter by which to sort the results. The default is Descending.

$sel:autoMLJobName:ListCandidatesForAutoMLJob', listCandidatesForAutoMLJob_autoMLJobName - List the candidates created for the job by providing the job's name.

Request Lenses

listCandidatesForAutoMLJob_candidateNameEquals :: Lens' ListCandidatesForAutoMLJob (Maybe Text) Source #

List the candidates for the job and filter by candidate name.

listCandidatesForAutoMLJob_nextToken :: Lens' ListCandidatesForAutoMLJob (Maybe Text) Source #

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

listCandidatesForAutoMLJob_sortOrder :: Lens' ListCandidatesForAutoMLJob (Maybe AutoMLSortOrder) Source #

The sort order for the results. The default is Ascending.

listCandidatesForAutoMLJob_statusEquals :: Lens' ListCandidatesForAutoMLJob (Maybe CandidateStatus) Source #

List the candidates for the job and filter by status.

listCandidatesForAutoMLJob_maxResults :: Lens' ListCandidatesForAutoMLJob (Maybe Natural) Source #

List the job's candidates up to a specified limit.

listCandidatesForAutoMLJob_sortBy :: Lens' ListCandidatesForAutoMLJob (Maybe CandidateSortBy) Source #

The parameter by which to sort the results. The default is Descending.

listCandidatesForAutoMLJob_autoMLJobName :: Lens' ListCandidatesForAutoMLJob Text Source #

List the candidates created for the job by providing the job's name.

Destructuring the Response

data ListCandidatesForAutoMLJobResponse Source #

See: newListCandidatesForAutoMLJobResponse smart constructor.

Constructors

ListCandidatesForAutoMLJobResponse' 

Fields

Instances

Instances details
Eq ListCandidatesForAutoMLJobResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListCandidatesForAutoMLJob

Methods

(==) :: ListCandidatesForAutoMLJobResponse -> ListCandidatesForAutoMLJobResponse -> Bool #

(/=) :: ListCandidatesForAutoMLJobResponse -> ListCandidatesForAutoMLJobResponse -> Bool #

Read ListCandidatesForAutoMLJobResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListCandidatesForAutoMLJob

Methods

readsPrec :: Int -> ReadS ListCandidatesForAutoMLJobResponse #

readList :: ReadS [ListCandidatesForAutoMLJobResponse] #

readPrec :: ReadPrec ListCandidatesForAutoMLJobResponse #

readListPrec :: ReadPrec [ListCandidatesForAutoMLJobResponse] #

Show ListCandidatesForAutoMLJobResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListCandidatesForAutoMLJob

Methods

showsPrec :: Int -> ListCandidatesForAutoMLJobResponse -> ShowS #

show :: ListCandidatesForAutoMLJobResponse -> String #

showList :: [ListCandidatesForAutoMLJobResponse] -> ShowS #

Generic ListCandidatesForAutoMLJobResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListCandidatesForAutoMLJob

Associated Types

type Rep ListCandidatesForAutoMLJobResponse :: Type -> Type #

Methods

from :: ListCandidatesForAutoMLJobResponse -> Rep ListCandidatesForAutoMLJobResponse x #

to :: Rep ListCandidatesForAutoMLJobResponse x -> ListCandidatesForAutoMLJobResponse #

NFData ListCandidatesForAutoMLJobResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListCandidatesForAutoMLJob

Methods

rnf :: ListCandidatesForAutoMLJobResponse -> () #

type Rep ListCandidatesForAutoMLJobResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListCandidatesForAutoMLJob

type Rep ListCandidatesForAutoMLJobResponse = D1 ('MetaData "ListCandidatesForAutoMLJobResponse" "Amazonka.SageMaker.ListCandidatesForAutoMLJob" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "ListCandidatesForAutoMLJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "candidates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [AutoMLCandidate]))))

newListCandidatesForAutoMLJobResponse Source #

Arguments

:: Int

$sel:httpStatus:ListCandidatesForAutoMLJobResponse'

-> ListCandidatesForAutoMLJobResponse 

Create a value of ListCandidatesForAutoMLJobResponse 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:ListCandidatesForAutoMLJob', listCandidatesForAutoMLJobResponse_nextToken - If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

$sel:httpStatus:ListCandidatesForAutoMLJobResponse', listCandidatesForAutoMLJobResponse_httpStatus - The response's http status code.

$sel:candidates:ListCandidatesForAutoMLJobResponse', listCandidatesForAutoMLJobResponse_candidates - Summaries about the AutoMLCandidates.

Response Lenses

listCandidatesForAutoMLJobResponse_nextToken :: Lens' ListCandidatesForAutoMLJobResponse (Maybe Text) Source #

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

listCandidatesForAutoMLJobResponse_httpStatus :: Lens' ListCandidatesForAutoMLJobResponse Int Source #

The response's http status code.

listCandidatesForAutoMLJobResponse_candidates :: Lens' ListCandidatesForAutoMLJobResponse [AutoMLCandidate] Source #

Summaries about the AutoMLCandidates.