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.
-
#create_rotation(params = {}) ⇒ Types::CreateRotationResult
Creates a rotation in an on-call schedule.
-
#create_rotation_override(params = {}) ⇒ Types::CreateRotationOverrideResult
Creates an override for a rotation in an on-call schedule.
-
#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.
-
#delete_rotation(params = {}) ⇒ Struct
Deletes a rotation from the system.
-
#delete_rotation_override(params = {}) ⇒ Struct
Deletes an existing override for an on-call rotation.
-
#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.
-
#get_rotation(params = {}) ⇒ Types::GetRotationResult
Retrieves information about an on-call rotation.
-
#get_rotation_override(params = {}) ⇒ Types::GetRotationOverrideResult
Retrieves information about an override to an on-call rotation.
-
#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_page_resolutions(params = {}) ⇒ Types::ListPageResolutionsResult
Returns the resolution path of an engagement.
-
#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_preview_rotation_shifts(params = {}) ⇒ Types::ListPreviewRotationShiftsResult
Returns a list of shifts based on rotation configuration parameters.
-
#list_rotation_overrides(params = {}) ⇒ Types::ListRotationOverridesResult
Retrieves a list of overrides currently specified for an on-call rotation.
-
#list_rotation_shifts(params = {}) ⇒ Types::ListRotationShiftsResult
Returns a list of shifts generated by an existing rotation in the system.
-
#list_rotations(params = {}) ⇒ Types::ListRotationsResult
Retrieves a list of on-call rotations.
-
#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.
-
#update_rotation(params = {}) ⇒ Struct
Updates the information specified for an on-call rotation.
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.
419 420 421 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 419 def initialize(*args) super end |
Instance Method Details
#accept_page(params = {}) ⇒ Struct
Used to acknowledge an engagement to a contact channel during an incident.
472 473 474 475 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 472 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.
500 501 502 503 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 500 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.
583 584 585 586 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 583 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.
655 656 657 658 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 655 def create_contact_channel(params = {}, = {}) req = build_request(:create_contact_channel, params) req.send_request() end |
#create_rotation(params = {}) ⇒ Types::CreateRotationResult
Creates a rotation in an on-call schedule.
780 781 782 783 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 780 def create_rotation(params = {}, = {}) req = build_request(:create_rotation, params) req.send_request() end |
#create_rotation_override(params = {}) ⇒ Types::CreateRotationOverrideResult
Creates an override for a rotation in an on-call schedule.
830 831 832 833 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 830 def create_rotation_override(params = {}, = {}) req = build_request(:create_rotation_override, 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.
854 855 856 857 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 854 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.
880 881 882 883 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 880 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.
906 907 908 909 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 906 def delete_contact_channel(params = {}, = {}) req = build_request(:delete_contact_channel, params) req.send_request() end |
#delete_rotation(params = {}) ⇒ Struct
Deletes a rotation from the system. If a rotation belongs to more than one on-call schedule, this operation deletes it from all of them.
929 930 931 932 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 929 def delete_rotation(params = {}, = {}) req = build_request(:delete_rotation, params) req.send_request() end |
#delete_rotation_override(params = {}) ⇒ Struct
Deletes an existing override for an on-call rotation.
956 957 958 959 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 956 def delete_rotation_override(params = {}, = {}) req = build_request(:delete_rotation_override, 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.
1005 1006 1007 1008 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1005 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.
1055 1056 1057 1058 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1055 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.
1099 1100 1101 1102 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1099 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.
1169 1170 1171 1172 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1169 def get_contact_policy(params = {}, = {}) req = build_request(:get_contact_policy, params) req.send_request() end |
#get_rotation(params = {}) ⇒ Types::GetRotationResult
Retrieves information about an on-call rotation.
1227 1228 1229 1230 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1227 def get_rotation(params = {}, = {}) req = build_request(:get_rotation, params) req.send_request() end |
#get_rotation_override(params = {}) ⇒ Types::GetRotationOverrideResult
Retrieves information about an override to an on-call rotation.
1272 1273 1274 1275 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1272 def get_rotation_override(params = {}, = {}) req = build_request(:get_rotation_override, 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.
1318 1319 1320 1321 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1318 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.
1369 1370 1371 1372 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1369 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.
1423 1424 1425 1426 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1423 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.
1469 1470 1471 1472 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1469 def list_page_receipts(params = {}, = {}) req = build_request(:list_page_receipts, params) req.send_request() end |
#list_page_resolutions(params = {}) ⇒ Types::ListPageResolutionsResult
Returns the resolution path of an engagement. For example, the escalation plan engaged in an incident might target an on-call schedule that includes several contacts in a rotation, but just one contact on-call when the incident starts. The resolution path indicates the hierarchy of escalation plan > on-call schedule > contact.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1515 1516 1517 1518 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1515 def list_page_resolutions(params = {}, = {}) req = build_request(:list_page_resolutions, 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.
1565 1566 1567 1568 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1565 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.
1615 1616 1617 1618 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1615 def list_pages_by_engagement(params = {}, = {}) req = build_request(:list_pages_by_engagement, params) req.send_request() end |
#list_preview_rotation_shifts(params = {}) ⇒ Types::ListPreviewRotationShiftsResult
Returns a list of shifts based on rotation configuration parameters.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1746 1747 1748 1749 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1746 def list_preview_rotation_shifts(params = {}, = {}) req = build_request(:list_preview_rotation_shifts, params) req.send_request() end |
#list_rotation_overrides(params = {}) ⇒ Types::ListRotationOverridesResult
Retrieves a list of overrides currently specified for an on-call rotation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1806 1807 1808 1809 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1806 def list_rotation_overrides(params = {}, = {}) req = build_request(:list_rotation_overrides, params) req.send_request() end |
#list_rotation_shifts(params = {}) ⇒ Types::ListRotationShiftsResult
Returns a list of shifts generated by an existing rotation in the system.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1867 1868 1869 1870 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1867 def list_rotation_shifts(params = {}, = {}) req = build_request(:list_rotation_shifts, params) req.send_request() end |
#list_rotations(params = {}) ⇒ Types::ListRotationsResult
Retrieves a list of on-call rotations.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1937 1938 1939 1940 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1937 def list_rotations(params = {}, = {}) req = build_request(:list_rotations, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResult
Lists the tags of an escalation plan or contact.
1967 1968 1969 1970 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1967 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.
2001 2002 2003 2004 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 2001 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.
2026 2027 2028 2029 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 2026 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.
2091 2092 2093 2094 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 2091 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.
2118 2119 2120 2121 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 2118 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.
2150 2151 2152 2153 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 2150 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from the specified resource.
2176 2177 2178 2179 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 2176 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.
2228 2229 2230 2231 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 2228 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.
2262 2263 2264 2265 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 2262 def update_contact_channel(params = {}, = {}) req = build_request(:update_contact_channel, params) req.send_request() end |
#update_rotation(params = {}) ⇒ Struct
Updates the information specified for an on-call rotation.
2359 2360 2361 2362 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 2359 def update_rotation(params = {}, = {}) req = build_request(:update_rotation, params) req.send_request() end |