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.Evidently.ListExperiments

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns configuration details about all the experiments in the specified project.

This operation returns paginated results.

Synopsis

data ListExperiments = ListExperiments' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- status :: Maybe ExperimentStatus
- project :: Text
}
newListExperiments :: Text -> ListExperiments
listExperiments_maxResults :: Lens' ListExperiments (Maybe Natural)
listExperiments_nextToken :: Lens' ListExperiments (Maybe Text)
listExperiments_status :: Lens' ListExperiments (Maybe ExperimentStatus)
listExperiments_project :: Lens' ListExperiments Text
data ListExperimentsResponse = ListExperimentsResponse' {
- experiments :: Maybe [Experiment]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListExperimentsResponse :: Int -> ListExperimentsResponse
listExperimentsResponse_experiments :: Lens' ListExperimentsResponse (Maybe [Experiment])
listExperimentsResponse_nextToken :: Lens' ListExperimentsResponse (Maybe Text)
listExperimentsResponse_httpStatus :: Lens' ListExperimentsResponse Int

Creating a Request

data ListExperiments Source #

See: newListExperiments smart constructor.

Constructors

ListExperiments'

Fields

maxResults :: Maybe Natural
The maximum number of results to include in the response.
nextToken :: Maybe Text
The token to use when requesting the next set of results. You received this token from a previous ListExperiments operation.
status :: Maybe ExperimentStatus
Use this optional parameter to limit the returned results to only the experiments with the status that you specify here.
project :: Text
The name or ARN of the project to return the experiment list from.

Instances

Instances details

ToHeaders ListExperiments Source #
Instance details Defined in Amazonka.Evidently.ListExperiments Methods toHeaders :: ListExperiments -> [Header] #
ToPath ListExperiments Source #
Instance details Defined in Amazonka.Evidently.ListExperiments Methods toPath :: ListExperiments -> ByteString #
ToQuery ListExperiments Source #
Instance details Defined in Amazonka.Evidently.ListExperiments Methods toQuery :: ListExperiments -> QueryString #
AWSPager ListExperiments Source #
Instance details Defined in Amazonka.Evidently.ListExperiments Methods page :: ListExperiments -> AWSResponse ListExperiments -> Maybe ListExperiments #
AWSRequest ListExperiments Source #
Instance details Defined in Amazonka.Evidently.ListExperiments Associated Types type AWSResponse ListExperiments # Methods request :: (Service -> Service) -> ListExperiments -> Request ListExperiments # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListExperiments -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListExperiments))) #
Generic ListExperiments Source #
Instance details Defined in Amazonka.Evidently.ListExperiments Associated Types type Rep ListExperiments :: Type -> Type # Methods from :: ListExperiments -> Rep ListExperiments x # to :: Rep ListExperiments x -> ListExperiments #
Read ListExperiments Source #
Instance details Defined in Amazonka.Evidently.ListExperiments Methods readsPrec :: Int -> ReadS ListExperiments # readList :: ReadS [ListExperiments] # readPrec :: ReadPrec ListExperiments # readListPrec :: ReadPrec [ListExperiments] #
Show ListExperiments Source #
Instance details Defined in Amazonka.Evidently.ListExperiments Methods showsPrec :: Int -> ListExperiments -> ShowS # show :: ListExperiments -> String # showList :: [ListExperiments] -> ShowS #
NFData ListExperiments Source #
Instance details Defined in Amazonka.Evidently.ListExperiments Methods rnf :: ListExperiments -> () #
Eq ListExperiments Source #
Instance details Defined in Amazonka.Evidently.ListExperiments Methods (==) :: ListExperiments -> ListExperiments -> Bool # (/=) :: ListExperiments -> ListExperiments -> Bool #
Hashable ListExperiments Source #
Instance details Defined in Amazonka.Evidently.ListExperiments Methods hashWithSalt :: Int -> ListExperiments -> Int # hash :: ListExperiments -> Int #
type AWSResponse ListExperiments Source #
Instance details Defined in Amazonka.Evidently.ListExperiments type AWSResponse ListExperiments = ListExperimentsResponse
type Rep ListExperiments Source #
Instance details Defined in Amazonka.Evidently.ListExperiments type Rep ListExperiments = D1 ('MetaData "ListExperiments" "Amazonka.Evidently.ListExperiments" "amazonka-evidently-2.0-Es2fJk98R0DAUPYaVkZSYC" 'False) (C1 ('MetaCons "ListExperiments'" '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 "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExperimentStatus)) :*: S1 ('MetaSel ('Just "project") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListExperiments Source #

Arguments

:: Text	`ListExperiments`
-> ListExperiments

Create a value of ListExperiments 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:ListExperiments', listExperiments_maxResults - The maximum number of results to include in the response.

ListExperiments, listExperiments_nextToken - The token to use when requesting the next set of results. You received this token from a previous ListExperiments operation.

ListExperiments, listExperiments_status - Use this optional parameter to limit the returned results to only the experiments with the status that you specify here.

ListExperiments, listExperiments_project - The name or ARN of the project to return the experiment list from.

Request Lenses

listExperiments_maxResults :: Lens' ListExperiments (Maybe Natural) Source #

The maximum number of results to include in the response.

listExperiments_nextToken :: Lens' ListExperiments (Maybe Text) Source #

The token to use when requesting the next set of results. You received this token from a previous ListExperiments operation.

listExperiments_status :: Lens' ListExperiments (Maybe ExperimentStatus) Source #

Use this optional parameter to limit the returned results to only the experiments with the status that you specify here.

listExperiments_project :: Lens' ListExperiments Text Source #

The name or ARN of the project to return the experiment list from.

Destructuring the Response

data ListExperimentsResponse Source #

See: newListExperimentsResponse smart constructor.

Constructors

ListExperimentsResponse'
Fields experiments :: Maybe [Experiment] An array of structures that contain the configuration details of the experiments in the specified project. nextToken :: Maybe Text The token to use in a subsequent `ListExperiments` operation to return the next set of results. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListExperimentsResponse Source #

Arguments

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

Create a value of ListExperimentsResponse 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:experiments:ListExperimentsResponse', listExperimentsResponse_experiments - An array of structures that contain the configuration details of the experiments in the specified project.

ListExperiments, listExperimentsResponse_nextToken - The token to use in a subsequent ListExperiments operation to return the next set of results.

$sel:httpStatus:ListExperimentsResponse', listExperimentsResponse_httpStatus - The response's http status code.

Response Lenses

listExperimentsResponse_experiments :: Lens' ListExperimentsResponse (Maybe [Experiment]) Source #

An array of structures that contain the configuration details of the experiments in the specified project.

listExperimentsResponse_nextToken :: Lens' ListExperimentsResponse (Maybe Text) Source #

The token to use in a subsequent ListExperiments operation to return the next set of results.

listExperimentsResponse_httpStatus :: Lens' ListExperimentsResponse Int Source #

The response's http status code.