Class: Aws::SocialMessaging::Types::LinkedWhatsAppBusinessAccountSummary

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/types.rb

Overview

The details of a linked WhatsApp Business Account.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The ARN of the linked WhatsApp Business Account.

Returns:

  • (String)


1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/types.rb', line 1159

class LinkedWhatsAppBusinessAccountSummary < Struct.new(
  :arn,
  :id,
  :waba_id,
  :registration_status,
  :link_date,
  :waba_name,
  :event_destinations,
  :marketing_messages_onboarding_status,
  :direct_send_enforcement_status,
  :direct_send_enforcement_status_expires_at,
  :dataset_id)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_id ⇒ String

The Meta Conversions API dataset ID associated with this WhatsApp Business Account. This value is a numeric string of 10 to 20 digits. This field is not present when no dataset has been created for this account.

Returns:

  • (String)


1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/types.rb', line 1159

class LinkedWhatsAppBusinessAccountSummary < Struct.new(
  :arn,
  :id,
  :waba_id,
  :registration_status,
  :link_date,
  :waba_name,
  :event_destinations,
  :marketing_messages_onboarding_status,
  :direct_send_enforcement_status,
  :direct_send_enforcement_status_expires_at,
  :dataset_id)
  SENSITIVE = []
  include Aws::Structure
end

#direct_send_enforcement_status ⇒ String

The Direct Send enforcement status for the WhatsApp Business Account. Enforcement applies when an account repeatedly sends messages in a category that does not match the content. This field is not present when no enforcement is active.

Returns:

  • (String)


1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/types.rb', line 1159

class LinkedWhatsAppBusinessAccountSummary < Struct.new(
  :arn,
  :id,
  :waba_id,
  :registration_status,
  :link_date,
  :waba_name,
  :event_destinations,
  :marketing_messages_onboarding_status,
  :direct_send_enforcement_status,
  :direct_send_enforcement_status_expires_at,
  :dataset_id)
  SENSITIVE = []
  include Aws::Structure
end

#direct_send_enforcement_status_expires_at ⇒ Time

The time when the current Direct Send enforcement is expected to lift. This field is not present for permanent enforcement or when no enforcement is active.

Returns:

  • (Time)


1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/types.rb', line 1159

class LinkedWhatsAppBusinessAccountSummary < Struct.new(
  :arn,
  :id,
  :waba_id,
  :registration_status,
  :link_date,
  :waba_name,
  :event_destinations,
  :marketing_messages_onboarding_status,
  :direct_send_enforcement_status,
  :direct_send_enforcement_status_expires_at,
  :dataset_id)
  SENSITIVE = []
  include Aws::Structure
end

#event_destinations ⇒ Array<Types::WhatsAppBusinessAccountEventDestination>

The event destinations for the linked WhatsApp Business Account.



1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/types.rb', line 1159

class LinkedWhatsAppBusinessAccountSummary < Struct.new(
  :arn,
  :id,
  :waba_id,
  :registration_status,
  :link_date,
  :waba_name,
  :event_destinations,
  :marketing_messages_onboarding_status,
  :direct_send_enforcement_status,
  :direct_send_enforcement_status_expires_at,
  :dataset_id)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The ID of the linked WhatsApp Business Account, formatted as waba-01234567890123456789012345678901.

Returns:

  • (String)


1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/types.rb', line 1159

class LinkedWhatsAppBusinessAccountSummary < Struct.new(
  :arn,
  :id,
  :waba_id,
  :registration_status,
  :link_date,
  :waba_name,
  :event_destinations,
  :marketing_messages_onboarding_status,
  :direct_send_enforcement_status,
  :direct_send_enforcement_status_expires_at,
  :dataset_id)
  SENSITIVE = []
  include Aws::Structure
end

The date the WhatsApp Business Account was linked.

Returns:

  • (Time)


1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/types.rb', line 1159

class LinkedWhatsAppBusinessAccountSummary < Struct.new(
  :arn,
  :id,
  :waba_id,
  :registration_status,
  :link_date,
  :waba_name,
  :event_destinations,
  :marketing_messages_onboarding_status,
  :direct_send_enforcement_status,
  :direct_send_enforcement_status_expires_at,
  :dataset_id)
  SENSITIVE = []
  include Aws::Structure
end

#marketing_messages_onboarding_status ⇒ String

The onboarding status for the Marketing Messages API. This value is fetched from Meta and indicates whether the WhatsApp Business Account is onboarded for Meta's Marketing Messages API.

Returns:

  • (String)


1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/types.rb', line 1159

class LinkedWhatsAppBusinessAccountSummary < Struct.new(
  :arn,
  :id,
  :waba_id,
  :registration_status,
  :link_date,
  :waba_name,
  :event_destinations,
  :marketing_messages_onboarding_status,
  :direct_send_enforcement_status,
  :direct_send_enforcement_status_expires_at,
  :dataset_id)
  SENSITIVE = []
  include Aws::Structure
end

#registration_status ⇒ String

The registration status of the linked WhatsApp Business Account.

Returns:

  • (String)


1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/types.rb', line 1159

class LinkedWhatsAppBusinessAccountSummary < Struct.new(
  :arn,
  :id,
  :waba_id,
  :registration_status,
  :link_date,
  :waba_name,
  :event_destinations,
  :marketing_messages_onboarding_status,
  :direct_send_enforcement_status,
  :direct_send_enforcement_status_expires_at,
  :dataset_id)
  SENSITIVE = []
  include Aws::Structure
end

#waba_id ⇒ String

The WhatsApp Business Account ID provided by Meta.

Returns:

  • (String)


1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/types.rb', line 1159

class LinkedWhatsAppBusinessAccountSummary < Struct.new(
  :arn,
  :id,
  :waba_id,
  :registration_status,
  :link_date,
  :waba_name,
  :event_destinations,
  :marketing_messages_onboarding_status,
  :direct_send_enforcement_status,
  :direct_send_enforcement_status_expires_at,
  :dataset_id)
  SENSITIVE = []
  include Aws::Structure
end

#waba_name ⇒ String

The name of the linked WhatsApp Business Account.

Returns:

  • (String)


1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/types.rb', line 1159

class LinkedWhatsAppBusinessAccountSummary < Struct.new(
  :arn,
  :id,
  :waba_id,
  :registration_status,
  :link_date,
  :waba_name,
  :event_destinations,
  :marketing_messages_onboarding_status,
  :direct_send_enforcement_status,
  :direct_send_enforcement_status_expires_at,
  :dataset_id)
  SENSITIVE = []
  include Aws::Structure
end