CodeBuild / Client / import_source_credentials

import_source_credentials#

CodeBuild.Client.import_source_credentials(**kwargs)#

Imports the source repository credentials for an CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.

See also: AWS API Documentation

Request Syntax

response = client.import_source_credentials(
    username='string',
    token='string',
    serverType='GITHUB'|'BITBUCKET'|'GITHUB_ENTERPRISE'|'GITLAB'|'GITLAB_SELF_MANAGED',
    authType='OAUTH'|'BASIC_AUTH'|'PERSONAL_ACCESS_TOKEN'|'CODECONNECTIONS',
    shouldOverwrite=True|False
)
Parameters:

  • username (string) – The Bitbucket username when the authType is BASIC_AUTH. This parameter is not valid for other types of source providers or connections.

  • token (string) –

    [REQUIRED]

    For GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket, this is either the access token or the app password. For the authType CODECONNECTIONS, this is the connectionArn.

  • serverType (string) –

    [REQUIRED]

    The source provider used for this project.

  • authType (string) –

    [REQUIRED]

    The type of authentication used to connect to a GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket repository. An OAUTH connection is not supported by the API and must be created using the CodeBuild console. Note that CODECONNECTIONS is only valid for GitLab and GitLab Self Managed.

  • shouldOverwrite (boolean) – Set to false to prevent overwriting the repository source credentials. Set to true to overwrite the repository source credentials. The default value is true.

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string'
}

Response Structure

  • (dict) –

    • arn (string) –

      The Amazon Resource Name (ARN) of the token.

Exceptions

  • CodeBuild.Client.exceptions.InvalidInputException

  • CodeBuild.Client.exceptions.AccountLimitExceededException

  • CodeBuild.Client.exceptions.ResourceAlreadyExistsException