Le guide de API référence AWS SDK for JavaScript V3 décrit en détail toutes les API opérations de la AWS SDK for JavaScript version 3 (V3).

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Gestion des rubriques dans Amazon SNS

Cet exemple de code Node.js présente :

Scénario

Dans cet exemple, vous utilisez une série de modules Node.js pour créer, répertorier et supprimer des rubriques Amazon SNS, ainsi que pour gérer les attributs des rubriques. Les modules Node.js utilisent le SDK pour gérer les sujets JavaScript à l'aide des méthodes suivantes de la classe SNS client :

Tâches prérequises

Pour configurer et exécuter cet exemple, vous devez d'abord :

Création d'une rubrique

Dans cet exemple, utilisez un module Node.js pour créer une rubrique Amazon SNS.

Créez un libs répertoire et créez un module Node.js avec le nom du fichiersnsClient.js. Copiez-collez le code ci-dessous pour créer l'objet client Amazon SNS. Remplacez REGION par votre AWS région.

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({});

Cet exemple de code se trouve ici GitHub.

Créez un module Node.js nommé create-topic.js. Configurez le SDK comme indiqué précédemment, notamment en installant les clients et les packages requis.

Créez un objet pour transmettre le paramètreName de la nouvelle rubrique à la méthode CreateTopicCommand de la classe client SNS. Pour appeler la CreateTopicCommand méthode, créez une fonction asynchrone invoquant un objet de service Amazon SNS, en transmettant l'objet de paramètres. Le data résultat contient l'ARN du sujet.

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

/**
 * @param {string} topicName - The name of the topic to create.
 */
export const createTopic = async (topicName = "TOPIC_NAME") => {
  const response = await snsClient.send(
    new CreateTopicCommand({ Name: topicName }),
  );
  console.log(response);
  // {
  //   '$metadata': {
  //     httpStatusCode: 200,
  //     requestId: '087b8ad2-4593-50c4-a496-d7e90b82cf3e',
  //     extendedRequestId: undefined,
  //     cfId: undefined,
  //     attempts: 1,
  //     totalRetryDelay: 0
  //   },
  //   TopicArn: 'arn:aws:sns:us-east-1:xxxxxxxxxxxx:TOPIC_NAME'
  // }
  return response;
};

Pour exécuter l'exemple, entrez ce qui suit à l'invite de commande.

node create-topic.js

Cet exemple de code se trouve ici GitHub.

Liste de vos rubriques

Dans cet exemple, utilisez un module Node.js pour répertorier toutes les rubriques Amazon SNS.

Créez un libs répertoire et créez un module Node.js avec le nom du fichiersnsClient.js. Copiez-collez le code ci-dessous pour créer l'objet client Amazon SNS. Remplacez REGION par votre AWS région.

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({});

Cet exemple de code se trouve ici GitHub.

Créez un module Node.js nommé list-topics.js. Configurez le SDK comme indiqué précédemment, notamment en installant les clients et les packages requis.

Créez un objet vide à transmettre à la méthode ListTopicsCommand de la classe client SNS. Pour appeler la ListTopicsCommand méthode, créez une fonction asynchrone invoquant un objet de service Amazon SNS, en transmettant l'objet de paramètres. Le data fichier renvoyé contient un tableau de votre sujet Amazon Resource Names (ARN).

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

export const listTopics = async () => {
  const response = await snsClient.send(new ListTopicsCommand({}));
  console.log(response);
  // {
  //   '$metadata': {
  //     httpStatusCode: 200,
  //     requestId: '936bc5ad-83ca-53c2-b0b7-9891167b909e',
  //     extendedRequestId: undefined,
  //     cfId: undefined,
  //     attempts: 1,
  //     totalRetryDelay: 0
  //   },
  //   Topics: [ { TopicArn: 'arn:aws:sns:us-east-1:xxxxxxxxxxxx:mytopic' } ]
  // }
  return response;
};

Pour exécuter l'exemple, entrez ce qui suit à l'invite de commande.

node list-topics.js

Cet exemple de code se trouve ici sur GitHub.

Suppression d'une rubrique

Dans cet exemple, utilisez un module Node.js pour supprimer une rubrique Amazon SNS.

Créez un libs répertoire et créez un module Node.js avec le nom du fichiersnsClient.js. Copiez-collez le code ci-dessous pour créer l'objet client Amazon SNS. Remplacez REGION par votre AWS région.

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({});

Cet exemple de code se trouve ici GitHub.

Créez un module Node.js nommé delete-topic.js. Configurez le SDK comme indiqué précédemment, notamment en installant les clients et les packages requis.

Créez un objet contenant le paramètre TopicArn de la rubrique à supprimer pour le transmettre à la méthode DeleteTopicCommand de la classe client SNS. Pour appeler la DeleteTopicCommand méthode, créez une fonction asynchrone invoquant un objet de service client Amazon SNS, en transmettant l'objet de paramètres.

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
  //   }
  // }
};

Pour exécuter l'exemple, entrez ce qui suit à l'invite de commande.

node delete-topic.js

Cet exemple de code se trouve ici GitHub.

Récupération d'attributs de rubrique

Dans cet exemple, utilisez un module Node.js pour récupérer les attributs d'une rubrique Amazon SNS.

Créez un libs répertoire et créez un module Node.js avec le nom du fichiersnsClient.js. Copiez-collez le code ci-dessous pour créer l'objet client Amazon SNS. Remplacez REGION par votre AWS région.

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({});

Cet exemple de code se trouve ici GitHub.

Créez un module Node.js nommé get-topic-attributes.js. Configurez le kit SDK comme illustré précédemment.

Créez un objet contenant le paramètre TopicArn d'une rubrique à supprimer pour le transmettre à la méthode GetTopicAttributesCommand de la classe client SNS. Pour appeler la GetTopicAttributesCommand méthode, appelez un objet du service client Amazon SNS et transmettez l'objet de paramètres.

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

/**
 * @param {string} topicArn - The ARN of the topic to retrieve attributes for.
 */
export const getTopicAttributes = async (topicArn = "TOPIC_ARN") => {
  const response = await snsClient.send(
    new GetTopicAttributesCommand({
      TopicArn: topicArn,
    }),
  );
  console.log(response);
  // {
  //   '$metadata': {
  //     httpStatusCode: 200,
  //     requestId: '36b6a24e-5473-5d4e-ac32-ff72d9a73d94',
  //     extendedRequestId: undefined,
  //     cfId: undefined,
  //     attempts: 1,
  //     totalRetryDelay: 0
  //   },
  //   Attributes: {
  //     Policy: '{...}',
  //     Owner: 'xxxxxxxxxxxx',
  //     SubscriptionsPending: '1',
  //     TopicArn: 'arn:aws:sns:us-east-1:xxxxxxxxxxxx:mytopic',
  //     TracingConfig: 'PassThrough',
  //     EffectiveDeliveryPolicy: '{"http":{"defaultHealthyRetryPolicy":{"minDelayTarget":20,"maxDelayTarget":20,"numRetries":3,"numMaxDelayRetries":0,"numNoDelayRetries":0,"numMinDelayRetries":0,"backoffFunction":"linear"},"disableSubscriptionOverrides":false,"defaultRequestPolicy":{"headerContentType":"text/plain; charset=UTF-8"}}}',
  //     SubscriptionsConfirmed: '0',
  //     DisplayName: '',
  //     SubscriptionsDeleted: '1'
  //   }
  // }
  return response;
};

Pour exécuter l'exemple, entrez ce qui suit à l'invite de commande.

node get-topic-attributes.js

Cet exemple de code se trouve ici GitHub.

Définition d'attributs de rubrique

Dans cet exemple, utilisez un module Node.js pour définir les attributs modifiables d'une rubrique Amazon SNS.

Créez un libs répertoire et créez un module Node.js avec le nom du fichiersnsClient.js. Copiez-collez le code ci-dessous pour créer l'objet client Amazon SNS. Remplacez REGION par votre AWS région.

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({});

Cet exemple de code se trouve ici GitHub.

Créez un module Node.js nommé set-topic-attributes.js. Configurez le kit SDK comme illustré précédemment.

Créez un objet contenant les paramètres pour la mise à jour de l'attribut, y compris le paramètre TopicArn de la rubrique dont vous souhaitez définir les attributs, le nom de l'attribut à définir et la nouvelle valeur pour cet attribut. Vous ne pouvez définir que les attributs Policy, DisplayName et DeliveryPolicy. Transmettez les paramètres à la méthode SetTopicAttributesCommand de la classe client SNS. Pour appeler la SetTopicAttributesCommand méthode, créez une fonction asynchrone invoquant un objet de service client Amazon SNS, en transmettant l'objet de paramètres.

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

export const setTopicAttributes = async (
  topicArn = "TOPIC_ARN",
  attributeName = "DisplayName",
  attributeValue = "Test Topic",
) => {
  const response = await snsClient.send(
    new SetTopicAttributesCommand({
      AttributeName: attributeName,
      AttributeValue: attributeValue,
      TopicArn: topicArn,
    }),
  );
  console.log(response);
  // {
  //   '$metadata': {
  //     httpStatusCode: 200,
  //     requestId: 'd1b08d0e-e9a4-54c3-b8b1-d03238d2b935',
  //     extendedRequestId: undefined,
  //     cfId: undefined,
  //     attempts: 1,
  //     totalRetryDelay: 0
  //   }
  // }
  return response;
};

Pour exécuter l'exemple, entrez ce qui suit à l'invite de commande.

node set-topic-attributes.js

Cet exemple de code se trouve ici GitHub.