Class: Aws::SSMContacts::Types::StartEngagementRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#contact_idString

The Amazon Resource Name (ARN) of the contact being engaged.

Returns:

  • (String)


2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/types.rb', line 2211

class StartEngagementRequest < Struct.new(
  :contact_id,
  :sender,
  :subject,
  :content,
  :public_subject,
  :public_content,
  :incident_id,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end

#contentString

The secure content of the message that was sent to the contact. Use this field for engagements to VOICE or EMAIL.

Returns:

  • (String)


2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/types.rb', line 2211

class StartEngagementRequest < Struct.new(
  :contact_id,
  :sender,
  :subject,
  :content,
  :public_subject,
  :public_content,
  :incident_id,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end

#idempotency_tokenString

A token ensuring that the operation is called only once with the specified details.

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

Returns:

  • (String)


2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/types.rb', line 2211

class StartEngagementRequest < Struct.new(
  :contact_id,
  :sender,
  :subject,
  :content,
  :public_subject,
  :public_content,
  :incident_id,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end

#incident_idString

The ARN of the incident that the engagement is part of.

Returns:

  • (String)


2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/types.rb', line 2211

class StartEngagementRequest < Struct.new(
  :contact_id,
  :sender,
  :subject,
  :content,
  :public_subject,
  :public_content,
  :incident_id,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end

#public_contentString

The insecure content of the message that was sent to the contact. Use this field for engagements to SMS.

Returns:

  • (String)


2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/types.rb', line 2211

class StartEngagementRequest < Struct.new(
  :contact_id,
  :sender,
  :subject,
  :content,
  :public_subject,
  :public_content,
  :incident_id,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end

#public_subjectString

The insecure subject of the message that was sent to the contact. Use this field for engagements to SMS.

Returns:

  • (String)


2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/types.rb', line 2211

class StartEngagementRequest < Struct.new(
  :contact_id,
  :sender,
  :subject,
  :content,
  :public_subject,
  :public_content,
  :incident_id,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end

#senderString

The user that started the engagement.

Returns:

  • (String)


2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/types.rb', line 2211

class StartEngagementRequest < Struct.new(
  :contact_id,
  :sender,
  :subject,
  :content,
  :public_subject,
  :public_content,
  :incident_id,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end

#subjectString

The secure subject of the message that was sent to the contact. Use this field for engagements to VOICE or EMAIL.

Returns:

  • (String)


2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/types.rb', line 2211

class StartEngagementRequest < Struct.new(
  :contact_id,
  :sender,
  :subject,
  :content,
  :public_subject,
  :public_content,
  :incident_id,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end