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

Inherits:

Struct

• Object
• Struct
• Aws::SSMContacts::Types::StartEngagementRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-ssmcontacts/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #contact_id ⇒ String

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

• #content ⇒ String

  The secure content of the message that was sent to the contact.

• #idempotency_token ⇒ String

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

• #incident_id ⇒ String

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

• #public_content ⇒ String

  The insecure content of the message that was sent to the contact.

• #public_subject ⇒ String

  The insecure subject of the message that was sent to the contact.

• #sender ⇒ String

  The user that started the engagement.

• #subject ⇒ String

  The secure subject of the message that was sent to the contact.

Instance Attribute Details

#contact_id ⇒ String

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

Returns:

• (String)

# File '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

#content ⇒ String

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

Returns:

• (String)

# File '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_token ⇒ String

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)

# File '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_id ⇒ String

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

Returns:

• (String)

# File '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_content ⇒ String

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

Returns:

• (String)

# File '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_subject ⇒ String

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

Returns:

• (String)

# File '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

#sender ⇒ String

The user that started the engagement.

Returns:

• (String)

# File '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

#subject ⇒ String

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

Returns:

• (String)

# File '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