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.CodeStar.DeleteProject

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deletes a project, including project resources. Does not delete users associated with the project, but does delete the IAM roles that allowed access to the project.

Creating a Request

data DeleteProject Source #

See: newDeleteProject smart constructor.

Constructors

DeleteProject'

Fields

clientRequestToken :: Maybe Text
A user- or system-generated token that identifies the entity that requested project deletion. This token can be used to repeat the request.
deleteStack :: Maybe Bool
Whether to send a delete request for the primary stack in AWS CloudFormation originally used to generate the project and its resources. This option will delete all AWS resources for the project (except for any buckets in Amazon S3) as well as deleting the project itself. Recommended for most use cases.
id :: Text
The ID of the project to be deleted in AWS CodeStar.

Instances

Instances details

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

newDeleteProject Source #

Arguments

:: Text	`DeleteProject`
-> DeleteProject

Create a value of DeleteProject 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:clientRequestToken:DeleteProject', deleteProject_clientRequestToken - A user- or system-generated token that identifies the entity that requested project deletion. This token can be used to repeat the request.

$sel:deleteStack:DeleteProject', deleteProject_deleteStack - Whether to send a delete request for the primary stack in AWS CloudFormation originally used to generate the project and its resources. This option will delete all AWS resources for the project (except for any buckets in Amazon S3) as well as deleting the project itself. Recommended for most use cases.

DeleteProject, deleteProject_id - The ID of the project to be deleted in AWS CodeStar.

Request Lenses

deleteProject_clientRequestToken :: Lens' DeleteProject (Maybe Text) Source #

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

deleteProject_deleteStack :: Lens' DeleteProject (Maybe Bool) Source #

Whether to send a delete request for the primary stack in AWS CloudFormation originally used to generate the project and its resources. This option will delete all AWS resources for the project (except for any buckets in Amazon S3) as well as deleting the project itself. Recommended for most use cases.

deleteProject_id :: Lens' DeleteProject Text Source #

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

Destructuring the Response

data DeleteProjectResponse Source #

See: newDeleteProjectResponse smart constructor.

Constructors

DeleteProjectResponse'
Fields projectArn :: Maybe Text The Amazon Resource Name (ARN) of the deleted project. stackId :: Maybe Text The ID of the primary stack in AWS CloudFormation that will be deleted as part of deleting the project and its resources. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDeleteProjectResponse Source #

Arguments

:: Int	`$sel:httpStatus:DeleteProjectResponse'`
-> DeleteProjectResponse

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

DeleteProjectResponse, deleteProjectResponse_projectArn - The Amazon Resource Name (ARN) of the deleted project.

$sel:stackId:DeleteProjectResponse', deleteProjectResponse_stackId - The ID of the primary stack in AWS CloudFormation that will be deleted as part of deleting the project and its resources.

$sel:httpStatus:DeleteProjectResponse', deleteProjectResponse_httpStatus - The response's http status code.

Response Lenses

deleteProjectResponse_projectArn :: Lens' DeleteProjectResponse (Maybe Text) Source #

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

deleteProjectResponse_stackId :: Lens' DeleteProjectResponse (Maybe Text) Source #

The ID of the primary stack in AWS CloudFormation that will be deleted as part of deleting the project and its resources.

deleteProjectResponse_httpStatus :: Lens' DeleteProjectResponse Int Source #

The response's http status code.