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.Braket.SearchJobs

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Searches for Amazon Braket jobs that match the specified filter values.

This operation returns paginated results.

Synopsis

Creating a Request

data SearchJobs Source #

See: newSearchJobs smart constructor.

Constructors

SearchJobs'
Fields maxResults :: Maybe Natural The maximum number of results to return in the response. nextToken :: Maybe Text A token used for pagination of results returned in the response. Use the token returned from the previous request to continue results where the previous request ended. filters :: [SearchJobsFilter] The filter values to use when searching for a job.

Instances

Instances details

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

newSearchJobs :: SearchJobs Source #

Create a value of SearchJobs 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:maxResults:SearchJobs', searchJobs_maxResults - The maximum number of results to return in the response.

SearchJobs, searchJobs_nextToken - A token used for pagination of results returned in the response. Use the token returned from the previous request to continue results where the previous request ended.

$sel:filters:SearchJobs', searchJobs_filters - The filter values to use when searching for a job.

Request Lenses

searchJobs_maxResults :: Lens' SearchJobs (Maybe Natural) Source #

The maximum number of results to return in the response.

searchJobs_nextToken :: Lens' SearchJobs (Maybe Text) Source #

A token used for pagination of results returned in the response. Use the token returned from the previous request to continue results where the previous request ended.

searchJobs_filters :: Lens' SearchJobs [SearchJobsFilter] Source #

The filter values to use when searching for a job.

Destructuring the Response

data SearchJobsResponse Source #

See: newSearchJobsResponse smart constructor.

Constructors

SearchJobsResponse'
Fields nextToken :: Maybe Text A token used for pagination of results, or `null` if there are no additional results. Use the token value in a subsequent request to continue results where the previous request ended. httpStatus :: Int The response's http status code. jobs :: [JobSummary] An array of `JobSummary` objects for devices that match the specified filter values.

Instances

Instances details

Generic SearchJobsResponse Source #
Instance details Defined in Amazonka.Braket.SearchJobs Associated Types type Rep SearchJobsResponse :: Type -> Type # Methods from :: SearchJobsResponse -> Rep SearchJobsResponse x # to :: Rep SearchJobsResponse x -> SearchJobsResponse #
Read SearchJobsResponse Source #
Instance details Defined in Amazonka.Braket.SearchJobs Methods readsPrec :: Int -> ReadS SearchJobsResponse # readList :: ReadS [SearchJobsResponse] # readPrec :: ReadPrec SearchJobsResponse # readListPrec :: ReadPrec [SearchJobsResponse] #
Show SearchJobsResponse Source #
Instance details Defined in Amazonka.Braket.SearchJobs Methods showsPrec :: Int -> SearchJobsResponse -> ShowS # show :: SearchJobsResponse -> String # showList :: [SearchJobsResponse] -> ShowS #
NFData SearchJobsResponse Source #
Instance details Defined in Amazonka.Braket.SearchJobs Methods rnf :: SearchJobsResponse -> () #
Eq SearchJobsResponse Source #
Instance details Defined in Amazonka.Braket.SearchJobs Methods (==) :: SearchJobsResponse -> SearchJobsResponse -> Bool # (/=) :: SearchJobsResponse -> SearchJobsResponse -> Bool #
type Rep SearchJobsResponse Source #
Instance details Defined in Amazonka.Braket.SearchJobs type Rep SearchJobsResponse = D1 ('MetaData "SearchJobsResponse" "Amazonka.Braket.SearchJobs" "amazonka-braket-2.0-K4GTd9RbB3VBh6Qg8rMHaZ" 'False) (C1 ('MetaCons "SearchJobsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "jobs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [JobSummary]))))

newSearchJobsResponse Source #

Arguments

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

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

SearchJobs, searchJobsResponse_nextToken - A token used for pagination of results, or null if there are no additional results. Use the token value in a subsequent request to continue results where the previous request ended.

$sel:httpStatus:SearchJobsResponse', searchJobsResponse_httpStatus - The response's http status code.

$sel:jobs:SearchJobsResponse', searchJobsResponse_jobs - An array of JobSummary objects for devices that match the specified filter values.

Response Lenses

searchJobsResponse_nextToken :: Lens' SearchJobsResponse (Maybe Text) Source #

A token used for pagination of results, or null if there are no additional results. Use the token value in a subsequent request to continue results where the previous request ended.

searchJobsResponse_httpStatus :: Lens' SearchJobsResponse Int Source #

The response's http status code.

searchJobsResponse_jobs :: Lens' SearchJobsResponse [JobSummary] Source #

An array of JobSummary objects for devices that match the specified filter values.