Class: Aws::AlexaForBusiness::Types::CreateContactRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::AlexaForBusiness::Types::CreateContactRequest
- Defined in:
- gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb
Overview
When making an API call, you may pass CreateContactRequest data as a hash:
{
display_name: "ContactName",
first_name: "ContactName", # required
last_name: "ContactName",
phone_number: "RawPhoneNumber",
phone_numbers: [
{
number: "RawPhoneNumber", # required
type: "MOBILE", # required, accepts MOBILE, WORK, HOME
},
],
sip_addresses: [
{
uri: "SipUri", # required
type: "WORK", # required, accepts WORK
},
],
client_request_token: "ClientRequestToken",
tags: [
{
key: "TagKey", # required
value: "TagValue", # required
},
],
}
Constant Summary collapse
- SENSITIVE =
[:phone_number]
Instance Attribute Summary collapse
-
#client_request_token ⇒ String
A unique, user-specified identifier for this request that ensures idempotency.
-
#display_name ⇒ String
The name of the contact to display on the console.
-
#first_name ⇒ String
The first name of the contact that is used to call the contact on the device.
-
#last_name ⇒ String
The last name of the contact that is used to call the contact on the device.
-
#phone_number ⇒ String
The phone number of the contact in E.164 format.
-
#phone_numbers ⇒ Array<Types::PhoneNumber>
The list of phone numbers for the contact.
-
#sip_addresses ⇒ Array<Types::SipAddress>
The list of SIP addresses for the contact.
-
#tags ⇒ Array<Types::Tag>
The tags to be added to the specified resource.
Instance Attribute Details
#client_request_token ⇒ String
A unique, user-specified identifier for this request that ensures idempotency.
A suitable default value is auto-generated. You should normally not need to pass this option.
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1013 class CreateContactRequest < Struct.new( :display_name, :first_name, :last_name, :phone_number, :phone_numbers, :sip_addresses, :client_request_token, :tags) SENSITIVE = [:phone_number] include Aws::Structure end |
#display_name ⇒ String
The name of the contact to display on the console.
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1013 class CreateContactRequest < Struct.new( :display_name, :first_name, :last_name, :phone_number, :phone_numbers, :sip_addresses, :client_request_token, :tags) SENSITIVE = [:phone_number] include Aws::Structure end |
#first_name ⇒ String
The first name of the contact that is used to call the contact on the device.
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1013 class CreateContactRequest < Struct.new( :display_name, :first_name, :last_name, :phone_number, :phone_numbers, :sip_addresses, :client_request_token, :tags) SENSITIVE = [:phone_number] include Aws::Structure end |
#last_name ⇒ String
The last name of the contact that is used to call the contact on the device.
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1013 class CreateContactRequest < Struct.new( :display_name, :first_name, :last_name, :phone_number, :phone_numbers, :sip_addresses, :client_request_token, :tags) SENSITIVE = [:phone_number] include Aws::Structure end |
#phone_number ⇒ String
The phone number of the contact in E.164 format. The phone number type defaults to WORK. You can specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1013 class CreateContactRequest < Struct.new( :display_name, :first_name, :last_name, :phone_number, :phone_numbers, :sip_addresses, :client_request_token, :tags) SENSITIVE = [:phone_number] include Aws::Structure end |
#phone_numbers ⇒ Array<Types::PhoneNumber>
The list of phone numbers for the contact.
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1013 class CreateContactRequest < Struct.new( :display_name, :first_name, :last_name, :phone_number, :phone_numbers, :sip_addresses, :client_request_token, :tags) SENSITIVE = [:phone_number] include Aws::Structure end |
#sip_addresses ⇒ Array<Types::SipAddress>
The list of SIP addresses for the contact.
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1013 class CreateContactRequest < Struct.new( :display_name, :first_name, :last_name, :phone_number, :phone_numbers, :sip_addresses, :client_request_token, :tags) SENSITIVE = [:phone_number] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
The tags to be added to the specified resource. Do not provide system tags.
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1013 class CreateContactRequest < Struct.new( :display_name, :first_name, :last_name, :phone_number, :phone_numbers, :sip_addresses, :client_request_token, :tags) SENSITIVE = [:phone_number] include Aws::Structure end |