CodeStar / Client / delete_project

delete_project#

CodeStar.Client.delete_project(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_project(
    id='string',
    clientRequestToken='string',
    deleteStack=True|False
)
Parameters:

  • id (string) –

    [REQUIRED]

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

  • clientRequestToken (string) – A user- or system-generated token that identifies the entity that requested project deletion. This token can be used to repeat the request.

  • deleteStack (boolean) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'stackId': 'string',
    'projectArn': 'string'
}

Response Structure

  • (dict) –

    • stackId (string) –

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

    • projectArn (string) –

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

Exceptions

  • CodeStar.Client.exceptions.ConcurrentModificationException

  • CodeStar.Client.exceptions.ValidationException

  • CodeStar.Client.exceptions.InvalidServiceRoleException