Amazonka.Evidently.ListExperiments

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

This operation returns paginated results.

Creating a Request

data ListExperiments

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

ToHeaders ListExperiments

Defined in Amazonka.Evidently.ListExperiments

Methods

toHeaders :: ListExperiments -> [Header]

ToPath ListExperiments

Defined in Amazonka.Evidently.ListExperiments

Methods

toPath :: ListExperiments -> ByteString

ToQuery ListExperiments

Defined in Amazonka.Evidently.ListExperiments

Methods

toQuery :: ListExperiments -> QueryString

AWSPager ListExperiments

Defined in Amazonka.Evidently.ListExperiments

Methods

page :: ListExperiments -> AWSResponse ListExperiments -> Maybe ListExperiments

AWSRequest ListExperiments

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

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

Defined in Amazonka.Evidently.ListExperiments

Methods

readsPrec :: Int -> ReadS ListExperiments

readList :: ReadS [ListExperiments]

readPrec :: ReadPrec ListExperiments

readListPrec :: ReadPrec [ListExperiments]

Show ListExperiments

Defined in Amazonka.Evidently.ListExperiments

Methods

showsPrec :: Int -> ListExperiments -> ShowS

show :: ListExperiments -> String

showList :: [ListExperiments] -> ShowS

NFData ListExperiments

Defined in Amazonka.Evidently.ListExperiments

Methods

rnf :: ListExperiments -> ()

Eq ListExperiments

Defined in Amazonka.Evidently.ListExperiments

Methods

(==) :: ListExperiments -> ListExperiments -> Bool

(/=) :: ListExperiments -> ListExperiments -> Bool

Hashable ListExperiments

Defined in Amazonka.Evidently.ListExperiments

Methods

hashWithSalt :: Int -> ListExperiments -> Int

hash :: ListExperiments -> Int

type AWSResponse ListExperiments

Defined in Amazonka.Evidently.ListExperiments

type AWSResponse ListExperiments = ListExperimentsResponse

type Rep ListExperiments

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

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)

The maximum number of results to include in the response.

listExperiments_nextToken :: Lens' ListExperiments (Maybe Text)

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)

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

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

Destructuring the Response

data ListExperimentsResponse

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

Generic ListExperimentsResponse

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

Defined in Amazonka.Evidently.ListExperiments

Methods

readsPrec :: Int -> ReadS ListExperimentsResponse

readList :: ReadS [ListExperimentsResponse]

readPrec :: ReadPrec ListExperimentsResponse

readListPrec :: ReadPrec [ListExperimentsResponse]

Show ListExperimentsResponse

Defined in Amazonka.Evidently.ListExperiments

Methods

showsPrec :: Int -> ListExperimentsResponse -> ShowS

show :: ListExperimentsResponse -> String

showList :: [ListExperimentsResponse] -> ShowS

NFData ListExperimentsResponse

Defined in Amazonka.Evidently.ListExperiments

Methods

rnf :: ListExperimentsResponse -> ()

Eq ListExperimentsResponse

Defined in Amazonka.Evidently.ListExperiments

Methods

(==) :: ListExperimentsResponse -> ListExperimentsResponse -> Bool

(/=) :: ListExperimentsResponse -> ListExperimentsResponse -> Bool

type Rep ListExperimentsResponse

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

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])

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

listExperimentsResponse_nextToken :: Lens' ListExperimentsResponse (Maybe Text)

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

listExperimentsResponse_httpStatus :: Lens' ListExperimentsResponse Int

The response's http status code.