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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a project in the specified portal.

Make sure that the project name and description don't contain confidential information.

Synopsis

data CreateProject = CreateProject' {
- clientToken :: Maybe Text
- projectDescription :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- portalId :: Text
- projectName :: Text
}
newCreateProject :: Text -> Text -> CreateProject
createProject_clientToken :: Lens' CreateProject (Maybe Text)
createProject_projectDescription :: Lens' CreateProject (Maybe Text)
createProject_tags :: Lens' CreateProject (Maybe (HashMap Text Text))
createProject_portalId :: Lens' CreateProject Text
createProject_projectName :: Lens' CreateProject Text
data CreateProjectResponse = CreateProjectResponse' {
- httpStatus :: Int
- projectId :: Text
- projectArn :: Text
}
newCreateProjectResponse :: Int -> Text -> Text -> CreateProjectResponse
createProjectResponse_httpStatus :: Lens' CreateProjectResponse Int
createProjectResponse_projectId :: Lens' CreateProjectResponse Text
createProjectResponse_projectArn :: Lens' CreateProjectResponse Text

Creating a Request

data CreateProject Source #

See: newCreateProject smart constructor.

Constructors

CreateProject'

Fields

clientToken :: Maybe Text
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
projectDescription :: Maybe Text
A description for the project.
tags :: Maybe (HashMap Text Text)
A list of key-value pairs that contain metadata for the project. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
portalId :: Text
The ID of the portal in which to create the project.
projectName :: Text
A friendly name for the project.

Instances

Instances details

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

newCreateProject Source #

Arguments

:: Text	`$sel:portalId:CreateProject'`
-> Text	`$sel:projectName: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:

$sel:clientToken:CreateProject', createProject_clientToken - A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

$sel:projectDescription:CreateProject', createProject_projectDescription - A description for the project.

$sel:tags:CreateProject', createProject_tags - A list of key-value pairs that contain metadata for the project. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

$sel:portalId:CreateProject', createProject_portalId - The ID of the portal in which to create the project.

$sel:projectName:CreateProject', createProject_projectName - A friendly name for the project.

Request Lenses

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

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

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

A description for the project.

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

A list of key-value pairs that contain metadata for the project. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

createProject_portalId :: Lens' CreateProject Text Source #

The ID of the portal in which to create the project.

createProject_projectName :: Lens' CreateProject Text Source #

A friendly 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. projectId :: Text The ID of the project. projectArn :: Text The ARN of the project, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}

Instances

Instances details

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

newCreateProjectResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateProjectResponse'`
-> Text	`$sel:projectId:CreateProjectResponse'`
-> Text	`$sel:projectArn: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.

$sel:projectId:CreateProjectResponse', createProjectResponse_projectId - The ID of the project.

$sel:projectArn:CreateProjectResponse', createProjectResponse_projectArn - The ARN of the project, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}

Response Lenses

createProjectResponse_httpStatus :: Lens' CreateProjectResponse Int Source #

The response's http status code.

createProjectResponse_projectId :: Lens' CreateProjectResponse Text Source #

The ID of the project.

createProjectResponse_projectArn :: Lens' CreateProjectResponse Text Source #

The ARN of the project, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}