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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an empty project with a placement template. A project contains zero or more placements that adhere to the placement template defined in the project.

Creating a Request

data CreateProject Source #

See: newCreateProject smart constructor.

Constructors

CreateProject'

Fields

description :: Maybe Text
An optional description for the project.
placementTemplate :: Maybe PlacementTemplate
The schema defining the placement to be created. A placement template defines placement default attributes and device templates. You cannot add or remove device templates after the project has been created. However, you can update callbackOverrides for the device templates using the UpdateProject API.
tags :: Maybe (HashMap Text Text)
Optional tags (metadata key/value pairs) to be associated with the project. For example, { {"key1": "value1", "key2": "value2"} }. For more information, see AWS Tagging Strategies.
projectName :: Text
The name of the project to create.

Instances

Instances details

ToJSON CreateProject Source #
Instance details Defined in Amazonka.IoT1ClickProjects.CreateProject Methods toJSON :: CreateProject -> Value # toEncoding :: CreateProject -> Encoding # toJSONList :: [CreateProject] -> Value # toEncodingList :: [CreateProject] -> Encoding #
ToHeaders CreateProject Source #
Instance details Defined in Amazonka.IoT1ClickProjects.CreateProject Methods toHeaders :: CreateProject -> [Header] #
ToPath CreateProject Source #
Instance details Defined in Amazonka.IoT1ClickProjects.CreateProject Methods toPath :: CreateProject -> ByteString #
ToQuery CreateProject Source #
Instance details Defined in Amazonka.IoT1ClickProjects.CreateProject Methods toQuery :: CreateProject -> QueryString #
AWSRequest CreateProject Source #
Instance details Defined in Amazonka.IoT1ClickProjects.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.IoT1ClickProjects.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.IoT1ClickProjects.CreateProject Methods readsPrec :: Int -> ReadS CreateProject # readList :: ReadS [CreateProject] # readPrec :: ReadPrec CreateProject # readListPrec :: ReadPrec [CreateProject] #
Show CreateProject Source #
Instance details Defined in Amazonka.IoT1ClickProjects.CreateProject Methods showsPrec :: Int -> CreateProject -> ShowS # show :: CreateProject -> String # showList :: [CreateProject] -> ShowS #
NFData CreateProject Source #
Instance details Defined in Amazonka.IoT1ClickProjects.CreateProject Methods rnf :: CreateProject -> () #
Eq CreateProject Source #
Instance details Defined in Amazonka.IoT1ClickProjects.CreateProject Methods (==) :: CreateProject -> CreateProject -> Bool # (/=) :: CreateProject -> CreateProject -> Bool #
Hashable CreateProject Source #
Instance details Defined in Amazonka.IoT1ClickProjects.CreateProject Methods hashWithSalt :: Int -> CreateProject -> Int # hash :: CreateProject -> Int #
type AWSResponse CreateProject Source #
Instance details Defined in Amazonka.IoT1ClickProjects.CreateProject type AWSResponse CreateProject = CreateProjectResponse
type Rep CreateProject Source #
Instance details Defined in Amazonka.IoT1ClickProjects.CreateProject type Rep CreateProject = D1 ('MetaData "CreateProject" "Amazonka.IoT1ClickProjects.CreateProject" "amazonka-iot1click-projects-2.0-KLltusBcTZO1f6G5pKsT1G" 'False) (C1 ('MetaCons "CreateProject'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "placementTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PlacementTemplate))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "projectName") '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_description - An optional description for the project.

CreateProject, createProject_placementTemplate - The schema defining the placement to be created. A placement template defines placement default attributes and device templates. You cannot add or remove device templates after the project has been created. However, you can update callbackOverrides for the device templates using the UpdateProject API.

CreateProject, createProject_tags - Optional tags (metadata key/value pairs) to be associated with the project. For example, { {"key1": "value1", "key2": "value2"} }. For more information, see AWS Tagging Strategies.

CreateProject, createProject_projectName - The name of the project to create.

Request Lenses

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

An optional description for the project.

createProject_placementTemplate :: Lens' CreateProject (Maybe PlacementTemplate) Source #

The schema defining the placement to be created. A placement template defines placement default attributes and device templates. You cannot add or remove device templates after the project has been created. However, you can update callbackOverrides for the device templates using the UpdateProject API.

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

Optional tags (metadata key/value pairs) to be associated with the project. For example, { {"key1": "value1", "key2": "value2"} }. For more information, see AWS Tagging Strategies.

createProject_projectName :: Lens' CreateProject Text Source #

The name of the project to create.

Destructuring the Response

data CreateProjectResponse Source #

See: newCreateProjectResponse smart constructor.

Constructors

CreateProjectResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateProjectResponse Source #
Instance details Defined in Amazonka.IoT1ClickProjects.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.IoT1ClickProjects.CreateProject Methods readsPrec :: Int -> ReadS CreateProjectResponse # readList :: ReadS [CreateProjectResponse] # readPrec :: ReadPrec CreateProjectResponse # readListPrec :: ReadPrec [CreateProjectResponse] #
Show CreateProjectResponse Source #
Instance details Defined in Amazonka.IoT1ClickProjects.CreateProject Methods showsPrec :: Int -> CreateProjectResponse -> ShowS # show :: CreateProjectResponse -> String # showList :: [CreateProjectResponse] -> ShowS #
NFData CreateProjectResponse Source #
Instance details Defined in Amazonka.IoT1ClickProjects.CreateProject Methods rnf :: CreateProjectResponse -> () #
Eq CreateProjectResponse Source #
Instance details Defined in Amazonka.IoT1ClickProjects.CreateProject Methods (==) :: CreateProjectResponse -> CreateProjectResponse -> Bool # (/=) :: CreateProjectResponse -> CreateProjectResponse -> Bool #
type Rep CreateProjectResponse Source #
Instance details Defined in Amazonka.IoT1ClickProjects.CreateProject type Rep CreateProjectResponse = D1 ('MetaData "CreateProjectResponse" "Amazonka.IoT1ClickProjects.CreateProject" "amazonka-iot1click-projects-2.0-KLltusBcTZO1f6G5pKsT1G" 'False) (C1 ('MetaCons "CreateProjectResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateProjectResponse Source #

Arguments

:: Int	`$sel:httpStatus: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.

Response Lenses

createProjectResponse_httpStatus :: Lens' CreateProjectResponse Int Source #

The response's http status code.