Amazonka.CodeStar.CreateProject

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.

Creating a Request

data CreateProject

See: newCreateProject smart constructor.

Constructors

CreateProject'

Fields

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

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

• tags :: Maybe (HashMap Text Text)

  The tags created for the project.

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

• 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

ToJSON CreateProject

Defined in Amazonka.CodeStar.CreateProject

Methods

toJSON :: CreateProject -> Value

toEncoding :: CreateProject -> Encoding

toJSONList :: [CreateProject] -> Value

toEncodingList :: [CreateProject] -> Encoding

ToHeaders CreateProject

Defined in Amazonka.CodeStar.CreateProject

Methods

toHeaders :: CreateProject -> [Header]

ToPath CreateProject

Defined in Amazonka.CodeStar.CreateProject

Methods

toPath :: CreateProject -> ByteString

ToQuery CreateProject

Defined in Amazonka.CodeStar.CreateProject

Methods

toQuery :: CreateProject -> QueryString

AWSRequest CreateProject

Defined in Amazonka.CodeStar.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

Defined in Amazonka.CodeStar.CreateProject

Associated Types

type Rep CreateProject :: Type -> Type

Methods

from :: CreateProject -> Rep CreateProject x

to :: Rep CreateProject x -> CreateProject

Show CreateProject

Defined in Amazonka.CodeStar.CreateProject

Methods

showsPrec :: Int -> CreateProject -> ShowS

show :: CreateProject -> String

showList :: [CreateProject] -> ShowS

NFData CreateProject

Defined in Amazonka.CodeStar.CreateProject

Methods

rnf :: CreateProject -> ()

Eq CreateProject

Defined in Amazonka.CodeStar.CreateProject

Methods

(==) :: CreateProject -> CreateProject -> Bool

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

Hashable CreateProject

Defined in Amazonka.CodeStar.CreateProject

Methods

hashWithSalt :: Int -> CreateProject -> Int

hash :: CreateProject -> Int

type AWSResponse CreateProject

Defined in Amazonka.CodeStar.CreateProject

type AWSResponse CreateProject = CreateProjectResponse

type Rep CreateProject

Defined in Amazonka.CodeStar.CreateProject

type Rep CreateProject = D1 ('MetaData "CreateProject" "Amazonka.CodeStar.CreateProject" "amazonka-codestar-2.0-J6u0QgMrENu7wBmwByxQnV" 'False) (C1 ('MetaCons "CreateProject'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "sourceCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Code])))) :*: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "toolchain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Toolchain))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateProject

Arguments

:: Text

CreateProject

-> 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_clientRequestToken - A user- or system-generated token that identifies the entity that requested project creation. This token can be used to repeat the request.

CreateProject, createProject_description - The description of the project, if any.

$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:tags:CreateProject', createProject_tags - The tags created for the project.

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

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

CreateProject, createProject_id - The ID of the project to be created in AWS CodeStar.

Request Lenses

createProject_clientRequestToken :: Lens' CreateProject (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.

createProject_description :: Lens' CreateProject (Maybe Text)

The description of the project, if any.

createProject_sourceCode :: Lens' CreateProject (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.

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

The tags created for the project.

createProject_toolchain :: Lens' CreateProject (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.

createProject_name :: Lens' CreateProject Text

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

createProject_id :: Lens' CreateProject Text

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

Destructuring the Response

data CreateProjectResponse

See: newCreateProjectResponse smart constructor.

Constructors

CreateProjectResponse'

Fields

• clientRequestToken :: Maybe Text

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

• projectTemplateId :: Maybe Text

  Reserved for future use.

• 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

Generic CreateProjectResponse

Defined in Amazonka.CodeStar.CreateProject

Associated Types

type Rep CreateProjectResponse :: Type -> Type

Methods

from :: CreateProjectResponse -> Rep CreateProjectResponse x

to :: Rep CreateProjectResponse x -> CreateProjectResponse

Read CreateProjectResponse

Defined in Amazonka.CodeStar.CreateProject

Methods

readsPrec :: Int -> ReadS CreateProjectResponse

readList :: ReadS [CreateProjectResponse]

readPrec :: ReadPrec CreateProjectResponse

readListPrec :: ReadPrec [CreateProjectResponse]

Show CreateProjectResponse

Defined in Amazonka.CodeStar.CreateProject

Methods

showsPrec :: Int -> CreateProjectResponse -> ShowS

show :: CreateProjectResponse -> String

showList :: [CreateProjectResponse] -> ShowS

NFData CreateProjectResponse

Defined in Amazonka.CodeStar.CreateProject

Methods

rnf :: CreateProjectResponse -> ()

Eq CreateProjectResponse

Defined in Amazonka.CodeStar.CreateProject

Methods

(==) :: CreateProjectResponse -> CreateProjectResponse -> Bool

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

type Rep CreateProjectResponse

Defined in Amazonka.CodeStar.CreateProject

type Rep CreateProjectResponse = D1 ('MetaData "CreateProjectResponse" "Amazonka.CodeStar.CreateProject" "amazonka-codestar-2.0-J6u0QgMrENu7wBmwByxQnV" 'False) (C1 ('MetaCons "CreateProjectResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "projectTemplateId") '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

Arguments

:: Int

$sel:httpStatus:CreateProjectResponse'

-> Text

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:

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

$sel:projectTemplateId:CreateProjectResponse', createProjectResponse_projectTemplateId - Reserved for future use.

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

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_clientRequestToken :: Lens' CreateProjectResponse (Maybe Text)

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

createProjectResponse_projectTemplateId :: Lens' CreateProjectResponse (Maybe Text)

Reserved for future use.

createProjectResponse_httpStatus :: Lens' CreateProjectResponse Int

The response's http status code.

createProjectResponse_id :: Lens' CreateProjectResponse Text

The ID of the project.

createProjectResponse_arn :: Lens' CreateProjectResponse Text

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