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

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

Overview

Note:

When making an API call, you may pass AcceptPageRequest data as a hash:

{
  page_id: "SsmContactsArn", # required
  contact_channel_id: "SsmContactsArn",
  accept_type: "DELIVERED", # required, accepts DELIVERED, READ
  note: "ReceiptInfo",
  accept_code: "AcceptCode", # required
  accept_code_validation: "IGNORE", # accepts IGNORE, ENFORCE
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#accept_codeString

The accept code is a 6-digit code used to acknowledge the page.

Returns:

  • (String)


62
63
64
65
66
67
68
69
70
71
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/types.rb', line 62

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

#accept_code_validationString

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)


62
63
64
65
66
67
68
69
70
71
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/types.rb', line 62

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

#accept_typeString

The type indicates if the page was DELIVERED or READ.

Returns:

  • (String)


62
63
64
65
66
67
68
69
70
71
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/types.rb', line 62

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

#contact_channel_idString

The ARN of the contact channel.

Returns:

  • (String)


62
63
64
65
66
67
68
69
70
71
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/types.rb', line 62

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

#noteString

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

Returns:

  • (String)


62
63
64
65
66
67
68
69
70
71
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/types.rb', line 62

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

#page_idString

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

Returns:

  • (String)


62
63
64
65
66
67
68
69
70
71
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/types.rb', line 62

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