

D'autres exemples de AWS SDK sont disponibles dans le référentiel [AWS Doc SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples) GitHub .

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.

# Exemples d'utilisation d'Amazon Pinpoint AWS CLI
<a name="cli_2_pinpoint_code_examples"></a>

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

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-app`
<a name="pinpoint_CreateApp_cli_2_topic"></a>

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

**AWS CLI**  
**Exemple 1 : pour créer une application**  
L’exemple `create-app` suivant crée une application (projet).  

```
aws pinpoint create-app \
    --create-application-request Name=ExampleCorp
```
Sortie :  

```
{
    "ApplicationResponse": {
        "Arn": "arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example",
        "Id": "810c7aab86d42fb2b56c8c966example",
        "Name": "ExampleCorp",
        "tags": {}
    }
}
```
**Exemple 2 : pour créer une application balisée**  
L’exemple `create-app` suivant crée une application (projet) et associe une balise (clé et valeur) à l’application.  

```
aws pinpoint create-app \
    --create-application-request Name=ExampleCorp,tags={"Stack"="Test"}
```
Sortie :  

```
{
    "ApplicationResponse": {
        "Arn": "arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example",
        "Id": "810c7aab86d42fb2b56c8c966example",
        "Name": "ExampleCorp",
        "tags": {
            "Stack": "Test"
        }
    }
}
```
+  Pour plus de détails sur l'API, reportez-vous [CreateApp](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/create-app.html)à la section *Référence des AWS CLI commandes*. 

### `create-sms-template`
<a name="pinpoint_CreateSmsTemplate_cli_2_topic"></a>

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

**AWS CLI**  
**Crée un modèle de message pour les messages qui sont envoyés par le canal SMS**  
L’exemple `create-sms-template` suivant crée un modèle de message SMS.  

```
aws pinpoint create-sms-template \
    --template-name TestTemplate \
    --sms-template-request file://myfile.json \
    --region us-east-1
```
Contenu de `myfile.json` :  

```
{
    "Body": "hello\n how are you?\n food is good",
    "TemplateDescription": "Test SMS Template"
}
```
Sortie :  

```
{
    "CreateTemplateMessageBody": {
        "Arn": "arn:aws:mobiletargeting:us-east-1:AIDACKCEVSQ6C2EXAMPLE:templates/TestTemplate/SMS",
        "Message": "Created",
        "RequestID": "8c36b17f-a0b0-400f-ac21-29e9b62a975d"
    }
}
```
Pour plus d’informations, consultez [Modèles de messages Amazon Pinpoint](https://docs.aws.amazon.com/pinpoint/latest/userguide/messages-templates.html) dans le *Guide de l’utilisateur Amazon Pinpoint*.  
+  Pour plus de détails sur l'API, reportez-vous [CreateSmsTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/create-sms-template.html)à la section *Référence des AWS CLI commandes*. 

### `delete-app`
<a name="pinpoint_DeleteApp_cli_2_topic"></a>

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

**AWS CLI**  
**Pour supprimer une application**  
L’exemple `delete-app` suivant supprime une application (projet).  

```
aws pinpoint delete-app \
    --application-id 810c7aab86d42fb2b56c8c966example
```
Sortie :  

```
{
    "ApplicationResponse": {
        "Arn": "arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example",
        "Id": "810c7aab86d42fb2b56c8c966example",
        "Name": "ExampleCorp",
        "tags": {}
    }
}
```
+  Pour plus de détails sur l'API, reportez-vous [DeleteApp](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/delete-app.html)à la section *Référence des AWS CLI commandes*. 

### `get-apns-channel`
<a name="pinpoint_GetApnsChannel_cli_2_topic"></a>

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

**AWS CLI**  
**Pour récupérer des informations sur l'état et les paramètres du APNs canal pour une application**  
L'`get-apns-channel`exemple suivant permet de récupérer des informations sur le statut et les paramètres du APNs canal pour une application.  

```
aws pinpoint get-apns-channel \
    --application-id 9ab1068eb0a6461c86cce7f27ce0efd7 \
    --region us-east-1
```
Sortie :  

```
{
    "APNSChannelResponse": {
        "ApplicationId": "9ab1068eb0a6461c86cce7f27ce0efd7",
        "CreationDate": "2019-05-09T21:54:45.082Z",
        "DefaultAuthenticationMethod": "CERTIFICATE",
        "Enabled": true,
        "HasCredential": true,
        "HasTokenKey": false,
        "Id": "apns",
        "IsArchived": false,
        "LastModifiedDate": "2019-05-09T22:04:01.067Z",
        "Platform": "APNS",
        "Version": 2
    }
}
```
+  Pour plus de détails sur l'API, reportez-vous [GetApnsChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-apns-channel.html)à la section *Référence des AWS CLI commandes*. 

### `get-app`
<a name="pinpoint_GetApp_cli_2_topic"></a>

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

**AWS CLI**  
**Pour extraire des informations sur une application (projet)**  
L’exemple `get-app` suivant extrait des informations sur une application (projet).  

```
aws pinpoint get-app \
    --application-id 810c7aab86d42fb2b56c8c966example \
    --region us-east-1
```
Sortie :  

```
{
    "ApplicationResponse": {
        "Arn": "arn:aws:mobiletargeting:us-east-1:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example",
        "Id": "810c7aab86d42fb2b56c8c966example",
        "Name": "ExampleCorp",
        "tags": {
                "Year": "2019",
                "Stack": "Production"
            }
    }
}
```
+  Pour plus de détails sur l'API, reportez-vous [GetApp](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-app.html)à la section *Référence des AWS CLI commandes*. 

### `get-apps`
<a name="pinpoint_GetApps_cli_2_topic"></a>

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

**AWS CLI**  
**Pour extraire des informations sur l’ensemble de vos applications**  
L’exemple `get-apps` suivant récupère les informations sur l’ensemble de vos applications (projets).  

```
aws pinpoint get-apps
```
Sortie :  

```
{
    "ApplicationsResponse": {
        "Item": [
            {
                "Arn": "arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example",
                "Id": "810c7aab86d42fb2b56c8c966example",
                "Name": "ExampleCorp",
                "tags": {
                    "Year": "2019",
                    "Stack": "Production"
                }
            },
            {
                "Arn": "arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/42d8c7eb0990a57ba1d5476a3example",
                "Id": "42d8c7eb0990a57ba1d5476a3example",
                "Name": "AnyCompany",
                "tags": {}
            },
            {
                "Arn": "arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/80f5c382b638ffe5ad12376bbexample",
                "Id": "80f5c382b638ffe5ad12376bbexample",
                "Name": "ExampleCorp_Test",
                "tags": {
                    "Year": "2019",
                    "Stack": "Test"
                }
            }
        ],
        "NextToken": "eyJDcmVhdGlvbkRhdGUiOiIyMDE5LTA3LTE2VDE0OjM4OjUzLjkwM1oiLCJBY2NvdW50SWQiOiI1MTIzOTcxODM4NzciLCJBcHBJZCI6Ijk1ZTM2MGRiMzBkMjQ1ZjRiYTYwYjhlMzllMzZlNjZhIn0"
    }
}
```
La présence de la réponse `NextToken` indique qu’il y a davantage de sorties disponibles. Appelez à nouveau la commande et indiquez cette valeur comme paramètre d’entrée `NextToken`.  
+  Pour plus de détails sur l'API, reportez-vous [GetApps](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-apps.html)à la section *Référence des AWS CLI commandes*. 

### `get-campaign`
<a name="pinpoint_GetCampaign_cli_2_topic"></a>

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

**AWS CLI**  
**Pour extraire des informations sur le statut, la configuration et d’autres paramètres d’une campagne**  
L’exemple `get-campaign` suivant extrait des informations sur le statut, la configuration et d’autres paramètres d’une campagne.  

```
aws pinpoint get-campaign \
    --application-id 6e0b7591a90841d2b5d93fa11143e5a7 \
    --campaign-id a1e63c6cc0eb43ed826ffcc3cc90b30d \
    --region us-east-1
```
Sortie :  

```
{
    "CampaignResponse": {
        "AdditionalTreatments": [],
        "ApplicationId": "6e0b7591a90841d2b5d93fa11143e5a7",
        "Arn": "arn:aws:mobiletargeting:us-east-1:AIDACKCEVSQ6C2EXAMPLE:apps/6e0b7591a90841d2b5d93fa11143e5a7/campaigns/a1e63c6cc0eb43ed826ffcc3cc90b30d",
        "CreationDate": "2019-10-08T18:40:16.581Z",
        "Description": " ",
        "HoldoutPercent": 0,
        "Id": "a1e63c6cc0eb43ed826ffcc3cc90b30d",
        "IsPaused": false,
        "LastModifiedDate": "2019-10-08T18:40:16.581Z",
        "Limits": {
            "Daily": 0,
            "MaximumDuration": 60,
            "MessagesPerSecond": 50,
            "Total": 0
        },
        "MessageConfiguration": {
            "EmailMessage": {
                "FromAddress": "sender@example.com",
                "HtmlBody": "<!DOCTYPE html>\n  <html lang=\"en\">\n    <head>\n    <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n</head>\n<body>Hello</body>\n</html>",
                "Title": "PinpointDemo"
            }
        },
        "Name": "MyCampaign",
        "Schedule": {
            "IsLocalTime": false,
            "StartTime": "IMMEDIATE",
            "Timezone": "utc"
        },
        "SegmentId": "b66c9e42f71444b2aa2e0ffc1df28f60",
        "SegmentVersion": 1,
        "State": {
            "CampaignStatus": "COMPLETED"
        },
        "tags": {},
        "TemplateConfiguration": {},
        "Version": 1
    }
}
```
+  Pour plus de détails sur l'API, reportez-vous [GetCampaign](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-campaign.html)à la section *Référence des AWS CLI commandes*. 

### `get-campaigns`
<a name="pinpoint_GetCampaigns_cli_2_topic"></a>

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

**AWS CLI**  
**Pour extraire des informations sur le statut, la configuration et d’autres paramètres de l’ensemble des campagnes associées à une application**  
L’exemple `get-campaigns` suivant extrait des informations sur le statut, la configuration et d’autres paramètres de l’ensemble des campagnes associées à une application.  

```
aws pinpoint get-campaigns \
    --application-id 6e0b7591a90841d2b5d93fa11143e5a7 \
    --region us-east-1
```
Sortie :  

```
{
    "CampaignsResponse": {
        "Item": [
            {
                "AdditionalTreatments": [],
                "ApplicationId": "6e0b7591a90841d2b5d93fa11143e5a7",
                "Arn": "arn:aws:mobiletargeting:us-east-1:AIDACKCEVSQ6C2EXAMPLE:apps/6e0b7591a90841d2b5d93fa11143e5a7/campaigns/7e1280344c8f4a9aa40a00b006fe44f1",
                "CreationDate": "2019-10-08T18:40:22.905Z",
                "Description": " ",
                "HoldoutPercent": 0,
                "Id": "7e1280344c8f4a9aa40a00b006fe44f1",
                "IsPaused": false,
                "LastModifiedDate": "2019-10-08T18:40:22.905Z",
                "Limits": {},
                "MessageConfiguration": {
                    "EmailMessage": {
                        "FromAddress": "sender@example.com",
                        "HtmlBody": "<!DOCTYPE html>\n    <html lang=\"en\">\n    <head>\n    <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n</head>\n<body>Hello</body>\n</html>",
                        "Title": "PInpointDemo Test"
                    }
                },
                "Name": "MyCampaign1",
                "Schedule": {
                    "IsLocalTime": false,
                    "QuietTime": {},
                    "StartTime": "IMMEDIATE",
                    "Timezone": "UTC"
                },
                "SegmentId": "b66c9e42f71444b2aa2e0ffc1df28f60",
                "SegmentVersion": 1,
                "State": {
                    "CampaignStatus": "COMPLETED"
                },
                "tags": {},
                "TemplateConfiguration": {},
                "Version": 1
            },
            {
                "AdditionalTreatments": [],
                "ApplicationId": "6e0b7591a90841d2b5d93fa11143e5a7",
                "Arn": "arn:aws:mobiletargeting:us-east-1:AIDACKCEVSQ6C2EXAMPLE:apps/6e0b7591a90841d2b5d93fa11143e5a7/campaigns/a1e63c6cc0eb43ed826ffcc3cc90b30d",
                "CreationDate": "2019-10-08T18:40:16.581Z",
                "Description": " ",
                "HoldoutPercent": 0,
                "Id": "a1e63c6cc0eb43ed826ffcc3cc90b30d",
                "IsPaused": false,
                "LastModifiedDate": "2019-10-08T18:40:16.581Z",
                "Limits": {
                    "Daily": 0,
                    "MaximumDuration": 60,
                    "MessagesPerSecond": 50,
                    "Total": 0
                },
                "MessageConfiguration": {
                    "EmailMessage": {
                        "FromAddress": "sender@example.com",
                        "HtmlBody": "<!DOCTYPE html>\n    <html lang=\"en\">\n    <head>\n    <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n</head>\n<body>Demo</body>\n</html>",
                        "Title": "PinpointDemo"
                    }
                },
                "Name": "MyCampaign2",
                "Schedule": {
                    "IsLocalTime": false,
                    "StartTime": "IMMEDIATE",
                    "Timezone": "utc"
                },
                "SegmentId": "b66c9e42f71444b2aa2e0ffc1df28f60",
                "SegmentVersion": 1,
                "State": {
                    "CampaignStatus": "COMPLETED"
                },
                "tags": {},
                "TemplateConfiguration": {},
                "Version": 1
            }
        ]
    }
}
```
+  Pour plus de détails sur l'API, reportez-vous [GetCampaigns](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-campaigns.html)à la section *Référence des AWS CLI commandes*. 

### `get-channels`
<a name="pinpoint_GetChannels_cli_2_topic"></a>

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

**AWS CLI**  
**Pour extraire des informations sur l’historique et le statut de chaque canal pour une application**  
L’exemple `get-channels` suivant extrait des informations sur l’historique et le statut de chaque canal pour une application.  

```
aws pinpoint get-channels \
    --application-id 6e0b7591a90841d2b5d93fa11143e5a7 \
    --region us-east-1
```
Sortie :  

```
{
    "ChannelsResponse": {
        "Channels": {
            "GCM": {
                "ApplicationId": "6e0b7591a90841d2b5d93fa11143e5a7",
                "CreationDate": "2019-10-08T18:28:23.182Z",
                "Enabled": true,
                "HasCredential": true,
                "Id": "gcm",
                "IsArchived": false,
                "LastModifiedDate": "2019-10-08T18:28:23.182Z",
                "Version": 1
            },
            "SMS": {
                "ApplicationId": "6e0b7591a90841d2b5d93fa11143e5a7",
                "CreationDate": "2019-10-08T18:39:18.511Z",
                "Enabled": true,
                "Id": "sms",
                "IsArchived": false,
                "LastModifiedDate": "2019-10-08T18:39:18.511Z",
                "Version": 1
            },
            "EMAIL": {
                "ApplicationId": "6e0b7591a90841d2b5d93fa11143e5a7",
                "CreationDate": "2019-10-08T18:27:23.990Z",
                "Enabled": true,
                "Id": "email",
                "IsArchived": false,
                "LastModifiedDate": "2019-10-08T18:27:23.990Z",
                "Version": 1
            },
            "IN_APP": {
                "Enabled": true,
                "IsArchived": false,
                "Version": 0
            }
        }
    }
}
```
+  Pour plus de détails sur l'API, reportez-vous [GetChannels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-channels.html)à la section *Référence des AWS CLI commandes*. 

### `get-email-channel`
<a name="pinpoint_GetEmailChannel_cli_2_topic"></a>

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

**AWS CLI**  
**Pour extraire des informations sur le statut et les paramètres du canal E-mail pour une application**  
L’exemple `get-email-channel` suivant récupère le statut et les paramètres du canal E-mail pour une application.  

```
aws pinpoint get-email-channel \
    --application-id 6e0b7591a90841d2b5d93fa11143e5a7 \
    --region us-east-1
```
Sortie :  

```
{
    "EmailChannelResponse": {
        "ApplicationId": "6e0b7591a90841d2b5d93fa11143e5a7",
        "CreationDate": "2019-10-08T18:27:23.990Z",
        "Enabled": true,
        "FromAddress": "sender@example.com",
        "Id": "email",
        "Identity": "arn:aws:ses:us-east-1:AIDACKCEVSQ6C2EXAMPLE:identity/sender@example.com",
        "IsArchived": false,
        "LastModifiedDate": "2019-10-08T18:27:23.990Z",
        "MessagesPerSecond": 1,
        "Platform": "EMAIL",
        "RoleArn": "arn:aws:iam::AIDACKCEVSQ6C2EXAMPLE:role/pinpoint-events",
        "Version": 1
    }
}
```
+  Pour plus de détails sur l'API, reportez-vous [GetEmailChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-email-channel.html)à la section *Référence des AWS CLI commandes*. 

### `get-endpoint`
<a name="pinpoint_GetEndpoint_cli_2_topic"></a>

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

**AWS CLI**  
**Pour récupérer les informations sur les paramètres et les attributs d’un point de terminaison spécifique pour une application**  
L’exemple `get-endpoint` suivant extrait des informations sur les paramètres et les attributs d’un point de terminaison spécifique pour une application.  

```
aws pinpoint get-endpoint \
    --application-id 611e3e3cdd47474c9c1399a505665b91 \
    --endpoint-id testendpoint \
    --region us-east-1
```
Sortie :  

```
{
    "EndpointResponse": {
        "Address": "+11234567890",
        "ApplicationId": "611e3e3cdd47474c9c1399a505665b91",
        "Attributes": {},
        "ChannelType": "SMS",
        "CohortId": "63",
        "CreationDate": "2019-01-28T23:55:11.534Z",
        "EffectiveDate": "2021-08-06T00:04:51.763Z",
        "EndpointStatus": "ACTIVE",
        "Id": "testendpoint",
        "Location": {
            "Country": "USA"
        },
        "Metrics": {
            "SmsDelivered": 1.0
        },
        "OptOut": "ALL",
        "RequestId": "a204b1f2-7e26-48a7-9c80-b49a2143489d",
        "User": {
            "UserAttributes": {
                "Age": [
                    "24"
                ]
            },
        "UserId": "testuser"
        }
    }
}
```
+  Pour plus de détails sur l'API, reportez-vous [GetEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-endpoint.html)à la section *Référence des AWS CLI commandes*. 

### `get-gcm-channel`
<a name="pinpoint_GetGcmChannel_cli_2_topic"></a>

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

**AWS CLI**  
**Pour récupérer des informations sur le statut et les paramètres du canal GCM pour une application**  
L’exemple `get-gcm-channel` suivant extrait des informations sur le statut et les paramètres du canal GCM pour une application.  

```
aws pinpoint get-gcm-channel \
    --application-id 6e0b7591a90841d2b5d93fa11143e5a7 \
    --region us-east-1
```
Sortie :  

```
{
    "GCMChannelResponse": {
        "ApplicationId": "6e0b7591a90841d2b5d93fa11143e5a7",
        "CreationDate": "2019-10-08T18:28:23.182Z",
        "Enabled": true,
        "HasCredential": true,
        "Id": "gcm",
        "IsArchived": false,
        "LastModifiedDate": "2019-10-08T18:28:23.182Z",
        "Platform": "GCM",
        "Version": 1
    }
}
```
+  Pour plus de détails sur l'API, reportez-vous [GetGcmChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-gcm-channel.html)à la section *Référence des AWS CLI commandes*. 

### `get-sms-channel`
<a name="pinpoint_GetSmsChannel_cli_2_topic"></a>

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

**AWS CLI**  
**Pour récupérer les informations sur le statut et les paramètres du canal SMS pour une application**  
L’exemple `get-sms-channel` suivant récupère le statut et les paramètres du canal SMS pour une application.  

```
aws pinpoint get-sms-channel \
    --application-id 6e0b7591a90841d2b5d93fa11143e5a7 \
    --region us-east-1
```
Sortie :  

```
{
    "SMSChannelResponse": {
        "ApplicationId": "6e0b7591a90841d2b5d93fa11143e5a7",
        "CreationDate": "2019-10-08T18:39:18.511Z",
        "Enabled": true,
        "Id": "sms",
        "IsArchived": false,
        "LastModifiedDate": "2019-10-08T18:39:18.511Z",
        "Platform": "SMS",
        "PromotionalMessagesPerSecond": 20,
        "TransactionalMessagesPerSecond": 20,
        "Version": 1
    }
}
```
+  Pour plus de détails sur l'API, reportez-vous [GetSmsChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-sms-channel.html)à la section *Référence des AWS CLI commandes*. 

### `get-sms-template`
<a name="pinpoint_GetSmsTemplate_cli_2_topic"></a>

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

**AWS CLI**  
**Extrait le contenu et les paramètres d’un modèle de message pour les messages envoyés par le canal SMS**  
L’exemple `get-sms-template` suivant extrait le contenu et les paramètres d’un modèle de message SMS.  

```
aws pinpoint get-sms-template \
    --template-name TestTemplate \
    --region us-east-1
```
Sortie :  

```
{
    "SMSTemplateResponse": {
        "Arn": "arn:aws:mobiletargeting:us-east-1:AIDACKCEVSQ6C2EXAMPLE:templates/TestTemplate/SMS",
        "Body": "hello\n how are you?\n food is good",
        "CreationDate": "2023-06-20T21:37:30.124Z",
        "LastModifiedDate": "2023-06-20T21:37:30.124Z",
        "tags": {},
        "TemplateDescription": "Test SMS Template",
        "TemplateName": "TestTemplate",
        "TemplateType": "SMS",
        "Version": "1"
    }
}
```
Pour plus d’informations, consultez [Modèles de messages Amazon Pinpoint](https://docs.aws.amazon.com/pinpoint/latest/userguide/messages-templates.html) dans le *Guide de l’utilisateur Amazon Pinpoint*.  
+  Pour plus de détails sur l'API, reportez-vous [GetSmsTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-sms-template.html)à la section *Référence des AWS CLI commandes*. 

### `get-voice-channel`
<a name="pinpoint_GetVoiceChannel_cli_2_topic"></a>

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

**AWS CLI**  
**Pour extraire des informations sur le statut et les paramètres du canal vocal pour une application**  
L’exemple `get-voice-channel` suivant récupère le statut et les paramètres du canal vocal pour une application.  

```
aws pinpoint get-voice-channel \
    --application-id 6e0b7591a90841d2b5d93fa11143e5a7 \
    --region us-east-1
```
Sortie :  

```
{
    "VoiceChannelResponse": {
        "ApplicationId": "6e0b7591a90841d2b5d93fa11143e5a7",
        "CreationDate": "2022-04-28T00:17:03.836Z",
        "Enabled": true,
        "Id": "voice",
        "IsArchived": false,
        "LastModifiedDate": "2022-04-28T00:17:03.836Z",
        "Platform": "VOICE",
        "Version": 1
    }
}
```
+  Pour plus de détails sur l'API, reportez-vous [GetVoiceChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-voice-channel.html)à la section *Référence des AWS CLI commandes*. 

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

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

**AWS CLI**  
**Pour extraire une liste de balises pour une ressource**  
L’exemple `list-tags-for-resource` suivant récupère l’ensemble des balises (noms et valeurs des clés) associées à la ressource spécifiée.  

```
aws pinpoint list-tags-for-resource \
    --resource-arn arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example
```
Sortie :  

```
{
    "TagsModel": {
        "tags": {
            "Year": "2019",
            "Stack": "Production"
        }
    }
}
```
*Pour plus d'informations, consultez « Tagging Amazon Pinpoint Resources https://docs.aws.amazon.com/pinpoint/ latest/developerguide/tagging < -resources.html>'\$1\$1 » dans le manuel Amazon Pinpoint Developer Guide.*  
+  Pour plus de détails sur l'API, reportez-vous [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/list-tags-for-resource.html)à la section *Référence des AWS CLI commandes*. 

### `phone-number-validate`
<a name="pinpoint_PhoneNumberValidate_cli_2_topic"></a>

L'exemple de code suivant montre comment utiliser`phone-number-validate`.

**AWS CLI**  
**Extrait les informations sur un numéro de téléphone**  
L’exemple `phone-number-validate` suivant récupère les informations sur un numéro de téléphone.  

```
aws pinpoint phone-number-validate \
    --number-validate-request PhoneNumber="+12065550142" \
    --region us-east-1
```
Sortie :  

```
{
    "NumberValidateResponse": {
        "Carrier": "ExampleCorp Mobile",
        "City": "Seattle",
        "CleansedPhoneNumberE164": "+12065550142",
        "CleansedPhoneNumberNational": "2065550142",
        "Country": "United States",
        "CountryCodeIso2": "US",
        "CountryCodeNumeric": "1",
        "OriginalPhoneNumber": "+12065550142",
        "PhoneType": "MOBILE",
        "PhoneTypeCode": 0,
        "Timezone": "America/Los_Angeles",
        "ZipCode": "98101"
    }
}
```
Pour plus d’informations, consultez [Canal Amazon Pinpoint SMS](https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms.html) dans le *Guide de l’utilisateur Amazon Pinpoint*.  
+  Pour plus de détails sur l'API, reportez-vous [PhoneNumberValidate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/phone-number-validate.html)à la section *Référence des AWS CLI commandes*. 

### `send-messages`
<a name="pinpoint_SendMessages_cli_2_topic"></a>

L'exemple de code suivant montre comment utiliser`send-messages`.

**AWS CLI**  
**Pour envoyer un message SMS à l’aide du point de terminaison d’une application**  
L’exemple `send-messages` suivant envoie un message direct pour une application dotée d’un point de terminaison.  

```
aws pinpoint send-messages \
    --application-id 611e3e3cdd47474c9c1399a505665b91 \
    --message-request file://myfile.json \
    --region us-west-2
```
Contenu de `myfile.json` :  

```
{
    "MessageConfiguration": {
        "SMSMessage": {
            "Body": "hello, how are you?"
        }
    },
    "Endpoints": {
        "testendpoint": {}
    }
}
```
Sortie :  

```
{
    "MessageResponse": {
        "ApplicationId": "611e3e3cdd47474c9c1399a505665b91",
        "EndpointResult": {
            "testendpoint": {
                "Address": "+12345678900",
                "DeliveryStatus": "SUCCESSFUL",
                "MessageId": "itnuqhai5alf1n6ahv3udc05n7hhddr6gb3lq6g0",
                "StatusCode": 200,
                "StatusMessage": "MessageId: itnuqhai5alf1n6ahv3udc05n7hhddr6gb3lq6g0"
            }
        },
        "RequestId": "c7e23264-04b2-4a46-b800-d24923f74753"
    }
}
```
Pour plus d’informations, consultez [Canal Amazon Pinpoint SMS](https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms.html) dans le *Guide de l’utilisateur Amazon Pinpoint*.  
+  Pour plus de détails sur l'API, reportez-vous [SendMessages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/send-messages.html)à la section *Référence des AWS CLI commandes*. 

### `send-users-messages`
<a name="pinpoint_SendUsersMessages_cli_2_topic"></a>

L'exemple de code suivant montre comment utiliser`send-users-messages`.

**AWS CLI**  
**Pour envoyer un message SMS à un utilisateur d’une application**  
L’exemple `send-users-messages` suivant envoie un message direct à un utilisateur d’une application.  

```
aws pinpoint send-users-messages \
    --application-id 611e3e3cdd47474c9c1399a505665b91 \
    --send-users-message-request file://myfile.json \
    --region us-west-2
```
Contenu de `myfile.json` :  

```
{
    "MessageConfiguration": {
        "SMSMessage": {
            "Body": "hello, how are you?"
        }
    },
    "Users": {
        "testuser": {}
    }
}
```
Sortie :  

```
{
    "SendUsersMessageResponse": {
        "ApplicationId": "611e3e3cdd47474c9c1399a505665b91",
        "RequestId": "e0b12cf5-2359-11e9-bb0b-d5fb91876b25",
        "Result": {
            "testuser": {
                "testuserendpoint": {
                    "DeliveryStatus": "SUCCESSFUL",
                    "MessageId": "7qu4hk5bqhda3i7i2n4pjf98qcuh8b7p45ifsmo0",
                    "StatusCode": 200,
                    "StatusMessage": "MessageId: 7qu4hk5bqhda3i7i2n4pjf98qcuh8b7p45ifsmo0",
                    "Address": "+12345678900"
                }
            }
        }
    }
}
```
Pour plus d’informations, consultez [Canal Amazon Pinpoint SMS](https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms.html) dans le *Guide de l’utilisateur Amazon Pinpoint*.  
+  Pour plus de détails sur l'API, reportez-vous [SendUsersMessages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/send-users-messages.html)à la section *Référence des AWS CLI commandes*. 

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

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

**AWS CLI**  
**Pour ajouter des balises à une ressource**  
L’exemple suivant ajoute deux balises (noms et valeurs de clés) à une ressource.  

```
aws pinpoint list-tags-for-resource \
    --resource-arn arn:aws:mobiletargeting:us-east-1:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example \
    --tags-model tags={Stack=Production,Year=2019}
```
Cette commande ne produit aucune sortie.  
*Pour plus d'informations, consultez « Tagging Amazon Pinpoint Resources https://docs.aws.amazon.com/pinpoint/ latest/developerguide/tagging < -resources.html>'\$1\$1 » dans le manuel Amazon Pinpoint Developer Guide.*  
+  Pour plus de détails sur l'API, reportez-vous [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/tag-resource.html)à la section *Référence des AWS CLI commandes*. 

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

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

**AWS CLI**  
**Exemple 1 : pour supprimer une balise d’une ressource**  
L’exemple `untag-resource` suivant supprime la balise spécifiée (nom et valeur de clé) d’une ressource.  

```
aws pinpoint untag-resource \
    --resource-arn arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example \
    --tag-keys Year
```
Cette commande ne produit aucune sortie.  
**Exemple 2 : pour supprimer plusieurs balises d’une ressource**  
L’exemple `untag-resource` suivant supprime les balises spécifiées (noms et valeurs de clés) d’une ressource.  

```
aws pinpoint untag-resource \
    --resource-arn arn:aws:mobiletargeting:us-east-1:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example \
    --tag-keys Year Stack
```
Cette commande ne produit aucune sortie.  
*Pour plus d'informations, consultez « Tagging Amazon Pinpoint Resources https://docs.aws.amazon.com/pinpoint/ latest/developerguide/tagging < -resources.html>'\$1\$1 » dans le manuel Amazon Pinpoint Developer Guide.*  
+  Pour plus de détails sur l'API, reportez-vous [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/untag-resource.html)à la section *Référence des AWS CLI commandes*. 

### `update-sms-channel`
<a name="pinpoint_UpdateSmsChannel_cli_2_topic"></a>

L'exemple de code suivant montre comment utiliser`update-sms-channel`.

**AWS CLI**  
**Pour activer le canal SMS ou pour mettre à jour le statut et les paramètres du canal SMS pour une application**  
L’exemple `update-sms-channel` suivant active le canal SMS d’un canal SMS pour une application.  

```
aws pinpoint update-sms-channel \
    --application-id 611e3e3cdd47474c9c1399a505665b91 \
    --sms-channel-request Enabled=true \
    --region us-west-2
```
Sortie :  

```
{
    "SMSChannelResponse": {
        "ApplicationId": "611e3e3cdd47474c9c1399a505665b91",
        "CreationDate": "2019-01-28T23:25:25.224Z",
        "Enabled": true,
        "Id": "sms",
        "IsArchived": false,
        "LastModifiedDate": "2023-05-18T23:22:50.977Z",
        "Platform": "SMS",
        "PromotionalMessagesPerSecond": 20,
        "TransactionalMessagesPerSecond": 20,
        "Version": 3
    }
}
```
Pour plus d’informations, consultez [Canal Amazon Pinpoint SMS](https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms.html) dans le *Guide de l’utilisateur Amazon Pinpoint*.  
+  Pour plus de détails sur l'API, reportez-vous [UpdateSmsChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/update-sms-channel.html)à la section *Référence des AWS CLI commandes*. 