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.
453 454 455 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 453 def initialize(*args) super end |
Instance Method Details
#accept_page(params = {}) ⇒ Struct
Used to acknowledge an engagement to a contact channel during an incident.
506 507 508 509 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 506 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.
534 535 536 537 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 534 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.
617 618 619 620 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 617 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.
689 690 691 692 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 689 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.
814 815 816 817 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 814 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.
864 865 866 867 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 864 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.
888 889 890 891 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 888 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.
914 915 916 917 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 914 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.
940 941 942 943 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 940 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.
963 964 965 966 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 963 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.
990 991 992 993 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 990 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.
1039 1040 1041 1042 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1039 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.
1089 1090 1091 1092 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1089 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.
1133 1134 1135 1136 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1133 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.
1172 1173 1174 1175 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1172 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.
1203 1204 1205 1206 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1203 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.
1261 1262 1263 1264 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1261 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.
1306 1307 1308 1309 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1306 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.
1352 1353 1354 1355 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1352 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.
1403 1404 1405 1406 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1403 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.
1457 1458 1459 1460 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1457 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.
1503 1504 1505 1506 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1503 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.
1549 1550 1551 1552 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1549 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.
1599 1600 1601 1602 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1599 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.
1649 1650 1651 1652 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1649 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.
1780 1781 1782 1783 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1780 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.
1840 1841 1842 1843 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1840 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.
1901 1902 1903 1904 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1901 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.
1971 1972 1973 1974 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1971 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.
2001 2002 2003 2004 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 2001 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.
2035 2036 2037 2038 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 2035 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.
2060 2061 2062 2063 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 2060 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.
2125 2126 2127 2128 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 2125 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.
2152 2153 2154 2155 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 2152 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.
2184 2185 2186 2187 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 2184 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from the specified resource.
2210 2211 2212 2213 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 2210 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.
2262 2263 2264 2265 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 2262 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.
2296 2297 2298 2299 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 2296 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.
2393 2394 2395 2396 |
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 2393 def update_rotation(params = {}, = {}) req = build_request(:update_rotation, params) req.send_request() end |