

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

# CodeConnections exemples utilisant AWS CLI
<a name="cli_codestar-connections_code_examples"></a>

Les exemples de code suivants vous montrent comment effectuer des actions et implémenter des scénarios courants à l'aide du AWS Command Line Interface with CodeConnections.

Les *actions* sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.

Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la configuration et l’exécution du code en contexte.

**Topics**
+ [Actions](#actions)

## Actions
<a name="actions"></a>

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

L'exemple de code suivant montre comment utiliser`create-connection`.

**AWS CLI**  
**Pour créer une connexion**  
L’exemple `create-connection` suivant montre comment créer une connexion à un référentiel tiers. Cet exemple crée une connexion dont le fournisseur tiers est Bitbucket.  
Une connexion créée via la AWS CLI ou dont le statut AWS CloudFormation est En attente par défaut. Après avoir créé une connexion avec la CLI AWS CloudFormation, utilisez la console pour modifier la connexion afin de rendre son statut disponible.  

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

```
{
    "ConnectionArn": "arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f"
}
```
Pour plus d’informations, consultez [Création d’une connexion](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-create.html) dans le *Guide de l’utilisateur de la console Outils pour développeurs*.  
+  Pour plus de détails sur l'API, reportez-vous [CreateConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/create-connection.html)à la section *Référence des AWS CLI commandes*. 

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

L'exemple de code suivant montre comment utiliser`create-host`.

**AWS CLI**  
**Pour créer un hôte**  
L’exemple `create-host` suivant montre comment créer un hôte pour représenter le point de terminaison de l’infrastructure sur laquelle votre fournisseur tiers est installé. Cet exemple crée un hôte sur lequel le fournisseur tiers installé est GitHub Enterprise Server.  
Un hôte créé via la AWS CLI est en attente par défaut. Après avoir créé un hôte avec la CLI, utilisez la console ou la CLI pour configurer l’hôte et définir son statut sur Available.  

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

```
{
    "HostArn": "arn:aws:codestar-connections:us-east-1:123456789012:host/My-Host-28aef605"
}
```
Pour plus d’informations, consultez [Créer un hôte (CLI)](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-host-create.html) dans le *Guide de l’utilisateur de la console Outils pour développeurs*.  
+  Pour plus de détails sur l'API, reportez-vous [CreateHost](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/create-host.html)à la section *Référence des AWS CLI commandes*. 

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

L'exemple de code suivant montre comment utiliser`delete-connection`.

**AWS CLI**  
**Pour supprimer une connexion**  
L’exemple `delete-connection` suivant montre comment supprimer une connexion.  

```
aws codestar-connections delete-connection \
    --connection-arn arn:aws:codestar-connections:us-west-2:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f
```
Cette commande ne produit aucune sortie.  
Pour plus d’informations, consultez [Suppression d’une connexion (CLI)](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-delete.html#connections-delete-cli) dans le *Guide de l’utilisateur de la console Outils pour développeurs*.  
+  Pour plus de détails sur l'API, reportez-vous [DeleteConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/delete-connection.html)à la section *Référence des AWS CLI commandes*. 

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

L'exemple de code suivant montre comment utiliser`delete-host`.

**AWS CLI**  
**Pour supprimer un hôte**  
L’exemple `delete-host` suivant illustre la suppression d’un hôte. Avant de pouvoir supprimer un hôte, vous devez supprimer toutes les connexions associées à l’hôte.  

```
aws codestar-connections delete-host \
    --host-arn "arn:aws:codestar-connections:us-east-1 :123456789012:host/My-Host-28aef605"
```
Cette commande ne produit aucune sortie.  
Pour plus d’informations, consultez [Supprimer un hôte (CLI)](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-host-delete.html#connections-host-delete-cli) dans le *Guide de l’utilisateur de la console Outils pour développeurs*.  
+  Pour plus de détails sur l'API, reportez-vous [DeleteHost](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/delete-host.html)à la section *Référence des AWS CLI commandes*. 

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

L'exemple de code suivant montre comment utiliser`get-connection`.

**AWS CLI**  
**Pour obtenir les informations sur une connexion**  
L’exemple `get-connection` suivant montre des informations sur une connexion.  

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

```
{
    "Connection": {
        "ConnectionName": "MyConnection",
        "ConnectionArn": "arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f",
        "ProviderType": "Bitbucket",
        "OwnerAccountId": "123456789012",
        "ConnectionStatus": "AVAILABLE"
    }
}
```
Pour plus d’informations, consultez [Affichage des informations de connexion](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-view-details.html) dans le *Guide de l’utilisateur de la console Outils pour développeurs*.  
+  Pour plus de détails sur l'API, reportez-vous [GetConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/get-connection.html)à la section *Référence des AWS CLI commandes*. 

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

L'exemple de code suivant montre comment utiliser`get-host`.

**AWS CLI**  
**Pour obtenir des informations sur un hôte**  
L’exemple `get-host` suivant montre des informations sur un hôte.  

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

```
{
    "Name": "MyHost",
    "Status": "AVAILABLE",
    "ProviderType": "GitHubEnterpriseServer",
    "ProviderEndpoint": "https://test-instance-1.dev/"
}
```
Pour plus d’informations, consultez [Supprimer un hôte (CLI)](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-host-view.html#connections-host-view-cli) dans le *Guide de l’utilisateur de la console Outils pour développeurs*.  
+  Pour plus de détails sur l'API, reportez-vous [GetHost](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/get-host.html)à la section *Référence des AWS CLI commandes*. 

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

L'exemple de code suivant montre comment utiliser`list-connections`.

**AWS CLI**  
**Pour répertorier les connexions**  
L’exemple `list-connections` suivant extrait une liste de toutes les connexions de votre compte pour le type de fournisseur Bitbucket :  

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

```
{
    "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"
}
```
Pour plus d’informations, consultez [Affichage de la liste des connexions (CLI)](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-list.html#connections-list-cli) dans le *Guide de l’utilisateur de la console Outils pour développeurs*.  
+  Pour plus de détails sur l'API, reportez-vous [ListConnections](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/list-connections.html)à la section *Référence des AWS CLI commandes*. 

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

L'exemple de code suivant montre comment utiliser`list-hosts`.

**AWS CLI**  
**Pour répertorier les hôtes**  
L’exemple `list-hosts` suivant extrait une liste de tous les hôtes de votre compte.  

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

```
{
    "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"
        }
    ]
}
```
Pour plus d’informations, consultez [Répertorier les hôtes (CLI)](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-host-list.html) dans le *Guide de l’utilisateur de la console Outils pour développeurs*.  
+  Pour plus de détails sur l'API, reportez-vous [ListHosts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/list-hosts.html)à la section *Référence des AWS CLI commandes*. 

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

L'exemple de code suivant montre comment utiliser`list-tags-for-resource`.

**AWS CLI**  
**Pour répertorier des balises**  
L’exemple `list-tags-for-resource` suivant extrait une liste de toutes les balises associées à la ressource de connexion spécifiée.  

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

```
{
    "Tags": [
        {
            "Key": "Project",
            "Value": "ProjectA"
        },
        {
            "Key": "ReadOnly",
            "Value": "true"
        }
    ]
}
```
Pour plus d’informations, consultez [Affichage des balises d’une ressource de connexions](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-tag.html#connections-tag-view) dans le *Guide de l’utilisateur de la console Outils pour développeurs*.  
+  Pour plus de détails sur l'API, reportez-vous [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/list-tags-for-resource.html)à la section *Référence des AWS CLI commandes*. 

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

L'exemple de code suivant montre comment utiliser`tag-resource`.

**AWS CLI**  
**Pour baliser une ressource**  
L’exemple `tag-resource` suivant associe un ensemble de balises fournies à une connexion. Utilisez cette commande pour ajouter ou modifier des balises.  

```
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
```
Cette commande ne produit aucune sortie.  
Pour plus d’informations, consultez [Ajout de balises à une ressource de connexions](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-tag.html#connections-tag-add) dans le *Guide de l’utilisateur de la console Outils pour développeurs*.  
+  Pour plus de détails sur l'API, reportez-vous [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/tag-resource.html)à la section *Référence des AWS CLI commandes*. 

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

L'exemple de code suivant montre comment utiliser`untag-resource`.

**AWS CLI**  
**Pour supprimer des AWS balises d'une ressource de connexion**  
`untag-resource` ci-dessous supprime une balise de la ressource spécifiée.  

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

```
{
    "Tags": []
}
```
Pour plus d’informations, consultez [Suppression des balises d’une ressource de connexions](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-tag.html#connections-tag-delete) dans le *Guide de l’utilisateur de la console Outils pour développeurs*.  
+  Pour plus de détails sur l'API, reportez-vous [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/untag-resource.html)à la section *Référence des AWS CLI commandes*. 