Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CodeStar.CreateProject

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a project, including project resources. This action creates a project based on a submitted project request. A set of source code files and a toolchain template file can be included with the project request. If these are not provided, an empty project is created.

Synopsis

data CreateProject = CreateProject' {
- sourceCode :: Maybe [Code]
- toolchain :: Maybe Toolchain
- clientRequestToken :: Maybe Text
- description :: Maybe (Sensitive Text)
- tags :: Maybe (HashMap Text Text)
- name :: Sensitive Text
- id :: Text
}
newCreateProject :: Text -> Text -> CreateProject
createProject_sourceCode :: Lens' CreateProject (Maybe [Code])
createProject_toolchain :: Lens' CreateProject (Maybe Toolchain)
createProject_clientRequestToken :: Lens' CreateProject (Maybe Text)
createProject_description :: Lens' CreateProject (Maybe Text)
createProject_tags :: Lens' CreateProject (Maybe (HashMap Text Text))
createProject_name :: Lens' CreateProject Text
createProject_id :: Lens' CreateProject Text
data CreateProjectResponse = CreateProjectResponse' {
- projectTemplateId :: Maybe Text
- clientRequestToken :: Maybe Text
- httpStatus :: Int
- id :: Text
- arn :: Text
}
newCreateProjectResponse :: Int -> Text -> Text -> CreateProjectResponse
createProjectResponse_projectTemplateId :: Lens' CreateProjectResponse (Maybe Text)
createProjectResponse_clientRequestToken :: Lens' CreateProjectResponse (Maybe Text)
createProjectResponse_httpStatus :: Lens' CreateProjectResponse Int
createProjectResponse_id :: Lens' CreateProjectResponse Text
createProjectResponse_arn :: Lens' CreateProjectResponse Text

Creating a Request

data CreateProject Source #

See: newCreateProject smart constructor.

Constructors

CreateProject'

Fields

sourceCode :: Maybe [Code]
A list of the Code objects submitted with the project request. If this parameter is specified, the request must also include the toolchain parameter.
toolchain :: Maybe Toolchain
The name of the toolchain template file submitted with the project request. If this parameter is specified, the request must also include the sourceCode parameter.
clientRequestToken :: Maybe Text
A user- or system-generated token that identifies the entity that requested project creation. This token can be used to repeat the request.
description :: Maybe (Sensitive Text)
The description of the project, if any.
tags :: Maybe (HashMap Text Text)
The tags created for the project.
name :: Sensitive Text
The display name for the project to be created in AWS CodeStar.
id :: Text
The ID of the project to be created in AWS CodeStar.

Instances

Instances details

Eq CreateProject Source #
Instance details Defined in Amazonka.CodeStar.CreateProject Methods (==) :: CreateProject -> CreateProject -> Bool # (/=) :: CreateProject -> CreateProject -> Bool #
Show CreateProject Source #
Instance details Defined in Amazonka.CodeStar.CreateProject Methods showsPrec :: Int -> CreateProject -> ShowS # show :: CreateProject -> String # showList :: [CreateProject] -> ShowS #
Generic CreateProject Source #
Instance details Defined in Amazonka.CodeStar.CreateProject Associated Types type Rep CreateProject :: Type -> Type # Methods from :: CreateProject -> Rep CreateProject x # to :: Rep CreateProject x -> CreateProject #
NFData CreateProject Source #
Instance details Defined in Amazonka.CodeStar.CreateProject Methods rnf :: CreateProject -> () #
Hashable CreateProject Source #
Instance details Defined in Amazonka.CodeStar.CreateProject Methods hashWithSalt :: Int -> CreateProject -> Int # hash :: CreateProject -> Int #
ToJSON CreateProject Source #
Instance details Defined in Amazonka.CodeStar.CreateProject Methods toJSON :: CreateProject -> Value # toEncoding :: CreateProject -> Encoding # toJSONList :: [CreateProject] -> Value # toEncodingList :: [CreateProject] -> Encoding #
AWSRequest CreateProject Source #
Instance details Defined in Amazonka.CodeStar.CreateProject Associated Types type AWSResponse CreateProject # Methods request :: CreateProject -> Request CreateProject # response :: MonadResource m => Logger -> Service -> Proxy CreateProject -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateProject))) #
ToHeaders CreateProject Source #
Instance details Defined in Amazonka.CodeStar.CreateProject Methods toHeaders :: CreateProject -> [Header] #
ToPath CreateProject Source #
Instance details Defined in Amazonka.CodeStar.CreateProject Methods toPath :: CreateProject -> ByteString #
ToQuery CreateProject Source #
Instance details Defined in Amazonka.CodeStar.CreateProject Methods toQuery :: CreateProject -> QueryString #
type Rep CreateProject Source #
Instance details Defined in Amazonka.CodeStar.CreateProject type Rep CreateProject = D1 ('MetaData "CreateProject" "Amazonka.CodeStar.CreateProject" "libZSservicesZSamazonka-codestarZSamazonka-codestar" 'False) (C1 ('MetaCons "CreateProject'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sourceCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Code])) :: (S1 ('MetaSel ('Just "toolchain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Toolchain)) :: S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateProject Source #
Instance details Defined in Amazonka.CodeStar.CreateProject type AWSResponse CreateProject = CreateProjectResponse

newCreateProject Source #

Arguments

:: Text	`$sel:name:CreateProject'`
-> Text	`$sel:id: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:sourceCode:CreateProject', createProject_sourceCode - A list of the Code objects submitted with the project request. If this parameter is specified, the request must also include the toolchain parameter.

$sel:toolchain:CreateProject', createProject_toolchain - The name of the toolchain template file submitted with the project request. If this parameter is specified, the request must also include the sourceCode parameter.

$sel:clientRequestToken:CreateProject', createProject_clientRequestToken - A user- or system-generated token that identifies the entity that requested project creation. This token can be used to repeat the request.

$sel:description:CreateProject', createProject_description - The description of the project, if any.

$sel:tags:CreateProject', createProject_tags - The tags created for the project.

$sel:name:CreateProject', createProject_name - The display name for the project to be created in AWS CodeStar.

$sel:id:CreateProject', createProject_id - The ID of the project to be created in AWS CodeStar.

Request Lenses

createProject_sourceCode :: Lens' CreateProject (Maybe [Code]) Source #

A list of the Code objects submitted with the project request. If this parameter is specified, the request must also include the toolchain parameter.

createProject_toolchain :: Lens' CreateProject (Maybe Toolchain) Source #

The name of the toolchain template file submitted with the project request. If this parameter is specified, the request must also include the sourceCode parameter.

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

A user- or system-generated token that identifies the entity that requested project creation. This token can be used to repeat the request.

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

The description of the project, if any.

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

The tags created for the project.

createProject_name :: Lens' CreateProject Text Source #

The display name for the project to be created in AWS CodeStar.

createProject_id :: Lens' CreateProject Text Source #

The ID of the project to be created in AWS CodeStar.

Destructuring the Response

data CreateProjectResponse Source #

See: newCreateProjectResponse smart constructor.

Constructors

CreateProjectResponse'
Fields projectTemplateId :: Maybe Text Reserved for future use. clientRequestToken :: Maybe Text A user- or system-generated token that identifies the entity that requested project creation. httpStatus :: Int The response's http status code. id :: Text The ID of the project. arn :: Text The Amazon Resource Name (ARN) of the created project.

Instances

Instances details

Eq CreateProjectResponse Source #
Instance details Defined in Amazonka.CodeStar.CreateProject Methods (==) :: CreateProjectResponse -> CreateProjectResponse -> Bool # (/=) :: CreateProjectResponse -> CreateProjectResponse -> Bool #
Read CreateProjectResponse Source #
Instance details Defined in Amazonka.CodeStar.CreateProject Methods readsPrec :: Int -> ReadS CreateProjectResponse # readList :: ReadS [CreateProjectResponse] # readPrec :: ReadPrec CreateProjectResponse # readListPrec :: ReadPrec [CreateProjectResponse] #
Show CreateProjectResponse Source #
Instance details Defined in Amazonka.CodeStar.CreateProject Methods showsPrec :: Int -> CreateProjectResponse -> ShowS # show :: CreateProjectResponse -> String # showList :: [CreateProjectResponse] -> ShowS #
Generic CreateProjectResponse Source #
Instance details Defined in Amazonka.CodeStar.CreateProject Associated Types type Rep CreateProjectResponse :: Type -> Type # Methods from :: CreateProjectResponse -> Rep CreateProjectResponse x # to :: Rep CreateProjectResponse x -> CreateProjectResponse #
NFData CreateProjectResponse Source #
Instance details Defined in Amazonka.CodeStar.CreateProject Methods rnf :: CreateProjectResponse -> () #
type Rep CreateProjectResponse Source #
Instance details Defined in Amazonka.CodeStar.CreateProject type Rep CreateProjectResponse = D1 ('MetaData "CreateProjectResponse" "Amazonka.CodeStar.CreateProject" "libZSservicesZSamazonka-codestarZSamazonka-codestar" 'False) (C1 ('MetaCons "CreateProjectResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "projectTemplateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateProjectResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateProjectResponse'`
-> Text	`$sel:id:CreateProject'`
-> Text	`$sel:arn: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:projectTemplateId:CreateProjectResponse', createProjectResponse_projectTemplateId - Reserved for future use.

$sel:clientRequestToken:CreateProject', createProjectResponse_clientRequestToken - A user- or system-generated token that identifies the entity that requested project creation.

$sel:httpStatus:CreateProjectResponse', createProjectResponse_httpStatus - The response's http status code.

$sel:id:CreateProject', createProjectResponse_id - The ID of the project.

$sel:arn:CreateProjectResponse', createProjectResponse_arn - The Amazon Resource Name (ARN) of the created project.

Response Lenses

createProjectResponse_projectTemplateId :: Lens' CreateProjectResponse (Maybe Text) Source #

Reserved for future use.

createProjectResponse_clientRequestToken :: Lens' CreateProjectResponse (Maybe Text) Source #

A user- or system-generated token that identifies the entity that requested project creation.

createProjectResponse_httpStatus :: Lens' CreateProjectResponse Int Source #

The response's http status code.

createProjectResponse_id :: Lens' CreateProjectResponse Text Source #

The ID of the project.

createProjectResponse_arn :: Lens' CreateProjectResponse Text Source #

The Amazon Resource Name (ARN) of the created project.