Amazon Pinpoint Pinpoint-Beispiele mit AWS CLI

Fokusmodus

Amazon Pinpoint Pinpoint-Beispiele mit AWS CLI - AWS Command Line Interface

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Die folgenden Codebeispiele zeigen Ihnen, wie Sie mithilfe von Amazon Pinpoint Aktionen ausführen und allgemeine Szenarien implementieren. AWS Command Line Interface

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 Szenarios anzeigen.

Jedes Beispiel enthält einen Link zum vollständigen Quellcode, in dem Sie Anweisungen zur Einrichtung und Ausführung des Codes im Kontext finden.

Themen

Aktionen

Aktionen

Das folgende Codebeispiel zeigt die Verwendungcreate-app.

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

Einzelheiten zur API finden Sie CreateAppin der AWS CLI Befehlsreferenz.

create-app

Das folgende Codebeispiel zeigt die Verwendungcreate-app.

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

Einzelheiten zur API finden Sie CreateAppin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungcreate-sms-template.

AWS CLI

Erstellt eine Nachrichtenvorlage für Nachrichten, die über den SMS-Kanal gesendet werden

Im folgenden create-sms-template Beispiel 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 Pinpoint-Nachrichtenvorlagen im Amazon Pinpoint Pinpoint-Benutzerhandbuch.

Einzelheiten zur API finden Sie unter CreateSmsTemplate AWS CLIBefehlsreferenz.

create-sms-template

Das folgende Codebeispiel zeigt die Verwendungcreate-sms-template.

AWS CLI

Erstellt eine Nachrichtenvorlage für Nachrichten, die über den SMS-Kanal gesendet werden

Im folgenden create-sms-template Beispiel 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 Pinpoint-Nachrichtenvorlagen im Amazon Pinpoint Pinpoint-Benutzerhandbuch.

Einzelheiten zur API finden Sie unter CreateSmsTemplate AWS CLIBefehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungdelete-app.

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

Einzelheiten zur API finden Sie DeleteAppin der AWS CLI Befehlsreferenz.

delete-app

Das folgende Codebeispiel zeigt die Verwendungdelete-app.

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

Einzelheiten zur API finden Sie DeleteAppin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungget-apns-channel.

AWS CLI

Um Informationen über den Status und die Einstellungen des APNs Kanals für eine Anwendung abzurufen

Im folgenden get-apns-channel Beispiel werden Informationen über den Status und die 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
    }
}

Einzelheiten zur API finden Sie unter GetApnsChannel AWS CLIBefehlsreferenz.

get-apns-channel

Das folgende Codebeispiel zeigt die Verwendungget-apns-channel.

AWS CLI

Um Informationen über den Status und die Einstellungen des APNs Kanals für eine Anwendung abzurufen

Im folgenden get-apns-channel Beispiel werden Informationen über den Status und die 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
    }
}

Einzelheiten zur API finden Sie unter GetApnsChannel AWS CLIBefehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungget-app.

AWS CLI

Um Informationen über eine Anwendung (Projekt) abzurufen

Im folgenden get-app Beispiel 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"
            }
    }
}

Einzelheiten zur API finden Sie unter GetApp AWS CLIBefehlsreferenz.

get-app

Das folgende Codebeispiel zeigt die Verwendungget-app.

AWS CLI

Um Informationen über eine Anwendung (Projekt) abzurufen

Im folgenden get-app Beispiel 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"
            }
    }
}

Einzelheiten zur API finden Sie unter GetApp AWS CLIBefehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungget-apps.

AWS CLI

Um Informationen über all Ihre Anwendungen abzurufen

Im folgenden get-apps Beispiel werden Informationen zu all 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.

Einzelheiten zur API finden Sie GetAppsin der AWS CLI Befehlsreferenz.

get-apps

Das folgende Codebeispiel zeigt die Verwendungget-apps.

AWS CLI

Um Informationen über all Ihre Anwendungen abzurufen

Im folgenden get-apps Beispiel werden Informationen zu all 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.

Einzelheiten zur API finden Sie GetAppsin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungget-campaign.

AWS CLI

Um Informationen über den Status, die Konfiguration und andere Einstellungen einer Kampagne abzurufen

Im folgenden get-campaign Beispiel werden Informationen über den Status, die Konfiguration und andere Einstellungen für eine 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
    }
}

Einzelheiten zur API finden Sie unter GetCampaign AWS CLIBefehlsreferenz.

get-campaign

Das folgende Codebeispiel zeigt die Verwendungget-campaign.

AWS CLI

Um Informationen über den Status, die Konfiguration und andere Einstellungen einer Kampagne abzurufen

Im folgenden get-campaign Beispiel werden Informationen über den Status, die Konfiguration und andere Einstellungen für eine 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
    }
}

Einzelheiten zur API finden Sie unter GetCampaign AWS CLIBefehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungget-campaigns.

AWS CLI

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

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


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

Einzelheiten zur API finden Sie unter GetCampaigns AWS CLIBefehlsreferenz.

get-campaigns

Das folgende Codebeispiel zeigt die Verwendungget-campaigns.

AWS CLI

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

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


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

Einzelheiten zur API finden Sie unter GetCampaigns AWS CLIBefehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungget-channels.

AWS CLI

Ruft Informationen über den Verlauf und den Status jedes Kanals für eine Anwendung ab

Im folgenden get-channels Beispiel 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
            }
        }
    }
}

Einzelheiten zur API finden Sie unter GetChannels AWS CLIBefehlsreferenz.

get-channels

Das folgende Codebeispiel zeigt die Verwendungget-channels.

AWS CLI

Ruft Informationen über den Verlauf und den Status jedes Kanals für eine Anwendung ab

Im folgenden get-channels Beispiel 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
            }
        }
    }
}

Einzelheiten zur API finden Sie unter GetChannels AWS CLIBefehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungget-email-channel.

AWS CLI

Um Informationen über den Status und die Einstellungen des E-Mail-Kanals für eine Anwendung abzurufen

Im folgenden get-email-channel Beispiel werden Status und 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
    }
}

Einzelheiten zur API finden Sie unter GetEmailChannel AWS CLIBefehlsreferenz.

get-email-channel

Das folgende Codebeispiel zeigt die Verwendungget-email-channel.

AWS CLI

Um Informationen über den Status und die Einstellungen des E-Mail-Kanals für eine Anwendung abzurufen

Im folgenden get-email-channel Beispiel werden Status und 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
    }
}

Einzelheiten zur API finden Sie unter GetEmailChannel AWS CLIBefehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungget-endpoint.

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

Einzelheiten zur API finden Sie GetEndpointin der AWS CLI Befehlsreferenz.

get-endpoint

Das folgende Codebeispiel zeigt die Verwendungget-endpoint.

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

Einzelheiten zur API finden Sie GetEndpointin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungget-gcm-channel.

AWS CLI

Um Informationen über den Status und die Einstellungen des GCM-Kanals für eine Anwendung abzurufen

Im folgenden get-gcm-channel Beispiel werden Informationen über den 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
    }
}

Einzelheiten zur API finden Sie unter GetGcmChannel AWS CLIBefehlsreferenz.

get-gcm-channel

Das folgende Codebeispiel zeigt die Verwendungget-gcm-channel.

AWS CLI

Um Informationen über den Status und die Einstellungen des GCM-Kanals für eine Anwendung abzurufen

Im folgenden get-gcm-channel Beispiel werden Informationen über den 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
    }
}

Einzelheiten zur API finden Sie unter GetGcmChannel AWS CLIBefehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungget-sms-channel.

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

Einzelheiten zur API finden Sie GetSmsChannelin der AWS CLI Befehlsreferenz.

get-sms-channel

Das folgende Codebeispiel zeigt die Verwendungget-sms-channel.

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

Einzelheiten zur API finden Sie GetSmsChannelin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungget-sms-template.

AWS CLI

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

Im folgenden get-sms-template Beispiel 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 Pinpoint-Nachrichtenvorlagen im Amazon Pinpoint Pinpoint-Benutzerhandbuch.

Einzelheiten zur API finden Sie unter GetSmsTemplate AWS CLIBefehlsreferenz.

get-sms-template

Das folgende Codebeispiel zeigt die Verwendungget-sms-template.

AWS CLI

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

Im folgenden get-sms-template Beispiel 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 Pinpoint-Nachrichtenvorlagen im Amazon Pinpoint Pinpoint-Benutzerhandbuch.

Einzelheiten zur API finden Sie unter GetSmsTemplate AWS CLIBefehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungget-voice-channel.

AWS CLI

Um Informationen über den Status und die Einstellungen des Sprachkanals für eine Anwendung abzurufen

Im folgenden get-voice-channel Beispiel werden Status und 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
    }
}

Einzelheiten zur API finden Sie unter GetVoiceChannel AWS CLIBefehlsreferenz.

get-voice-channel

Das folgende Codebeispiel zeigt die Verwendungget-voice-channel.

AWS CLI

Um Informationen über den Status und die Einstellungen des Sprachkanals für eine Anwendung abzurufen

Im folgenden get-voice-channel Beispiel werden Status und 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
    }
}

Einzelheiten zur API finden Sie unter GetVoiceChannel AWS CLIBefehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendunglist-tags-for-resource.

AWS CLI

Um eine Liste von Tags für eine Ressource abzurufen

Im folgenden list-tags-for-resource Beispiel 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 'Tagging Amazon Pinpoint Resources < https://docs.aws.amazon.com/pinpoint/ latest/developerguide/tagging -resources.html>'__ im Amazon Pinpoint Developer Guide.

Einzelheiten ListTagsForResourcezur API AWS CLI finden Sie in der Befehlsreferenz.

list-tags-for-resource

Das folgende Codebeispiel zeigt die Verwendunglist-tags-for-resource.

AWS CLI

Um eine Liste von Tags für eine Ressource abzurufen

Im folgenden list-tags-for-resource Beispiel 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"
        }
    }
}

Einzelheiten ListTagsForResourcezur API AWS CLI finden Sie in der Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungphone-number-validate.

AWS CLI

Ruft Informationen über eine Telefonnummer ab

Im Folgenden werden Informationen zu einer Telefonnummer phone-number-validate 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.

Einzelheiten zur API finden Sie unter PhoneNumberValidate AWS CLIBefehlsreferenz.

phone-number-validate

Das folgende Codebeispiel zeigt die Verwendungphone-number-validate.

AWS CLI

Ruft Informationen über eine Telefonnummer ab

Im Folgenden werden Informationen zu einer Telefonnummer phone-number-validate 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.

Einzelheiten zur API finden Sie unter PhoneNumberValidate AWS CLIBefehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungsend-messages.

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.

Einzelheiten zur API finden Sie SendMessagesin der AWS CLI Befehlsreferenz.

send-messages

Das folgende Codebeispiel zeigt die Verwendungsend-messages.

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.

Einzelheiten zur API finden Sie SendMessagesin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungsend-users-messages.

AWS CLI

Um eine SMS-Nachricht für einen Benutzer einer Anwendung zu senden

Im folgenden send-users-messages Beispiel 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.

Einzelheiten zur API finden Sie SendUsersMessagesin der AWS CLI Befehlsreferenz.

send-users-messages

Das folgende Codebeispiel zeigt die Verwendungsend-users-messages.

AWS CLI

Um eine SMS-Nachricht für einen Benutzer einer Anwendung zu senden

Im folgenden send-users-messages Beispiel 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.

Einzelheiten zur API finden Sie SendUsersMessagesin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungtag-resource.

AWS CLI

Um einer Ressource Tags hinzuzufügen

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.

Einzelheiten TagResourcezur API AWS CLI finden Sie in der Befehlsreferenz.

tag-resource

Das folgende Codebeispiel zeigt die Verwendungtag-resource.

AWS CLI

Um einer Ressource Tags hinzuzufügen

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.

Einzelheiten TagResourcezur API AWS CLI finden Sie in der Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendunguntag-resource.

AWS CLI

Beispiel 1: Um ein Tag aus einer Ressource zu entfernen

Im folgenden untag-resource Beispiel wird das angegebene Tag (Schlüsselname und Wert) aus einer 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: Um mehrere Tags aus einer Ressource zu entfernen

Im folgenden untag-resource Beispiel werden die angegebenen Tags (Schlüsselnamen und Werte) aus einer 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.

Einzelheiten UntagResourcezur API AWS CLI finden Sie in der Befehlsreferenz.

untag-resource

Das folgende Codebeispiel zeigt die Verwendunguntag-resource.

AWS CLI

Beispiel 1: Um ein Tag aus einer Ressource zu entfernen

Im folgenden untag-resource Beispiel wird das angegebene Tag (Schlüsselname und Wert) aus einer 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: Um mehrere Tags aus einer Ressource zu entfernen

Im folgenden untag-resource Beispiel werden die angegebenen Tags (Schlüsselnamen und Werte) aus einer 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.

Einzelheiten UntagResourcezur API AWS CLI finden Sie in der Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungupdate-sms-channel.

AWS CLI

Um den SMS-Kanal zu aktivieren oder den Status und die Einstellungen des SMS-Kanals für eine Anwendung zu aktualisieren.

Im folgenden update-sms-channel Beispiel wird der SMS-Kanal für einen SMS-Kanal für eine 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.

Einzelheiten zur API finden Sie UpdateSmsChannelunter AWS CLI Befehlsreferenz.

update-sms-channel

Das folgende Codebeispiel zeigt die Verwendungupdate-sms-channel.

AWS CLI

Um den SMS-Kanal zu aktivieren oder den Status und die Einstellungen des SMS-Kanals für eine Anwendung zu aktualisieren.

Im folgenden update-sms-channel Beispiel wird der SMS-Kanal für einen SMS-Kanal für eine 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.

Einzelheiten zur API finden Sie UpdateSmsChannelunter AWS CLI Befehlsreferenz.

Warnung JavaScript ist in Ihrem Browser nicht verfügbar oder deaktiviert.

Zur Nutzung der AWS-Dokumentation muss JavaScript aktiviert sein. Weitere Informationen finden auf den Hilfe-Seiten Ihres Browsers.

Dokumentkonventionen

AWS Payment Cryptography Datenebene

Amazon Polly

Auf dieser Seite

Wählen Sie Ihre Cookie-Einstellungen aus

Cookie-Einstellungen anpassen

Essenziell

Leistung

Funktional

Werbung

Cookie-Einstellungen konnten nicht gespeichert werden

Amazon Pinpoint Pinpoint-Beispiele mit AWS CLI

Themen

Aktionen

create-app

create-sms-template

delete-app

get-apns-channel

get-app

get-apps

get-campaign

get-campaigns

get-channels

get-email-channel

get-endpoint

get-gcm-channel

get-sms-channel

get-sms-template

get-voice-channel

list-tags-for-resource

phone-number-validate

send-messages

send-users-messages

tag-resource

untag-resource

update-sms-channel

Auf dieser Seite

Hat Ihnen diese Seite geholfen?

Nächstes Thema:

Vorheriges Thema:

Brauchen Sie Hilfe?