Exemples d'utilisation d'Amazon Pinpoint AWS CLI

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 façon de configurer et d'exécuter le code en contexte.

Rubriques

Actions

Actions

L'exemple de code suivant montre comment utilisercreate-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à la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-sms-template.

AWS CLI

Crée un modèle de message pour les messages envoyés via le canal SMS

L'create-sms-templateexemple 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 les modèles de messages Amazon Pinpoint dans le guide de l'utilisateur Amazon Pinpoint.

Pour plus de détails sur l'API, reportez-vous CreateSmsTemplateà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-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à la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-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-channelexemple 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à la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-app.

AWS CLI

Pour récupérer des informations sur une application (projet)

L'get-appexemple suivant permet de récupérer 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à la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-apps.

AWS CLI

Pour récupérer des informations sur toutes vos applications

L'get-appsexemple suivant permet de récupérer des informations sur toutes 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 valeur de NextToken réponse indique qu'il y a davantage de sorties disponibles. Appelez à nouveau la commande et indiquez cette valeur comme paramètre NextToken d'entrée.

Pour plus de détails sur l'API, reportez-vous GetAppsà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-campaign.

AWS CLI

Pour récupérer des informations sur le statut, la configuration et les autres paramètres d'une campagne

L'get-campaignexemple suivant permet de récupérer des informations sur le statut, la configuration et les 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à la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-campaigns.

AWS CLI

Pour récupérer des informations sur le statut, la configuration et les autres paramètres de toutes les campagnes associées à une application

L'get-campaignsexemple suivant permet de récupérer des informations sur le statut, la configuration et les autres paramètres de toutes les 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à la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-channels.

AWS CLI

Pour récupérer des informations sur l'historique et le statut de chaque canal pour une application

L'get-channelsexemple suivant permet de récupérer 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à la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-email-channel.

AWS CLI

Pour récupérer des informations sur le statut et les paramètres du canal de messagerie d'une application

L'get-email-channelexemple suivant permet de récupérer le statut et les paramètres du canal de courrier électronique d'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à la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-endpoint.

AWS CLI

Pour récupérer des informations sur les paramètres et les attributs d’un point de terminaison spécifique pour une application

L’exemple get-endpoint suivant récupère 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à la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-gcm-channel.

AWS CLI

Pour récupérer des informations sur l'état et les paramètres du canal GCM pour une application

L'get-gcm-channelexemple suivant permet de récupérer des informations sur l'état 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à la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-sms-channel.

AWS CLI

Pour récupérer des 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à la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-sms-template.

AWS CLI

Récupère le contenu et les paramètres d'un modèle de message pour les messages envoyés via le canal SMS

L'get-sms-templateexemple 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 les modèles de messages Amazon Pinpoint dans le guide de l'utilisateur Amazon Pinpoint.

Pour plus de détails sur l'API, reportez-vous GetSmsTemplateà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-voice-channel.

AWS CLI

Pour récupérer des informations sur l'état et les paramètres du canal vocal d'une application

L'get-voice-channelexemple suivant permet de récupérer le statut et les paramètres du canal vocal d'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à la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-tags-for-resource.

AWS CLI

Pour récupérer une liste de balises pour une ressource

L'list-tags-for-resourceexemple suivant récupère toutes les balises (noms de clé et valeurs) 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>'__ » dans le manuel Amazon Pinpoint Developer Guide.

Pour plus de détails sur l'API, reportez-vous ListTagsForResourceà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserphone-number-validate.

AWS CLI

Récupère les informations relatives à un numéro de téléphone

Ce qui suit phone-number-validate permet de récupérer les informations relatives à 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 dans le Guide de l’utilisateur Amazon Pinpoint.

Pour plus de détails sur l'API, reportez-vous PhoneNumberValidateà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisersend-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 dans le Guide de l’utilisateur Amazon Pinpoint.

Pour plus de détails sur l'API, reportez-vous SendMessagesà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisersend-users-messages.

AWS CLI

Pour envoyer un message SMS à un utilisateur d'une application

L'send-users-messagesexemple 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 dans le Guide de l’utilisateur Amazon Pinpoint.

Pour plus de détails sur l'API, reportez-vous SendUsersMessagesà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisertag-resource.

AWS CLI

Pour ajouter des balises à une ressource

L'exemple suivant ajoute deux balises (noms de clés et valeurs) à 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 aucun résultat.

Pour plus de détails sur l'API, reportez-vous TagResourceà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliseruntag-resource.

AWS CLI

Exemple 1 : pour supprimer un tag d'une ressource

L'untag-resourceexemple suivant supprime la balise spécifiée (nom de clé et valeur) 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 aucun résultat.

Exemple 2 : pour supprimer plusieurs balises d'une ressource

L'untag-resourceexemple suivant supprime les balises spécifiées (noms de clés et valeurs) 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 aucun résultat.

Pour plus de détails sur l'API, reportez-vous UntagResourceà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-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'update-sms-channelexemple suivant active le canal SMS pour 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 dans le Guide de l’utilisateur Amazon Pinpoint.

Pour plus de détails sur l'API, reportez-vous UpdateSmsChannelà la section Référence des AWS CLI commandes.

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

AWS Payment Cryptography Plan de données

Amazon Polly