Class SnsAPI

constructor

• new SnsAPI(client: Client): SnsAPI

• Parameters

  • client: Client

  Returns SnsAPI

Static ReadonlyLOCALITIES

activateSns

• activateSns(request?: Readonly<SnsApiActivateSnsRequest>): Promise<SnsInfo>

• Activate Topics and Events. Activate Topics and Events for the specified Project ID. Topics and Events must be activated before any usage. Activating Topics and Events does not trigger any billing, and you can deactivate at any time.

  Parameters

  • request: Readonly<SnsApiActivateSnsRequest> = {}

    The request SnsApiActivateSnsRequest

  Returns Promise<SnsInfo>

  A Promise of SnsInfo

createSnsCredentials

• createSnsCredentials(
      request?: Readonly<MNQ.v1beta1.SnsApiCreateSnsCredentialsRequest>,
  ): Promise<MNQ.v1beta1.SnsCredentials>

• Create Topics and Events credentials. Create a set of credentials for Topics and Events, specified by a Project ID. Credentials give the bearer access to topics, and the level of permissions can be defined granularly.

  Parameters

  • request: Readonly<MNQ.v1beta1.SnsApiCreateSnsCredentialsRequest> = {}

    The request SnsApiCreateSnsCredentialsRequest

  Returns Promise<MNQ.v1beta1.SnsCredentials>

  A Promise of SnsCredentials

deactivateSns

• deactivateSns(request?: Readonly<SnsApiDeactivateSnsRequest>): Promise<SnsInfo>

• Deactivate Topics and Events. Deactivate Topics and Events for the specified Project ID. You must delete all topics and credentials before this call or you need to set the force_delete parameter.

  Parameters

  • request: Readonly<SnsApiDeactivateSnsRequest> = {}

    The request SnsApiDeactivateSnsRequest

  Returns Promise<SnsInfo>

  A Promise of SnsInfo

deleteSnsCredentials

• deleteSnsCredentials(
      request: Readonly<SnsApiDeleteSnsCredentialsRequest>,
  ): Promise<void>

• Delete Topics and Events credentials. Delete a set of Topics and Events credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can then no longer be used to access Topics and Events.

  Parameters

  • request: Readonly<SnsApiDeleteSnsCredentialsRequest>

    The request SnsApiDeleteSnsCredentialsRequest

  Returns Promise<void>

getSnsCredentials

• getSnsCredentials(
      request: Readonly<SnsApiGetSnsCredentialsRequest>,
  ): Promise<MNQ.v1beta1.SnsCredentials>

• Get Topics and Events credentials. Retrieve an existing set of credentials, identified by the credentials_id. The credentials themselves, as well as their metadata (name, project ID etc), are returned in the response.

  Parameters

  • request: Readonly<SnsApiGetSnsCredentialsRequest>

    The request SnsApiGetSnsCredentialsRequest

  Returns Promise<MNQ.v1beta1.SnsCredentials>

  A Promise of SnsCredentials

getSnsInfo

• getSnsInfo(request?: Readonly<SnsApiGetSnsInfoRequest>): Promise<SnsInfo>

• Get Topics and Events info. Retrieve the Topics and Events information of the specified Project ID. Informations include the activation status and the Topics and Events API endpoint URL.

  Parameters

  • request: Readonly<SnsApiGetSnsInfoRequest> = {}

    The request SnsApiGetSnsInfoRequest

  Returns Promise<SnsInfo>

  A Promise of SnsInfo

listSnsCredentials

• listSnsCredentials(
      request?: Readonly<SnsApiListSnsCredentialsRequest>,
  ): Promise<ListSnsCredentialsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          MNQ.v1beta1.SnsCredentials[],
          void,
          void,
      >;
      all: () => Promise<MNQ.v1beta1.SnsCredentials[]>;
  }

• List Topics and Events credentials. List existing Topics and Events credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves.

  Parameters

  • request: Readonly<SnsApiListSnsCredentialsRequest> = {}

    The request SnsApiListSnsCredentialsRequest

  Returns Promise<ListSnsCredentialsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          MNQ.v1beta1.SnsCredentials[],
          void,
          void,
      >;
      all: () => Promise<MNQ.v1beta1.SnsCredentials[]>;
  }

  A Promise of ListSnsCredentialsResponse

updateSnsCredentials

• updateSnsCredentials(
      request: Readonly<MNQ.v1beta1.SnsApiUpdateSnsCredentialsRequest>,
  ): Promise<MNQ.v1beta1.SnsCredentials>

• Update Topics and Events credentials. Update a set of Topics and Events credentials. You can update the credentials' name, or their permissions.

  Parameters

  • request: Readonly<MNQ.v1beta1.SnsApiUpdateSnsCredentialsRequest>

    The request SnsApiUpdateSnsCredentialsRequest

  Returns Promise<MNQ.v1beta1.SnsCredentials>

  A Promise of SnsCredentials