Hay más ejemplos de AWS SDK disponibles en el repositorio de ejemplos de [AWS Doc SDK. ](https://github.com/awsdocs/aws-doc-sdk-examples) GitHub 

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 que utilizan AWS CLI
<a name="cli_2_pinpoint_code_examples"></a>

Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes AWS Command Line Interface con 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 distintas funciones de servicio, es posible ver las acciones en contexto en los escenarios relacionados.

En cada ejemplo se incluye un enlace al código de origen completo, con instrucciones de configuración y ejecución del código en el contexto.

**Topics**
+ [Acciones](#actions)

## Acciones
<a name="actions"></a>

### `crear una aplicación`
<a name="pinpoint_CreateApp_cli_2_topic"></a>

En el siguiente ejemplo de código, se muestra cómo utilizar `create-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 obtener más información sobre la API, consulte la Referencia [ CreateApp ](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/create-app.html) de *AWS CLI comandos. * 

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

En el siguiente ejemplo de código, se muestra cómo utilizar `create-sms-template`.

**AWS CLI**  
**Permite crear una plantilla de mensaje para los mensajes que se envían a través del canal de SMS**  
En el siguiente ejemplo de `create-sms-template`, se crea una plantilla de mensaje SMS.  

```
aws pinpoint create-sms-template \
    --template-name {{TestTemplate}} \
    --sms-template-request {{file://myfile.json}} \
    --region {{us-east-1}}
```
Contenido 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 [Amazon Pinpoint message templates](https://docs.aws.amazon.com/pinpoint/latest/userguide/messages-templates.html) en la *Guía del usuario de Amazon Pinpoint*.  
+  Para obtener más información sobre la API, consulte [ CreateSmsTemplate ](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/create-sms-template.html) la Referencia de comandos. *AWS CLI * 

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

En el siguiente ejemplo de código, se muestra cómo utilizar `delete-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 obtener más información sobre la API, consulte la Referencia [ DeleteApp ](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/delete-app.html) de *AWS CLI comandos. * 

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

En el siguiente ejemplo de código, se muestra cómo utilizar `get-apns-channel`.

**AWS CLI**  
**Recuperación de información sobre el estado y la configuración del canal de APN para una aplicación**  
En el siguiente ejemplo de `get-apns-channel` se recupera el estado y la configuración del canal de APN 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 obtener más información sobre la API, consulte la Referencia de comandos. [ GetApnsChannel ](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-apns-channel.html) *AWS CLI * 

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

En el siguiente ejemplo de código, se muestra cómo utilizar `get-app`.

**AWS CLI**  
**Obtención de información sobre una aplicación (proyecto)**  
En el siguiente ejemplo de `get-app`, se 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 obtener más información sobre la API, consulte la Referencia [ GetApp ](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-app.html) de *AWS CLI comandos. * 

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

En el siguiente ejemplo de código, se muestra cómo utilizar `get-apps`.

**AWS CLI**  
**Obtención de información sobre todas las aplicaciones**  
En el siguiente ejemplo de `get-apps`, se recupera información sobre todas las 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 respuesta `NextToken` indica que hay más resultados disponibles. Vuelva a ejecutar el comando e introduzca ese valor como el parámetro de entrada `NextToken`.  
+  Para obtener más información sobre la API, consulte la Referencia [ GetApps ](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-apps.html) de *AWS CLI comandos. * 

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

En el siguiente ejemplo de código, se muestra cómo utilizar `get-campaign`.

**AWS CLI**  
**Recuperación de información sobre el estado, la configuración y otros ajustes de una campaña**  
El siguiente ejemplo de `get-campaign` recupera información sobre el estado, la configuración y otros ajustes para 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 obtener más información sobre la API, consulta la sección de [ GetCampaign ](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-campaign.html) referencia de *AWS CLI comandos. * 

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

En el siguiente ejemplo de código, se muestra cómo utilizar `get-campaigns`.

**AWS CLI**  
**Recuperación de información sobre el estado, la configuración y otros ajustes para todas las campañas asociadas a una aplicación**  
El siguiente ejemplo de `get-campaigns` recupera información sobre el estado, la configuración y otros ajustes para todas las campañas que están 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 obtener más información sobre la API, consulta la sección [ GetCampaigns ](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-campaigns.html) Referencia de *AWS CLI comandos. * 

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

En el siguiente ejemplo de código, se muestra cómo utilizar `get-channels`.

**AWS CLI**  
**Recuperación de información del historial y el estado de todos los canales de una aplicación**  
El siguiente ejemplo de `get-channels` 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 obtener más información sobre la API, consulte la Referencia [ GetChannels ](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-channels.html) de *AWS CLI comandos. * 

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

En el siguiente ejemplo de código, se muestra cómo utilizar `get-email-channel`.

**AWS CLI**  
**Recuperación de información sobre el estado y la configuración del canal de correo electrónico para una aplicación**  
En el siguiente ejemplo de `get-email-channel`, se recupera el estado y la configuración del canal de correo electrónico para 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 obtener más información sobre la API, consulte [ GetEmailChannel ](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-email-channel.html) la Referencia de comandos. *AWS CLI * 

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

En el siguiente ejemplo de código, se muestra cómo utilizar `get-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 obtener más información sobre la API, consulte la Referencia [ GetEndpoint ](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-endpoint.html) de *AWS CLI comandos. * 

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

En el siguiente ejemplo de código, se muestra cómo utilizar `get-gcm-channel`.

**AWS CLI**  
**Recuperación de información sobre el estado y la configuración del canal GCM para una aplicación**  
En el siguiente ejemplo de `get-gcm-channel`, se recupera información sobre el estado y la configuración del canal GCM para 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 obtener más información sobre la API, consulte la Referencia de comandos. [ GetGcmChannel ](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-gcm-channel.html) *AWS CLI * 

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

En el siguiente ejemplo de código, se muestra cómo utilizar `get-sms-channel`.

**AWS CLI**  
**Recuperación de información sobre el estado y la configuración del canal de SMS para 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 obtener más información sobre la API, consulte [ GetSmsChannel ](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-sms-channel.html) la Referencia de comandos. *AWS CLI * 

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

En el siguiente ejemplo de código, se muestra cómo utilizar `get-sms-template`.

**AWS CLI**  
**Recupera el contenido y la configuración de una plantilla de mensaje para los mensajes que se envían a través del canal de SMS**  
El siguiente ejemplo de `get-sms-template` recupera el contenido y la configuración de una plantilla de mensaje SMS.  

```
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 [Amazon Pinpoint message templates](https://docs.aws.amazon.com/pinpoint/latest/userguide/messages-templates.html) en la *Guía del usuario de Amazon Pinpoint*.  
+  Para obtener más información sobre la API, consulte [ GetSmsTemplate ](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-sms-template.html) *AWS CLI Command Reference*. 

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

En el siguiente ejemplo de código, se muestra cómo utilizar `get-voice-channel`.

**AWS CLI**  
**Recuperación de información sobre el estado y la configuración del canal de voz para una aplicación**  
El siguiente ejemplo de `get-voice-channel` 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 obtener más información sobre la API, consulte [ GetVoiceChannel ](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-voice-channel.html) la Referencia de comandos. *AWS CLI * 

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

En el siguiente ejemplo de código, se muestra cómo utilizar `list-tags-for-resource`.

**AWS CLI**  
**Pare recuperar una lista de etiquetas para un recurso**  
El siguiente ejemplo de `list-tags-for-resource` recupera todas las etiquetas (nombres y valores clave) 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 «Etiquetar 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 más información sobre la API, consulte la referencia de comandos. [ ListTagsForResource ](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/list-tags-for-resource.html) *AWS CLI * 

### `validar el número de teléfono`
<a name="pinpoint_PhoneNumberValidate_cli_2_topic"></a>

En el siguiente ejemplo de código, se muestra cómo utilizar `phone-number-validate`.

**AWS CLI**  
**Recupera información sobre un número de teléfono**  
El siguiente `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 [Canal de SMS de Amazon Pinpoint](https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms.html) en la *Guía del usuario de Amazon Pinpoint*.  
+  Para obtener más información sobre la API, consulte [ PhoneNumberValidate ](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/phone-number-validate.html) la Referencia de comandos. *AWS CLI * 

### `enviar mensajes`
<a name="pinpoint_SendMessages_cli_2_topic"></a>

En el siguiente ejemplo de código, se muestra cómo utilizar `send-messages`.

**AWS CLI**  
**Envío de un mensaje SMS mediante el punto de conexión 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}}
```
Contenido 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 [Canal de SMS de Amazon Pinpoint](https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms.html) en la *Guía del usuario de Amazon Pinpoint*.  
+  Para obtener más información sobre la API, consulte la Referencia [ SendMessages ](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/send-messages.html) de *AWS CLI comandos. * 

### `enviar mensajes a los usuarios`
<a name="pinpoint_SendUsersMessages_cli_2_topic"></a>

En el siguiente ejemplo de código, se muestra cómo utilizar `send-users-messages`.

**AWS CLI**  
**Envío de mensaje SMS a un usuario de una aplicación**  
El siguiente ejemplo de `send-users-messages` 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}}
```
Contenido 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 [Canal de SMS de Amazon Pinpoint](https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms.html) en la *Guía del usuario de Amazon Pinpoint*.  
+  Para obtener más información sobre la API, consulte [ SendUsersMessages ](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/send-users-messages.html) la Referencia de comandos. *AWS CLI * 

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

En el siguiente ejemplo de código, se muestra cómo utilizar `tag-resource`.

**AWS CLI**  
**Para agregar 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 «Etiquetar 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 más información sobre la API, consulte la referencia de comandos. [ TagResource ](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/tag-resource.html) *AWS CLI * 

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

En el siguiente ejemplo de código, se muestra cómo utilizar `untag-resource`.

**AWS CLI**  
**Ejemplo 1: cómo eliminar una etiqueta de un recurso**  
El siguiente ejemplo de `untag-resource` elimina la etiqueta especificada (nombre y valor de 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: eliminar varias etiquetas de un recurso**  
El siguiente ejemplo de `untag-resource` elimina las etiquetas especificadas (nombres y valores de 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 «Etiquetar 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 más información sobre la API, consulte la referencia de comandos. [ UntagResource ](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/untag-resource.html) *AWS CLI * 

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

En el siguiente ejemplo de código, se muestra cómo utilizar `update-sms-channel`.

**AWS CLI**  
**Habilitación de un canal de SMS o actualización del estado y la configuración del canal de SMS para una aplicación**.  
El siguiente ejemplo de `update-sms-channel` habilita un canal de SMS para un canal de SMS 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 [Canal de SMS de Amazon Pinpoint](https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms.html) en la *Guía del usuario de Amazon Pinpoint*.  
+  Para obtener más información sobre la API, consulte [ UpdateSmsChannel ](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/update-sms-channel.html) la Referencia de comandos. *AWS CLI *