CodeConnections 使用示例 AWS CLI - AWS SDK 代码示例

CodeConnections 使用示例 AWS CLI

以下代码示例向您展示了如何使用with来执行操作和实现常见场景 CodeConnections。 AWS Command Line Interface

操作是大型程序的代码摘录，必须在上下文中运行。您可以通过操作了解如何调用单个服务函数，还可以通过函数相关场景的上下文查看操作。

每个示例都包含一个指向完整源代码的链接，您可以从中找到有关如何在上下文中设置和运行代码的说明。

主题

操作

操作

以下代码示例演示如何使用 create-connection。

AWS CLI

创建连接

以下 create-connection 示例演示如何创建与第三方存储库的连接。此示例创建第三方提供程序为 Bitbucket 的连接。

通过 AWS CLI 创建的连接或默认 AWS CloudFormation 处于待处理状态。使用 CLI 或创建连接后 AWS CloudFormation，使用控制台编辑连接以使其状态变为 “可用”。


aws codestar-connections create-connection \
    --provider-type Bitbucket \
    --connection-name MyConnection

输出：


{
    "ConnectionArn": "arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f"
}

有关更多信息，请参阅《开发人员工具控制台用户指南》中的创建连接。

有关 API 的详细信息，请参阅AWS CLI 命令参考CreateConnection中的。

create-connection

以下代码示例演示如何使用 create-connection。

AWS CLI

创建连接

以下 create-connection 示例演示如何创建与第三方存储库的连接。此示例创建第三方提供程序为 Bitbucket 的连接。

通过 AWS CLI 创建的连接或默认 AWS CloudFormation 处于待处理状态。使用 CLI 或创建连接后 AWS CloudFormation，使用控制台编辑连接以使其状态变为 “可用”。


aws codestar-connections create-connection \
    --provider-type Bitbucket \
    --connection-name MyConnection

输出：


{
    "ConnectionArn": "arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f"
}

有关更多信息，请参阅《开发人员工具控制台用户指南》中的创建连接。

有关 API 的详细信息，请参阅AWS CLI 命令参考CreateConnection中的。

以下代码示例演示如何使用 create-host。

AWS CLI

创建主机

以下 create-host 示例演示如何创建主机，来表示安装第三方提供程序的基础设施的端点。此示例创建了一台主机，其中安装的第三方提供商是 GitHub 企业服务器。

默认情况下，通过 AWS CLI 创建的主机处于待处理状态。使用 CLI 创建主机后，可使用控制台或 CLI 设置主机以使其状态为 Available。


aws codestar-connections create-host \
    --name MyHost \
    --provider-type GitHubEnterpriseServer \
    --provider-endpoint "https://my-instance.dev"

输出：


{
    "HostArn": "arn:aws:codestar-connections:us-east-1:123456789012:host/My-Host-28aef605"
}

有关更多信息，请参阅《开发人员工具控制台用户指南》中的创建主机（CLI）。

有关 API 的详细信息，请参阅AWS CLI 命令参考CreateHost中的。

create-host

以下代码示例演示如何使用 create-host。

AWS CLI

创建主机

默认情况下，通过 AWS CLI 创建的主机处于待处理状态。使用 CLI 创建主机后，可使用控制台或 CLI 设置主机以使其状态为 Available。


aws codestar-connections create-host \
    --name MyHost \
    --provider-type GitHubEnterpriseServer \
    --provider-endpoint "https://my-instance.dev"

输出：


{
    "HostArn": "arn:aws:codestar-connections:us-east-1:123456789012:host/My-Host-28aef605"
}

有关更多信息，请参阅《开发人员工具控制台用户指南》中的创建主机（CLI）。

有关 API 的详细信息，请参阅AWS CLI 命令参考CreateHost中的。

以下代码示例演示如何使用 delete-connection。

AWS CLI

删除连接

以下 delete-connection 示例演示如何删除连接。


aws codestar-connections delete-connection \
    --connection-arn arn:aws:codestar-connections:us-west-2:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f

此命令不生成任何输出。

有关更多信息，请参阅《开发人员工具控制台用户指南》中的删除连接（CLI）。

有关 API 的详细信息，请参阅AWS CLI 命令参考DeleteConnection中的。

delete-connection

以下代码示例演示如何使用 delete-connection。

AWS CLI

删除连接

以下 delete-connection 示例演示如何删除连接。


aws codestar-connections delete-connection \
    --connection-arn arn:aws:codestar-connections:us-west-2:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f

此命令不生成任何输出。

有关更多信息，请参阅《开发人员工具控制台用户指南》中的删除连接（CLI）。

有关 API 的详细信息，请参阅AWS CLI 命令参考DeleteConnection中的。

以下代码示例演示如何使用 delete-host。

AWS CLI

删除主机

下面的 delete-host 示例演示如何删除主机。必须先删除与主机关联的所有连接，然后才能删除主机。


aws codestar-connections delete-host \
    --host-arn "arn:aws:codestar-connections:us-east-1 :123456789012:host/My-Host-28aef605"

此命令不生成任何输出。

有关更多信息，请参阅《开发人员工具控制台用户指南》中的删除主机（CLI）。

有关 API 的详细信息，请参阅AWS CLI 命令参考DeleteHost中的。

delete-host

以下代码示例演示如何使用 delete-host。

AWS CLI

删除主机

下面的 delete-host 示例演示如何删除主机。必须先删除与主机关联的所有连接，然后才能删除主机。


aws codestar-connections delete-host \
    --host-arn "arn:aws:codestar-connections:us-east-1 :123456789012:host/My-Host-28aef605"

此命令不生成任何输出。

有关更多信息，请参阅《开发人员工具控制台用户指南》中的删除主机（CLI）。

有关 API 的详细信息，请参阅AWS CLI 命令参考DeleteHost中的。

以下代码示例演示如何使用 get-connection。

AWS CLI

获取有关连接的信息

以下 get-connection 示例演示有关连接的信息。


aws codestar-connections get-connection \
    --connection-arn arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f

输出：


{
    "Connection": {
        "ConnectionName": "MyConnection",
        "ConnectionArn": "arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f",
        "ProviderType": "Bitbucket",
        "OwnerAccountId": "123456789012",
        "ConnectionStatus": "AVAILABLE"
    }
}

有关更多信息，请参阅《开发人员工具控制台用户指南》中的查看连接的详细信息。

有关 API 的详细信息，请参阅AWS CLI 命令参考GetConnection中的。

get-connection

以下代码示例演示如何使用 get-connection。

AWS CLI

获取有关连接的信息

以下 get-connection 示例演示有关连接的信息。


aws codestar-connections get-connection \
    --connection-arn arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f

输出：


{
    "Connection": {
        "ConnectionName": "MyConnection",
        "ConnectionArn": "arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f",
        "ProviderType": "Bitbucket",
        "OwnerAccountId": "123456789012",
        "ConnectionStatus": "AVAILABLE"
    }
}

有关更多信息，请参阅《开发人员工具控制台用户指南》中的查看连接的详细信息。

有关 API 的详细信息，请参阅AWS CLI 命令参考GetConnection中的。

以下代码示例演示如何使用 get-host。

AWS CLI

获取有关主机的信息

以下 get-host 示例演示有关主机的信息。


aws codestar-connections get-host \
    --host-arn arn:aws:codestar-connections:us-east-1:123456789012:host/MyHost-28aef605

输出：


{
    "Name": "MyHost",
    "Status": "AVAILABLE",
    "ProviderType": "GitHubEnterpriseServer",
    "ProviderEndpoint": "https://test-instance-1.dev/"
}

有关更多信息，请参阅《开发人员工具控制台用户指南》中的查看主机的详细信息（CLI）。

有关 API 的详细信息，请参阅AWS CLI 命令参考GetHost中的。

get-host

以下代码示例演示如何使用 get-host。

AWS CLI

获取有关主机的信息

以下 get-host 示例演示有关主机的信息。


aws codestar-connections get-host \
    --host-arn arn:aws:codestar-connections:us-east-1:123456789012:host/MyHost-28aef605

输出：


{
    "Name": "MyHost",
    "Status": "AVAILABLE",
    "ProviderType": "GitHubEnterpriseServer",
    "ProviderEndpoint": "https://test-instance-1.dev/"
}

有关更多信息，请参阅《开发人员工具控制台用户指南》中的查看主机的详细信息（CLI）。

有关 API 的详细信息，请参阅AWS CLI 命令参考GetHost中的。

以下代码示例演示如何使用 list-connections。

AWS CLI

列出连接

以下 list-connections 示例检索您账户中 Bitbucket 提供程序类型的所有连接的列表：


aws codestar-connections list-connections \
--provider-type Bitbucket \
--max-results 5 \
--next-token: next-token

输出：


{
    "Connections": [
        {
            "ConnectionName": "my-connection",
            "ProviderType": "Bitbucket",
            "Status": "PENDING",
            "ARN": "arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f",
            "OwnerAccountId": "123456789012"
        },
        {
            "ConnectionName": "my-other-connection",
            "ProviderType": "Bitbucket",
            "Status": "AVAILABLE",
            "ARN": "arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f",
            "OwnerAccountId": "123456789012"
        },
    ],
    "NextToken": "next-token"
}

有关更多信息，请参阅《开发人员工具控制台用户指南》中的列出连接（CLI）。

有关 API 的详细信息，请参阅AWS CLI 命令参考ListConnections中的。

list-connections

以下代码示例演示如何使用 list-connections。

AWS CLI

列出连接

以下 list-connections 示例检索您账户中 Bitbucket 提供程序类型的所有连接的列表：


aws codestar-connections list-connections \
--provider-type Bitbucket \
--max-results 5 \
--next-token: next-token

输出：


{
    "Connections": [
        {
            "ConnectionName": "my-connection",
            "ProviderType": "Bitbucket",
            "Status": "PENDING",
            "ARN": "arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f",
            "OwnerAccountId": "123456789012"
        },
        {
            "ConnectionName": "my-other-connection",
            "ProviderType": "Bitbucket",
            "Status": "AVAILABLE",
            "ARN": "arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f",
            "OwnerAccountId": "123456789012"
        },
    ],
    "NextToken": "next-token"
}

有关更多信息，请参阅《开发人员工具控制台用户指南》中的列出连接（CLI）。

有关 API 的详细信息，请参阅AWS CLI 命令参考ListConnections中的。

以下代码示例演示如何使用 list-hosts。

AWS CLI

列出主机

以下 list-hosts 示例检索您账户中所有主机的列表。


aws codestar-connections list-hosts

输出：


{
    "Hosts": [
        {
            "Name": "My-Host",
            "HostArn": "arn:aws:codestar-connections:us-east-1:123456789012:host/My-Host-28aef605",
            "ProviderType": "GitHubEnterpriseServer",
            "ProviderEndpoint": "https://my-instance.test.dev",
            "Status": "AVAILABLE"
        }
    ]
}

有关更多信息，请参阅《开发人员工具控制台用户指南》中的列出主机（CLI）。

有关 API 的详细信息，请参阅AWS CLI 命令参考ListHosts中的。

list-hosts

以下代码示例演示如何使用 list-hosts。

AWS CLI

列出主机

以下 list-hosts 示例检索您账户中所有主机的列表。


aws codestar-connections list-hosts

输出：


{
    "Hosts": [
        {
            "Name": "My-Host",
            "HostArn": "arn:aws:codestar-connections:us-east-1:123456789012:host/My-Host-28aef605",
            "ProviderType": "GitHubEnterpriseServer",
            "ProviderEndpoint": "https://my-instance.test.dev",
            "Status": "AVAILABLE"
        }
    ]
}

有关更多信息，请参阅《开发人员工具控制台用户指南》中的列出主机（CLI）。

有关 API 的详细信息，请参阅AWS CLI 命令参考ListHosts中的。

以下代码示例演示如何使用 list-tags-for-resource。

AWS CLI

列出标签

以下 list-tags-for-resource 示例检索附加到指定连接资源的所有标签的列表。


aws codestar-connections list-tags-for-resource \
    --resource-arn arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f

输出：


{
    "Tags": [
        {
            "Key": "Project",
            "Value": "ProjectA"
        },
        {
            "Key": "ReadOnly",
            "Value": "true"
        }
    ]
}

有关更多信息，请参阅《开发人员工具控制台用户指南》中的查看连接资源的标签。

有关 API 的详细信息，请参阅AWS CLI 命令参考ListTagsForResource中的。

list-tags-for-resource

以下代码示例演示如何使用 list-tags-for-resource。

AWS CLI

列出标签

以下 list-tags-for-resource 示例检索附加到指定连接资源的所有标签的列表。


aws codestar-connections list-tags-for-resource \
    --resource-arn arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f

输出：


{
    "Tags": [
        {
            "Key": "Project",
            "Value": "ProjectA"
        },
        {
            "Key": "ReadOnly",
            "Value": "true"
        }
    ]
}

有关更多信息，请参阅《开发人员工具控制台用户指南》中的查看连接资源的标签。

有关 API 的详细信息，请参阅AWS CLI 命令参考ListTagsForResource中的。

以下代码示例演示如何使用 tag-resource。

AWS CLI

标记资源

以下 tag-resource 示例将一组提供的标签与连接关联。使用此命令添加或编辑标签。


aws codestar-connections tag-resource \
    --resource-arn arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f \
    --tags Key=Project,Value=ProjectA Key=IscontainerBased,Value=true

此命令不生成任何输出。

有关更多信息，请参阅《开发人员工具控制台用户指南》中的向连接资源添加标签。

有关 API 的详细信息，请参阅AWS CLI 命令参考TagResource中的。

tag-resource

以下代码示例演示如何使用 tag-resource。

AWS CLI

标记资源

以下 tag-resource 示例将一组提供的标签与连接关联。使用此命令添加或编辑标签。


aws codestar-connections tag-resource \
    --resource-arn arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f \
    --tags Key=Project,Value=ProjectA Key=IscontainerBased,Value=true

此命令不生成任何输出。

有关更多信息，请参阅《开发人员工具控制台用户指南》中的向连接资源添加标签。

有关 API 的详细信息，请参阅AWS CLI 命令参考TagResource中的。

以下代码示例演示如何使用 untag-resource。

AWS CLI

从连接资源中移除 AWS 标签

以下 untag-resource 移除指定资源的标签。


aws codestar-connections untag-resource \
    --resource-arn arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f \
    --tag-keys Project ReadOnly

输出：


{
    "Tags": []
}

有关更多信息，请参阅《开发人员工具控制台用户指南》中的移除连接资源的标签。

有关 API 的详细信息，请参阅AWS CLI 命令参考UntagResource中的。

untag-resource

以下代码示例演示如何使用 untag-resource。

AWS CLI

从连接资源中移除 AWS 标签

以下 untag-resource 移除指定资源的标签。


aws codestar-connections untag-resource \
    --resource-arn arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f \
    --tag-keys Project ReadOnly

输出：


{
    "Tags": []
}

有关更多信息，请参阅《开发人员工具控制台用户指南》中的移除连接资源的标签。

有关 API 的详细信息，请参阅AWS CLI 命令参考UntagResource中的。

Javascript 在您的浏览器中被禁用或不可用。

要使用 Amazon Web Services 文档，必须启用 Javascript。请参阅浏览器的帮助页面以了解相关说明。

文档惯例

AWS CodeStar 通知

Amazon Cognito Identity

选择您的 Cookie 首选项

自定义 Cookie 首选项

关键

性能

功能

广告

无法保存 Cookie 首选项

CodeConnections 使用示例 AWS CLI

主题

操作

create-connection

create-host

delete-connection

delete-host

get-connection

get-host

list-connections

list-hosts

list-tags-for-resource

tag-resource

untag-resource

此页内容对您是否有帮助？

下一主题：

上一主题：

需要帮助吗？