Class: Aws::SSMContacts::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::SSMContacts::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb
Overview
An API client for SSMContacts. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::SSMContacts::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
-
#accept_page(params = {}) ⇒ Struct
Used to acknowledge an engagement to a contact channel during an incident.
-
#activate_contact_channel(params = {}) ⇒ Struct
Activates a contact's contact channel.
-
#create_contact(params = {}) ⇒ Types::CreateContactResult
Contacts are either the contacts that Incident Manager engages during an incident or the escalation plans that Incident Manager uses to engage contacts in phases during an incident.
-
#create_contact_channel(params = {}) ⇒ Types::CreateContactChannelResult
A contact channel is the method that Incident Manager uses to engage your contact.
-
#deactivate_contact_channel(params = {}) ⇒ Struct
To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.
-
#delete_contact(params = {}) ⇒ Struct
To remove a contact from Incident Manager, you can delete the contact.
-
#delete_contact_channel(params = {}) ⇒ Struct
To no longer receive engagements on a contact channel, you can delete the channel from a contact.
-
#describe_engagement(params = {}) ⇒ Types::DescribeEngagementResult
Incident Manager uses engagements to engage contacts and escalation plans during an incident.
-
#describe_page(params = {}) ⇒ Types::DescribePageResult
Lists details of the engagement to a contact channel.
-
#get_contact(params = {}) ⇒ Types::GetContactResult
Retrieves information about the specified contact or escalation plan.
-
#get_contact_channel(params = {}) ⇒ Types::GetContactChannelResult
List details about a specific contact channel.
-
#get_contact_policy(params = {}) ⇒ Types::GetContactPolicyResult
Retrieves the resource policies attached to the specified contact or escalation plan.
-
#list_contact_channels(params = {}) ⇒ Types::ListContactChannelsResult
Lists all contact channels for the specified contact.
-
#list_contacts(params = {}) ⇒ Types::ListContactsResult
Lists all contacts and escalation plans in Incident Manager.
-
#list_engagements(params = {}) ⇒ Types::ListEngagementsResult
Lists all engagements that have happened in an incident.
-
#list_page_receipts(params = {}) ⇒ Types::ListPageReceiptsResult
Lists all of the engagements to contact channels that have been acknowledged.
-
#list_pages_by_contact(params = {}) ⇒ Types::ListPagesByContactResult
Lists the engagements to a contact's contact channels.
-
#list_pages_by_engagement(params = {}) ⇒ Types::ListPagesByEngagementResult
Lists the engagements to contact channels that occurred by engaging a contact.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResult
Lists the tags of an escalation plan or contact.
-
#put_contact_policy(params = {}) ⇒ Struct
Adds a resource policy to the specified contact or escalation plan.
-
#send_activation_code(params = {}) ⇒ Struct
Sends an activation code to a contact channel.
-
#start_engagement(params = {}) ⇒ Types::StartEngagementResult
Starts an engagement to a contact or escalation plan.
-
#stop_engagement(params = {}) ⇒ Struct
Stops an engagement before it finishes the final stage of the escalation plan or engagement plan.
-
#tag_resource(params = {}) ⇒ Struct
Tags a contact or escalation plan.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from the specified resource.
-
#update_contact(params = {}) ⇒ Struct
Updates the contact or escalation plan specified.
-
#update_contact_channel(params = {}) ⇒ Struct
Updates a contact's contact channel.
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.
358 359 360 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 358 def initialize(*args) super end |
Instance Method Details
#accept_page(params = {}) ⇒ Struct
Used to acknowledge an engagement to a contact channel during an incident.
426 427 428 429 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 426 def accept_page(params = {}, = {}) req = build_request(:accept_page, params) req.send_request() end |
#activate_contact_channel(params = {}) ⇒ Struct
Activates a contact's contact channel. Incident Manager can't engage a contact until the contact channel has been activated.
468 469 470 471 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 468 def activate_contact_channel(params = {}, = {}) req = build_request(:activate_contact_channel, params) req.send_request() end |
#create_contact(params = {}) ⇒ Types::CreateContactResult
Contacts are either the contacts that Incident Manager engages during an incident or the escalation plans that Incident Manager uses to engage contacts in phases during an incident.
572 573 574 575 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 572 def create_contact(params = {}, = {}) req = build_request(:create_contact, params) req.send_request() end |
#create_contact_channel(params = {}) ⇒ Types::CreateContactChannelResult
A contact channel is the method that Incident Manager uses to engage your contact.
664 665 666 667 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 664 def create_contact_channel(params = {}, = {}) req = build_request(:create_contact_channel, params) req.send_request() end |
#deactivate_contact_channel(params = {}) ⇒ Struct
To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.
703 704 705 706 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 703 def deactivate_contact_channel(params = {}, = {}) req = build_request(:deactivate_contact_channel, params) req.send_request() end |
#delete_contact(params = {}) ⇒ Struct
To remove a contact from Incident Manager, you can delete the contact. Deleting a contact removes them from all escalation plans and related response plans. Deleting an escalation plan removes it from all related response plans. You will have to recreate the contact and its contact channels before you can use it again.
743 744 745 746 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 743 def delete_contact(params = {}, = {}) req = build_request(:delete_contact, params) req.send_request() end |
#delete_contact_channel(params = {}) ⇒ Struct
To no longer receive engagements on a contact channel, you can delete the channel from a contact. Deleting the contact channel removes it from the contact's engagement plan. If you delete the only contact channel for a contact, you won't be able to engage that contact during an incident.
783 784 785 786 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 783 def delete_contact_channel(params = {}, = {}) req = build_request(:delete_contact_channel, params) req.send_request() end |
#describe_engagement(params = {}) ⇒ Types::DescribeEngagementResult
Incident Manager uses engagements to engage contacts and escalation plans during an incident. Use this command to describe the engagement that occurred during an incident.
854 855 856 857 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 854 def describe_engagement(params = {}, = {}) req = build_request(:describe_engagement, params) req.send_request() end |
#describe_page(params = {}) ⇒ Types::DescribePageResult
Lists details of the engagement to a contact channel.
929 930 931 932 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 929 def describe_page(params = {}, = {}) req = build_request(:describe_page, params) req.send_request() end |
#get_contact(params = {}) ⇒ Types::GetContactResult
Retrieves information about the specified contact or escalation plan.
1078 1079 1080 1081 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1078 def get_contact(params = {}, = {}) req = build_request(:get_contact, params) req.send_request() end |
#get_contact_channel(params = {}) ⇒ Types::GetContactChannelResult
List details about a specific contact channel.
1138 1139 1140 1141 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1138 def get_contact_channel(params = {}, = {}) req = build_request(:get_contact_channel, params) req.send_request() end |
#get_contact_policy(params = {}) ⇒ Types::GetContactPolicyResult
Retrieves the resource policies attached to the specified contact or escalation plan.
1184 1185 1186 1187 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1184 def get_contact_policy(params = {}, = {}) req = build_request(:get_contact_policy, params) req.send_request() end |
#list_contact_channels(params = {}) ⇒ Types::ListContactChannelsResult
Lists all contact channels for the specified contact.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1255 1256 1257 1258 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1255 def list_contact_channels(params = {}, = {}) req = build_request(:list_contact_channels, params) req.send_request() end |
#list_contacts(params = {}) ⇒ Types::ListContactsResult
Lists all contacts and escalation plans in Incident Manager.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1344 1345 1346 1347 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1344 def list_contacts(params = {}, = {}) req = build_request(:list_contacts, params) req.send_request() end |
#list_engagements(params = {}) ⇒ Types::ListEngagementsResult
Lists all engagements that have happened in an incident.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1437 1438 1439 1440 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1437 def list_engagements(params = {}, = {}) req = build_request(:list_engagements, params) req.send_request() end |
#list_page_receipts(params = {}) ⇒ Types::ListPageReceiptsResult
Lists all of the engagements to contact channels that have been acknowledged.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1516 1517 1518 1519 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1516 def list_page_receipts(params = {}, = {}) req = build_request(:list_page_receipts, params) req.send_request() end |
#list_pages_by_contact(params = {}) ⇒ Types::ListPagesByContactResult
Lists the engagements to a contact's contact channels.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1590 1591 1592 1593 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1590 def list_pages_by_contact(params = {}, = {}) req = build_request(:list_pages_by_contact, params) req.send_request() end |
#list_pages_by_engagement(params = {}) ⇒ Types::ListPagesByEngagementResult
Lists the engagements to contact channels that occurred by engaging a contact.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1662 1663 1664 1665 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1662 def list_pages_by_engagement(params = {}, = {}) req = build_request(:list_pages_by_engagement, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResult
Lists the tags of an escalation plan or contact.
1711 1712 1713 1714 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1711 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_contact_policy(params = {}) ⇒ Struct
Adds a resource policy to the specified contact or escalation plan. The resource policy is used to share the contact or escalation plan using Resource Access Manager (RAM). For more information about cross-account sharing, see Setting up cross-account functionality.
1760 1761 1762 1763 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1760 def put_contact_policy(params = {}, = {}) req = build_request(:put_contact_policy, params) req.send_request() end |
#send_activation_code(params = {}) ⇒ Struct
Sends an activation code to a contact channel. The contact can use
this code to activate the contact channel in the console or with the
ActivateChannel
operation. Incident Manager can't engage a contact
channel until it has been activated.
1798 1799 1800 1801 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1798 def send_activation_code(params = {}, = {}) req = build_request(:send_activation_code, params) req.send_request() end |
#start_engagement(params = {}) ⇒ Types::StartEngagementResult
Starts an engagement to a contact or escalation plan. The engagement engages each contact specified in the incident.
1904 1905 1906 1907 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1904 def start_engagement(params = {}, = {}) req = build_request(:start_engagement, params) req.send_request() end |
#stop_engagement(params = {}) ⇒ Struct
Stops an engagement before it finishes the final stage of the escalation plan or engagement plan. Further contacts aren't engaged.
1944 1945 1946 1947 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1944 def stop_engagement(params = {}, = {}) req = build_request(:stop_engagement, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Tags a contact or escalation plan. You can tag only contacts and escalation plans in the first region of your replication set.
1995 1996 1997 1998 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1995 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from the specified resource.
2037 2038 2039 2040 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 2037 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_contact(params = {}) ⇒ Struct
Updates the contact or escalation plan specified.
2139 2140 2141 2142 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 2139 def update_contact(params = {}, = {}) req = build_request(:update_contact, params) req.send_request() end |
#update_contact_channel(params = {}) ⇒ Struct
Updates a contact's contact channel.
2190 2191 2192 2193 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 2190 def update_contact_channel(params = {}, = {}) req = build_request(:update_contact_channel, params) req.send_request() end |