1. Packages
  2. Ibm Provider
  3. API Docs
  4. getEnSubscriptionSms
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.getEnSubscriptionSms

Explore with Pulumi AI

Provides a read-only data source for SMS subscription. You can then reference the fields of the data source in other resources within the same configuration using interpolation syntax.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const smsSubscription = ibm.getEnSubscriptionSms({
    instanceGuid: ibm_resource_instance.en_terraform_test_resource.guid,
    subscriptionId: ibm_en_subscription_sms.subscriptionsmsnew.subscription_id,
});
Copy
import pulumi
import pulumi_ibm as ibm

sms_subscription = ibm.get_en_subscription_sms(instance_guid=ibm_resource_instance["en_terraform_test_resource"]["guid"],
    subscription_id=ibm_en_subscription_sms["subscriptionsmsnew"]["subscription_id"])
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.LookupEnSubscriptionSms(ctx, &ibm.LookupEnSubscriptionSmsArgs{
			InstanceGuid:   ibm_resource_instance.En_terraform_test_resource.Guid,
			SubscriptionId: ibm_en_subscription_sms.Subscriptionsmsnew.Subscription_id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var smsSubscription = Ibm.GetEnSubscriptionSms.Invoke(new()
    {
        InstanceGuid = ibm_resource_instance.En_terraform_test_resource.Guid,
        SubscriptionId = ibm_en_subscription_sms.Subscriptionsmsnew.Subscription_id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetEnSubscriptionSmsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var smsSubscription = IbmFunctions.getEnSubscriptionSms(GetEnSubscriptionSmsArgs.builder()
            .instanceGuid(ibm_resource_instance.en_terraform_test_resource().guid())
            .subscriptionId(ibm_en_subscription_sms.subscriptionsmsnew().subscription_id())
            .build());

    }
}
Copy
variables:
  smsSubscription:
    fn::invoke:
      function: ibm:getEnSubscriptionSms
      arguments:
        instanceGuid: ${ibm_resource_instance.en_terraform_test_resource.guid}
        subscriptionId: ${ibm_en_subscription_sms.subscriptionsmsnew.subscription_id}
Copy

Using getEnSubscriptionSms

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getEnSubscriptionSms(args: GetEnSubscriptionSmsArgs, opts?: InvokeOptions): Promise<GetEnSubscriptionSmsResult>
function getEnSubscriptionSmsOutput(args: GetEnSubscriptionSmsOutputArgs, opts?: InvokeOptions): Output<GetEnSubscriptionSmsResult>
Copy
def get_en_subscription_sms(id: Optional[str] = None,
                            instance_guid: Optional[str] = None,
                            subscription_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetEnSubscriptionSmsResult
def get_en_subscription_sms_output(id: Optional[pulumi.Input[str]] = None,
                            instance_guid: Optional[pulumi.Input[str]] = None,
                            subscription_id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetEnSubscriptionSmsResult]
Copy
func LookupEnSubscriptionSms(ctx *Context, args *LookupEnSubscriptionSmsArgs, opts ...InvokeOption) (*LookupEnSubscriptionSmsResult, error)
func LookupEnSubscriptionSmsOutput(ctx *Context, args *LookupEnSubscriptionSmsOutputArgs, opts ...InvokeOption) LookupEnSubscriptionSmsResultOutput
Copy

> Note: This function is named LookupEnSubscriptionSms in the Go SDK.

public static class GetEnSubscriptionSms 
{
    public static Task<GetEnSubscriptionSmsResult> InvokeAsync(GetEnSubscriptionSmsArgs args, InvokeOptions? opts = null)
    public static Output<GetEnSubscriptionSmsResult> Invoke(GetEnSubscriptionSmsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetEnSubscriptionSmsResult> getEnSubscriptionSms(GetEnSubscriptionSmsArgs args, InvokeOptions options)
public static Output<GetEnSubscriptionSmsResult> getEnSubscriptionSms(GetEnSubscriptionSmsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getEnSubscriptionSms:getEnSubscriptionSms
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

InstanceGuid This property is required. string
Unique identifier for IBM Cloud Event Notifications instance.
SubscriptionId This property is required. string
Unique identifier for Subscription.
Id string
The unique identifier of the sms_subscription.
InstanceGuid This property is required. string
Unique identifier for IBM Cloud Event Notifications instance.
SubscriptionId This property is required. string
Unique identifier for Subscription.
Id string
The unique identifier of the sms_subscription.
instanceGuid This property is required. String
Unique identifier for IBM Cloud Event Notifications instance.
subscriptionId This property is required. String
Unique identifier for Subscription.
id String
The unique identifier of the sms_subscription.
instanceGuid This property is required. string
Unique identifier for IBM Cloud Event Notifications instance.
subscriptionId This property is required. string
Unique identifier for Subscription.
id string
The unique identifier of the sms_subscription.
instance_guid This property is required. str
Unique identifier for IBM Cloud Event Notifications instance.
subscription_id This property is required. str
Unique identifier for Subscription.
id str
The unique identifier of the sms_subscription.
instanceGuid This property is required. String
Unique identifier for IBM Cloud Event Notifications instance.
subscriptionId This property is required. String
Unique identifier for Subscription.
id String
The unique identifier of the sms_subscription.

getEnSubscriptionSms Result

The following output properties are available:

Attributes List<GetEnSubscriptionSmsAttribute>
Description string
(String) Subscription description.
DestinationId string
(String) The destination ID.
Id string
The unique identifier of the sms_subscription.
InstanceGuid string
Name string
(String) Subscription name.
SubscriptionId string
TopicId string
(String) Topic ID.
UpdatedAt string
(String) Last updated time.
Attributes []GetEnSubscriptionSmsAttribute
Description string
(String) Subscription description.
DestinationId string
(String) The destination ID.
Id string
The unique identifier of the sms_subscription.
InstanceGuid string
Name string
(String) Subscription name.
SubscriptionId string
TopicId string
(String) Topic ID.
UpdatedAt string
(String) Last updated time.
attributes List<GetEnSubscriptionSmsAttribute>
description String
(String) Subscription description.
destinationId String
(String) The destination ID.
id String
The unique identifier of the sms_subscription.
instanceGuid String
name String
(String) Subscription name.
subscriptionId String
topicId String
(String) Topic ID.
updatedAt String
(String) Last updated time.
attributes GetEnSubscriptionSmsAttribute[]
description string
(String) Subscription description.
destinationId string
(String) The destination ID.
id string
The unique identifier of the sms_subscription.
instanceGuid string
name string
(String) Subscription name.
subscriptionId string
topicId string
(String) Topic ID.
updatedAt string
(String) Last updated time.
attributes Sequence[GetEnSubscriptionSmsAttribute]
description str
(String) Subscription description.
destination_id str
(String) The destination ID.
id str
The unique identifier of the sms_subscription.
instance_guid str
name str
(String) Subscription name.
subscription_id str
topic_id str
(String) Topic ID.
updated_at str
(String) Last updated time.
attributes List<Property Map>
description String
(String) Subscription description.
destinationId String
(String) The destination ID.
id String
The unique identifier of the sms_subscription.
instanceGuid String
name String
(String) Subscription name.
subscriptionId String
topicId String
(String) Topic ID.
updatedAt String
(String) Last updated time.

Supporting Types

GetEnSubscriptionSmsAttribute

Inviteds This property is required. List<GetEnSubscriptionSmsAttributeInvited>
(List) The phone number for invitation.
Subscribeds This property is required. List<GetEnSubscriptionSmsAttributeSubscribed>
Unsubscribeds This property is required. List<GetEnSubscriptionSmsAttributeUnsubscribed>
(List) The phone number which has opted for unsusbscribtion from that topic.
Inviteds This property is required. []GetEnSubscriptionSmsAttributeInvited
(List) The phone number for invitation.
Subscribeds This property is required. []GetEnSubscriptionSmsAttributeSubscribed
Unsubscribeds This property is required. []GetEnSubscriptionSmsAttributeUnsubscribed
(List) The phone number which has opted for unsusbscribtion from that topic.
inviteds This property is required. List<GetEnSubscriptionSmsAttributeInvited>
(List) The phone number for invitation.
subscribeds This property is required. List<GetEnSubscriptionSmsAttributeSubscribed>
unsubscribeds This property is required. List<GetEnSubscriptionSmsAttributeUnsubscribed>
(List) The phone number which has opted for unsusbscribtion from that topic.
inviteds This property is required. GetEnSubscriptionSmsAttributeInvited[]
(List) The phone number for invitation.
subscribeds This property is required. GetEnSubscriptionSmsAttributeSubscribed[]
unsubscribeds This property is required. GetEnSubscriptionSmsAttributeUnsubscribed[]
(List) The phone number which has opted for unsusbscribtion from that topic.
inviteds This property is required. Sequence[GetEnSubscriptionSmsAttributeInvited]
(List) The phone number for invitation.
subscribeds This property is required. Sequence[GetEnSubscriptionSmsAttributeSubscribed]
unsubscribeds This property is required. Sequence[GetEnSubscriptionSmsAttributeUnsubscribed]
(List) The phone number which has opted for unsusbscribtion from that topic.
inviteds This property is required. List<Property Map>
(List) The phone number for invitation.
subscribeds This property is required. List<Property Map>
unsubscribeds This property is required. List<Property Map>
(List) The phone number which has opted for unsusbscribtion from that topic.

GetEnSubscriptionSmsAttributeInvited

ExpiresAt This property is required. string
PhoneNumber This property is required. string
UpdatedAt This property is required. string
(String) Last updated time.
ExpiresAt This property is required. string
PhoneNumber This property is required. string
UpdatedAt This property is required. string
(String) Last updated time.
expiresAt This property is required. String
phoneNumber This property is required. String
updatedAt This property is required. String
(String) Last updated time.
expiresAt This property is required. string
phoneNumber This property is required. string
updatedAt This property is required. string
(String) Last updated time.
expires_at This property is required. str
phone_number This property is required. str
updated_at This property is required. str
(String) Last updated time.
expiresAt This property is required. String
phoneNumber This property is required. String
updatedAt This property is required. String
(String) Last updated time.

GetEnSubscriptionSmsAttributeSubscribed

PhoneNumber This property is required. string
UpdatedAt This property is required. string
(String) Last updated time.
PhoneNumber This property is required. string
UpdatedAt This property is required. string
(String) Last updated time.
phoneNumber This property is required. String
updatedAt This property is required. String
(String) Last updated time.
phoneNumber This property is required. string
updatedAt This property is required. string
(String) Last updated time.
phone_number This property is required. str
updated_at This property is required. str
(String) Last updated time.
phoneNumber This property is required. String
updatedAt This property is required. String
(String) Last updated time.

GetEnSubscriptionSmsAttributeUnsubscribed

PhoneNumber This property is required. string
UpdatedAt This property is required. string
(String) Last updated time.
PhoneNumber This property is required. string
UpdatedAt This property is required. string
(String) Last updated time.
phoneNumber This property is required. String
updatedAt This property is required. String
(String) Last updated time.
phoneNumber This property is required. string
updatedAt This property is required. string
(String) Last updated time.
phone_number This property is required. str
updated_at This property is required. str
(String) Last updated time.
phoneNumber This property is required. String
updatedAt This property is required. String
(String) Last updated time.

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.