Ejemplos de Amazon Pinpoint con AWS CLI - AWS Command Line Interface
Acciones

Esta documentación es AWS CLI únicamente para la versión 1 de la versión. Para ver la documentación relacionada con la versión 2 de AWS CLI, consulte la Guía del usuario de la versión 2.

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Ejemplos de Amazon Pinpoint con AWS CLI

Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes AWS Command Line Interface mediante Amazon Pinpoint.

Las acciones son extractos de código de programas más grandes y deben ejecutarse en contexto. Mientras las acciones muestran cómo llamar a las funciones de servicio individuales, es posible ver las acciones en contexto en los escenarios relacionados.

Cada ejemplo incluye un enlace al código fuente completo, donde puede encontrar instrucciones sobre cómo configurar y ejecutar el código en su contexto.

Acciones

El siguiente ejemplo de código muestra cómo usarlocreate-app.

AWS CLI

Ejemplo 1: Creación de una aplicación

En el siguiente ejemplo de create-app se crea una nueva aplicación (proyecto).

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

Salida:

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

Ejemplo 2: Creación de una aplicación etiquetada

En el siguiente ejemplo de create-app se crea una nueva aplicación (proyecto) y asocia una etiqueta (clave y valor) a la aplicación.

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

Salida:

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

  • Para API obtener más información, consulte CreateAppla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlocreate-sms-template.

AWS CLI

Crea una plantilla de mensajes para los mensajes que se envían a través del SMS canal

En el siguiente create-sms-template ejemplo, se crea una plantilla de SMS mensaje.

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

Contenidos de myfile.json:

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

Salida:

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

Para obtener más información, consulte las plantillas de mensajes de Amazon Pinpoint en la Guía del usuario de Amazon Pinpoint.

  • Para API obtener más información, consulte la Referencia CreateSmsTemplatede AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlodelete-app.

AWS CLI

Eliminación de una aplicación

En el siguiente ejemplo delete-app se elimina una aplicación (proyecto).

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

Salida:

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

  • Para API obtener más información, consulte DeleteAppla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloget-apns-channel.

AWS CLI

Para recuperar información sobre el estado y la configuración del APNs canal de una aplicación

El siguiente get-apns-channel ejemplo recupera información sobre el estado y la configuración del APNs canal de una aplicación.

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

Salida:

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

  • Para API obtener más información, consulte GetApnsChannella Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloget-app.

AWS CLI

Para recuperar información sobre una aplicación (proyecto)

El siguiente get-app ejemplo recupera información sobre una aplicación (proyecto).

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

Salida:

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

  • Para API obtener más información, consulte GetAppla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloget-apps.

AWS CLI

Para recuperar información sobre todas sus aplicaciones

El siguiente get-apps ejemplo recupera información sobre todas sus aplicaciones (proyectos).

aws pinpoint get-apps

Salida:

{
    "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 presencia del valor de NextToken respuesta indica que hay más resultados disponibles. Vuelva a ejecutar el comando e introduzca ese valor como parámetro de NextToken entrada.

  • Para API obtener más información, consulte GetAppsla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloget-campaign.

AWS CLI

Para recuperar información sobre el estado, la configuración y otros ajustes de una campaña

En el siguiente get-campaign ejemplo, se recupera información sobre el estado, la configuración y otros ajustes de una campaña.

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

Salida:

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

  • Para API obtener más información, consulte GetCampaignla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloget-campaigns.

AWS CLI

Para recuperar información sobre el estado, la configuración y otros ajustes de todas las campañas asociadas a una aplicación

En el siguiente get-campaigns ejemplo, se recupera información sobre el estado, la configuración y otros ajustes de todas las campañas asociadas a una aplicación.

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

Salida:

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

  • Para API obtener más información, consulte GetCampaignsla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloget-channels.

AWS CLI

Para recuperar información sobre el historial y el estado de cada canal de una aplicación

El siguiente get-channels ejemplo recupera información sobre el historial y el estado de cada canal de una aplicación.

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

Salida:

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

  • Para API obtener más información, consulte GetChannelsla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloget-email-channel.

AWS CLI

Para recuperar información sobre el estado y la configuración del canal de correo electrónico de una aplicación

El siguiente get-email-channel ejemplo recupera el estado y la configuración del canal de correo electrónico de una aplicación.

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

Salida:

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

  • Para API obtener más información, consulte GetEmailChannella Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloget-endpoint.

AWS CLI

Recuperación de información sobre la configuración y los atributos de un punto de conexión específico de una aplicación

En el siguiente ejemplo get-endpoint se recupera información sobre la configuración y los atributos de un punto de conexión específico de una aplicación.

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

Salida:

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

  • Para API obtener más información, consulte GetEndpointla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloget-gcm-channel.

AWS CLI

Para recuperar información sobre el estado y la configuración del GCM canal de una aplicación

El siguiente get-gcm-channel ejemplo recupera información sobre el estado y la configuración del GCM canal de una aplicación.

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

Salida:

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

  • Para API obtener más información, consulte GetGcmChannella Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloget-sms-channel.

AWS CLI

Para recuperar información sobre el estado y la configuración del SMS canal de una aplicación

En el siguiente ejemplo de get-sms-channel se recupera el estado y la configuración del canal de SMS de una aplicación.

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

Salida:

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

  • Para API obtener más información, consulte GetSmsChannella Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloget-sms-template.

AWS CLI

Recupera el contenido y la configuración de una plantilla de mensajes para los mensajes que se envían a través del canal SMS

En el siguiente get-sms-template ejemplo, se recupera el contenido y la configuración de una plantilla de SMS mensaje.

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

Salida:

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

Para obtener más información, consulte las plantillas de mensajes de Amazon Pinpoint en la Guía del usuario de Amazon Pinpoint.

  • Para API obtener más información, consulte la Referencia GetSmsTemplatede AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloget-voice-channel.

AWS CLI

Para recuperar información sobre el estado y la configuración del canal de voz de una aplicación

El siguiente get-voice-channel ejemplo recupera el estado y la configuración del canal de voz de una aplicación.

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

Salida:

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

  • Para API obtener más información, consulte GetVoiceChannella Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlolist-tags-for-resource.

AWS CLI

Para recuperar una lista de etiquetas de un recurso

En el siguiente list-tags-for-resource ejemplo, se recuperan todas las etiquetas (nombres y valores clave) que están asociadas al recurso especificado.

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

Salida:

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

Para obtener más información, consulte «Etiquetado de los recursos de Amazon Pinpoint https://docs.aws.amazon.com/pinpoint/ latest/developerguide/tagging < -resources.html>'__» en la Guía para desarrolladores de Amazon Pinpoint.

  • Para obtener API más información, ListTagsForResourceconsulte AWS CLI la Referencia de comandos.

El siguiente ejemplo de código muestra cómo usarlophone-number-validate.

AWS CLI

Recupera información sobre un número de teléfono

A continuación, se phone-number-validate recupera información sobre un número de teléfono.

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

Salida:

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

Para obtener más información, consulte el SMScanal Amazon Pinpoint en la Guía del usuario de Amazon Pinpoint.

  • Para API obtener más información, consulte la Referencia PhoneNumberValidatede AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlosend-messages.

AWS CLI

Para enviar un SMS mensaje mediante el punto final de una aplicación

En el siguiente ejemplo de send-messages se envía un mensaje directo a una aplicación con un punto de conexión.

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

Contenidos de myfile.json:

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

Salida:

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

Para obtener más información, consulte el SMScanal Amazon Pinpoint en la Guía del usuario de Amazon Pinpoint.

  • Para API obtener más información, consulte la Referencia SendMessagesde AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlosend-users-messages.

AWS CLI

Para enviar un SMS mensaje a un usuario de una aplicación

El siguiente send-users-messages ejemplo envía un mensaje directo a un usuario de una aplicación.

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

Contenidos de myfile.json:

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

Salida:

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

Para obtener más información, consulte el SMScanal Amazon Pinpoint en la Guía del usuario de Amazon Pinpoint.

  • Para API obtener más información, consulte la Referencia SendUsersMessagesde AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlotag-resource.

AWS CLI

Para añadir etiquetas a un recurso

En el siguiente ejemplo, se agregan dos etiquetas (nombres y valores clave) a un recurso.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte «Etiquetado de los recursos de Amazon Pinpoint https://docs.aws.amazon.com/pinpoint/ latest/developerguide/tagging < -resources.html>'__» en la Guía para desarrolladores de Amazon Pinpoint.

  • Para obtener API más información, TagResourceconsulte AWS CLI la Referencia de comandos.

El siguiente ejemplo de código muestra cómo usarlountag-resource.

AWS CLI

Ejemplo 1: Para eliminar una etiqueta de un recurso

En el siguiente untag-resource ejemplo, se elimina la etiqueta especificada (nombre y valor de la clave) de un recurso.

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

Este comando no genera ninguna salida.

Ejemplo 2: Para eliminar varias etiquetas de un recurso

En el siguiente untag-resource ejemplo, se eliminan las etiquetas especificadas (nombres y valores clave) de un recurso.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte «Etiquetado de los recursos de Amazon Pinpoint https://docs.aws.amazon.com/pinpoint/ latest/developerguide/tagging < -resources.html>'__» en la Guía para desarrolladores de Amazon Pinpoint.

  • Para obtener API más información, UntagResourceconsulte AWS CLI la Referencia de comandos.

El siguiente ejemplo de código muestra cómo usarloupdate-sms-channel.

AWS CLI

Para habilitar el SMS canal o actualizar el estado y la configuración del SMS canal para una aplicación.

El siguiente update-sms-channel ejemplo habilita el SMS canal para un SMS canal de una aplicación.

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

Salida:

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

Para obtener más información, consulte el SMScanal Amazon Pinpoint en la Guía del usuario de Amazon Pinpoint.

  • Para API obtener más información, consulte la Referencia UpdateSmsChannelde AWS CLI comandos.