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.DescribeProject API'
  description: <fullname>AWS CodeStar</fullname> <p>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.</p> <p>You can use the AWS CodeStar API to work with:</p> <p>Projects and their resources, by calling the following:</p> <ul> <li> <p> <code>DeleteProject</code>, which deletes a project.</p> </li> <li> <p> <code>DescribeProject</code>, which lists the attributes of a project.</p> </li> <li> <p> <code>ListProjects</code>, which lists all projects associated with your AWS account.</p> </li> <li> <p> <code>ListResources</code>, which lists the resources associated with a project.</p> </li> <li> <p> <code>ListTagsForProject</code>, which lists the tags associated with a project.</p> </li> <li> <p> <code>TagProject</code>, which adds tags to a project.</p> </li> <li> <p> <code>UntagProject</code>, which removes tags from a project.</p> </li> <li> <p> <code>UpdateProject</code>, which updates the attributes of a project.</p> </li> </ul> <p>Teams and team members, by calling the following:</p> <ul> <li> <p> <code>AssociateTeamMember</code>, which adds an IAM user to the team for a project.</p> </li> <li> <p> <code>DisassociateTeamMember</code>, which removes an IAM user from the team for a project.</p> </li> <li> <p> <code>ListTeamMembers</code>, which lists all the IAM users in the team for a project, including their roles and attributes.</p> </li> <li> <p> <code>UpdateTeamMember</code>, which updates a team member's attributes in a project.</p> </li> </ul> <p>Users, by calling the following:</p> <ul> <li> <p> <code>CreateUserProfile</code>, which creates a user profile that contains data associated with the user across all projects.</p> </li> <li> <p> <code>DeleteUserProfile</code>, which deletes all user profile information across all projects.</p> </li> <li> <p> <code>DescribeUserProfile</code>, which describes the profile of a user.</p> </li> <li> <p> <code>ListUserProfiles</code>, which lists all user profiles.</p> </li> <li> <p> <code>UpdateUserProfile</code>, which updates the profile for a user.</p> </li> </ul>
  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.DescribeProject'
paths:
  /#X-Amz-Target=CodeStar_20170419.DescribeProject:
    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: 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
      tags:
      - '#X Amz Target=CodeStar 20170419.DescribeProject'
components:
  schemas:
    DescribeProjectRequest:
      type: object
      required:
      - id
      title: DescribeProjectRequest
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/ProjectId'
          - description: The ID of the project.
    ValidationException: {}
    ProjectArn:
      type: string
      pattern: ^arn:aws[^:\s]*:codestar:[^:\s]+:[0-9]{12}:project\/[a-z]([a-z0-9|-])+$
    ProjectNotFoundException: {}
    ProjectTemplateId:
      type: string
      pattern: ^arn:aws[^:\s]{0,5}:codestar:[^:\s]+::project-template(\/(github|codecommit))?\/[a-z0-9-]+$
      minLength: 1
    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.
    State:
      type: string
      pattern: ^(CreateInProgress|CreateComplete|CreateFailed|DeleteComplete|DeleteFailed|DeleteInProgress|UpdateComplete|UpdateInProgress|UpdateFailed|Unknown)$
    InvalidServiceRoleException: {}
    ProjectDescription:
      type: string
      pattern: ^$|^\S(.*\S)?$
      maxLength: 1024
      format: password
    ProjectName:
      type: string
      pattern: ^\S(.*\S)?$
      minLength: 1
      maxLength: 100
      format: password
    CreatedTimestamp:
      type: string
      format: date-time
    Reason:
      type: string
      pattern: ^$|^\S(.*\S)?$
      maxLength: 1024
    ConcurrentModificationException: {}
    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.
    ProjectId:
      type: string
      pattern: ^[a-z][a-z0-9-]+$
      minLength: 2
      maxLength: 15
    ClientRequestToken:
      type: string
      pattern: ^[\w:/-]+$
      minLength: 1
      maxLength: 256
    ProjectConfigurationException: {}
    StackId:
      type: string
      pattern: ^arn:aws[^:\s]*:cloudformation:[^:\s]+:[0-9]{12}:stack\/[^:\s]+\/[^:\s]+$
  parameters:
    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-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      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
  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