Class: Aws::NotificationsContacts::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::NotificationsContacts::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-notificationscontacts/client.rb
Overview
An API client for NotificationsContacts. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::NotificationsContacts::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#activate_email_contact(params = {}) ⇒ Struct
Activates an email contact using an activation code.
-
#create_email_contact(params = {}) ⇒ Types::CreateEmailContactResponse
Creates an email contact for the provided email address.
-
#delete_email_contact(params = {}) ⇒ Struct
Deletes an email contact.
-
#get_email_contact(params = {}) ⇒ Types::GetEmailContactResponse
Returns an email contact.
-
#list_email_contacts(params = {}) ⇒ Types::ListEmailContactsResponse
Lists all email contacts created under the Account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.
-
#send_activation_code(params = {}) ⇒ Struct
Sends an activation email to the email address associated with the specified email contact.
-
#tag_resource(params = {}) ⇒ Struct
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
-
#untag_resource(params = {}) ⇒ Struct
Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
473 474 475 |
# File 'lib/aws-sdk-notificationscontacts/client.rb', line 473 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
817 818 819 |
# File 'lib/aws-sdk-notificationscontacts/client.rb', line 817 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
820 821 822 |
# File 'lib/aws-sdk-notificationscontacts/client.rb', line 820 def errors_module Errors end |
Instance Method Details
#activate_email_contact(params = {}) ⇒ Struct
Activates an email contact using an activation code. This code is in the activation email sent to the email address associated with this email contact.
510 511 512 513 |
# File 'lib/aws-sdk-notificationscontacts/client.rb', line 510 def activate_email_contact(params = {}, = {}) req = build_request(:activate_email_contact, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 |
# File 'lib/aws-sdk-notificationscontacts/client.rb', line 790 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) tracer = config.telemetry_provider.tracer_provider.tracer( Aws::Telemetry.module_to_tracer_name('Aws::NotificationsContacts') ) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config, tracer: tracer ) context[:gem_name] = 'aws-sdk-notificationscontacts' context[:gem_version] = '1.14.0' Seahorse::Client::Request.new(handlers, context) end |
#create_email_contact(params = {}) ⇒ Types::CreateEmailContactResponse
Creates an email contact for the provided email address.
554 555 556 557 |
# File 'lib/aws-sdk-notificationscontacts/client.rb', line 554 def create_email_contact(params = {}, = {}) req = build_request(:create_email_contact, params) req.send_request() end |
#delete_email_contact(params = {}) ⇒ Struct
Deletes an email contact.
<note markdown=“1”> Deleting an email contact removes it from all associated notification configurations.
</note>
581 582 583 584 |
# File 'lib/aws-sdk-notificationscontacts/client.rb', line 581 def delete_email_contact(params = {}, = {}) req = build_request(:delete_email_contact, params) req.send_request() end |
#get_email_contact(params = {}) ⇒ Types::GetEmailContactResponse
Returns an email contact.
614 615 616 617 |
# File 'lib/aws-sdk-notificationscontacts/client.rb', line 614 def get_email_contact(params = {}, = {}) req = build_request(:get_email_contact, params) req.send_request() end |
#list_email_contacts(params = {}) ⇒ Types::ListEmailContactsResponse
Lists all email contacts created under the Account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
661 662 663 664 |
# File 'lib/aws-sdk-notificationscontacts/client.rb', line 661 def list_email_contacts(params = {}, = {}) req = build_request(:list_email_contacts, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.
691 692 693 694 |
# File 'lib/aws-sdk-notificationscontacts/client.rb', line 691 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#send_activation_code(params = {}) ⇒ Struct
Sends an activation email to the email address associated with the specified email contact.
<note markdown=“1”> It might take a few minutes for the activation email to arrive. If it doesn’t arrive, check in your spam folder or try sending another activation email.
</note>
720 721 722 723 |
# File 'lib/aws-sdk-notificationscontacts/client.rb', line 720 def send_activation_code(params = {}, = {}) req = build_request(:send_activation_code, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Taggable resources in AWS User Notifications Contacts include email contacts.
750 751 752 753 |
# File 'lib/aws-sdk-notificationscontacts/client.rb', line 750 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Taggable resources in AWS User Notifications Contacts include email contacts..
781 782 783 784 |
# File 'lib/aws-sdk-notificationscontacts/client.rb', line 781 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
810 811 812 |
# File 'lib/aws-sdk-notificationscontacts/client.rb', line 810 def waiter_names [] end |