Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SageMaker.ListCandidatesForAutoMLJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

candidateNameEquals :: Maybe Text
List the candidates for the job and filter by candidate name.
maxResults :: Maybe Natural
List the job's candidates up to a specified limit.
nextToken :: Maybe Text
If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
sortBy :: Maybe CandidateSortBy
The parameter by which to sort the results. The default is Descending.
sortOrder :: Maybe AutoMLSortOrder
The sort order for the results. The default is Ascending.
statusEquals :: Maybe CandidateStatus
List the candidates for the job and filter by status.
autoMLJobName :: Text
List the candidates created for the job by providing the job's name.

Instances

Instances details

ToJSON ListCandidatesForAutoMLJob Source #
Instance details Defined in Amazonka.SageMaker.ListCandidatesForAutoMLJob Methods toJSON :: ListCandidatesForAutoMLJob -> Value # toEncoding :: ListCandidatesForAutoMLJob -> Encoding # toJSONList :: [ListCandidatesForAutoMLJob] -> Value # toEncodingList :: [ListCandidatesForAutoMLJob] -> Encoding #
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 #
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 :: (Service -> Service) -> ListCandidatesForAutoMLJob -> Request ListCandidatesForAutoMLJob # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListCandidatesForAutoMLJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListCandidatesForAutoMLJob))) #
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 #
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 #
NFData ListCandidatesForAutoMLJob Source #
Instance details Defined in Amazonka.SageMaker.ListCandidatesForAutoMLJob Methods rnf :: ListCandidatesForAutoMLJob -> () #
Eq ListCandidatesForAutoMLJob Source #
Instance details Defined in Amazonka.SageMaker.ListCandidatesForAutoMLJob Methods (==) :: ListCandidatesForAutoMLJob -> ListCandidatesForAutoMLJob -> Bool # (/=) :: ListCandidatesForAutoMLJob -> ListCandidatesForAutoMLJob -> Bool #
Hashable ListCandidatesForAutoMLJob Source #
Instance details Defined in Amazonka.SageMaker.ListCandidatesForAutoMLJob Methods hashWithSalt :: Int -> ListCandidatesForAutoMLJob -> Int # hash :: ListCandidatesForAutoMLJob -> Int #
type AWSResponse ListCandidatesForAutoMLJob Source #
Instance details Defined in Amazonka.SageMaker.ListCandidatesForAutoMLJob type AWSResponse ListCandidatesForAutoMLJob = ListCandidatesForAutoMLJobResponse
type Rep ListCandidatesForAutoMLJob Source #
Instance details Defined in Amazonka.SageMaker.ListCandidatesForAutoMLJob type Rep ListCandidatesForAutoMLJob = D1 ('MetaData "ListCandidatesForAutoMLJob" "Amazonka.SageMaker.ListCandidatesForAutoMLJob" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "ListCandidatesForAutoMLJob'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "candidateNameEquals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CandidateSortBy)) :: S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoMLSortOrder))) :: (S1 ('MetaSel ('Just "statusEquals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CandidateStatus)) :: S1 ('MetaSel ('Just "autoMLJobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListCandidatesForAutoMLJob Source #

Arguments

:: Text	`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:maxResults:ListCandidatesForAutoMLJob', listCandidatesForAutoMLJob_maxResults - List the job's candidates up to a specified limit.

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:sortBy:ListCandidatesForAutoMLJob', listCandidatesForAutoMLJob_sortBy - The parameter by which to sort the results. The default is Descending.

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

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_maxResults :: Lens' ListCandidatesForAutoMLJob (Maybe Natural) Source #

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

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_sortBy :: Lens' ListCandidatesForAutoMLJob (Maybe CandidateSortBy) Source #

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

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_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 nextToken :: Maybe Text If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results. httpStatus :: Int The response's http status code. candidates :: [AutoMLCandidate] Summaries about the `AutoMLCandidates`.

Instances

Instances details

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 #
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 #
NFData ListCandidatesForAutoMLJobResponse Source #
Instance details Defined in Amazonka.SageMaker.ListCandidatesForAutoMLJob Methods rnf :: ListCandidatesForAutoMLJobResponse -> () #
Eq ListCandidatesForAutoMLJobResponse Source #
Instance details Defined in Amazonka.SageMaker.ListCandidatesForAutoMLJob Methods (==) :: ListCandidatesForAutoMLJobResponse -> ListCandidatesForAutoMLJobResponse -> Bool # (/=) :: ListCandidatesForAutoMLJobResponse -> ListCandidatesForAutoMLJobResponse -> Bool #
type Rep ListCandidatesForAutoMLJobResponse Source #
Instance details Defined in Amazonka.SageMaker.ListCandidatesForAutoMLJob type Rep ListCandidatesForAutoMLJobResponse = D1 ('MetaData "ListCandidatesForAutoMLJobResponse" "Amazonka.SageMaker.ListCandidatesForAutoMLJob" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" '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:

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.