Class: Aws::SSMContacts::Types::AcceptPageRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#accept_code ⇒ String

A 6-digit code used to acknowledge the page.

Returns:

  • (String) 


50
51
52
53
54
55
56
57
58
59
 
# File 'lib/aws-sdk-ssmcontacts/types.rb', line 50

class AcceptPageRequest < Struct.new(
  :page_id,
  :contact_channel_id,
  :accept_type,
  :note,
  :accept_code,
  :accept_code_validation)
  SENSITIVE = []
  include Aws::Structure
end

#accept_code_validation ⇒ String

An optional field that Incident Manager uses to ‘ENFORCE` `AcceptCode` validation when acknowledging an page. Acknowledgement can occur by replying to a page, or when entering the AcceptCode in the console. Enforcing AcceptCode validation causes Incident Manager to verify that the code entered by the user matches the code sent by Incident Manager with the page.

Incident Manager can also ‘IGNORE` `AcceptCode` validation. Ignoring `AcceptCode` validation causes Incident Manager to accept any value entered for the `AcceptCode`.

Returns:

  • (String) 


50
51
52
53
54
55
56
57
58
59
 
# File 'lib/aws-sdk-ssmcontacts/types.rb', line 50

class AcceptPageRequest < Struct.new(
  :page_id,
  :contact_channel_id,
  :accept_type,
  :note,
  :accept_code,
  :accept_code_validation)
  SENSITIVE = []
  include Aws::Structure
end

#accept_type ⇒ String

The type indicates if the page was ‘DELIVERED` or `READ`.

Returns:

  • (String) 


50
51
52
53
54
55
56
57
58
59
 
# File 'lib/aws-sdk-ssmcontacts/types.rb', line 50

class AcceptPageRequest < Struct.new(
  :page_id,
  :contact_channel_id,
  :accept_type,
  :note,
  :accept_code,
  :accept_code_validation)
  SENSITIVE = []
  include Aws::Structure
end

#contact_channel_id ⇒ String

The ARN of the contact channel.

Returns:

  • (String) 


50
51
52
53
54
55
56
57
58
59
 
# File 'lib/aws-sdk-ssmcontacts/types.rb', line 50

class AcceptPageRequest < Struct.new(
  :page_id,
  :contact_channel_id,
  :accept_type,
  :note,
  :accept_code,
  :accept_code_validation)
  SENSITIVE = []
  include Aws::Structure
end

#note ⇒ String

Information provided by the user when the user acknowledges the page.

Returns:

  • (String) 


50
51
52
53
54
55
56
57
58
59
 
# File 'lib/aws-sdk-ssmcontacts/types.rb', line 50

class AcceptPageRequest < Struct.new(
  :page_id,
  :contact_channel_id,
  :accept_type,
  :note,
  :accept_code,
  :accept_code_validation)
  SENSITIVE = []
  include Aws::Structure
end

#page_id ⇒ String

The Amazon Resource Name (ARN) of the engagement to a contact channel.

Returns:

  • (String) 


50
51
52
53
54
55
56
57
58
59
 
# File 'lib/aws-sdk-ssmcontacts/types.rb', line 50

class AcceptPageRequest < Struct.new(
  :page_id,
  :contact_channel_id,
  :accept_type,
  :note,
  :accept_code,
  :accept_code_validation)
  SENSITIVE = []
  include Aws::Structure
end