openapi: 3.0.0
info:
version: '2017-04-19'
x-release: v4
title: 'AWS CodeStar #X Amz Target=CodeStar 20170419.AssociateTeamMember #X Amz Target=CodeStar 20170419.AssociateTeamMember #X Amz Target=CodeStar 20170419.DeleteProject API'
description: AWS CodeStar
This is the API reference for AWS CodeStar. This reference provides descriptions of the operations and data types for the AWS CodeStar API along with usage examples.
You can use the AWS CodeStar API to work with:
Projects and their resources, by calling the following:
-
DeleteProject, which deletes a project.
-
DescribeProject, which lists the attributes of a project.
-
ListProjects, which lists all projects associated with your AWS account.
-
ListResources, which lists the resources associated with a project.
-
ListTagsForProject, which lists the tags associated with a project.
-
TagProject, which adds tags to a project.
-
UntagProject, which removes tags from a project.
-
UpdateProject, which updates the attributes of a project.
Teams and team members, by calling the following:
-
AssociateTeamMember, which adds an IAM user to the team for a project.
-
DisassociateTeamMember, which removes an IAM user from the team for a project.
-
ListTeamMembers, which lists all the IAM users in the team for a project, including their roles and attributes.
-
UpdateTeamMember, which updates a team member's attributes in a project.
Users, by calling the following:
-
CreateUserProfile, which creates a user profile that contains data associated with the user across all projects.
-
DeleteUserProfile, which deletes all user profile information across all projects.
-
DescribeUserProfile, which describes the profile of a user.
-
ListUserProfiles, which lists all user profiles.
-
UpdateUserProfile, which updates the profile for a user.
x-logo:
url: https://twitter.com/awscloud/profile_image?size=original
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: codestar
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/codestar-2017-04-19.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://codestar.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The CodeStar multi-region endpoint
- url: https://codestar.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The CodeStar multi-region endpoint
- url: http://codestar.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The CodeStar endpoint for China (Beijing) and China (Ningxia)
- url: https://codestar.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The CodeStar endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=CodeStar 20170419.DeleteProject'
paths:
/#X-Amz-Target=CodeStar_20170419.DeleteProject:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DeleteProject
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.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteProjectResult'
examples:
DeleteProject200Example:
summary: Default DeleteProject 200 response
x-microcks-default: true
value:
stackId: example
projectArn: example
'480':
description: ConcurrentModificationException
content:
application/json:
schema:
$ref: '#/components/schemas/ConcurrentModificationException'
examples:
DeleteProject480Example:
summary: Default DeleteProject 480 response
x-microcks-default: true
value: example
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
DeleteProject481Example:
summary: Default DeleteProject 481 response
x-microcks-default: true
value: example
'482':
description: InvalidServiceRoleException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidServiceRoleException'
examples:
DeleteProject482Example:
summary: Default DeleteProject 482 response
x-microcks-default: true
value: example
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteProjectRequest'
examples:
DeleteProjectRequestExample:
summary: Default DeleteProject request
x-microcks-default: true
value:
id: example
clientRequestToken: example
deleteStack: example
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeStar_20170419.DeleteProject
summary: Amazon CodeStar Delete Project
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#X Amz Target=CodeStar 20170419.DeleteProject'
components:
parameters:
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
schemas:
DeleteStack:
type: boolean
InvalidServiceRoleException: {}
ConcurrentModificationException: {}
DeleteProjectRequest:
type: object
required:
- id
title: DeleteProjectRequest
properties:
id:
allOf:
- $ref: '#/components/schemas/ProjectId'
- description: The ID of the project to be deleted in AWS CodeStar.
clientRequestToken:
allOf:
- $ref: '#/components/schemas/ClientRequestToken'
- description: 'A user- or system-generated token that identifies the entity that requested project deletion. This token can be used to repeat the request. '
deleteStack:
allOf:
- $ref: '#/components/schemas/DeleteStack'
- description: 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.
ProjectArn:
type: string
pattern: ^arn:aws[^:\s]*:codestar:[^:\s]+:[0-9]{12}:project\/[a-z]([a-z0-9|-])+$
ValidationException: {}
ClientRequestToken:
type: string
pattern: ^[\w:/-]+$
minLength: 1
maxLength: 256
StackId:
type: string
pattern: ^arn:aws[^:\s]*:cloudformation:[^:\s]+:[0-9]{12}:stack\/[^:\s]+\/[^:\s]+$
DeleteProjectResult:
type: object
properties:
stackId:
allOf:
- $ref: '#/components/schemas/StackId'
- description: The ID of the primary stack in AWS CloudFormation that will be deleted as part of deleting the project and its resources.
projectArn:
allOf:
- $ref: '#/components/schemas/ProjectArn'
- description: The Amazon Resource Name (ARN) of the deleted project.
ProjectId:
type: string
pattern: ^[a-z][a-z0-9-]+$
minLength: 2
maxLength: 15
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/codestar/
x-hasEquivalentPaths: true