Amazon CodeBuild #X Amz Target=CodeBuild 20161006.ImportSourceCredentials API

The #X Amz Target=CodeBuild 20161006.ImportSourceCredentials API from Amazon CodeBuild — 1 operation(s) for #x amz target=codebuild 20161006.importsourcecredentials.

OpenAPI Specification

amazon-codebuild-x-amz-target-codebuild-20161006-importsourcecredentials-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  version: '2016-10-06'
  x-release: v4
  title: 'AWS CodeBuild Builds #X Amz Target=CodeBuild 20161006.ImportSourceCredentials API'
  description: <fullname>CodeBuild</fullname> <p>CodeBuild is a fully managed build service in the cloud. CodeBuild compiles your source code, runs unit tests, and produces artifacts that are ready to deploy. CodeBuild eliminates the need to provision, manage, and scale your own build servers. It provides prepackaged build environments for the most popular programming languages and build tools, such as Apache Maven, Gradle, and more. You can also fully customize build environments in CodeBuild to use your own build tools. CodeBuild scales automatically to meet peak build requests. You pay only for the build time you consume. For more information about CodeBuild, see the <i> <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/welcome.html">CodeBuild User Guide</a>.</i> </p>
  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: codebuild
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/codebuild-2016-10-06.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://codebuild.{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 AWS CodeBuild multi-region endpoint
- url: https://codebuild.{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 AWS CodeBuild multi-region endpoint
- url: http://codebuild.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS CodeBuild endpoint for China (Beijing) and China (Ningxia)
- url: https://codebuild.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS CodeBuild endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=CodeBuild 20161006.ImportSourceCredentials'
paths:
  /#X-Amz-Target=CodeBuild_20161006.ImportSourceCredentials:
    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: ImportSourceCredentials
      description: ' Imports the source repository credentials for an CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository. '
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportSourceCredentialsOutput'
              examples:
                ImportSourceCredentials200Example:
                  summary: Default ImportSourceCredentials 200 response
                  x-microcks-default: true
                  value:
                    arn: arn:aws:service:us-east-1:123456789012:resource/example
        '480':
          description: InvalidInputException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
              examples:
                ImportSourceCredentials480Example:
                  summary: Default ImportSourceCredentials 480 response
                  x-microcks-default: true
                  value: example-value
        '481':
          description: AccountLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountLimitExceededException'
              examples:
                ImportSourceCredentials481Example:
                  summary: Default ImportSourceCredentials 481 response
                  x-microcks-default: true
                  value: example-value
        '482':
          description: ResourceAlreadyExistsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceAlreadyExistsException'
              examples:
                ImportSourceCredentials482Example:
                  summary: Default ImportSourceCredentials 482 response
                  x-microcks-default: true
                  value: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportSourceCredentialsInput'
            examples:
              ImportSourceCredentialsRequestExample:
                summary: Default ImportSourceCredentials request
                x-microcks-default: true
                value:
                  username: example-resource
                  token: example-value
                  serverType: STANDARD
                  authType: STANDARD
                  shouldOverwrite: example-value
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CodeBuild_20161006.ImportSourceCredentials
      summary: Amazon CodeBuild Import Source Credentials
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=CodeBuild 20161006.ImportSourceCredentials'
components:
  schemas:
    ImportSourceCredentialsOutput:
      type: object
      properties:
        arn:
          allOf:
          - $ref: '#/components/schemas/NonEmptyString'
          - description: ' The Amazon Resource Name (ARN) of the token. '
    AuthType:
      type: string
      enum:
      - OAUTH
      - BASIC_AUTH
      - PERSONAL_ACCESS_TOKEN
    WrapperBoolean:
      type: boolean
    AccountLimitExceededException: {}
    ResourceAlreadyExistsException: {}
    ImportSourceCredentialsInput:
      type: object
      required:
      - token
      - serverType
      - authType
      title: ImportSourceCredentialsInput
      properties:
        username:
          allOf:
          - $ref: '#/components/schemas/NonEmptyString'
          - description: ' The Bitbucket username when the <code>authType</code> is BASIC_AUTH. This parameter is not valid for other types of source providers or connections. '
        token:
          allOf:
          - $ref: '#/components/schemas/SensitiveNonEmptyString'
          - description: ' For GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket, this is the app password. '
        serverType:
          allOf:
          - $ref: '#/components/schemas/ServerType'
          - description: ' The source provider used for this project. '
        authType:
          allOf:
          - $ref: '#/components/schemas/AuthType'
          - description: ' The type of authentication used to connect to a GitHub, GitHub Enterprise, or Bitbucket repository. An OAUTH connection is not supported by the API and must be created using the CodeBuild console. '
        shouldOverwrite:
          allOf:
          - $ref: '#/components/schemas/WrapperBoolean'
          - description: ' Set to <code>false</code> to prevent overwriting the repository source credentials. Set to <code>true</code> to overwrite the repository source credentials. The default value is <code>true</code>. '
    NonEmptyString:
      type: string
      minLength: 1
    InvalidInputException: {}
    ServerType:
      type: string
      enum:
      - GITHUB
      - BITBUCKET
      - GITHUB_ENTERPRISE
    SensitiveNonEmptyString:
      type: string
      minLength: 1
      format: password
  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-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-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
  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/codebuild/
x-hasEquivalentPaths: true