Class: Aws::SSMContacts::Types::ListContactsRequest

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 ListContactsRequest data as a hash:

{
  next_token: "PaginationToken",
  max_results: 1,
  alias_prefix: "ContactAlias",
  type: "PERSONAL", # accepts PERSONAL, ESCALATION
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#alias_prefixString

Used to list only contacts who's aliases start with the specified prefix.

Returns:

  • (String)


1030
1031
1032
1033
1034
1035
1036
1037
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/types.rb', line 1030

class ListContactsRequest < Struct.new(
  :next_token,
  :max_results,
  :alias_prefix,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of contacts and escalation plans per page of results.

Returns:

  • (Integer)


1030
1031
1032
1033
1034
1035
1036
1037
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/types.rb', line 1030

class ListContactsRequest < Struct.new(
  :next_token,
  :max_results,
  :alias_prefix,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

The pagination token to continue to the next page of results.

Returns:

  • (String)


1030
1031
1032
1033
1034
1035
1036
1037
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/types.rb', line 1030

class ListContactsRequest < Struct.new(
  :next_token,
  :max_results,
  :alias_prefix,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

The type of contact. A contact is type PERSONAL and an escalation plan is type ESCALATION.

Returns:

  • (String)


1030
1031
1032
1033
1034
1035
1036
1037
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/types.rb', line 1030

class ListContactsRequest < Struct.new(
  :next_token,
  :max_results,
  :alias_prefix,
  :type)
  SENSITIVE = []
  include Aws::Structure
end