openapi: 3.0.0
info:
version: '2017-04-19'
x-release: v4
title: AWS CodeStar
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
externalDocs:
description: Amazon Web Services documentation
url: 'https://docs.aws.amazon.com/codestar/'
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)
x-hasEquivalentPaths: true
paths:
/#X-Amz-Target=CodeStar_20170419.AssociateTeamMember:
post:
operationId: AssociateTeamMember
description: Adds an IAM user to the team for an AWS CodeStar project.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AssociateTeamMemberResult'
examples:
AssociateTeamMember200Example:
summary: Default AssociateTeamMember 200 response
x-microcks-default: true
value:
clientRequestToken: example
'480':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
examples:
AssociateTeamMember480Example:
summary: Default AssociateTeamMember 480 response
x-microcks-default: true
value: example
'481':
description: ProjectNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectNotFoundException'
examples:
AssociateTeamMember481Example:
summary: Default AssociateTeamMember 481 response
x-microcks-default: true
value: example
'482':
description: TeamMemberAlreadyAssociatedException
content:
application/json:
schema:
$ref: '#/components/schemas/TeamMemberAlreadyAssociatedException'
examples:
AssociateTeamMember482Example:
summary: Default AssociateTeamMember 482 response
x-microcks-default: true
value: example
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
AssociateTeamMember483Example:
summary: Default AssociateTeamMember 483 response
x-microcks-default: true
value: example
'484':
description: InvalidServiceRoleException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidServiceRoleException'
examples:
AssociateTeamMember484Example:
summary: Default AssociateTeamMember 484 response
x-microcks-default: true
value: example
'485':
description: ProjectConfigurationException
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectConfigurationException'
examples:
AssociateTeamMember485Example:
summary: Default AssociateTeamMember 485 response
x-microcks-default: true
value: example
'486':
description: ConcurrentModificationException
content:
application/json:
schema:
$ref: '#/components/schemas/ConcurrentModificationException'
examples:
AssociateTeamMember486Example:
summary: Default AssociateTeamMember 486 response
x-microcks-default: true
value: example
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AssociateTeamMemberRequest'
examples:
AssociateTeamMemberRequestExample:
summary: Default AssociateTeamMember request
x-microcks-default: true
value:
projectId: example
clientRequestToken: example
userArn: example
projectRole: example
remoteAccessAllowed: example
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeStar_20170419.AssociateTeamMember
summary: Amazon CodeStar Associate Team Member
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=CodeStar_20170419.CreateProject:
post:
operationId: CreateProject
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.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateProjectResult'
examples:
CreateProject200Example:
summary: Default CreateProject 200 response
x-microcks-default: true
value:
id: example
arn: example
clientRequestToken: example
projectTemplateId: example
'480':
description: ProjectAlreadyExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectAlreadyExistsException'
examples:
CreateProject480Example:
summary: Default CreateProject 480 response
x-microcks-default: true
value: example
'481':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
examples:
CreateProject481Example:
summary: Default CreateProject 481 response
x-microcks-default: true
value: example
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
CreateProject482Example:
summary: Default CreateProject 482 response
x-microcks-default: true
value: example
'483':
description: ProjectCreationFailedException
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectCreationFailedException'
examples:
CreateProject483Example:
summary: Default CreateProject 483 response
x-microcks-default: true
value: example
'484':
description: InvalidServiceRoleException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidServiceRoleException'
examples:
CreateProject484Example:
summary: Default CreateProject 484 response
x-microcks-default: true
value: example
'485':
description: ProjectConfigurationException
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectConfigurationException'
examples:
CreateProject485Example:
summary: Default CreateProject 485 response
x-microcks-default: true
value: example
'486':
description: ConcurrentModificationException
content:
application/json:
schema:
$ref: '#/components/schemas/ConcurrentModificationException'
examples:
CreateProject486Example:
summary: Default CreateProject 486 response
x-microcks-default: true
value: example
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateProjectRequest'
examples:
CreateProjectRequestExample:
summary: Default CreateProject request
x-microcks-default: true
value:
name: example
id: example
description: example
clientRequestToken: example
sourceCode: example
toolchain: example
tags: example
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeStar_20170419.CreateProject
summary: Amazon CodeStar Create Project
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=CodeStar_20170419.CreateUserProfile:
post:
operationId: CreateUserProfile
description: 'Creates a profile for a user that includes user preferences, such as the display name and email address assocciated with the user, in AWS CodeStar. The user profile is not project-specific.
Information in the user profile is displayed wherever the user''s information appears to other users in AWS CodeStar.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUserProfileResult'
examples:
CreateUserProfile200Example:
summary: Default CreateUserProfile 200 response
x-microcks-default: true
value:
userArn: example
displayName: example
emailAddress: example
sshPublicKey: example
createdTimestamp: example
lastModifiedTimestamp: example
'480':
description: UserProfileAlreadyExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/UserProfileAlreadyExistsException'
examples:
CreateUserProfile480Example:
summary: Default CreateUserProfile 480 response
x-microcks-default: true
value: example
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
CreateUserProfile481Example:
summary: Default CreateUserProfile 481 response
x-microcks-default: true
value: example
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUserProfileRequest'
examples:
CreateUserProfileRequestExample:
summary: Default CreateUserProfile request
x-microcks-default: true
value:
userArn: example
displayName: example
emailAddress: example
sshPublicKey: example
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeStar_20170419.CreateUserProfile
summary: Amazon CodeStar Create User Profile
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=CodeStar_20170419.DeleteProject:
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
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'
/#X-Amz-Target=CodeStar_20170419.DeleteUserProfile:
post:
operationId: DeleteUserProfile
description: 'Deletes a user profile in AWS CodeStar, including all personal preference data associated with that profile, such as display name and email address. It does not delete the history of
that user, for example the history of commits made by that user.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteUserProfileResult'
examples:
DeleteUserProfile200Example:
summary: Default DeleteUserProfile 200 response
x-microcks-default: true
value:
userArn: example
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
DeleteUserProfile480Example:
summary: Default DeleteUserProfile 480 response
x-microcks-default: true
value: example
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteUserProfileRequest'
examples:
DeleteUserProfileRequestExample:
summary: Default DeleteUserProfile request
x-microcks-default: true
value:
userArn: example
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeStar_20170419.DeleteUserProfile
summary: Amazon CodeStar Delete User Profile
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=CodeStar_20170419.DescribeProject:
post:
operationId: DescribeProject
description: Describes a project and its resources.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeProjectResult'
examples:
DescribeProject200Example:
summary: Default DescribeProject 200 response
x-microcks-default: true
value:
name: example
id: example
arn: example
description: example
clientRequestToken: example
createdTimeStamp: example
stackId: example
projectTemplateId: example
status: example
'480':
description: ProjectNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectNotFoundException'
examples:
DescribeProject480Example:
summary: Default DescribeProject 480 response
x-microcks-default: true
value: example
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
DescribeProject481Example:
summary: Default DescribeProject 481 response
x-microcks-default: true
value: example
'482':
description: InvalidServiceRoleException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidServiceRoleException'
examples:
DescribeProject482Example:
summary: Default DescribeProject 482 response
x-microcks-default: true
value: example
'483':
description: ProjectConfigurationException
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectConfigurationException'
examples:
DescribeProject483Example:
summary: Default DescribeProject 483 response
x-microcks-default: true
value: example
'484':
description: ConcurrentModificationException
content:
application/json:
schema:
$ref: '#/components/schemas/ConcurrentModificationException'
examples:
DescribeProject484Example:
summary: Default DescribeProject 484 response
x-microcks-default: true
value: example
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeProjectRequest'
examples:
DescribeProjectRequestExample:
summary: Default DescribeProject request
x-microcks-default: true
value:
id: example
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeStar_20170419.DescribeProject
summary: Amazon CodeStar Describe Project
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=CodeStar_20170419.DescribeUserProfile:
post:
operationId: DescribeUserProfile
description: Describes a user in AWS CodeStar and the user attributes across all projects.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeUserProfileResult'
examples:
DescribeUserProfile200Example:
summary: Default DescribeUserProfile 200 response
x-microcks-default: true
value:
userArn: example
displayName: example
emailAddress: example
sshPublicKey: example
createdTimestamp: example
lastModifiedTimestamp: example
'480':
description: UserProfileNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/UserProfileNotFoundException'
examples:
DescribeUserProfile480Example:
summary: Default DescribeUserProfile 480 response
x-microcks-default: true
value: example
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
DescribeUserProfile481Example:
summary: Default DescribeUserProfile 481 response
x-microcks-default: true
value: example
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeUserProfileRequest'
examples:
DescribeUserProfileRequestExample:
summary: Default DescribeUserProfile request
x-microcks-default: true
value:
userArn: example
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeStar_20170419.DescribeUserProfile
summary: Amazon CodeStar Describe User Profile
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=CodeStar_20170419.DisassociateTeamMember:
post:
operationId: DisassociateTeamMember
description: Removes a user from a project. Removing a user from a project also removes the IAM policies from that user that allowed access to the project and its resources. Disassociating a
team member does not remove that user's profile from AWS CodeStar. It does not remove the user from IAM.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DisassociateTeamMemberResult'
examples:
DisassociateTeamMember200Example:
summary: Default DisassociateTeamMember 200 response
x-microcks-default: true
value: {}
'480':
description: ProjectNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectNotFoundException'
examples:
DisassociateTeamMember480Example:
summary: Default DisassociateTeamMember 480 response
x-microcks-default: true
value: example
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
DisassociateTeamMember481Example:
summary: Default DisassociateTeamMember 481 response
x-microcks-default: true
value: example
'482':
description: InvalidServiceRoleException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidServiceRoleException'
examples:
DisassociateTeamMember482Example:
summary: Default DisassociateTeamMember 482 response
x-microcks-default: true
value: example
'483':
description: ConcurrentModificationException
content:
application/json:
schema:
$ref: '#/components/schemas/ConcurrentModificationException'
examples:
DisassociateTeamMember483Example:
summary: Default DisassociateTeamMember 483 response
x-microcks-default: true
value: example
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DisassociateTeamMemberRequest'
examples:
DisassociateTeamMemberRequestExample:
summary: Default DisassociateTeamMember request
x-microcks-default: true
value:
projectId: example
userArn: example
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeStar_20170419.DisassociateTeamMember
summary: Amazon CodeStar Disassociate Team Member
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=CodeStar_20170419.ListProjects:
post:
operationId: ListProjects
description: Lists all projects in AWS CodeStar associated with your AWS account.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListProjectsResult'
examples:
ListProjects200Example:
summary: Default ListProjects 200 response
x-microcks-default: true
value:
projects: example
nextToken: example
'480':
description: InvalidNextTokenException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidNextTokenException'
examples:
ListProjects480Example:
summary: Default ListProjects 480 response
x-microcks-default: true
value: example
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
ListProjects481Example:
summary: Default ListProjects 481 response
x-microcks-default: true
value: example
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListProjectsRequest'
examples:
ListProjectsRequestExample:
summary: Default ListProjects request
x-microcks-default: true
value:
nextToken: example
maxResults: example
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeStar_20170419.ListProjects
summary: Amazon CodeStar List Projects
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=CodeStar_20170419.ListResources:
post:
operationId: ListResources
description: Lists resources associated with a project in AWS CodeStar.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListResourcesResult'
examples:
ListResources200Example:
summary: Default ListResources 200 response
x-microcks-default: true
value:
resources: example
nextToken: example
'480':
description: ProjectNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectNotFoundException'
examples:
ListResources480Example:
summary: Default ListResources 480 response
x-microcks-default: true
value: example
'481':
description: InvalidNextTokenException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidNextTokenException'
examples:
ListResources481Example:
summary: Default ListResources 481 response
x-microcks-default: true
value: example
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
ListResources482Example:
summary: Default ListResources 482 response
x-microcks-default: true
value: example
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListResourcesRequest'
examples:
ListResourcesRequestExample:
summary: Default ListResources request
x-microcks-default: true
value:
projectId: example
nextToken: example
maxResults: example
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeStar_20170419.ListResources
summary: Amazon CodeStar List Resources
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=CodeStar_20170419.ListTagsForProject:
post:
operationId: ListTagsForProject
description: Gets the tags for a project.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListTagsForProjectResult'
examples:
ListTagsForProject200Example:
summary: Default ListTagsForProject 200 response
x-microcks-default: true
value:
tags: example
nextToken: example
'480':
description: ProjectNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectNotFoundException'
examples:
ListTagsForProject480Example:
summary: Default ListTagsForProject 480 response
x-microcks-default: true
value: example
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
ListTagsForProject481Example:
summary: Default ListTagsForProject 481 response
x-microcks-default: true
value: example
'482':
description: InvalidNextTokenException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidNextTokenException'
examples:
ListTagsForProject482Example:
summary: Default ListTagsForProject 482 response
x-microcks-default: true
value: example
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListTagsForProjectRequest'
examples:
ListTagsForProjectRequestExample:
summary: Default ListTagsForProject request
x-microcks-default: true
value:
id: example
nextToken: example
maxResults: example
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeStar_20170419.ListTagsForProject
summary: Amazon CodeStar List Tags for Project
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=CodeStar_20170419.ListTeamMembers:
post:
operationId: ListTeamMembers
description: Lists all team members associated with a project.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListTeamMembersResult'
examples:
ListTeamMembers200Example:
summary: Default ListTeamMembers 200 response
x-microcks-default: true
value:
teamMembers: example
nextToken: example
'480':
description: ProjectNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectNotFoundException'
examples:
ListTeamMembers480Example:
summary: Default ListTeamMembers 480 response
x-microcks-default: true
value: example
'481':
description: InvalidNextTokenException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidNextTokenException'
examples:
ListTeamMembers481Example:
summary: Default ListTeamMembers 481 response
x-microcks-default: true
value: example
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
ListTeamMembers482Example:
summary: Default ListTeamMembers 482 response
x-microcks-default: true
value: example
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListTeamMembersRequest'
examples:
ListTeamMembersRequestExample:
summary: Default ListTeamMembers request
x-microcks-default: true
value:
projectId: example
nextToken: example
maxResults: example
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeStar_20170419.ListTeamMembers
summary: Amazon CodeStar List Team Members
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=CodeStar_20170419.ListUserProfiles:
post:
operationId: ListUserProfiles
description: Lists all the user profiles configured for your AWS account in AWS CodeStar.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListUserProfilesResult'
examples:
ListUserProfiles200Example:
summary: Default ListUserProfiles 200 response
x-microcks-default: true
value:
userProfiles: example
nextToken: example
'480':
description: InvalidNextTokenException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidNextTokenException'
examples:
ListUserProfiles480Example:
summary: Default ListUserProfiles 480 response
x-microcks-default: true
value: example
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
ListUserProfiles481Example:
summary: Default ListUserProfiles 481 response
x-microcks-default: true
value: example
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListUserProfilesRequest'
examples:
ListUserProfilesRequestExample:
summary: Default ListUserProfiles request
x-microcks-default: true
value:
nextToken: example
maxResults: example
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeStar_20170419.ListUserProfiles
summary: Amazon CodeStar List User Profiles
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=CodeStar_20170419.TagProject:
post:
operationId: TagProject
description: Adds tags to a project.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/TagProjectResult'
examples:
TagProject200Example:
summary: Default TagProject 200 response
x-microcks-default: true
value:
tags: example
'480':
description: ProjectNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectNotFoundException'
examples:
TagProject480Example:
summary: Default TagProject 480 response
x-microcks-default: true
value: example
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
TagProject481Example:
summary: Default TagProject 481 response
x-microcks-default: true
value: example
'482':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
examples:
TagProject482Example:
summary: Default TagProject 482 response
x-microcks-default: true
value: example
'483':
description: ConcurrentModificationException
content:
application/json:
schema:
$ref: '#/components/schemas/ConcurrentModificationException'
examples:
TagProject483Example:
summary: Default TagProject 483 response
x-microcks-default: true
value: example
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TagProjectRequest'
examples:
TagProjectRequestExample:
summary: Default TagProject request
x-microcks-default: true
value:
id: example
tags: example
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeStar_20170419.TagProject
summary: Amazon CodeStar Tag Project
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=CodeStar_20170419.UntagProject:
post:
operationId: UntagProject
description: Removes tags from a project.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UntagProjectResult'
examples:
UntagProject200Example:
summary: Default UntagProject 200 response
x-microcks-default: true
value: {}
'480':
description: ProjectNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectNotFoundException'
examples:
UntagProject480Example:
summary: Default UntagProject 480 response
x-microcks-default: true
value: example
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
UntagProject481Example:
summary: Default UntagProject 481 response
x-microcks-default: true
value: example
'482':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
examples:
UntagProject482Example:
summary: Default UntagProject 482 response
x-microcks-default: true
value: example
'483':
description: ConcurrentModificationException
content:
application/json:
schema:
$ref: '#/components/schemas/ConcurrentModificationException'
examples:
UntagProject483Example:
summary: Default UntagProject 483 response
x-microcks-default: true
value: example
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UntagProjectRequest'
examples:
UntagProjectRequestExample:
summary: Default UntagProject request
x-microcks-default: true
value:
id: example
tags: example
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeStar_20170419.UntagProject
summary: Amazon CodeStar Untag Project
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=CodeStar_20170419.UpdateProject:
post:
operationId: UpdateProject
description: Updates a project in AWS CodeStar.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateProjectResult'
examples:
UpdateProject200Example:
summary: Default UpdateProject 200 response
x-microcks-default: true
value: {}
'480':
description: ProjectNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectNotFoundException'
examples:
UpdateProject480Example:
summary: Default UpdateProject 480 response
x-microcks-default: true
value: example
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
UpdateProject481Example:
summary: Default UpdateProject 481 response
x-microcks-default: true
value: example
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateProjectRequest'
examples:
UpdateProjectRequestExample:
summary: Default UpdateProject request
x-microcks-default: true
value:
id: example
name: example
description: example
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeStar_20170419.UpdateProject
summary: Amazon CodeStar Update Project
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=CodeStar_20170419.UpdateTeamMember:
post:
operationId: UpdateTeamMember
description: 'Updates a team member''s attributes in an AWS CodeStar project. For example, you can change a team member''s role in the project, or change whether they have remote access to project
resources.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTeamMemberResult'
examples:
UpdateTeamMember200Example:
summary: Default UpdateTeamMember 200 response
x-microcks-default: true
value:
userArn: example
projectRole: example
remoteAccessAllowed: example
'480':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
examples:
UpdateTeamMember480Example:
summary: Default UpdateTeamMember 480 response
x-microcks-default: true
value: example
'481':
description: ProjectNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectNotFoundException'
examples:
UpdateTeamMember481Example:
summary: Default UpdateTeamMember 481 response
x-microcks-default: true
value: example
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
UpdateTeamMember482Example:
summary: Default UpdateTeamMember 482 response
x-microcks-default: true
value: example
'483':
description: InvalidServiceRoleException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidServiceRoleException'
examples:
UpdateTeamMember483Example:
summary: Default UpdateTeamMember 483 response
x-microcks-default: true
value: example
'484':
description: ProjectConfigurationException
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectConfigurationException'
examples:
UpdateTeamMember484Example:
summary: Default UpdateTeamMember 484 response
x-microcks-default: true
value: example
'485':
description: ConcurrentModificationException
content:
application/json:
schema:
$ref: '#/components/schemas/ConcurrentModificationException'
examples:
UpdateTeamMember485Example:
summary: Default UpdateTeamMember 485 response
x-microcks-default: true
value: example
'486':
description: TeamMemberNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/TeamMemberNotFoundException'
examples:
UpdateTeamMember486Example:
summary: Default UpdateTeamMember 486 response
x-microcks-default: true
value: example
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTeamMemberRequest'
examples:
UpdateTeamMemberRequestExample:
summary: Default UpdateTeamMember request
x-microcks-default: true
value:
projectId: example
userArn: example
projectRole: example
remoteAccessAllowed: example
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeStar_20170419.UpdateTeamMember
summary: Amazon CodeStar Update Team Member
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=CodeStar_20170419.UpdateUserProfile:
post:
operationId: UpdateUserProfile
description: 'Updates a user''s profile in AWS CodeStar. The user profile is not project-specific. Information in the user profile is displayed wherever the user''s information appears to other users
in AWS CodeStar. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateUserProfileResult'
examples:
UpdateUserProfile200Example:
summary: Default UpdateUserProfile 200 response
x-microcks-default: true
value:
userArn: example
displayName: example
emailAddress: example
sshPublicKey: example
createdTimestamp: example
lastModifiedTimestamp: example
'480':
description: UserProfileNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/UserProfileNotFoundException'
examples:
UpdateUserProfile480Example:
summary: Default UpdateUserProfile 480 response
x-microcks-default: true
value: example
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
UpdateUserProfile481Example:
summary: Default UpdateUserProfile 481 response
x-microcks-default: true
value: example
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateUserProfileRequest'
examples:
UpdateUserProfileRequestExample:
summary: Default UpdateUserProfile request
x-microcks-default: true
value:
userArn: example
displayName: example
emailAddress: example
sshPublicKey: example
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeStar_20170419.UpdateUserProfile
summary: Amazon CodeStar Update User Profile
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
components:
parameters:
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
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-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
schemas:
AssociateTeamMemberResult:
type: object
properties:
clientRequestToken:
allOf:
- $ref: '#/components/schemas/ClientRequestToken'
- description: The user- or system-generated token from the initial request that can be used to repeat the request.
AssociateTeamMemberRequest:
type: object
required:
- projectId
- userArn
- projectRole
title: AssociateTeamMemberRequest
properties:
projectId:
allOf:
- $ref: '#/components/schemas/ProjectId'
- description: The ID of the project to which you will add the IAM user.
clientRequestToken:
allOf:
- $ref: '#/components/schemas/ClientRequestToken'
- description: A user- or system-generated token that identifies the entity that requested the team member association to the project. This token can be used to repeat the request.
userArn:
allOf:
- $ref: '#/components/schemas/UserArn'
- description: The Amazon Resource Name (ARN) for the IAM user you want to add to the AWS CodeStar project.
projectRole:
allOf:
- $ref: '#/components/schemas/Role'
- description: The AWS CodeStar project role that will apply to this user. This role determines what actions a user can take in an AWS CodeStar project.
remoteAccessAllowed:
allOf:
- $ref: '#/components/schemas/RemoteAccessAllowed'
- description: 'Whether the team member is allowed to use an SSH public/private key pair to remotely access project resources, for example Amazon EC2 instances.'
LimitExceededException: {}
ProjectNotFoundException: {}
TeamMemberAlreadyAssociatedException: {}
ValidationException: {}
InvalidServiceRoleException: {}
ProjectConfigurationException: {}
ConcurrentModificationException: {}
CreateProjectResult:
type: object
required:
- id
- arn
properties:
id:
allOf:
- $ref: '#/components/schemas/ProjectId'
- description: The ID of the project.
arn:
allOf:
- $ref: '#/components/schemas/ProjectArn'
- description: The Amazon Resource Name (ARN) of the created project.
clientRequestToken:
allOf:
- $ref: '#/components/schemas/ClientRequestToken'
- description: A user- or system-generated token that identifies the entity that requested project creation.
projectTemplateId:
allOf:
- $ref: '#/components/schemas/ProjectTemplateId'
- description: Reserved for future use.
CreateProjectRequest:
type: object
required:
- name
- id
title: CreateProjectRequest
properties:
name:
allOf:
- $ref: '#/components/schemas/ProjectName'
- description: The display name for the project to be created in AWS CodeStar.
id:
allOf:
- $ref: '#/components/schemas/ProjectId'
- description: The ID of the project to be created in AWS CodeStar.
description:
allOf:
- $ref: '#/components/schemas/ProjectDescription'
- description: 'The description of the project, if any.'
clientRequestToken:
allOf:
- $ref: '#/components/schemas/ClientRequestToken'
- description: A user- or system-generated token that identifies the entity that requested project creation. This token can be used to repeat the request.
sourceCode:
allOf:
- $ref: '#/components/schemas/SourceCode'
- description: '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:
allOf:
- $ref: '#/components/schemas/Toolchain'
- description: '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.'
tags:
allOf:
- $ref: '#/components/schemas/Tags'
- description: The tags created for the project.
ProjectAlreadyExistsException: {}
ProjectCreationFailedException: {}
CreateUserProfileResult:
type: object
required:
- userArn
properties:
userArn:
allOf:
- $ref: '#/components/schemas/UserArn'
- description: The Amazon Resource Name (ARN) of the user in IAM.
displayName:
allOf:
- $ref: '#/components/schemas/UserProfileDisplayName'
- description: The name that is displayed as the friendly name for the user in AWS CodeStar.
emailAddress:
allOf:
- $ref: '#/components/schemas/Email'
- description: The email address that is displayed as part of the user's profile in AWS CodeStar.
sshPublicKey:
allOf:
- $ref: '#/components/schemas/SshPublicKey'
- description: The SSH public key associated with the user in AWS CodeStar. This is the public portion of the public/private keypair the user can use to access project resources if a project
owner allows the user remote access to those resources.
createdTimestamp:
allOf:
- $ref: '#/components/schemas/CreatedTimestamp'
- description: 'The date the user profile was created, in timestamp format.'
lastModifiedTimestamp:
allOf:
- $ref: '#/components/schemas/LastModifiedTimestamp'
- description: 'The date the user profile was last modified, in timestamp format.'
CreateUserProfileRequest:
type: object
required:
- userArn
- displayName
- emailAddress
title: CreateUserProfileRequest
properties:
userArn:
allOf:
- $ref: '#/components/schemas/UserArn'
- description: The Amazon Resource Name (ARN) of the user in IAM.
displayName:
allOf:
- $ref: '#/components/schemas/UserProfileDisplayName'
- description: 'The name that will be displayed as the friendly name for the user in AWS CodeStar. '
emailAddress:
allOf:
- $ref: '#/components/schemas/Email'
- description: The email address that will be displayed as part of the user's profile in AWS CodeStar.
sshPublicKey:
allOf:
- $ref: '#/components/schemas/SshPublicKey'
- description: 'The SSH public key associated with the user in AWS CodeStar. If a project owner allows the user remote access to project resources, this public key will be used along with the
user''s private key for SSH access.'
UserProfileAlreadyExistsException: {}
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.
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.
DeleteUserProfileResult:
type: object
required:
- userArn
properties:
userArn:
allOf:
- $ref: '#/components/schemas/UserArn'
- description: The Amazon Resource Name (ARN) of the user deleted from AWS CodeStar.
DeleteUserProfileRequest:
type: object
required:
- userArn
title: DeleteUserProfileRequest
properties:
userArn:
allOf:
- $ref: '#/components/schemas/UserArn'
- description: The Amazon Resource Name (ARN) of the user to delete from AWS CodeStar.
DescribeProjectResult:
type: object
properties:
name:
allOf:
- $ref: '#/components/schemas/ProjectName'
- description: The display name for the project.
id:
allOf:
- $ref: '#/components/schemas/ProjectId'
- description: The ID of the project.
arn:
allOf:
- $ref: '#/components/schemas/ProjectArn'
- description: The Amazon Resource Name (ARN) for the project.
description:
allOf:
- $ref: '#/components/schemas/ProjectDescription'
- description: 'The description of the project, if any.'
clientRequestToken:
allOf:
- $ref: '#/components/schemas/ClientRequestToken'
- description: 'A user- or system-generated token that identifies the entity that requested project creation. '
createdTimeStamp:
allOf:
- $ref: '#/components/schemas/CreatedTimestamp'
- description: 'The date and time the project was created, in timestamp format.'
stackId:
allOf:
- $ref: '#/components/schemas/StackId'
- description: The ID of the primary stack in AWS CloudFormation used to generate resources for the project.
projectTemplateId:
allOf:
- $ref: '#/components/schemas/ProjectTemplateId'
- description: The ID for the AWS CodeStar project template used to create the project.
status:
allOf:
- $ref: '#/components/schemas/ProjectStatus'
- description: The project creation or deletion status.
DescribeProjectRequest:
type: object
required:
- id
title: DescribeProjectRequest
properties:
id:
allOf:
- $ref: '#/components/schemas/ProjectId'
- description: The ID of the project.
DescribeUserProfileResult:
type: object
required:
- userArn
- createdTimestamp
- lastModifiedTimestamp
properties:
userArn:
allOf:
- $ref: '#/components/schemas/UserArn'
- description: The Amazon Resource Name (ARN) of the user.
displayName:
allOf:
- $ref: '#/components/schemas/UserProfileDisplayName'
- description: 'The display name shown for the user in AWS CodeStar projects. For example, this could be set to both first and last name ("Mary Major") or a single name ("Mary"). The display name
is also used to generate the initial icon associated with the user in AWS CodeStar projects. If spaces are included in the display name, the first character that appears after the space will
be used as the second character in the user initial icon. The initial icon displays a maximum of two characters, so a display name with more than one space (for example "Mary Jane Major")
would generate an initial icon using the first character and the first character after the space ("MJ", not "MM").'
emailAddress:
allOf:
- $ref: '#/components/schemas/Email'
- description: The email address for the user. Optional.
sshPublicKey:
allOf:
- $ref: '#/components/schemas/SshPublicKey'
- description: 'The SSH public key associated with the user. This SSH public key is associated with the user profile, and can be used in conjunction with the associated private key for access
to project resources, such as Amazon EC2 instances, if a project owner grants remote access to those resources.'
createdTimestamp:
allOf:
- $ref: '#/components/schemas/CreatedTimestamp'
- description: 'The date and time when the user profile was created in AWS CodeStar, in timestamp format.'
lastModifiedTimestamp:
allOf:
- $ref: '#/components/schemas/LastModifiedTimestamp'
- description: 'The date and time when the user profile was last modified, in timestamp format.'
DescribeUserProfileRequest:
type: object
required:
- userArn
title: DescribeUserProfileRequest
properties:
userArn:
allOf:
- $ref: '#/components/schemas/UserArn'
- description: The Amazon Resource Name (ARN) of the user.
UserProfileNotFoundException: {}
DisassociateTeamMemberResult:
type: object
properties: {}
DisassociateTeamMemberRequest:
type: object
required:
- projectId
- userArn
title: DisassociateTeamMemberRequest
properties:
projectId:
allOf:
- $ref: '#/components/schemas/ProjectId'
- description: The ID of the AWS CodeStar project from which you want to remove a team member.
userArn:
allOf:
- $ref: '#/components/schemas/UserArn'
- description: The Amazon Resource Name (ARN) of the IAM user or group whom you want to remove from the project.
ListProjectsResult:
type: object
required:
- projects
properties:
projects:
allOf:
- $ref: '#/components/schemas/ProjectsList'
- description: A list of projects.
nextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: 'The continuation token to use when requesting the next set of results, if there are more results to be returned.'
ListProjectsRequest:
type: object
title: ListProjectsRequest
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: 'The continuation token to be used to return the next set of results, if the results cannot be returned in one response.'
maxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: The maximum amount of data that can be contained in a single set of results.
InvalidNextTokenException: {}
ListResourcesResult:
type: object
properties:
resources:
allOf:
- $ref: '#/components/schemas/ResourcesResult'
- description: 'An array of resources associated with the project. '
nextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: 'The continuation token to use when requesting the next set of results, if there are more results to be returned.'
ListResourcesRequest:
type: object
required:
- projectId
title: ListResourcesRequest
properties:
projectId:
allOf:
- $ref: '#/components/schemas/ProjectId'
- description: The ID of the project.
nextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: 'The continuation token for the next set of results, if the results cannot be returned in one response.'
maxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: The maximum amount of data that can be contained in a single set of results.
ListTagsForProjectResult:
type: object
properties:
tags:
allOf:
- $ref: '#/components/schemas/Tags'
- description: The tags for the project.
nextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: Reserved for future use.
ListTagsForProjectRequest:
type: object
required:
- id
title: ListTagsForProjectRequest
properties:
id:
allOf:
- $ref: '#/components/schemas/ProjectId'
- description: The ID of the project to get tags for.
nextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: Reserved for future use.
maxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: Reserved for future use.
ListTeamMembersResult:
type: object
required:
- teamMembers
properties:
teamMembers:
allOf:
- $ref: '#/components/schemas/TeamMemberResult'
- description: A list of team member objects for the project.
nextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: 'The continuation token to use when requesting the next set of results, if there are more results to be returned.'
ListTeamMembersRequest:
type: object
required:
- projectId
title: ListTeamMembersRequest
properties:
projectId:
allOf:
- $ref: '#/components/schemas/ProjectId'
- description: The ID of the project for which you want to list team members.
nextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: 'The continuation token for the next set of results, if the results cannot be returned in one response.'
maxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: The maximum number of team members you want returned in a response.
ListUserProfilesResult:
type: object
required:
- userProfiles
properties:
userProfiles:
allOf:
- $ref: '#/components/schemas/UserProfilesList'
- description: All the user profiles configured in AWS CodeStar for an AWS account.
nextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: 'The continuation token to use when requesting the next set of results, if there are more results to be returned.'
ListUserProfilesRequest:
type: object
title: ListUserProfilesRequest
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: 'The continuation token for the next set of results, if the results cannot be returned in one response.'
maxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: The maximum number of results to return in a response.
TagProjectResult:
type: object
properties:
tags:
allOf:
- $ref: '#/components/schemas/Tags'
- description: The tags for the project.
TagProjectRequest:
type: object
required:
- id
- tags
title: TagProjectRequest
properties:
id:
allOf:
- $ref: '#/components/schemas/ProjectId'
- description: The ID of the project you want to add a tag to.
tags:
allOf:
- $ref: '#/components/schemas/Tags'
- description: The tags you want to add to the project.
UntagProjectResult:
type: object
properties: {}
UntagProjectRequest:
type: object
required:
- id
- tags
title: UntagProjectRequest
properties:
id:
allOf:
- $ref: '#/components/schemas/ProjectId'
- description: The ID of the project to remove tags from.
tags:
allOf:
- $ref: '#/components/schemas/TagKeys'
- description: The tags to remove from the project.
UpdateProjectResult:
type: object
properties: {}
UpdateProjectRequest:
type: object
required:
- id
title: UpdateProjectRequest
properties:
id:
allOf:
- $ref: '#/components/schemas/ProjectId'
- description: The ID of the project you want to update.
name:
allOf:
- $ref: '#/components/schemas/ProjectName'
- description: The name of the project you want to update.
description:
allOf:
- $ref: '#/components/schemas/ProjectDescription'
- description: 'The description of the project, if any.'
UpdateTeamMemberResult:
type: object
properties:
userArn:
allOf:
- $ref: '#/components/schemas/UserArn'
- description: The Amazon Resource Name (ARN) of the user whose team membership attributes were updated.
projectRole:
allOf:
- $ref: '#/components/schemas/Role'
- description: The project role granted to the user.
remoteAccessAllowed:
allOf:
- $ref: '#/components/schemas/RemoteAccessAllowed'
- description: Whether a team member is allowed to remotely access project resources using the SSH public key associated with the user's profile.
UpdateTeamMemberRequest:
type: object
required:
- projectId
- userArn
title: UpdateTeamMemberRequest
properties:
projectId:
allOf:
- $ref: '#/components/schemas/ProjectId'
- description: The ID of the project.
userArn:
allOf:
- $ref: '#/components/schemas/UserArn'
- description: The Amazon Resource Name (ARN) of the user for whom you want to change team membership attributes.
projectRole:
allOf:
- $ref: '#/components/schemas/Role'
- description: 'The role assigned to the user in the project. Project roles have different levels of access. For more information, see Working
with Teams in the AWS CodeStar User Guide.'
remoteAccessAllowed:
allOf:
- $ref: '#/components/schemas/RemoteAccessAllowed'
- description: 'Whether a team member is allowed to remotely access project resources using the SSH public key associated with the user''s profile. Even if this is set to True, the user must associate
a public key with their profile before the user can access resources.'
TeamMemberNotFoundException: {}
UpdateUserProfileResult:
type: object
required:
- userArn
properties:
userArn:
allOf:
- $ref: '#/components/schemas/UserArn'
- description: The Amazon Resource Name (ARN) of the user in IAM.
displayName:
allOf:
- $ref: '#/components/schemas/UserProfileDisplayName'
- description: The name that is displayed as the friendly name for the user in AWS CodeStar.
emailAddress:
allOf:
- $ref: '#/components/schemas/Email'
- description: The email address that is displayed as part of the user's profile in AWS CodeStar.
sshPublicKey:
allOf:
- $ref: '#/components/schemas/SshPublicKey'
- description: The SSH public key associated with the user in AWS CodeStar. This is the public portion of the public/private keypair the user can use to access project resources if a project
owner allows the user remote access to those resources.
createdTimestamp:
allOf:
- $ref: '#/components/schemas/CreatedTimestamp'
- description: 'The date the user profile was created, in timestamp format.'
lastModifiedTimestamp:
allOf:
- $ref: '#/components/schemas/LastModifiedTimestamp'
- description: 'The date the user profile was last modified, in timestamp format.'
UpdateUserProfileRequest:
type: object
required:
- userArn
title: UpdateUserProfileRequest
properties:
userArn:
allOf:
- $ref: '#/components/schemas/UserArn'
- description: The name that will be displayed as the friendly name for the user in AWS CodeStar.
displayName:
allOf:
- $ref: '#/components/schemas/UserProfileDisplayName'
- description: The name that is displayed as the friendly name for the user in AWS CodeStar.
emailAddress:
allOf:
- $ref: '#/components/schemas/Email'
- description: The email address that is displayed as part of the user's profile in AWS CodeStar.
sshPublicKey:
allOf:
- $ref: '#/components/schemas/SshPublicKey'
- description: 'The SSH public key associated with the user in AWS CodeStar. If a project owner allows the user remote access to project resources, this public key will be used along with the
user''s private key for SSH access.'
ProjectId:
type: string
pattern: '^[a-z][a-z0-9-]+$'
minLength: 2
maxLength: 15
ClientRequestToken:
type: string
pattern: '^[\w:/-]+$'
minLength: 1
maxLength: 256
UserArn:
type: string
pattern: '^arn:aws:iam::\d{12}:user(?:(\u002F)|(\u002F[\u0021-\u007E]+\u002F))[\w+=,.@-]+$'
minLength: 32
maxLength: 95
Role:
type: string
pattern: ^(Owner|Viewer|Contributor)$
RemoteAccessAllowed:
type: boolean
BucketKey:
type: string
BucketName:
type: string
minLength: 3
maxLength: 63
CodeSource:
type: object
required:
- s3
properties:
s3:
allOf:
- $ref: '#/components/schemas/S3Location'
- description: 'Information about the Amazon S3 location where the source code files provided with the project request are stored. '
description: The location where the source code files provided with the project request are stored. AWS CodeStar retrieves the files during project creation.
CodeDestination:
type: object
properties:
codeCommit:
allOf:
- $ref: '#/components/schemas/CodeCommitCodeDestination'
- description: Information about the AWS CodeCommit repository to be created in AWS CodeStar. This is where the source code files provided with the project request will be uploaded after
project creation.
gitHub:
allOf:
- $ref: '#/components/schemas/GitHubCodeDestination'
- description: Information about the GitHub repository to be created in AWS CodeStar. This is where the source code files provided with the project request will be uploaded after project
creation.
description: 'The repository to be created in AWS CodeStar. Valid values are AWS CodeCommit or GitHub. After AWS CodeStar provisions the new repository, the source code files provided with the project
request are placed in the repository.'
Code:
type: object
required:
- source
- destination
properties:
source:
allOf:
- $ref: '#/components/schemas/CodeSource'
- description: The location where the source code files provided with the project request are stored. AWS CodeStar retrieves the files during project creation.
destination:
allOf:
- $ref: '#/components/schemas/CodeDestination'
- description: 'The repository to be created in AWS CodeStar. Valid values are AWS CodeCommit or GitHub. After AWS CodeStar provisions the new repository, the source code files provided with the
project request are placed in the repository.'
description: Location and destination information about the source code files provided with the project request. The source code is uploaded to the new project source repository after project
creation.
RepositoryName:
type: string
pattern: '^\S[\w.-]*$'
minLength: 1
maxLength: 100
CodeCommitCodeDestination:
type: object
required:
- name
properties:
name:
allOf:
- $ref: '#/components/schemas/RepositoryName'
- description: The name of the AWS CodeCommit repository to be created in AWS CodeStar.
description: Information about the AWS CodeCommit repository to be created in AWS CodeStar. This is where the source code files provided with the project request will be uploaded after project
creation.
GitHubCodeDestination:
type: object
required:
- name
- type
- owner
- privateRepository
- issuesEnabled
- token
properties:
name:
allOf:
- $ref: '#/components/schemas/RepositoryName'
- description: Name of the GitHub repository to be created in AWS CodeStar.
description:
allOf:
- $ref: '#/components/schemas/RepositoryDescription'
- description: Description for the GitHub repository to be created in AWS CodeStar. This description displays in GitHub after the repository is created.
type:
allOf:
- $ref: '#/components/schemas/RepositoryType'
- description: The type of GitHub repository to be created in AWS CodeStar. Valid values are User or Organization.
owner:
allOf:
- $ref: '#/components/schemas/RepositoryOwner'
- description: 'The GitHub username for the owner of the GitHub repository to be created in AWS CodeStar. If this repository should be owned by a GitHub organization, provide its name.'
privateRepository:
allOf:
- $ref: '#/components/schemas/RepositoryIsPrivate'
- description: Whether the GitHub repository is to be a private repository.
issuesEnabled:
allOf:
- $ref: '#/components/schemas/RepositoryEnableIssues'
- description: Whether to enable issues for the GitHub repository.
token:
allOf:
- $ref: '#/components/schemas/GitHubPersonalToken'
- description: The GitHub user's personal access token for the GitHub repository.
description: Information about the GitHub repository to be created in AWS CodeStar. This is where the source code files provided with the project request will be uploaded after project creation.
S3Location:
type: object
properties:
bucketName:
allOf:
- $ref: '#/components/schemas/BucketName'
- description: The Amazon S3 bucket name where the source code files provided with the project request are stored.
bucketKey:
allOf:
- $ref: '#/components/schemas/BucketKey'
- description: The Amazon S3 object key where the source code files provided with the project request are stored.
description: The Amazon S3 location where the source code files provided with the project request are stored.
ProjectName:
type: string
pattern: ^\S(.*\S)?$
minLength: 1
maxLength: 100
format: password
ProjectDescription:
type: string
pattern: ^$|^\S(.*\S)?$
maxLength: 1024
format: password
SourceCode:
type: array
items:
$ref: '#/components/schemas/Code'
Toolchain:
type: object
required:
- source
properties:
source:
allOf:
- $ref: '#/components/schemas/ToolchainSource'
- description: The Amazon S3 location where the toolchain template file provided with the project request is stored. AWS CodeStar retrieves the file during project creation.
roleArn:
allOf:
- $ref: '#/components/schemas/RoleArn'
- description: The service role ARN for AWS CodeStar to use for the toolchain template during stack provisioning.
stackParameters:
allOf:
- $ref: '#/components/schemas/TemplateParameterMap'
- description: 'The list of parameter overrides to be passed into the toolchain template during stack provisioning, if any.'
description: The toolchain template file provided with the project request. AWS CodeStar uses the template to provision the toolchain stack in AWS CloudFormation.
Tags:
type: object
additionalProperties:
$ref: '#/components/schemas/TagValue'
ProjectArn:
type: string
pattern: '^arn:aws[^:\s]*:codestar:[^:\s]+:[0-9]{12}:project\/[a-z]([a-z0-9|-])+$'
ProjectTemplateId:
type: string
pattern: '^arn:aws[^:\s]{0,5}:codestar:[^:\s]+::project-template(\/(github|codecommit))?\/[a-z0-9-]+$'
minLength: 1
UserProfileDisplayName:
type: string
pattern: ^\S(.*\S)?$
minLength: 1
maxLength: 64
format: password
Email:
type: string
pattern: '^[\w-.+]+@[\w-.+]+$'
minLength: 3
maxLength: 128
format: password
SshPublicKey:
type: string
pattern: '^[\t\r\n\u0020-\u00FF]*$'
maxLength: 16384
CreatedTimestamp:
type: string
format: date-time
LastModifiedTimestamp:
type: string
format: date-time
DeleteStack:
type: boolean
StackId:
type: string
pattern: '^arn:aws[^:\s]*:cloudformation:[^:\s]+:[0-9]{12}:stack\/[^:\s]+\/[^:\s]+$'
ProjectStatus:
type: object
required:
- state
properties:
state:
allOf:
- $ref: '#/components/schemas/State'
- description: The phase of completion for a project creation or deletion.
reason:
allOf:
- $ref: '#/components/schemas/Reason'
- description: 'In the case of a project creation or deletion failure, a reason for the failure.'
description: An indication of whether a project creation or deletion is failed or successful.
RepositoryDescription:
type: string
pattern: ^\S(.*\S)?$
minLength: 1
maxLength: 1000
RepositoryType:
type: string
pattern: ^(user|organization|User|Organization)$
RepositoryOwner:
type: string
pattern: ^\S(.*\S)?$
minLength: 1
maxLength: 100
RepositoryIsPrivate:
type: boolean
RepositoryEnableIssues:
type: boolean
GitHubPersonalToken:
type: string
minLength: 1
format: password
PaginationToken:
type: string
pattern: '^[\w/+=]+$'
minLength: 1
maxLength: 512
MaxResults:
type: integer
minimum: 1
maximum: 100
ProjectsList:
type: array
items:
$ref: '#/components/schemas/ProjectSummary'
ResourcesResult:
type: array
items:
$ref: '#/components/schemas/Resource'
TeamMemberResult:
type: array
items:
$ref: '#/components/schemas/TeamMember'
UserProfilesList:
type: array
items:
$ref: '#/components/schemas/UserProfileSummary'
State:
type: string
pattern: ^(CreateInProgress|CreateComplete|CreateFailed|DeleteComplete|DeleteFailed|DeleteInProgress|UpdateComplete|UpdateInProgress|UpdateFailed|Unknown)$
Reason:
type: string
pattern: ^$|^\S(.*\S)?$
maxLength: 1024
ProjectSummary:
type: object
properties:
projectId:
allOf:
- $ref: '#/components/schemas/ProjectId'
- description: The ID of the project.
projectArn:
allOf:
- $ref: '#/components/schemas/ProjectArn'
- description: The Amazon Resource Name (ARN) of the project.
description: Information about the metadata for a project.
ResourceId:
type: string
pattern: '^arn\:aws\:\S.*\:.*'
minLength: 11
Resource:
type: object
required:
- id
properties:
id:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The Amazon Resource Name (ARN) of the resource.
description: Information about a resource for a project.
RoleArn:
type: string
minLength: 1
maxLength: 1224
TagKey:
type: string
pattern: '^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$'
minLength: 1
maxLength: 128
TagKeys:
type: array
items:
$ref: '#/components/schemas/TagKey'
TagValue:
type: string
pattern: '^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$'
maxLength: 256
TeamMember:
type: object
required:
- userArn
- projectRole
properties:
userArn:
allOf:
- $ref: '#/components/schemas/UserArn'
- description: The Amazon Resource Name (ARN) of the user in IAM.
projectRole:
allOf:
- $ref: '#/components/schemas/Role'
- description: 'The role assigned to the user in the project. Project roles have different levels of access. For more information, see Working
with Teams in the AWS CodeStar User Guide. '
remoteAccessAllowed:
allOf:
- $ref: '#/components/schemas/RemoteAccessAllowed'
- description: Whether the user is allowed to remotely access project resources using an SSH public/private key pair.
description: Information about a team member in a project.
TemplateParameterKey:
type: string
pattern: ^\S(.*\S)?$
minLength: 1
maxLength: 30
TemplateParameterValue:
type: string
pattern: ^\S(.*\S)?$
minLength: 1
maxLength: 100
format: password
TemplateParameterMap:
type: object
maxProperties: 25
additionalProperties:
$ref: '#/components/schemas/TemplateParameterValue'
ToolchainSource:
type: object
required:
- s3
properties:
s3:
allOf:
- $ref: '#/components/schemas/S3Location'
- description: The Amazon S3 bucket where the toolchain template file provided with the project request is stored.
description: The Amazon S3 location where the toolchain template file provided with the project request is stored. AWS CodeStar retrieves the file during project creation.
UserProfileSummary:
type: object
properties:
userArn:
allOf:
- $ref: '#/components/schemas/UserArn'
- description: The Amazon Resource Name (ARN) of the user in IAM.
displayName:
allOf:
- $ref: '#/components/schemas/UserProfileDisplayName'
- description: 'The display name of a user in AWS CodeStar. For example, this could be set to both first and last name ("Mary Major") or a single name ("Mary"). The display name is also used to
generate the initial icon associated with the user in AWS CodeStar projects. If spaces are included in the display name, the first character that appears after the space will be used as the
second character in the user initial icon. The initial icon displays a maximum of two characters, so a display name with more than one space (for example "Mary Jane Major") would generate
an initial icon using the first character and the first character after the space ("MJ", not "MM").'
emailAddress:
allOf:
- $ref: '#/components/schemas/Email'
- description: The email address associated with the user.
sshPublicKey:
allOf:
- $ref: '#/components/schemas/SshPublicKey'
- description: 'The SSH public key associated with the user in AWS CodeStar. If a project owner allows the user remote access to project resources, this public key will be used along with the
user''s private key for SSH access.'
description: Information about a user's profile in AWS CodeStar.
security:
- hmac: []