AWS CodeStar连接API参考

接入教程

1. 创建AWS账户并登录控制台
2. 在CodeStar服务中新建连接配置
3. 选择代码仓库平台（如GitHub）并授权
4. 使用API密钥配置本地开发环境
5. 调用Connections API管理连接状态

列出所有连接

python

import boto3

client = boto3.client('codestar-connections', region_name='us-east-1')
response = client.list_connections()
print(response['Connections'])

获取连接详情

php

<?php
require 'vendor/autoload.php';

use Aws\CodeStarconnections\CodeStarconnectionsClient;
use Aws\Exception\AwsException;

$client = new CodeStarconnectionsClient([
    'region' => 'us-east-1',
    'version' => 'latest'
]);

try {
    $result = $client->getConnection([
        'ConnectionArn' => 'arn:aws:codestar-connections:us-east-1:123456789012:connection/example-connection-id'
    ]);
    echo $result['Connection'];
} catch (AwsException $e) {
    echo $e->getMessage();
}
?>

创建新的连接

javascript

const { CodeStarconnectionsClient, CreateConnectionCommand } = require('@aws-sdk/client-codestar-connections');

const client = new CodeStarconnectionsClient({ region: 'us-east-1' });

const command = new CreateConnectionCommand({
  ConnectionName: 'MyGitHubConnection',
  ProviderType: 'GitHub'
});

async function run() {
  try {
    const data = await client.send(command);
    console.log(data.ConnectionArn);
  } catch (error) {
    console.error(error);
  }
}

run();

常见问题

如何获取访问 AWS CodeStar Connections API 的凭证？

您需要使用 AWS IAM 用户或角色的访问密钥（Access Key ID 和 Secret Access Key）。建议通过 AWS CLI 配置凭证，或在代码中使用环境变量、IAM 角色等方式。

AWS CodeStar Connections 支持哪些代码仓库提供商？

AWS CodeStar Connections 支持连接至 GitHub、GitHub Enterprise Server、Bitbucket 等主流代码仓库服务，用于在 AWS 服务（如 CodePipeline）中集成源代码。

创建连接后，为什么状态显示为 'PENDING'？

连接状态为 'PENDING' 通常表示需要在目标代码仓库提供商（如 GitHub）中完成授权安装。您需要按照 AWS 控制台或 API 返回的提示，完成 OAuth 授权流程。