Excluir endpoints do Amazon Pinpoint de forma programática - Amazon Pinpoint
Exemplos

Aviso de fim do suporte: em 30 de outubro de 2026, a AWS encerrará o suporte para o Amazon Pinpoint. Após 30 de outubro de 2026, você não poderá mais acessar o console do Amazon Pinpoint nem seus recursos (endpoints, segmentos, campanhas, jornadas e analytics). Para acessar mais informações, consulte Amazon Pinpoint end of support. Observação: as APIs relacionadas a SMS, voz, notificações push para dispositivos móveis, OTP e validação de número de telefone não são afetadas por essa alteração e são compatíveis com o AWS End User Messaging.

Excluir endpoints do Amazon Pinpoint de forma programática

Um endpoint representa um único método de contato com um de seus clientes. Cada endpoint pode se referir ao endereço de e-mail de cliente, identificador de dispositivo móvel, número de telefone ou outro tipo de destino ao qual você pode enviar mensagens. Em várias jurisdições, esse tipo de informação pode ser considerada pessoal. Você pode excluir endpoints quando não desejar mais enviar mensagens a um determinado destino, como quando o destino se tornar inacessível ou quando um cliente fechar uma conta.

Exemplos

Os exemplos a seguir mostram como excluir um endpoint.

AWS CLI

Você pode usar o Amazon Pinpoint executando comandos com a AWS CLI.

exemplo Comando Delete endpoint

Para excluir um endpoint, use o comando delete-endpoint:

$ aws pinpoint delete-endpoint \
> --application-id application-id \
> --endpoint-id endpoint-id

Em que:

  • application-id é o ID do projeto do Amazon Pinpoint que contém o endpoint.

  • endpoint-id é o ID do endpoint que você está excluindo.

A resposta a esse comando é a definição JSON do endpoint excluído.

AWS SDK para Java

Você pode usar a API do Amazon Pinpoint em seus aplicativos Java usando o cliente fornecido pelo AWS SDK para Java.

exemplo Código

Para excluir um endpoint, use o método deleteEndpoint do cliente do AmazonPinpoint. Forneça um objeto DeleteEndpointRequest como o argumento do método:

import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.pinpoint.PinpointClient;
import software.amazon.awssdk.services.pinpoint.model.DeleteEndpointRequest;
import software.amazon.awssdk.services.pinpoint.model.DeleteEndpointResponse;
import software.amazon.awssdk.services.pinpoint.model.PinpointException;

import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.pinpoint.PinpointClient;
import software.amazon.awssdk.services.pinpoint.model.DeleteEndpointRequest;
import software.amazon.awssdk.services.pinpoint.model.DeleteEndpointResponse;
import software.amazon.awssdk.services.pinpoint.model.PinpointException;

/**
 * Before running this Java V2 code example, set up your development
 * environment, including your credentials.
 *
 * For more information, see the following documentation topic:
 *
 * https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
 */
public class DeleteEndpoint {
    public static void main(String[] args) {
        final String usage = """

                Usage:   <appName> <endpointId >

                Where:
                  appId - The id of the application to delete.
                  endpointId - The id of the endpoint to delete.
                """;

        if (args.length != 2) {
            System.out.println(usage);
            System.exit(1);
        }

        String appId = args[0];
        String endpointId = args[1];
        System.out.println("Deleting an endpoint with id: " + endpointId);
        PinpointClient pinpoint = PinpointClient.builder()
                .region(Region.US_EAST_1)
                .build();

        deletePinEncpoint(pinpoint, appId, endpointId);
        pinpoint.close();
    }

    public static void deletePinEncpoint(PinpointClient pinpoint, String appId, String endpointId) {
        try {
            DeleteEndpointRequest appRequest = DeleteEndpointRequest.builder()
                    .applicationId(appId)
                    .endpointId(endpointId)
                    .build();

            DeleteEndpointResponse result = pinpoint.deleteEndpoint(appRequest);
            String id = result.endpointResponse().id();
            System.out.println("The deleted endpoint id  " + id);

        } catch (PinpointException e) {
            System.err.println(e.awsErrorDetails().errorMessage());
            System.exit(1);
        }
        System.out.println("Done");
    }
}

Para ver o exemplo completo do SDK, consulte DeleteEndpoint.java no GitHub.

HTTP

Você pode usar o Amazon Pinpoint fazendo solicitações HTTP diretamente para a API REST.

exemplo Solicitação DELETE endpoint

Para excluir um endpoint, envie uma solicitação DELETE para o recurso Endpoint:

DELETE /v1/apps/application-id/endpoints/endpoint-id HTTP/1.1
Host: pinpoint.us-east-1.amazonaws.com
Content-Type: application/json
Accept: application/json
Cache-Control: no-cache

Em que:

  • application-id é o ID do projeto do Amazon Pinpoint que contém o endpoint.

  • endpoint-id é o ID do endpoint que você está excluindo.

A resposta a essa solicitação é a definição JSON do endpoint excluído.