在 Amazon 中管理電話號碼和SMS訂閱 SNS

Amazon SNS提供多種選項，用於管理從您的帳戶接收SMS訊息的人員。在有限的頻率下，您可以選擇不接收來自您帳戶SMS訊息的電話號碼。若要停止傳送訊息至SMS訂閱，您可以移除訂閱或發佈至訂閱的主題。

主題

選擇不接收SMS訊息
管理電話號碼和簡訊訂閱 (主控台)

選擇不接收SMS訊息

依當地法律和法規（例如美國和加拿大）要求，SMS收件人可以使用其裝置，透過下列任何項目回覆訊息來選擇退出：

ARRET （法文）
CANCEL
END
OPT-OUT
OPTOUT
QUIT
REMOVE
STOP
TD
UNSUBSCRIBE

若要選擇退出，收件人必須回覆與 Amazon SNS用來傳送訊息的相同原始號碼。選擇退出後，收件人將不再收到來自 SMS的訊息， AWS 帳戶除非您選擇加入電話號碼。

如果電話號碼已訂閱 Amazon SNS主題，選擇退出不會移除訂閱，但除非您選擇加入電話號碼，否則SMS訊息將無法傳遞至該訂閱。

管理電話號碼和簡訊訂閱 (主控台)

您可以使用 Amazon SNS主控台來控制哪些電話號碼從您的帳戶接收SMS訊息。

選擇加入已選擇退出的電話號碼

您可以檢視哪些電話號碼已選擇退出接收來自您帳戶SMS的訊息，而且您可以選擇加入這些電話號碼，以繼續傳送訊息給他們。

您只能選擇每 30 天接收一次電話號碼。

登入 Amazon SNS主控台。
在主控台功能表中，將區域選取器設定為支援SMS訊息的區域。
在導覽面板上，選擇簡訊（SMS）。
在行動簡訊（SMS） 頁面上，在選擇退出的電話號碼區段中，會顯示選擇退出的電話號碼。
選取您要選擇加入的電話號碼的核取方塊，然後選擇加入。該電話號碼不再選擇退出，且將收到您傳送給該電話號碼SMS的訊息。

刪除SMS訂閱

當您發佈至主題時，請刪除SMS訂閱以停止SMS傳送訊息至該電話號碼。

在導覽面板上，選擇 Subscriptions (訂閱)。
選擇您要刪除之訂閱的核取方塊。然後選擇 Actions (動作)，再選擇 Delete Subscriptions (刪除訂閱)。
在 Delete (刪除) 視窗中，選擇 Delete (刪除)。Amazon 會SNS刪除訂閱並顯示成功訊息。

刪除主題

當您不再想要發布訊息其訂閱的端點，請刪除該主題。

在導覽面板上，選擇 Topics (主題)。
選擇您要刪除之主題的核取方塊。然後選擇 Actions (動作)，再選擇 Delete Topics (刪除主題)。
在 Delete (刪除) 視窗中，選擇 Delete (刪除)。Amazon 會SNS刪除主題並顯示成功訊息。

管理電話號碼和訂閱（AWS SDKs）

您可以使用 AWS SDKs向 Amazon 提出程式設計請求SNS，並管理哪些電話號碼可以從您的帳戶接收SMS訊息。

若要使用 AWS SDK，您必須使用憑證進行設定。如需詳細資訊，請參閱和 AWS SDKs 工具參考指南 中的共用組態和憑證檔案。

檢視所有選擇退出的電話號碼

若要檢視所有選擇退出的電話號碼，請透過 Amazon SNS 提交ListPhoneNumbersOptedOut請求API。

下列程式碼範例示範如何使用 ListPhoneNumbersOptedOut。

CLI

AWS CLI

列出SMS訊息選擇退出

下列list-phone-numbers-opted-out範例列出選擇不接收SMS訊息的電話號碼。


aws sns list-phone-numbers-opted-out

輸出：


{
    "phoneNumbers": [
        "+15555550100"
    ]
}

如需API詳細資訊，請參閱命令參考 ListPhoneNumbersOptedOut中的。 AWS CLI

Java

SDK 適用於 Java 2.x

注意

還有更多。 GitHub尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。


import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.sns.SnsClient;
import software.amazon.awssdk.services.sns.model.ListPhoneNumbersOptedOutRequest;
import software.amazon.awssdk.services.sns.model.ListPhoneNumbersOptedOutResponse;
import software.amazon.awssdk.services.sns.model.SnsException;

/**
 * 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 ListOptOut {
    public static void main(String[] args) {
        SnsClient snsClient = SnsClient.builder()
                .region(Region.US_EAST_1)
                .build();

        listOpts(snsClient);
        snsClient.close();
    }

    public static void listOpts(SnsClient snsClient) {
        try {
            ListPhoneNumbersOptedOutRequest request = ListPhoneNumbersOptedOutRequest.builder().build();
            ListPhoneNumbersOptedOutResponse result = snsClient.listPhoneNumbersOptedOut(request);
            System.out.println("Status is " + result.sdkHttpResponse().statusCode() + "\n\nPhone Numbers: \n\n"
                    + result.phoneNumbers());

        } catch (SnsException e) {
            System.err.println(e.awsErrorDetails().errorMessage());
            System.exit(1);
        }
    }
}

如需API詳細資訊，請參閱參考 ListPhoneNumbersOptedOut中的。 AWS SDK for Java 2.x API

PHP

適用於 PHP 的 SDK

注意

還有更多。 GitHub尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。


require 'vendor/autoload.php';

use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;


/**
 * Returns a list of phone numbers that are opted out of receiving SMS messages from your AWS SNS account.
 *
 * This code expects that you have AWS credentials set up per:
 * https://docs.aws.amazon.com/sdk-for-php/v3/developer-guide/guide_credentials.html
 */

$SnSclient = new SnsClient([
    'profile' => 'default',
    'region' => 'us-east-1',
    'version' => '2010-03-31'
]);

try {
    $result = $SnSclient->listPhoneNumbersOptedOut();
    var_dump($result);
} catch (AwsException $e) {
    // output error message if fails
    error_log($e->getMessage());
}

如需詳細資訊，請參閱《AWS SDK for PHP 開發人員指南》。
如需API詳細資訊，請參閱參考 ListPhoneNumbersOptedOut中的。 AWS SDK for PHP API

檢查電話號碼是否選擇退出

若要檢查電話號碼是否選擇退出，請透過 SNS Amazon 提交CheckIfPhoneNumberIsOptedOut請求API。

下列程式碼範例示範如何使用 CheckIfPhoneNumberIsOptedOut。

.NET

AWS SDK for .NET

注意

還有更多。 GitHub尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。


    using System;
    using System.Threading.Tasks;
    using Amazon.SimpleNotificationService;
    using Amazon.SimpleNotificationService.Model;

    /// <summary>
    /// This example shows how to use the Amazon Simple Notification Service
    /// (Amazon SNS) to check whether a phone number has been opted out.
    /// </summary>
    public class IsPhoneNumOptedOut
    {
        public static async Task Main()
        {
            string phoneNumber = "+15551112222";

            IAmazonSimpleNotificationService client = new AmazonSimpleNotificationServiceClient();

            await CheckIfOptedOutAsync(client, phoneNumber);
        }

        /// <summary>
        /// Checks to see if the supplied phone number has been opted out.
        /// </summary>
        /// <param name="client">The initialized Amazon SNS Client object used
        /// to check if the phone number has been opted out.</param>
        /// <param name="phoneNumber">A string representing the phone number
        /// to check.</param>
        public static async Task CheckIfOptedOutAsync(IAmazonSimpleNotificationService client, string phoneNumber)
        {
            var request = new CheckIfPhoneNumberIsOptedOutRequest
            {
                PhoneNumber = phoneNumber,
            };

            try
            {
                var response = await client.CheckIfPhoneNumberIsOptedOutAsync(request);

                if (response.HttpStatusCode == System.Net.HttpStatusCode.OK)
                {
                    string optOutStatus = response.IsOptedOut ? "opted out" : "not opted out.";
                    Console.WriteLine($"The phone number: {phoneNumber} is {optOutStatus}");
                }
            }
            catch (AuthorizationErrorException ex)
            {
                Console.WriteLine($"{ex.Message}");
            }
        }
    }

如需API詳細資訊，請參閱參考 CheckIfPhoneNumberIsOptedOut中的。 AWS SDK for .NET API

CLI

AWS CLI

若要檢查SMS訊息是否選擇退出電話號碼

下列check-if-phone-number-is-opted-out範例會檢查指定的電話號碼是否選擇不接收來自目前 AWS 帳戶SMS的訊息。


aws sns check-if-phone-number-is-opted-out \
    --phone-number +1555550100

輸出：


{
    "isOptedOut": false
}

如需API詳細資訊，請參閱命令參考 CheckIfPhoneNumberIsOptedOut中的。 AWS CLI

Java

SDK 適用於 Java 2.x

注意

還有更多。 GitHub尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。


import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.sns.SnsClient;
import software.amazon.awssdk.services.sns.model.CheckIfPhoneNumberIsOptedOutRequest;
import software.amazon.awssdk.services.sns.model.CheckIfPhoneNumberIsOptedOutResponse;
import software.amazon.awssdk.services.sns.model.SnsException;

/**
 * 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 CheckOptOut {
    public static void main(String[] args) {

        final String usage = """

                Usage:    <phoneNumber>

                Where:
                   phoneNumber - The mobile phone number to look up (for example, +1XXX5550100).

                """;

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

        String phoneNumber = args[0];
        SnsClient snsClient = SnsClient.builder()
                .region(Region.US_EAST_1)
                .build();

        checkPhone(snsClient, phoneNumber);
        snsClient.close();
    }

    public static void checkPhone(SnsClient snsClient, String phoneNumber) {
        try {
            CheckIfPhoneNumberIsOptedOutRequest request = CheckIfPhoneNumberIsOptedOutRequest.builder()
                    .phoneNumber(phoneNumber)
                    .build();

            CheckIfPhoneNumberIsOptedOutResponse result = snsClient.checkIfPhoneNumberIsOptedOut(request);
            System.out.println(
                    result.isOptedOut() + "Phone Number " + phoneNumber + " has Opted Out of receiving sns messages." +
                            "\n\nStatus was " + result.sdkHttpResponse().statusCode());

        } catch (SnsException e) {
            System.err.println(e.awsErrorDetails().errorMessage());
            System.exit(1);
        }
    }
}

如需API詳細資訊，請參閱參考 CheckIfPhoneNumberIsOptedOut中的。 AWS SDK for Java 2.x API

JavaScript

SDK 適用於 JavaScript （v3）

注意

還有更多。 GitHub尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。

在單獨的模組中建立用戶端並將其匯出。


import { SNSClient } from "@aws-sdk/client-sns";

// The AWS Region can be provided here using the `region` property. If you leave it blank
// the SDK will default to the region set in your AWS config.
export const snsClient = new SNSClient({});

匯入 SDK和用戶端模組，並呼叫 API。


import { CheckIfPhoneNumberIsOptedOutCommand } from "@aws-sdk/client-sns";

import { snsClient } from "../libs/snsClient.js";

export const checkIfPhoneNumberIsOptedOut = async (
  phoneNumber = "5555555555",
) => {
  const command = new CheckIfPhoneNumberIsOptedOutCommand({
    phoneNumber,
  });

  const response = await snsClient.send(command);
  console.log(response);
  // {
  //   '$metadata': {
  //     httpStatusCode: 200,
  //     requestId: '3341c28a-cdc8-5b39-a3ee-9fb0ee125732',
  //     extendedRequestId: undefined,
  //     cfId: undefined,
  //     attempts: 1,
  //     totalRetryDelay: 0
  //   },
  //   isOptedOut: false
  // }
  return response;
};

如需詳細資訊，請參閱《AWS SDK for JavaScript 開發人員指南》。
如需API詳細資訊，請參閱參考 CheckIfPhoneNumberIsOptedOut中的。 AWS SDK for JavaScript API

PHP

適用於 PHP 的 SDK

注意

還有更多。 GitHub尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。


require 'vendor/autoload.php';

use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;


/**
 * Indicates whether the phone number owner has opted out of receiving SMS messages from your AWS SNS account.
 *
 * This code expects that you have AWS credentials set up per:
 * https://docs.aws.amazon.com/sdk-for-php/v3/developer-guide/guide_credentials.html
 */

$SnSclient = new SnsClient([
    'profile' => 'default',
    'region' => 'us-east-1',
    'version' => '2010-03-31'
]);

$phone = '+1XXX5550100';

try {
    $result = $SnSclient->checkIfPhoneNumberIsOptedOut([
        'phoneNumber' => $phone,
    ]);
    var_dump($result);
} catch (AwsException $e) {
    // output error message if fails
    error_log($e->getMessage());
}

如需詳細資訊，請參閱《AWS SDK for PHP 開發人員指南》。
如需API詳細資訊，請參閱參考 CheckIfPhoneNumberIsOptedOut中的。 AWS SDK for PHP API

選擇加入已選擇退出的電話號碼

若要選擇加入電話號碼，請透過 Amazon SNS 提交OptInPhoneNumber請求API。

您只能選擇每 30 天接收一次電話號碼。

刪除SMS訂閱

若要從 Amazon SNS主題刪除SMS訂閱，ARN請透過向 Amazon SNS 提交ListSubscriptions請求來取得訂閱API，然後將傳遞ARN給Unsubscribe請求。

下列程式碼範例示範如何使用 Unsubscribe。

.NET

AWS SDK for .NET

注意

還有更多。 GitHub尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。

訂閱取消訂閱主題ARN。


    /// <summary>
    /// Unsubscribe from a topic by a subscription ARN.
    /// </summary>
    /// <param name="subscriptionArn">The ARN of the subscription.</param>
    /// <returns>True if successful.</returns>
    public async Task<bool> UnsubscribeByArn(string subscriptionArn)
    {
        var unsubscribeResponse = await _amazonSNSClient.UnsubscribeAsync(
            new UnsubscribeRequest()
            {
                SubscriptionArn = subscriptionArn
            });
        return unsubscribeResponse.HttpStatusCode == HttpStatusCode.OK;
    }

如需API詳細資訊，請參閱AWS SDK for .NET API參考 中的取消訂閱。

C++

SDK 適用於 C++

注意

還有更多。 GitHub尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。


//! Delete a subscription to an Amazon Simple Notification Service (Amazon SNS) topic.
/*!
  \param subscriptionARN: The Amazon Resource Name (ARN) for an Amazon SNS topic subscription.
  \param clientConfiguration: AWS client configuration.
  \return bool: Function succeeded.
 */
bool AwsDoc::SNS::unsubscribe(const Aws::String &subscriptionARN,
                              const Aws::Client::ClientConfiguration &clientConfiguration) {
    Aws::SNS::SNSClient snsClient(clientConfiguration);

    Aws::SNS::Model::UnsubscribeRequest request;
    request.SetSubscriptionArn(subscriptionARN);

    const Aws::SNS::Model::UnsubscribeOutcome outcome = snsClient.Unsubscribe(request);

    if (outcome.IsSuccess()) {
        std::cout << "Unsubscribed successfully " << std::endl;
    }
    else {
        std::cerr << "Error while unsubscribing " << outcome.GetError().GetMessage()
                  << std::endl;
    }

    return outcome.IsSuccess();
}

如需API詳細資訊，請參閱AWS SDK for C++ API參考 中的取消訂閱。

CLI

AWS CLI

取消訂閱主題

下列 unsubscribe 範例會從主題中刪除指定的訂閱。


aws sns unsubscribe \
    --subscription-arn arn:aws:sns:us-west-2:0123456789012:my-topic:8a21d249-4329-4871-acc6-7be709c6ea7f

此命令不會產生輸出。

如需API詳細資訊，請參閱 AWS CLI 命令參考 中的取消訂閱。

Java

SDK 適用於 Java 2.x

注意

還有更多。 GitHub尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。


import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.sns.SnsClient;
import software.amazon.awssdk.services.sns.model.SnsException;
import software.amazon.awssdk.services.sns.model.UnsubscribeRequest;
import software.amazon.awssdk.services.sns.model.UnsubscribeResponse;

/**
 * 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 Unsubscribe {
    public static void main(String[] args) {
        final String usage = """

                Usage:    <subscriptionArn>

                Where:
                   subscriptionArn - The ARN of the subscription to delete.
                """;

        if (args.length < 1) {
            System.out.println(usage);
            System.exit(1);
        }

        String subscriptionArn = args[0];
        SnsClient snsClient = SnsClient.builder()
                .region(Region.US_EAST_1)
                .build();

        unSub(snsClient, subscriptionArn);
        snsClient.close();
    }

    public static void unSub(SnsClient snsClient, String subscriptionArn) {
        try {
            UnsubscribeRequest request = UnsubscribeRequest.builder()
                    .subscriptionArn(subscriptionArn)
                    .build();

            UnsubscribeResponse result = snsClient.unsubscribe(request);
            System.out.println("\n\nStatus was " + result.sdkHttpResponse().statusCode()
                    + "\n\nSubscription was removed for " + request.subscriptionArn());

        } catch (SnsException e) {
            System.err.println(e.awsErrorDetails().errorMessage());
            System.exit(1);
        }
    }
}

如需API詳細資訊，請參閱AWS SDK for Java 2.x API參考 中的取消訂閱。

JavaScript

SDK 適用於 JavaScript （v3）

注意

還有更多。 GitHub尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。

在單獨的模組中建立用戶端並將其匯出。


import { SNSClient } from "@aws-sdk/client-sns";

// The AWS Region can be provided here using the `region` property. If you leave it blank
// the SDK will default to the region set in your AWS config.
export const snsClient = new SNSClient({});

匯入 SDK和用戶端模組，並呼叫 API。


import { UnsubscribeCommand } from "@aws-sdk/client-sns";
import { snsClient } from "../libs/snsClient.js";

/**
 * @param {string} subscriptionArn - The ARN of the subscription to cancel.
 */
const unsubscribe = async (
  subscriptionArn = "arn:aws:sns:us-east-1:xxxxxxxxxxxx:mytopic:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
) => {
  const response = await snsClient.send(
    new UnsubscribeCommand({
      SubscriptionArn: subscriptionArn,
    }),
  );
  console.log(response);
  // {
  //   '$metadata': {
  //     httpStatusCode: 200,
  //     requestId: '0178259a-9204-507c-b620-78a7570a44c6',
  //     extendedRequestId: undefined,
  //     cfId: undefined,
  //     attempts: 1,
  //     totalRetryDelay: 0
  //   }
  // }
  return response;
};

如需詳細資訊，請參閱《AWS SDK for JavaScript 開發人員指南》。
如需API詳細資訊，請參閱AWS SDK for JavaScript API參考 中的取消訂閱。

Kotlin

SDK 適用於 Kotlin

注意

還有更多。 GitHub尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。


suspend fun unSub(subscriptionArnVal: String) {
    val request =
        UnsubscribeRequest {
            subscriptionArn = subscriptionArnVal
        }

    SnsClient { region = "us-east-1" }.use { snsClient ->
        snsClient.unsubscribe(request)
        println("Subscription was removed for ${request.subscriptionArn}")
    }
}

如需API詳細資訊，請參閱中的取消訂閱 AWS SDK for Kotlin API參考 。

PHP

適用於 PHP 的 SDK

注意

還有更多。 GitHub尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。


require 'vendor/autoload.php';

use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;


/**
 * Deletes a subscription to an Amazon SNS topic.
 *
 * This code expects that you have AWS credentials set up per:
 * https://docs.aws.amazon.com/sdk-for-php/v3/developer-guide/guide_credentials.html
 */

$SnSclient = new SnsClient([
    'profile' => 'default',
    'region' => 'us-east-1',
    'version' => '2010-03-31'
]);

$subscription = 'arn:aws:sns:us-east-1:111122223333:MySubscription';

try {
    $result = $SnSclient->unsubscribe([
        'SubscriptionArn' => $subscription,
    ]);
    var_dump($result);
} catch (AwsException $e) {
    // output error message if fails
    error_log($e->getMessage());
}

如需詳細資訊，請參閱《AWS SDK for PHP 開發人員指南》。
如需API詳細資訊，請參閱AWS SDK for PHP API參考 中的取消訂閱。

Python

SDK for Python （Boto3）

注意

還有更多。 GitHub尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。


class SnsWrapper:
    """Encapsulates Amazon SNS topic and subscription functions."""

    def __init__(self, sns_resource):
        """
        :param sns_resource: A Boto3 Amazon SNS resource.
        """
        self.sns_resource = sns_resource


    @staticmethod
    def delete_subscription(subscription):
        """
        Unsubscribes and deletes a subscription.
        """
        try:
            subscription.delete()
            logger.info("Deleted subscription %s.", subscription.arn)
        except ClientError:
            logger.exception("Couldn't delete subscription %s.", subscription.arn)
            raise

如需API詳細資訊，請參閱中的取消訂閱 AWS SDK for Python （Boto3） API參考 。

SAP ABAP

SDK 適用於 SAP ABAP

注意

還有更多。 GitHub尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。


    TRY.
        lo_sns->unsubscribe( iv_subscriptionarn = iv_subscription_arn ).
        MESSAGE 'Subscription deleted.' TYPE 'I'.
      CATCH /aws1/cx_snsnotfoundexception.
        MESSAGE 'Subscription does not exist.' TYPE 'E'.
      CATCH /aws1/cx_snsinvalidparameterex.
        MESSAGE 'Subscription with "PendingConfirmation" status cannot be deleted/unsubscribed. Confirm subscription before performing unsubscribe operation.' TYPE 'E'.
    ENDTRY.

如需API詳細資訊，請參閱中的取消訂閱AWS SDK以取得SAPABAPAPI參考 。

刪除主題

若要刪除主題及其所有訂閱，ARN請透過向 Amazon 提交ListTopics請求來取得主題SNSAPI，然後將傳遞ARN給DeleteTopic請求。

下列程式碼範例示範如何使用 DeleteTopic。

.NET

AWS SDK for .NET

注意

還有更多。 GitHub尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。

依主題刪除主題ARN。


    /// <summary>
    /// Delete a topic by its topic ARN.
    /// </summary>
    /// <param name="topicArn">The ARN of the topic.</param>
    /// <returns>True if successful.</returns>
    public async Task<bool> DeleteTopicByArn(string topicArn)
    {
        var deleteResponse = await _amazonSNSClient.DeleteTopicAsync(
            new DeleteTopicRequest()
            {
                TopicArn = topicArn
            });
        return deleteResponse.HttpStatusCode == HttpStatusCode.OK;
    }

如需API詳細資訊，請參閱參考 DeleteTopic中的。 AWS SDK for .NET API

C++

SDK 適用於 C++

注意

還有更多。 GitHub尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。


//! Delete an Amazon Simple Notification Service (Amazon SNS) topic.
/*!
  \param topicARN: The Amazon Resource Name (ARN) for an Amazon SNS topic.
  \param clientConfiguration: AWS client configuration.
  \return bool: Function succeeded.
 */
bool AwsDoc::SNS::deleteTopic(const Aws::String &topicARN,
                              const Aws::Client::ClientConfiguration &clientConfiguration) {
    Aws::SNS::SNSClient snsClient(clientConfiguration);

    Aws::SNS::Model::DeleteTopicRequest request;
    request.SetTopicArn(topicARN);

    const Aws::SNS::Model::DeleteTopicOutcome outcome = snsClient.DeleteTopic(request);

    if (outcome.IsSuccess()) {
        std::cout << "Successfully deleted the Amazon SNS topic " << topicARN << std::endl;
    }
    else {
        std::cerr << "Error deleting topic " << topicARN << ":" <<
                  outcome.GetError().GetMessage() << std::endl;
    }

    return outcome.IsSuccess();
}

如需API詳細資訊，請參閱參考 DeleteTopic中的。 AWS SDK for C++ API

CLI

AWS CLI

若要刪除SNS主題

下列delete-topic範例會刪除指定的SNS主題。


aws sns delete-topic \
    --topic-arn "arn:aws:sns:us-west-2:123456789012:my-topic"

此命令不會產生輸出。

如需API詳細資訊，請參閱命令參考 DeleteTopic中的。 AWS CLI

Go

SDK for Go V2

注意

還有更多。 GitHub尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。



// SnsActions encapsulates the Amazon Simple Notification Service (Amazon SNS) actions
// used in the examples.
type SnsActions struct {
	SnsClient *sns.Client
}



// DeleteTopic delete an Amazon SNS topic.
func (actor SnsActions) DeleteTopic(topicArn string) error {
	_, err := actor.SnsClient.DeleteTopic(context.TODO(), &sns.DeleteTopicInput{
		TopicArn: aws.String(topicArn)})
	if err != nil {
		log.Printf("Couldn't delete topic %v. Here's why: %v\n", topicArn, err)
	}
	return err
}

如需API詳細資訊，請參閱參考 DeleteTopic中的。 AWS SDK for Go API

Java

SDK 適用於 Java 2.x

注意

還有更多。 GitHub尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。


import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.sns.SnsClient;
import software.amazon.awssdk.services.sns.model.DeleteTopicRequest;
import software.amazon.awssdk.services.sns.model.DeleteTopicResponse;
import software.amazon.awssdk.services.sns.model.SnsException;

/**
 * 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 DeleteTopic {
    public static void main(String[] args) {
        final String usage = """

                Usage:     <topicArn>

                Where:
                   topicArn - The ARN of the topic to delete.
                """;

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

        String topicArn = args[0];
        SnsClient snsClient = SnsClient.builder()
                .region(Region.US_EAST_1)
                .build();

        System.out.println("Deleting a topic with name: " + topicArn);
        deleteSNSTopic(snsClient, topicArn);
        snsClient.close();
    }

    public static void deleteSNSTopic(SnsClient snsClient, String topicArn) {
        try {
            DeleteTopicRequest request = DeleteTopicRequest.builder()
                    .topicArn(topicArn)
                    .build();

            DeleteTopicResponse result = snsClient.deleteTopic(request);
            System.out.println("\n\nStatus was " + result.sdkHttpResponse().statusCode());

        } catch (SnsException e) {
            System.err.println(e.awsErrorDetails().errorMessage());
            System.exit(1);
        }
    }
}

如需API詳細資訊，請參閱參考 DeleteTopic中的。 AWS SDK for Java 2.x API

JavaScript

SDK 適用於 JavaScript （v3）

注意

還有更多。 GitHub尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。

在單獨的模組中建立用戶端並將其匯出。


import { SNSClient } from "@aws-sdk/client-sns";

// The AWS Region can be provided here using the `region` property. If you leave it blank
// the SDK will default to the region set in your AWS config.
export const snsClient = new SNSClient({});

匯入 SDK和用戶端模組，並呼叫 API。


import { DeleteTopicCommand } from "@aws-sdk/client-sns";
import { snsClient } from "../libs/snsClient.js";

/**
 * @param {string} topicArn - The ARN of the topic to delete.
 */
export const deleteTopic = async (topicArn = "TOPIC_ARN") => {
  const response = await snsClient.send(
    new DeleteTopicCommand({ TopicArn: topicArn }),
  );
  console.log(response);
  // {
  //   '$metadata': {
  //     httpStatusCode: 200,
  //     requestId: 'a10e2886-5a8f-5114-af36-75bd39498332',
  //     extendedRequestId: undefined,
  //     cfId: undefined,
  //     attempts: 1,
  //     totalRetryDelay: 0
  //   }
  // }
};

如需詳細資訊，請參閱《AWS SDK for JavaScript 開發人員指南》。
如需API詳細資訊，請參閱參考 DeleteTopic中的。 AWS SDK for JavaScript API

Kotlin

SDK 適用於 Kotlin

注意

還有更多。 GitHub尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。


suspend fun deleteSNSTopic(topicArnVal: String) {
    val request =
        DeleteTopicRequest {
            topicArn = topicArnVal
        }

    SnsClient { region = "us-east-1" }.use { snsClient ->
        snsClient.deleteTopic(request)
        println("$topicArnVal was successfully deleted.")
    }
}

如需API詳細資訊，請參閱DeleteTopic中的 AWS SDK for Kotlin API參考 。

PHP

適用於 PHP 的 SDK

注意

還有更多。 GitHub尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。


require 'vendor/autoload.php';

use Aws\Exception\AwsException;
use Aws\Sns\SnsClient;


/**
 * Deletes an SNS topic and all its subscriptions.
 *
 * This code expects that you have AWS credentials set up per:
 * https://docs.aws.amazon.com/sdk-for-php/v3/developer-guide/guide_credentials.html
 */

$SnSclient = new SnsClient([
    'profile' => 'default',
    'region' => 'us-east-1',
    'version' => '2010-03-31'
]);

$topic = 'arn:aws:sns:us-east-1:111122223333:MyTopic';

try {
    $result = $SnSclient->deleteTopic([
        'TopicArn' => $topic,
    ]);
    var_dump($result);
} catch (AwsException $e) {
    // output error message if fails
    error_log($e->getMessage());
}

如需API詳細資訊，請參閱參考 DeleteTopic中的。 AWS SDK for PHP API

Python

SDK for Python （Boto3）

注意

還有更多。 GitHub尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。


class SnsWrapper:
    """Encapsulates Amazon SNS topic and subscription functions."""

    def __init__(self, sns_resource):
        """
        :param sns_resource: A Boto3 Amazon SNS resource.
        """
        self.sns_resource = sns_resource


    @staticmethod
    def delete_topic(topic):
        """
        Deletes a topic. All subscriptions to the topic are also deleted.
        """
        try:
            topic.delete()
            logger.info("Deleted topic %s.", topic.arn)
        except ClientError:
            logger.exception("Couldn't delete topic %s.", topic.arn)
            raise

如需API詳細資訊，請參閱 DeleteTopic 中的 AWS SDK for Python （Boto3） API參考 。

SAP ABAP

SDK 適用於 SAP ABAP

注意

還有更多。 GitHub尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。


    TRY.
        lo_sns->deletetopic( iv_topicarn = iv_topic_arn ).
        MESSAGE 'SNS topic deleted.' TYPE 'I'.
      CATCH /aws1/cx_snsnotfoundexception.
        MESSAGE 'Topic does not exist.' TYPE 'E'.
    ENDTRY.

如需API詳細資訊，請參閱DeleteTopic中的 AWS SDK 以取得SAPABAPAPI參考 。

您的瀏覽器已停用或無法使用 Javascript。

您必須啟用 Javascript，才能使用 AWS 文件。請參閱您的瀏覽器說明頁以取得說明。

文件慣用形式

設定SMS偏好設定

監控SMS活動

在 Amazon 中管理電話號碼和SMS訂閱 SNS

主題

選擇不接收SMS訊息

管理電話號碼和簡訊訂閱 (主控台)

選擇加入已選擇退出的電話號碼

刪除SMS訂閱

刪除主題

管理電話號碼和訂閱 （AWS SDKs）

檢視所有選擇退出的電話號碼

注意

注意

檢查電話號碼是否選擇退出

注意

注意

注意

注意

選擇加入已選擇退出的電話號碼

刪除SMS訂閱

注意

注意

注意

注意

注意

注意

注意

注意

刪除主題

注意

注意

注意

注意

注意

注意

注意

注意

注意

管理電話號碼和訂閱（AWS SDKs）