# Exemplos do CodeConnections usando a AWS CLI
<a name="cli_codestar-connections_code_examples"></a>

Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o CodeConnections.

*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.

Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.

**Topics**
+ [Ações](#actions)

## Ações
<a name="actions"></a>

### `create-connection`
<a name="codestar-connections_CreateConnection_cli_topic"></a>

O código de exemplo a seguir mostra como usar `create-connection`.

**AWS CLI**  
**Para criar uma conexão**  
O exemplo `create-connection` a seguir mostra como criar uma conexão com um repositório de terceiros. Este exemplo cria uma conexão em que o provedor de terceiros é o Bitbucket.  
Uma conexão criada por meio da AWS CLI ou do AWS CloudFormation permanece com o status Pendente por padrão. Depois de criar uma conexão com a CLI ou o AWS CloudFormation, use o console para editar a conexão e tornar seu status Disponível.  

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

```
{
    "ConnectionArn": "arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f"
}
```
Para obter mais informações, consulte [Criar uma conexão](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-create.html) no *Guia do usuário do console de ferramentas do desenvolvedor*.  
+  Para ver detalhes da API, consulte [CreateConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/create-connection.html) na *Referência de comandos da AWS CLI*. 

### `create-host`
<a name="codestar-connections_CreateHost_cli_topic"></a>

O código de exemplo a seguir mostra como usar `create-host`.

**AWS CLI**  
**Para criar um host**  
O exemplo `create-host` a seguir mostra como criar um host para representar o endpoint da infraestrutura em que seu provedor de terceiros está instalado. Este exemplo cria um host em que o provedor de terceiros instalado é o GitHub Enterprise Server.  
Um host criado por meio da AWS CLI permanece no status Pendente por padrão. Após criar um host com a CLI, use o console ou a CLI para configurar o host e tornar seu status Disponível.  

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

```
{
    "HostArn": "arn:aws:codestar-connections:us-east-1:123456789012:host/My-Host-28aef605"
}
```
Para obter mais informações, consulte [Criar um host (CLI)](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-host-create.html) no *Guia do usuário do console de ferramentas do desenvolvedor*.  
+  Para ver detalhes da API, consulte [CreateHost](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/create-host.html) na *Referência de comandos da AWS CLI*. 

### `delete-connection`
<a name="codestar-connections_DeleteConnection_cli_topic"></a>

O código de exemplo a seguir mostra como usar `delete-connection`.

**AWS CLI**  
**Para excluir uma conexão**  
O exemplo `delete-connection` a seguir mostra como excluir uma conexão.  

```
aws codestar-connections delete-connection \
    --connection-arn arn:aws:codestar-connections:us-west-2:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f
```
Este comando não produz saída.  
Para obter mais informações, consulte [Excluir uma conexão (CLI)](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-delete.html#connections-delete-cli) no *Guia do usuário do console de ferramentas do desenvolvedor*.  
+  Para ver detalhes da API, consulte [DeleteConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/delete-connection.html) na *Referência de comandos da AWS CLI*. 

### `delete-host`
<a name="codestar-connections_DeleteHost_cli_topic"></a>

O código de exemplo a seguir mostra como usar `delete-host`.

**AWS CLI**  
**Para excluir um host**  
O exemplo `delete-host` a seguir mostra como excluir um host. Para poder excluir um host, primeiro é necessário excluir todas as conexões associadas a ele.  

```
aws codestar-connections delete-host \
    --host-arn "arn:aws:codestar-connections:us-east-1 :123456789012:host/My-Host-28aef605"
```
Este comando não produz saída.  
Para obter mais informações, consulte [Excluir um host (CLI)](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-host-delete.html#connections-host-delete-cli) no *Guia do usuário do console de ferramentas do desenvolvedor*.  
+  Para ver detalhes da API, consulte [DeleteHost](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/delete-host.html) na *Referência de comandos da AWS CLI*. 

### `get-connection`
<a name="codestar-connections_GetConnection_cli_topic"></a>

O código de exemplo a seguir mostra como usar `get-connection`.

**AWS CLI**  
**Para obter informações sobre uma conexão**  
O exemplo `get-connection` a seguir mostra detalhes de uma conexão.  

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

```
{
    "Connection": {
        "ConnectionName": "MyConnection",
        "ConnectionArn": "arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f",
        "ProviderType": "Bitbucket",
        "OwnerAccountId": "123456789012",
        "ConnectionStatus": "AVAILABLE"
    }
}
```
Para obter mais informações, consulte [Visualizar detalhes da conexão](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-view-details.html) no *Guia do usuário do console de ferramentas do desenvolvedor*.  
+  Para ver detalhes da API, consulte [GetConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/get-connection.html) na *Referência de comandos da AWS CLI*. 

### `get-host`
<a name="codestar-connections_GetHost_cli_topic"></a>

O código de exemplo a seguir mostra como usar `get-host`.

**AWS CLI**  
**Para obter informações sobre um host**  
O exemplo `get-host` a seguir mostra detalhes sobre um host.  

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

```
{
    "Name": "MyHost",
    "Status": "AVAILABLE",
    "ProviderType": "GitHubEnterpriseServer",
    "ProviderEndpoint": "https://test-instance-1.dev/"
}
```
Para obter mais informações, consulte [Visualizar detalhes do host (CLI)](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-host-view.html#connections-host-view-cli) no *Guia do usuário do console de ferramentas do desenvolvedor*.  
+  Para ver detalhes da API, consulte [GetHost](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/get-host.html) na *Referência de comandos da AWS CLI*. 

### `list-connections`
<a name="codestar-connections_ListConnections_cli_topic"></a>

O código de exemplo a seguir mostra como usar `list-connections`.

**AWS CLI**  
**Para listar conexões**  
O exemplo `list-connections` a seguir recupera uma lista de todas as conexões em sua conta para o tipo de provedor Bitbucket:  

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

```
{
    "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"
}
```
Para obter mais informações sobre conexões, consulte [Listar conexões (CLI)](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-list.html#connections-list-cli) no *Guia do usuário do console de ferramentas do desenvolvedor*.  
+  Para ver detalhes da API, consulte [ListConnections](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/list-connections.html) na *Referência de comandos da AWS CLI*. 

### `list-hosts`
<a name="codestar-connections_ListHosts_cli_topic"></a>

O código de exemplo a seguir mostra como usar `list-hosts`.

**AWS CLI**  
**Para listar hosts**  
O exemplo `list-hosts` a seguir recupera uma lista de todos os hosts em sua conta.  

```
aws codestar-connections list-hosts
```
Resultado:  

```
{
    "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"
        }
    ]
}
```
Para obter mais informações sobre conexões, consulte [Listar host (CLI)](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-host-list.html) no *Guia do usuário do console de ferramentas do desenvolvedor*.  
+  Para ver detalhes da API, consulte [ListHosts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/list-hosts.html) na *Referência de comandos da AWS CLI*. 

### `list-tags-for-resource`
<a name="codestar-connections_ListTagsForResource_cli_topic"></a>

O código de exemplo a seguir mostra como usar `list-tags-for-resource`.

**AWS CLI**  
**Para listar tags**  
O exemplo `list-tags-for-resource` a seguir recupera uma lista de todas as tags anexadas ao recurso de conexões especificado.  

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

```
{
    "Tags": [
        {
            "Key": "Project",
            "Value": "ProjectA"
        },
        {
            "Key": "ReadOnly",
            "Value": "true"
        }
    ]
}
```
Para obter mais informações, consulte [Visualizar tags de um recurso de conexões](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-tag.html#connections-tag-view) no *Guia do usuário do console de ferramentas do desenvolvedor*.  
+  Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/list-tags-for-resource.html) na *AWS CLI Command Reference*. 

### `tag-resource`
<a name="codestar-connections_TagResource_cli_topic"></a>

O código de exemplo a seguir mostra como usar `tag-resource`.

**AWS CLI**  
**Como marcar um recurso**  
O exemplo `tag-resource` a seguir associa um conjunto de tags fornecidas a um conexão. Use esse comando para adicionar ou editar tags.  

```
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
```
Este comando não produz saída.  
Para obter mais informações, consulte [Adicionar tags a um recurso de conexões](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-tag.html#connections-tag-add) no *Guia do usuário do console de ferramentas do desenvolvedor*.  
+  Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/tag-resource.html) na *Referência de comandos da AWS CLI*. 

### `untag-resource`
<a name="codestar-connections_UntagResource_cli_topic"></a>

O código de exemplo a seguir mostra como usar `untag-resource`.

**AWS CLI**  
**Para remover tags da AWS de um recurso de conexões**  
O `untag-resource` a seguir remove uma tag do recurso especificado.  

```
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
```
Resultado:  

```
{
    "Tags": []
}
```
Para obter mais informações, consulte [Remover tags de um recurso de conexões](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-tag.html#connections-tag-delete) no *Guia do usuário do console de ferramentas do desenvolvedor*.  
+  Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/untag-resource.html) na *Referência de comandos da AWS CLI*.