Amazon Pinpoint からエンドポイントを削除する

宛先不明でエラーになる場合や、顧客がアカウントを削除した場合など、特定の送信先へのメッセージの送信が不要になった場合は、そのエンドポイントを削除することができます。

例

エンドポイントの削除方法を次の例に示します。

AWS CLI

Amazon Pinpoint を使用するには、 AWS CLIでコマンドを実行します。

例 Delete Endpoint コマンド

エンドポイントを削除するには、delete-endpoint コマンドを使用します。

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

コードの説明は以下のとおりです。

• application-id は、エンドポイントを含む Amazon Pinpoint プロジェクトの ID です。

• endpoint-id は、削除するエンドポイントの ID です。

このコマンドのレスポンスは、削除したエンドポイントの JSON 定義です。

AWS SDK for Java

AWS SDK for Javaが提供するクライアントにより、Java アプリケーションで Amazon Pinpoint API を使用できます。

例 コード

エンドポイントを削除するには、AmazonPinpoint クライアントの deleteEndpoint メソッドを使用します。メソッドの引数として DeleteEndpointRequest オブジェクトを指定します。

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

SDK の完全な例については、「」のDeleteEndpoint「.java」を参照してくださいGitHub。

HTTP

HTTP リクエストを直接 REST API に送信して Amazon Pinpoint を使用することができます。

例 DELETE Endpoint リクエスト

エンドポイントを削除するには、Endpoint リソースに対して DELETE リクエストを発行します。

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

コードの説明は以下のとおりです。

• application-id は、エンドポイントを含む Amazon Pinpoint プロジェクトの ID です。

• endpoint-id は、削除するエンドポイントの ID です。

このリクエストのレスポンスは、削除したエンドポイントの JSON 定義です。