Class: Aws::PinpointSMSVoice::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::PinpointSMSVoice::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-pinpointsmsvoice/lib/aws-sdk-pinpointsmsvoice/client.rb
Overview
An API client for PinpointSMSVoice. To construct a client, you need to configure a :region and :credentials.
client = Aws::PinpointSMSVoice::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_configuration_set(params = {}) ⇒ Struct
Create a new configuration set.
-
#create_configuration_set_event_destination(params = {}) ⇒ Struct
Create a new event destination in a configuration set.
-
#delete_configuration_set(params = {}) ⇒ Struct
Deletes an existing configuration set.
-
#delete_configuration_set_event_destination(params = {}) ⇒ Struct
Deletes an event destination in a configuration set.
-
#get_configuration_set_event_destinations(params = {}) ⇒ Types::GetConfigurationSetEventDestinationsResponse
Obtain information about an event destination, including the types of events it reports, the Amazon Resource Name (ARN) of the destination, and the name of the event destination.
-
#list_configuration_sets(params = {}) ⇒ Types::ListConfigurationSetsResponse
List all of the configuration sets associated with your Amazon Pinpoint account in the current region.
-
#send_voice_message(params = {}) ⇒ Types::SendVoiceMessageResponse
Create a new voice message and send it to a recipient's phone number.
-
#update_configuration_set_event_destination(params = {}) ⇒ Struct
Update an event destination in a configuration set.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
478 479 480 |
# File 'gems/aws-sdk-pinpointsmsvoice/lib/aws-sdk-pinpointsmsvoice/client.rb', line 478 def initialize(*args) super end |
Instance Method Details
#create_configuration_set(params = {}) ⇒ Struct
Create a new configuration set. After you create the configuration set, you can add one or more event destinations to it.
502 503 504 505 |
# File 'gems/aws-sdk-pinpointsmsvoice/lib/aws-sdk-pinpointsmsvoice/client.rb', line 502 def create_configuration_set(params = {}, = {}) req = build_request(:create_configuration_set, params) req.send_request() end |
#create_configuration_set_event_destination(params = {}) ⇒ Struct
Create a new event destination in a configuration set.
545 546 547 548 |
# File 'gems/aws-sdk-pinpointsmsvoice/lib/aws-sdk-pinpointsmsvoice/client.rb', line 545 def create_configuration_set_event_destination(params = {}, = {}) req = build_request(:create_configuration_set_event_destination, params) req.send_request() end |
#delete_configuration_set(params = {}) ⇒ Struct
Deletes an existing configuration set.
566 567 568 569 |
# File 'gems/aws-sdk-pinpointsmsvoice/lib/aws-sdk-pinpointsmsvoice/client.rb', line 566 def delete_configuration_set(params = {}, = {}) req = build_request(:delete_configuration_set, params) req.send_request() end |
#delete_configuration_set_event_destination(params = {}) ⇒ Struct
Deletes an event destination in a configuration set.
590 591 592 593 |
# File 'gems/aws-sdk-pinpointsmsvoice/lib/aws-sdk-pinpointsmsvoice/client.rb', line 590 def delete_configuration_set_event_destination(params = {}, = {}) req = build_request(:delete_configuration_set_event_destination, params) req.send_request() end |
#get_configuration_set_event_destinations(params = {}) ⇒ Types::GetConfigurationSetEventDestinationsResponse
Obtain information about an event destination, including the types of events it reports, the Amazon Resource Name (ARN) of the destination, and the name of the event destination.
628 629 630 631 |
# File 'gems/aws-sdk-pinpointsmsvoice/lib/aws-sdk-pinpointsmsvoice/client.rb', line 628 def get_configuration_set_event_destinations(params = {}, = {}) req = build_request(:get_configuration_set_event_destinations, params) req.send_request() end |
#list_configuration_sets(params = {}) ⇒ Types::ListConfigurationSetsResponse
List all of the configuration sets associated with your Amazon Pinpoint account in the current region.
662 663 664 665 |
# File 'gems/aws-sdk-pinpointsmsvoice/lib/aws-sdk-pinpointsmsvoice/client.rb', line 662 def list_configuration_sets(params = {}, = {}) req = build_request(:list_configuration_sets, params) req.send_request() end |
#send_voice_message(params = {}) ⇒ Types::SendVoiceMessageResponse
Create a new voice message and send it to a recipient's phone number.
726 727 728 729 |
# File 'gems/aws-sdk-pinpointsmsvoice/lib/aws-sdk-pinpointsmsvoice/client.rb', line 726 def (params = {}, = {}) req = build_request(:send_voice_message, params) req.send_request() end |
#update_configuration_set_event_destination(params = {}) ⇒ Struct
Update an event destination in a configuration set. An event destination is a location that you publish information about your voice calls to. For example, you can log an event to an Amazon CloudWatch destination when a call fails.
771 772 773 774 |
# File 'gems/aws-sdk-pinpointsmsvoice/lib/aws-sdk-pinpointsmsvoice/client.rb', line 771 def update_configuration_set_event_destination(params = {}, = {}) req = build_request(:update_configuration_set_event_destination, params) req.send_request() end |