Skip to main content Link Search Menu Expand Document (external link)

SNSService overview

Added in v1.0.0


Table of contents


constructors

makeSNSService

Signature

export declare const makeSNSService: Effect.Effect<SNSService, never, SNSClientInstance>

Added in v1.0.0

layers

BaseSNSServiceLayer

Signature

export declare const BaseSNSServiceLayer: Layer.Layer<SNSService, never, SNSClientInstance>

Added in v1.0.0

DefaultSNSServiceLayer

Signature

export declare const DefaultSNSServiceLayer: Layer.Layer<SNSService, never, never>

Added in v1.0.0

SNSServiceLayer

Signature

export declare const SNSServiceLayer: Layer.Layer<SNSService, never, SNSClientInstanceConfig>

Added in v1.0.0

models

SNSService (interface)

Signature

export interface SNSService {
  readonly _: unique symbol

  /**
   * @see {@link AddPermissionCommand}
   */
  addPermission(
    args: AddPermissionCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    AddPermissionCommandOutput,
    SdkError | AuthorizationError | InternalError | InvalidParameterError | NotFoundError
  >

  /**
   * @see {@link CheckIfPhoneNumberIsOptedOutCommand}
   */
  checkIfPhoneNumberIsOptedOut(
    args: CheckIfPhoneNumberIsOptedOutCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    CheckIfPhoneNumberIsOptedOutCommandOutput,
    SdkError | AuthorizationError | InternalError | InvalidParameterError | ThrottledError
  >

  /**
   * @see {@link ConfirmSubscriptionCommand}
   */
  confirmSubscription(
    args: ConfirmSubscriptionCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    ConfirmSubscriptionCommandOutput,
    | SdkError
    | AuthorizationError
    | FilterPolicyLimitExceededError
    | InternalError
    | InvalidParameterError
    | NotFoundError
    | SubscriptionLimitExceededError
  >

  /**
   * @see {@link CreatePlatformApplicationCommand}
   */
  createPlatformApplication(
    args: CreatePlatformApplicationCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    CreatePlatformApplicationCommandOutput,
    SdkError | AuthorizationError | InternalError | InvalidParameterError
  >

  /**
   * @see {@link CreatePlatformEndpointCommand}
   */
  createPlatformEndpoint(
    args: CreatePlatformEndpointCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    CreatePlatformEndpointCommandOutput,
    SdkError | AuthorizationError | InternalError | InvalidParameterError | NotFoundError
  >

  /**
   * @see {@link CreateSMSSandboxPhoneNumberCommand}
   */
  createSMSSandboxPhoneNumber(
    args: CreateSMSSandboxPhoneNumberCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    CreateSMSSandboxPhoneNumberCommandOutput,
    SdkError | AuthorizationError | InternalError | InvalidParameterError | OptedOutError | ThrottledError | UserError
  >

  /**
   * @see {@link CreateTopicCommand}
   */
  createTopic(
    args: CreateTopicCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    CreateTopicCommandOutput,
    | SdkError
    | AuthorizationError
    | ConcurrentAccessError
    | InternalError
    | InvalidParameterError
    | InvalidSecurityError
    | StaleTagError
    | TagLimitExceededError
    | TagPolicyError
    | TopicLimitExceededError
  >

  /**
   * @see {@link DeleteEndpointCommand}
   */
  deleteEndpoint(
    args: DeleteEndpointCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<DeleteEndpointCommandOutput, SdkError | AuthorizationError | InternalError | InvalidParameterError>

  /**
   * @see {@link DeletePlatformApplicationCommand}
   */
  deletePlatformApplication(
    args: DeletePlatformApplicationCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    DeletePlatformApplicationCommandOutput,
    SdkError | AuthorizationError | InternalError | InvalidParameterError
  >

  /**
   * @see {@link DeleteSMSSandboxPhoneNumberCommand}
   */
  deleteSMSSandboxPhoneNumber(
    args: DeleteSMSSandboxPhoneNumberCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    DeleteSMSSandboxPhoneNumberCommandOutput,
    | SdkError
    | AuthorizationError
    | InternalError
    | InvalidParameterError
    | ResourceNotFoundError
    | ThrottledError
    | UserError
  >

  /**
   * @see {@link DeleteTopicCommand}
   */
  deleteTopic(
    args: DeleteTopicCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    DeleteTopicCommandOutput,
    | SdkError
    | AuthorizationError
    | ConcurrentAccessError
    | InternalError
    | InvalidParameterError
    | NotFoundError
    | StaleTagError
    | TagPolicyError
  >

  /**
   * @see {@link GetDataProtectionPolicyCommand}
   */
  getDataProtectionPolicy(
    args: GetDataProtectionPolicyCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    GetDataProtectionPolicyCommandOutput,
    SdkError | AuthorizationError | InternalError | InvalidParameterError | InvalidSecurityError | NotFoundError
  >

  /**
   * @see {@link GetEndpointAttributesCommand}
   */
  getEndpointAttributes(
    args: GetEndpointAttributesCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    GetEndpointAttributesCommandOutput,
    SdkError | AuthorizationError | InternalError | InvalidParameterError | NotFoundError
  >

  /**
   * @see {@link GetPlatformApplicationAttributesCommand}
   */
  getPlatformApplicationAttributes(
    args: GetPlatformApplicationAttributesCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    GetPlatformApplicationAttributesCommandOutput,
    SdkError | AuthorizationError | InternalError | InvalidParameterError | NotFoundError
  >

  /**
   * @see {@link GetSMSAttributesCommand}
   */
  getSMSAttributes(
    args: GetSMSAttributesCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    GetSMSAttributesCommandOutput,
    SdkError | AuthorizationError | InternalError | InvalidParameterError | ThrottledError
  >

  /**
   * @see {@link GetSMSSandboxAccountStatusCommand}
   */
  getSMSSandboxAccountStatus(
    args: GetSMSSandboxAccountStatusCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    GetSMSSandboxAccountStatusCommandOutput,
    SdkError | AuthorizationError | InternalError | ThrottledError
  >

  /**
   * @see {@link GetSubscriptionAttributesCommand}
   */
  getSubscriptionAttributes(
    args: GetSubscriptionAttributesCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    GetSubscriptionAttributesCommandOutput,
    SdkError | AuthorizationError | InternalError | InvalidParameterError | NotFoundError
  >

  /**
   * @see {@link GetTopicAttributesCommand}
   */
  getTopicAttributes(
    args: GetTopicAttributesCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    GetTopicAttributesCommandOutput,
    SdkError | AuthorizationError | InternalError | InvalidParameterError | InvalidSecurityError | NotFoundError
  >

  /**
   * @see {@link ListEndpointsByPlatformApplicationCommand}
   */
  listEndpointsByPlatformApplication(
    args: ListEndpointsByPlatformApplicationCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    ListEndpointsByPlatformApplicationCommandOutput,
    SdkError | AuthorizationError | InternalError | InvalidParameterError | NotFoundError
  >

  /**
   * @see {@link ListOriginationNumbersCommand}
   */
  listOriginationNumbers(
    args: ListOriginationNumbersCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    ListOriginationNumbersCommandOutput,
    SdkError | AuthorizationError | InternalError | InvalidParameterError | ThrottledError | ValidationError
  >

  /**
   * @see {@link ListPhoneNumbersOptedOutCommand}
   */
  listPhoneNumbersOptedOut(
    args: ListPhoneNumbersOptedOutCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    ListPhoneNumbersOptedOutCommandOutput,
    SdkError | AuthorizationError | InternalError | InvalidParameterError | ThrottledError
  >

  /**
   * @see {@link ListPlatformApplicationsCommand}
   */
  listPlatformApplications(
    args: ListPlatformApplicationsCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    ListPlatformApplicationsCommandOutput,
    SdkError | AuthorizationError | InternalError | InvalidParameterError
  >

  /**
   * @see {@link ListSMSSandboxPhoneNumbersCommand}
   */
  listSMSSandboxPhoneNumbers(
    args: ListSMSSandboxPhoneNumbersCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    ListSMSSandboxPhoneNumbersCommandOutput,
    SdkError | AuthorizationError | InternalError | InvalidParameterError | ResourceNotFoundError | ThrottledError
  >

  /**
   * @see {@link ListSubscriptionsCommand}
   */
  listSubscriptions(
    args: ListSubscriptionsCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    ListSubscriptionsCommandOutput,
    SdkError | AuthorizationError | InternalError | InvalidParameterError
  >

  /**
   * @see {@link ListSubscriptionsByTopicCommand}
   */
  listSubscriptionsByTopic(
    args: ListSubscriptionsByTopicCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    ListSubscriptionsByTopicCommandOutput,
    SdkError | AuthorizationError | InternalError | InvalidParameterError | NotFoundError
  >

  /**
   * @see {@link ListTagsForResourceCommand}
   */
  listTagsForResource(
    args: ListTagsForResourceCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    ListTagsForResourceCommandOutput,
    | SdkError
    | AuthorizationError
    | ConcurrentAccessError
    | InvalidParameterError
    | ResourceNotFoundError
    | TagPolicyError
  >

  /**
   * @see {@link ListTopicsCommand}
   */
  listTopics(
    args: ListTopicsCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<ListTopicsCommandOutput, SdkError | AuthorizationError | InternalError | InvalidParameterError>

  /**
   * @see {@link OptInPhoneNumberCommand}
   */
  optInPhoneNumber(
    args: OptInPhoneNumberCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    OptInPhoneNumberCommandOutput,
    SdkError | AuthorizationError | InternalError | InvalidParameterError | ThrottledError
  >

  /**
   * @see {@link PublishCommand}
   */
  publish(
    args: PublishCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    PublishCommandOutput,
    | SdkError
    | AuthorizationError
    | EndpointDisabledError
    | InternalError
    | InvalidParameterError
    | InvalidSecurityError
    | KMSAccessDeniedError
    | KMSDisabledError
    | KMSInvalidStateError
    | KMSNotFoundError
    | KMSOptInRequiredError
    | KMSThrottlingError
    | NotFoundError
    | InvalidParameterValueError
    | PlatformApplicationDisabledError
    | ValidationError
  >

  /**
   * @see {@link PublishBatchCommand}
   */
  publishBatch(
    args: PublishBatchCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    PublishBatchCommandOutput,
    | SdkError
    | AuthorizationError
    | BatchEntryIdsNotDistinctError
    | BatchRequestTooLongError
    | EmptyBatchRequestError
    | EndpointDisabledError
    | InternalError
    | InvalidBatchEntryIdError
    | InvalidParameterError
    | InvalidSecurityError
    | KMSAccessDeniedError
    | KMSDisabledError
    | KMSInvalidStateError
    | KMSNotFoundError
    | KMSOptInRequiredError
    | KMSThrottlingError
    | NotFoundError
    | InvalidParameterValueError
    | PlatformApplicationDisabledError
    | TooManyEntriesInBatchRequestError
    | ValidationError
  >

  /**
   * @see {@link PutDataProtectionPolicyCommand}
   */
  putDataProtectionPolicy(
    args: PutDataProtectionPolicyCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    PutDataProtectionPolicyCommandOutput,
    SdkError | AuthorizationError | InternalError | InvalidParameterError | InvalidSecurityError | NotFoundError
  >

  /**
   * @see {@link RemovePermissionCommand}
   */
  removePermission(
    args: RemovePermissionCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    RemovePermissionCommandOutput,
    SdkError | AuthorizationError | InternalError | InvalidParameterError | NotFoundError
  >

  /**
   * @see {@link SetEndpointAttributesCommand}
   */
  setEndpointAttributes(
    args: SetEndpointAttributesCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    SetEndpointAttributesCommandOutput,
    SdkError | AuthorizationError | InternalError | InvalidParameterError | NotFoundError
  >

  /**
   * @see {@link SetPlatformApplicationAttributesCommand}
   */
  setPlatformApplicationAttributes(
    args: SetPlatformApplicationAttributesCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    SetPlatformApplicationAttributesCommandOutput,
    SdkError | AuthorizationError | InternalError | InvalidParameterError | NotFoundError
  >

  /**
   * @see {@link SetSMSAttributesCommand}
   */
  setSMSAttributes(
    args: SetSMSAttributesCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    SetSMSAttributesCommandOutput,
    SdkError | AuthorizationError | InternalError | InvalidParameterError | ThrottledError
  >

  /**
   * @see {@link SetSubscriptionAttributesCommand}
   */
  setSubscriptionAttributes(
    args: SetSubscriptionAttributesCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    SetSubscriptionAttributesCommandOutput,
    | SdkError
    | AuthorizationError
    | FilterPolicyLimitExceededError
    | InternalError
    | InvalidParameterError
    | NotFoundError
  >

  /**
   * @see {@link SetTopicAttributesCommand}
   */
  setTopicAttributes(
    args: SetTopicAttributesCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    SetTopicAttributesCommandOutput,
    SdkError | AuthorizationError | InternalError | InvalidParameterError | InvalidSecurityError | NotFoundError
  >

  /**
   * @see {@link SubscribeCommand}
   */
  subscribe(
    args: SubscribeCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    SubscribeCommandOutput,
    | SdkError
    | AuthorizationError
    | FilterPolicyLimitExceededError
    | InternalError
    | InvalidParameterError
    | InvalidSecurityError
    | NotFoundError
    | SubscriptionLimitExceededError
  >

  /**
   * @see {@link TagResourceCommand}
   */
  tagResource(
    args: TagResourceCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    TagResourceCommandOutput,
    | SdkError
    | AuthorizationError
    | ConcurrentAccessError
    | InvalidParameterError
    | ResourceNotFoundError
    | StaleTagError
    | TagLimitExceededError
    | TagPolicyError
  >

  /**
   * @see {@link UnsubscribeCommand}
   */
  unsubscribe(
    args: UnsubscribeCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    UnsubscribeCommandOutput,
    SdkError | AuthorizationError | InternalError | InvalidParameterError | InvalidSecurityError | NotFoundError
  >

  /**
   * @see {@link UntagResourceCommand}
   */
  untagResource(
    args: UntagResourceCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    UntagResourceCommandOutput,
    | SdkError
    | AuthorizationError
    | ConcurrentAccessError
    | InvalidParameterError
    | ResourceNotFoundError
    | StaleTagError
    | TagLimitExceededError
    | TagPolicyError
  >

  /**
   * @see {@link VerifySMSSandboxPhoneNumberCommand}
   */
  verifySMSSandboxPhoneNumber(
    args: VerifySMSSandboxPhoneNumberCommandInput,
    options?: __HttpHandlerOptions
  ): Effect.Effect<
    VerifySMSSandboxPhoneNumberCommandOutput,
    | SdkError
    | AuthorizationError
    | InternalError
    | InvalidParameterError
    | ResourceNotFoundError
    | ThrottledError
    | VerificationError
  >
}

Added in v1.0.0

tags

SNSService

Signature

export declare const SNSService: Context.Tag<SNSService, SNSService>

Added in v1.0.0