Class: Aws::Connect::Types::CreateNotificationRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#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)


7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 7518

class CreateNotificationRequest < Struct.new(
  :instance_id,
  :expires_at,
  :recipients,
  :priority,
  :content,
  :tags,
  :predefined_notification_id,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#content ⇒ Hash<String,String>

The localized content of the notification. A map where keys are locale codes and values are the notification text in that locale. Content supports links. Maximum 250 characters per locale.

Returns:

  • (Hash<String,String>)


7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 7518

class CreateNotificationRequest < Struct.new(
  :instance_id,
  :expires_at,
  :recipients,
  :priority,
  :content,
  :tags,
  :predefined_notification_id,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#expires_at ⇒ Time

The timestamp when the notification should expire and no longer be displayed to users. If not specified, defaults to one week from creation.

Returns:

  • (Time)


7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 7518

class CreateNotificationRequest < Struct.new(
  :instance_id,
  :expires_at,
  :recipients,
  :priority,
  :content,
  :tags,
  :predefined_notification_id,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#instance_id ⇒ String

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

Returns:

  • (String)


7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 7518

class CreateNotificationRequest < Struct.new(
  :instance_id,
  :expires_at,
  :recipients,
  :priority,
  :content,
  :tags,
  :predefined_notification_id,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#predefined_notification_id ⇒ String

The unique identifier for a notification.

Returns:

  • (String)


7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 7518

class CreateNotificationRequest < Struct.new(
  :instance_id,
  :expires_at,
  :recipients,
  :priority,
  :content,
  :tags,
  :predefined_notification_id,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#priority ⇒ String

The priority level of the notification. Valid values are HIGH and LOW. High priority notifications are displayed above low priority notifications.

Returns:

  • (String)


7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 7518

class CreateNotificationRequest < Struct.new(
  :instance_id,
  :expires_at,
  :recipients,
  :priority,
  :content,
  :tags,
  :predefined_notification_id,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#recipients ⇒ Array<String>

A list of Amazon Resource Names (ARNs) identifying the recipients of the notification. Can include user ARNs or instance ARNs to target all users in an instance. Maximum of 200 recipients.

Returns:

  • (Array<String>)


7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 7518

class CreateNotificationRequest < Struct.new(
  :instance_id,
  :expires_at,
  :recipients,
  :priority,
  :content,
  :tags,
  :predefined_notification_id,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

Returns:

  • (Hash<String,String>)


7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 7518

class CreateNotificationRequest < Struct.new(
  :instance_id,
  :expires_at,
  :recipients,
  :priority,
  :content,
  :tags,
  :predefined_notification_id,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end