Class: Aws::Connect::Types::SendOutboundWebNotificationRequest

Inherits:

Struct

• Object
• Struct
• Aws::Connect::Types::SendOutboundWebNotificationRequest

Includes:

Structure

Defined in:

lib/aws-sdk-connect/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #browser_id ⇒ String

  A unique identifier for the customer's web browser instance to which the notification is being sent.

• #client_token ⇒ String

  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

• #content ⇒ Types::WebNotificationContent

  The content of the web notification, including the notification type, the view to render, and any optional attributes used to populate it.

• #destination ⇒ Types::WidgetDestination

  The destination for the web notification, specifying the communication widget that delivers the notification and the customer profile of the recipient.

• #expires_at ⇒ Time

  The timestamp, in Unix epoch time format, at which the web notification expires.

• #instance_id ⇒ String

  The identifier of the Connect Customer instance.

• #session_id ⇒ String

  A unique identifier for the customer's web session to which the notification is being sent.

• #source ⇒ Types::WebNotificationSource

  The source of the web notification.

Instance Attribute Details

#browser_id ⇒ String

A unique identifier for the customer's web browser instance to which the notification is being sent.

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 31925

class SendOutboundWebNotificationRequest < Struct.new(
  :instance_id,
  :client_token,
  :browser_id,
  :session_id,
  :expires_at,
  :source,
  :destination,
  :content)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 31925

class SendOutboundWebNotificationRequest < Struct.new(
  :instance_id,
  :client_token,
  :browser_id,
  :session_id,
  :expires_at,
  :source,
  :destination,
  :content)
  SENSITIVE = []
  include Aws::Structure
end

#content ⇒ Types::WebNotificationContent

The content of the web notification, including the notification type, the view to render, and any optional attributes used to populate it.

Returns:

• (Types::WebNotificationContent)

# File 'lib/aws-sdk-connect/types.rb', line 31925

class SendOutboundWebNotificationRequest < Struct.new(
  :instance_id,
  :client_token,
  :browser_id,
  :session_id,
  :expires_at,
  :source,
  :destination,
  :content)
  SENSITIVE = []
  include Aws::Structure
end

#destination ⇒ Types::WidgetDestination

The destination for the web notification, specifying the communication widget that delivers the notification and the customer profile of the recipient.

Returns:

• (Types::WidgetDestination)

# File 'lib/aws-sdk-connect/types.rb', line 31925

class SendOutboundWebNotificationRequest < Struct.new(
  :instance_id,
  :client_token,
  :browser_id,
  :session_id,
  :expires_at,
  :source,
  :destination,
  :content)
  SENSITIVE = []
  include Aws::Structure
end

#expires_at ⇒ Time

The timestamp, in Unix epoch time format, at which the web notification expires. After this time, the notification is no longer delivered to the customer's browser.

Returns:

• (Time)

# File 'lib/aws-sdk-connect/types.rb', line 31925

class SendOutboundWebNotificationRequest < Struct.new(
  :instance_id,
  :client_token,
  :browser_id,
  :session_id,
  :expires_at,
  :source,
  :destination,
  :content)
  SENSITIVE = []
  include Aws::Structure
end

#instance_id ⇒ String

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 31925

class SendOutboundWebNotificationRequest < Struct.new(
  :instance_id,
  :client_token,
  :browser_id,
  :session_id,
  :expires_at,
  :source,
  :destination,
  :content)
  SENSITIVE = []
  include Aws::Structure
end

#session_id ⇒ String

A unique identifier for the customer's web session to which the notification is being sent.

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 31925

class SendOutboundWebNotificationRequest < Struct.new(
  :instance_id,
  :client_token,
  :browser_id,
  :session_id,
  :expires_at,
  :source,
  :destination,
  :content)
  SENSITIVE = []
  include Aws::Structure
end

#source ⇒ Types::WebNotificationSource

The source of the web notification. A SourceCampaign object identifies the campaign and outbound request that triggered this notification.

Returns:

• (Types::WebNotificationSource)

# File 'lib/aws-sdk-connect/types.rb', line 31925

class SendOutboundWebNotificationRequest < Struct.new(
  :instance_id,
  :client_token,
  :browser_id,
  :session_id,
  :expires_at,
  :source,
  :destination,
  :content)
  SENSITIVE = []
  include Aws::Structure
end