Amazon-Pinpoint-Beispiele unter Verwendung von AWS CLI - AWS Command Line Interface
Aktionen

Amazon-Pinpoint-Beispiele unter Verwendung von AWS CLI

Die folgenden Codebeispiele zeigen, wie Sie Aktionen durchführen und gängige Szenarien implementieren, indem Sie das AWS Command Line Interface mit Amazon Pinpoint nutzen.

Aktionen sind Codeauszüge aus größeren Programmen und müssen im Kontext ausgeführt werden. Während Aktionen Ihnen zeigen, wie Sie einzelne Service-Funktionen aufrufen, können Sie Aktionen im Kontext der zugehörigen Szenarien anzeigen.

Jedes Beispiel enthält einen Link zum vollständigen Quellcode, wo Sie Anleitungen zum Einrichten und Ausführen des Codes im Kontext finden.

Themen

Aktionen

Das folgende Codebeispiel zeigt, wie create-app verwendet wird.

AWS CLI

Beispiel 1: Erstellen einer Anwendung

Im folgenden create-app-Beispiel wird eine neue Anwendung (Projekt) erstellt.

aws pinpoint create-app \
    --create-application-request Name=ExampleCorp

Ausgabe:

{
    "ApplicationResponse": {
        "Arn": "arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example",
        "Id": "810c7aab86d42fb2b56c8c966example",
        "Name": "ExampleCorp",
        "tags": {}
    }
}

Beispiel 2: Erstellen einer mit Tags versehenen Anwendung

Im folgenden create-app-Beispiel wird eine neue Anwendung (Projekt) erstellt und der Anwendung ein Tag (Schlüssel und Wert) zugeordnet.

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

Ausgabe:

{
    "ApplicationResponse": {
        "Arn": "arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example",
        "Id": "810c7aab86d42fb2b56c8c966example",
        "Name": "ExampleCorp",
        "tags": {
            "Stack": "Test"
        }
    }
}

  • API-Details finden Sie unter CreateApp in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie create-sms-template verwendet wird.

AWS CLI

So erstellen Sie eine Nachrichtenvorlage für Nachrichten, die über den SMS-Kanal gesendet werden

Im folgenden Beispiel für create-sms-template wird eine SMS-Nachrichtenvorlage erstellt.

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

Inhalt von myfile.json:

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

Ausgabe:

{
    "CreateTemplateMessageBody": {
        "Arn": "arn:aws:mobiletargeting:us-east-1:AIDACKCEVSQ6C2EXAMPLE:templates/TestTemplate/SMS",
        "Message": "Created",
        "RequestID": "8c36b17f-a0b0-400f-ac21-29e9b62a975d"
    }
}

Weitere Informationen finden Sie unter Amazon-Pinpoint-Nachrichtenvorlagen im Benutzerhandbuch zu Amazon Pinpoint.

Das folgende Codebeispiel zeigt, wie delete-app verwendet wird.

AWS CLI

So löschen Sie eine Anwendung

Im folgenden delete-app-Beispiel wird eine Anwendung (Projekt) gelöscht.

aws pinpoint delete-app \
    --application-id 810c7aab86d42fb2b56c8c966example

Ausgabe:

{
    "ApplicationResponse": {
        "Arn": "arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example",
        "Id": "810c7aab86d42fb2b56c8c966example",
        "Name": "ExampleCorp",
        "tags": {}
    }
}

  • API-Details finden Sie unter DeleteApp in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie get-apns-channel verwendet wird.

AWS CLI

So rufen Sie Informationen über den Status und die Einstellungen des APNs-Kanals für eine Anwendung ab

Im folgenden Beispiel für get-apns-channel werden Informationen zum Status und zu den Einstellungen des APNs-Kanals für eine Anwendung abgerufen.

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

Ausgabe:

{
    "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
    }
}

  • API-Details finden Sie unter GetApnsChannel in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie get-app verwendet wird.

AWS CLI

So rufen Sie Informationen über Anwendung (Projekt) ab

Im folgenden Beispiel für get-app werden Informationen über eine Anwendung (Projekt) abgerufen.

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

Ausgabe:

{
    "ApplicationResponse": {
        "Arn": "arn:aws:mobiletargeting:us-east-1:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example",
        "Id": "810c7aab86d42fb2b56c8c966example",
        "Name": "ExampleCorp",
        "tags": {
                "Year": "2019",
                "Stack": "Production"
            }
    }
}

  • API-Details finden Sie unter GetApp in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie get-apps verwendet wird.

AWS CLI

So rufen Sie Informationen über alle Ihre Anwendungen ab

Im folgenden Beispiel für get-apps werden Informationen zu allen Ihren Anwendungen (Projekten) abgerufen.

aws pinpoint get-apps

Ausgabe:

{
    "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"
    }
}

Das Vorhandensein des NextToken-Antwortwerts weist darauf hin, dass mehr Ausgabe verfügbar ist. Rufen Sie den Befehl erneut auf und geben Sie diesen Wert als NextToken-Eingabeparameter an.

  • API-Details finden Sie unter GetApps in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie get-campaign verwendet wird.

AWS CLI

So rufen Sie Informationen über den Status, die Konfiguration und andere Einstellungen einer Kampagne ab

Im folgenden Beispiel für get-campaign werden Informationen über den Status, die Konfiguration und andere Einstellungen einer Kampagne abgerufen.

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

Ausgabe:

{
    "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
    }
}

  • API-Details finden Sie unter GetCampaign in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie get-campaigns verwendet wird.

AWS CLI

So rufen Sie Informationen über den Status, die Konfiguration und andere Einstellungen für alle Kampagnen ab, die einer Anwendung zugeordnet sind

Im folgenden Beispiel für get-campaigns werden Informationen über den Status, die Konfiguration und andere Einstellungen für alle einer Anwendung zugeordneten Kampagnen ab.

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

Ausgabe:

{
    "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
            }
        ]
    }
}

  • API-Details finden Sie unter GetCampaigns in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie get-channels verwendet wird.

AWS CLI

So rufen Sie Informationen über den Verlauf und den Status jedes Kanals für eine Anwendung ab

Im folgenden Beispiel für get-channels werden Informationen über den Verlauf und den Status jedes Kanals für eine Anwendung abgerufen.

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

Ausgabe:

{
    "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
            }
        }
    }
}

  • API-Details finden Sie unter GetChannels in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie get-email-channel verwendet wird.

AWS CLI

So rufen Sie Informationen über den Status und die Einstellungen des E-Mail-kanals für eine Anwendung ab

Im folgenden Beispiel für get-email-channel werden der Status und die Einstellungen des E-Mail-Kanals für eine Anwendung abgerufen.

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

Ausgabe:

{
    "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
    }
}

  • API-Details finden Sie unter GetEmailChannel in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie get-endpoint verwendet wird.

AWS CLI

So rufen Sie Informationen über die Einstellungen und Attribute eines bestimmten Endpunkts für eine Anwendung ab

Das folgende get-endpoint-Beispiel ruft Informationen über die Einstellungen und Attribute eines bestimmten Endpunkts für eine Anwendung ab.

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

Ausgabe:

{
    "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"
        }
    }
}

  • API-Details finden Sie unter GetEndpoint in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie get-gcm-channel verwendet wird.

AWS CLI

So rufen Sie Informationen über den Status und die Einstellungen des GCM-Kanals für eine Anwendung ab

Im folgenden Beispiel für get-gcm-channel werden der Status und die Einstellungen des GCM-Kanals für eine Anwendung abgerufen.

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

Ausgabe:

{
    "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
    }
}

  • API-Details finden Sie unter GetGcmChannel in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie get-sms-channel verwendet wird.

AWS CLI

So rufen Sie Informationen über den Status und die Einstellungen jedes Sprachkanals für eine Anwendung ab

Im folgenden get-sms-channel-Beispiel werden Status und Einstellungen des SMS-Kanals für eine Anwendung abgerufen.

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

Ausgabe:

{
    "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
    }
}

  • API-Details finden Sie unter GetSmsChannel in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie get-sms-template verwendet wird.

AWS CLI

So rufen Sie den Inhalt und die Einstellungen einer Nachrichtenvorlage für Nachrichten ab, die über den SMS-Kanal gesendet werden

Im folgenden Beispiel für get-sms-template werden der Inhalt und die Einstellungen einer SMS-Nachrichtenvorlage abgerufen.

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

Ausgabe:

{
    "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"
    }
}

Weitere Informationen finden Sie unter Amazon-Pinpoint-Nachrichtenvorlagen im Benutzerhandbuch zu Amazon Pinpoint.

  • API-Details finden Sie unter GetSmsTemplate in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie get-voice-channel verwendet wird.

AWS CLI

So rufen Sie Informationen über den Status und die Einstellungen des Sprachkanals für eine Anwendung ab

Im folgenden Beispiel für get-voice-channel werden der Status und die Einstellungen des Sprachkanals für eine Anwendung abgerufen.

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

Ausgabe:

{
    "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
    }
}

  • API-Details finden Sie unter GetVoiceChannel in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie list-tags-for-resource verwendet wird.

AWS CLI

So rufen Sie eine Liste der Tags für eine Ressource ab

Im folgenden Beispiel für list-tags-for-resource werden alle Tags (Schlüsselnamen und -werte) abgerufen, die der angegebenen Ressource zugeordnet sind

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

Ausgabe:

{
    "TagsModel": {
        "tags": {
            "Year": "2019",
            "Stack": "Production"
        }
    }
}

Weitere Informationen finden Sie unter Markieren von Amazon-Pinpoint-Ressourcen <https://docs.aws.amazon.com/pinpoint/latest/developerguide/tagging-resources.html> im Entwicklerhandbuch zu Amazon Pinpoint.

Das folgende Codebeispiel zeigt, wie phone-number-validate verwendet wird.

AWS CLI

So rufen Sie Informationen zu einer Telefonnummer ab

Im folgenden Beispiel für phone-number-validate werden Informationen zu einer Telefonnummer abgerufen.

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

Ausgabe:

{
    "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"
    }
}

Weitere Informationen finden Sie unter Amazon-Pinpoint-SMS-Kanal im Amazon-Pinpoint-Benutzerhandbuch.

Das folgende Codebeispiel zeigt, wie send-messages verwendet wird.

AWS CLI

So senden Sie eine SMS-Nachricht über den Endpunkt einer Anwendung

Im folgenden send-messages-Beispiel wird eine Direktnachricht für eine Anwendung mit einem Endpunkt gesendet.

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

Inhalt von myfile.json:

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

Ausgabe:

{
    "MessageResponse": {
        "ApplicationId": "611e3e3cdd47474c9c1399a505665b91",
        "EndpointResult": {
            "testendpoint": {
                "Address": "+12345678900",
                "DeliveryStatus": "SUCCESSFUL",
                "MessageId": "itnuqhai5alf1n6ahv3udc05n7hhddr6gb3lq6g0",
                "StatusCode": 200,
                "StatusMessage": "MessageId: itnuqhai5alf1n6ahv3udc05n7hhddr6gb3lq6g0"
            }
        },
        "RequestId": "c7e23264-04b2-4a46-b800-d24923f74753"
    }
}

Weitere Informationen finden Sie unter Amazon-Pinpoint-SMS-Kanal im Amazon-Pinpoint-Benutzerhandbuch.

  • API-Details finden Sie unter SendMessages in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie send-users-messages verwendet wird.

AWS CLI

So senden Sie eine SMS-Nachricht für einen Benutzer einer Anwendung

Im folgenden Beispiel für send-users-messages wird eine Direktnachricht für einen Benutzer einer Anwendung gesendet.

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

Inhalt von myfile.json:

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

Ausgabe:

{
    "SendUsersMessageResponse": {
        "ApplicationId": "611e3e3cdd47474c9c1399a505665b91",
        "RequestId": "e0b12cf5-2359-11e9-bb0b-d5fb91876b25",
        "Result": {
            "testuser": {
                "testuserendpoint": {
                    "DeliveryStatus": "SUCCESSFUL",
                    "MessageId": "7qu4hk5bqhda3i7i2n4pjf98qcuh8b7p45ifsmo0",
                    "StatusCode": 200,
                    "StatusMessage": "MessageId: 7qu4hk5bqhda3i7i2n4pjf98qcuh8b7p45ifsmo0",
                    "Address": "+12345678900"
                }
            }
        }
    }
}

Weitere Informationen finden Sie unter Amazon-Pinpoint-SMS-Kanal im Amazon-Pinpoint-Benutzerhandbuch.

Das folgende Codebeispiel zeigt, wie tag-resource verwendet wird.

AWS CLI

So fügen Sie einer Ressource Tags hinzu

Im folgenden Beispiel werden einer Ressource zwei Tags (Schlüsselnamen und -werte) hinzugefügt.

aws pinpoint list-tags-for-resource \
    --resource-arn arn:aws:mobiletargeting:us-east-1:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example \
    --tags-model tags={Stack=Production,Year=2019}

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Markieren von Amazon-Pinpoint-Ressourcen <https://docs.aws.amazon.com/pinpoint/latest/developerguide/tagging-resources.html> im Entwicklerhandbuch zu Amazon Pinpoint.

  • API-Details finden Sie unter TagResource in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie untag-resource verwendet wird.

AWS CLI

Beispiel 1: So entfernen Sie einen Tag aus einer Ressource

Im folgenden Beispiel für untag-resource wird der angegebene Tag (Schlüsselname und -wert) aus der Ressource entfernt.

aws pinpoint untag-resource \
    --resource-arn arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example \
    --tag-keys Year

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Beispiel 2: So entfernen Sie mehrere Tags aus einer Ressource

Im folgenden Beispiel für untag-resource werden die angegebenen Tags (Schlüsselnamen und -wert) aus der Ressource entfernt.

aws pinpoint untag-resource \
    --resource-arn arn:aws:mobiletargeting:us-east-1:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example \
    --tag-keys Year Stack

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Markieren von Amazon-Pinpoint-Ressourcen <https://docs.aws.amazon.com/pinpoint/latest/developerguide/tagging-resources.html> im Entwicklerhandbuch zu Amazon Pinpoint.

  • API-Details finden Sie unter UntagResource in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie update-sms-channel verwendet wird.

AWS CLI

So aktivieren Sie den SMS-Kanal oder aktualisieren den Status und die Einstellungen des SMS-Kanals für eine Anwendung

Im folgenden Beispiel für update-sms-channel wird SMS-Kanal für einen SMS-Kanal einer Anwendung aktiviert.

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

Ausgabe:

{
    "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
    }
}

Weitere Informationen finden Sie unter Amazon-Pinpoint-SMS-Kanal im Amazon-Pinpoint-Benutzerhandbuch.