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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a project, which is the logical object in Evidently that can contain features, launches, and experiments. Use projects to group similar features together.

To update an existing project, use UpdateProject.

Synopsis

data CreateProject = CreateProject' {
- appConfigResource :: Maybe ProjectAppConfigResourceConfig
- dataDelivery :: Maybe ProjectDataDeliveryConfig
- description :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- name :: Text
}
newCreateProject :: Text -> CreateProject
createProject_appConfigResource :: Lens' CreateProject (Maybe ProjectAppConfigResourceConfig)
createProject_dataDelivery :: Lens' CreateProject (Maybe ProjectDataDeliveryConfig)
createProject_description :: Lens' CreateProject (Maybe Text)
createProject_tags :: Lens' CreateProject (Maybe (HashMap Text Text))
createProject_name :: Lens' CreateProject Text
data CreateProjectResponse = CreateProjectResponse' {
- httpStatus :: Int
- project :: Project
}
newCreateProjectResponse :: Int -> Project -> CreateProjectResponse
createProjectResponse_httpStatus :: Lens' CreateProjectResponse Int
createProjectResponse_project :: Lens' CreateProjectResponse Project

Creating a Request

data CreateProject Source #

See: newCreateProject smart constructor.

Constructors

CreateProject'

Fields

appConfigResource :: Maybe ProjectAppConfigResourceConfig
Use this parameter if the project will use /client-side evaluation powered by AppConfig/. Client-side evaluation allows your application to assign variations to user sessions locally instead of by calling the EvaluateFeature operation. This mitigates the latency and availability risks that come with an API call. For more information, see Client-side evaluation - powered by AppConfig.
This parameter is a structure that contains information about the AppConfig application and environment that will be used as for client-side evaluation.
To create a project that uses client-side evaluation, you must have the evidently:ExportProjectAsConfiguration permission.
dataDelivery :: Maybe ProjectDataDeliveryConfig
A structure that contains information about where Evidently is to store evaluation events for longer term storage, if you choose to do so. If you choose not to store these events, Evidently deletes them after using them to produce metrics and other experiment results that you can view.
description :: Maybe Text
An optional description of the project.
tags :: Maybe (HashMap Text Text)
Assigns one or more tags (key-value pairs) to the project.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
```
 <p>You can associate as many as 50 tags with a project.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
```
name :: Text
The name for the project.

Instances

Instances details

ToJSON CreateProject Source #
Instance details Defined in Amazonka.Evidently.CreateProject Methods toJSON :: CreateProject -> Value # toEncoding :: CreateProject -> Encoding # toJSONList :: [CreateProject] -> Value # toEncodingList :: [CreateProject] -> Encoding #
ToHeaders CreateProject Source #
Instance details Defined in Amazonka.Evidently.CreateProject Methods toHeaders :: CreateProject -> [Header] #
ToPath CreateProject Source #
Instance details Defined in Amazonka.Evidently.CreateProject Methods toPath :: CreateProject -> ByteString #
ToQuery CreateProject Source #
Instance details Defined in Amazonka.Evidently.CreateProject Methods toQuery :: CreateProject -> QueryString #
AWSRequest CreateProject Source #
Instance details Defined in Amazonka.Evidently.CreateProject Associated Types type AWSResponse CreateProject # Methods request :: (Service -> Service) -> CreateProject -> Request CreateProject # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateProject -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateProject))) #
Generic CreateProject Source #
Instance details Defined in Amazonka.Evidently.CreateProject Associated Types type Rep CreateProject :: Type -> Type # Methods from :: CreateProject -> Rep CreateProject x # to :: Rep CreateProject x -> CreateProject #
Read CreateProject Source #
Instance details Defined in Amazonka.Evidently.CreateProject Methods readsPrec :: Int -> ReadS CreateProject # readList :: ReadS [CreateProject] # readPrec :: ReadPrec CreateProject # readListPrec :: ReadPrec [CreateProject] #
Show CreateProject Source #
Instance details Defined in Amazonka.Evidently.CreateProject Methods showsPrec :: Int -> CreateProject -> ShowS # show :: CreateProject -> String # showList :: [CreateProject] -> ShowS #
NFData CreateProject Source #
Instance details Defined in Amazonka.Evidently.CreateProject Methods rnf :: CreateProject -> () #
Eq CreateProject Source #
Instance details Defined in Amazonka.Evidently.CreateProject Methods (==) :: CreateProject -> CreateProject -> Bool # (/=) :: CreateProject -> CreateProject -> Bool #
Hashable CreateProject Source #
Instance details Defined in Amazonka.Evidently.CreateProject Methods hashWithSalt :: Int -> CreateProject -> Int # hash :: CreateProject -> Int #
type AWSResponse CreateProject Source #
Instance details Defined in Amazonka.Evidently.CreateProject type AWSResponse CreateProject = CreateProjectResponse
type Rep CreateProject Source #
Instance details Defined in Amazonka.Evidently.CreateProject type Rep CreateProject = D1 ('MetaData "CreateProject" "Amazonka.Evidently.CreateProject" "amazonka-evidently-2.0-Es2fJk98R0DAUPYaVkZSYC" 'False) (C1 ('MetaCons "CreateProject'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "appConfigResource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProjectAppConfigResourceConfig)) :: S1 ('MetaSel ('Just "dataDelivery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProjectDataDeliveryConfig))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateProject Source #

Arguments

:: Text	`CreateProject`
-> CreateProject

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

CreateProject, createProject_appConfigResource - Use this parameter if the project will use /client-side evaluation powered by AppConfig/. Client-side evaluation allows your application to assign variations to user sessions locally instead of by calling the EvaluateFeature operation. This mitigates the latency and availability risks that come with an API call. For more information, see Client-side evaluation - powered by AppConfig.

This parameter is a structure that contains information about the AppConfig application and environment that will be used as for client-side evaluation.

To create a project that uses client-side evaluation, you must have the evidently:ExportProjectAsConfiguration permission.

CreateProject, createProject_dataDelivery - A structure that contains information about where Evidently is to store evaluation events for longer term storage, if you choose to do so. If you choose not to store these events, Evidently deletes them after using them to produce metrics and other experiment results that you can view.

CreateProject, createProject_description - An optional description of the project.

CreateProject, createProject_tags - Assigns one or more tags (key-value pairs) to the project.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

 <p>You can associate as many as 50 tags with a project.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>

CreateProject, createProject_name - The name for the project.

Request Lenses

createProject_appConfigResource :: Lens' CreateProject (Maybe ProjectAppConfigResourceConfig) Source #

Use this parameter if the project will use /client-side evaluation powered by AppConfig/. Client-side evaluation allows your application to assign variations to user sessions locally instead of by calling the EvaluateFeature operation. This mitigates the latency and availability risks that come with an API call. For more information, see Client-side evaluation - powered by AppConfig.

This parameter is a structure that contains information about the AppConfig application and environment that will be used as for client-side evaluation.

To create a project that uses client-side evaluation, you must have the evidently:ExportProjectAsConfiguration permission.

createProject_dataDelivery :: Lens' CreateProject (Maybe ProjectDataDeliveryConfig) Source #

A structure that contains information about where Evidently is to store evaluation events for longer term storage, if you choose to do so. If you choose not to store these events, Evidently deletes them after using them to produce metrics and other experiment results that you can view.

createProject_description :: Lens' CreateProject (Maybe Text) Source #

An optional description of the project.

createProject_tags :: Lens' CreateProject (Maybe (HashMap Text Text)) Source #

Assigns one or more tags (key-value pairs) to the project.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

 <p>You can associate as many as 50 tags with a project.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>

createProject_name :: Lens' CreateProject Text Source #

The name for the project.

Destructuring the Response

data CreateProjectResponse Source #

See: newCreateProjectResponse smart constructor.

Constructors

CreateProjectResponse'
Fields httpStatus :: Int The response's http status code. project :: Project A structure that contains information about the created project.

Instances

Instances details

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

newCreateProjectResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateProjectResponse'`
-> Project	`CreateProjectResponse`
-> CreateProjectResponse

Create a value of CreateProjectResponse 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:httpStatus:CreateProjectResponse', createProjectResponse_httpStatus - The response's http status code.

CreateProjectResponse, createProjectResponse_project - A structure that contains information about the created project.

Response Lenses

createProjectResponse_httpStatus :: Lens' CreateProjectResponse Int Source #

The response's http status code.

createProjectResponse_project :: Lens' CreateProjectResponse Project Source #

A structure that contains information about the created project.