AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Implementation for accessing SSMContacts

Systems Manager Incident Manager is an incident management console designed to help users mitigate and recover from incidents affecting their Amazon Web Services-hosted applications. An incident is any unplanned interruption or reduction in quality of services.

Incident Manager increases incident resolution by notifying responders of impact, highlighting relevant troubleshooting data, and providing collaboration tools to get services back up and running. To achieve the primary goal of reducing the time-to-resolution of critical incidents, Incident Manager automates response plans and enables responder team escalation.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.SSMContacts.AmazonSSMContactsClient

Namespace: Amazon.SSMContacts
Assembly: AWSSDK.SSMContacts.dll
Version: 3.x.y.z

Syntax

C# 
public class AmazonSSMContactsClient : AmazonServiceClient
         IAmazonService, IAmazonSSMContacts, IDisposable

The AmazonSSMContactsClient type exposes the following members

Constructors

NameDescription
Public Method AmazonSSMContactsClient()

Constructs AmazonSSMContactsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. 

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>

Public Method AmazonSSMContactsClient(RegionEndpoint)

Constructs AmazonSSMContactsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. 

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>

Public Method AmazonSSMContactsClient(AmazonSSMContactsConfig)

Constructs AmazonSSMContactsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. 

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>

Public Method AmazonSSMContactsClient(AWSCredentials)

Constructs AmazonSSMContactsClient with AWS Credentials

Public Method AmazonSSMContactsClient(AWSCredentials, RegionEndpoint)

Constructs AmazonSSMContactsClient with AWS Credentials

Public Method AmazonSSMContactsClient(AWSCredentials, AmazonSSMContactsConfig)

Constructs AmazonSSMContactsClient with AWS Credentials and an AmazonSSMContactsClient Configuration object.

Public Method AmazonSSMContactsClient(string, string)

Constructs AmazonSSMContactsClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonSSMContactsClient(string, string, RegionEndpoint)

Constructs AmazonSSMContactsClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonSSMContactsClient(string, string, AmazonSSMContactsConfig)

Constructs AmazonSSMContactsClient with AWS Access Key ID, AWS Secret Key and an AmazonSSMContactsClient Configuration object.

Public Method AmazonSSMContactsClient(string, string, string)

Constructs AmazonSSMContactsClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonSSMContactsClient(string, string, string, RegionEndpoint)

Constructs AmazonSSMContactsClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonSSMContactsClient(string, string, string, AmazonSSMContactsConfig)

Constructs AmazonSSMContactsClient with AWS Access Key ID, AWS Secret Key and an AmazonSSMContactsClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.
Public Property Paginators Amazon.SSMContacts.Model.ISSMContactsPaginatorFactory

Paginators for the service

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AcceptPage(AcceptPageRequest)

Used to acknowledge an engagement to a contact channel during an incident.

Public Method AcceptPageAsync(AcceptPageRequest, CancellationToken)

Used to acknowledge an engagement to a contact channel during an incident.

Public Method ActivateContactChannel(ActivateContactChannelRequest)

Activates a contact's contact channel. Incident Manager can't engage a contact until the contact channel has been activated.

Public Method ActivateContactChannelAsync(ActivateContactChannelRequest, CancellationToken)

Activates a contact's contact channel. Incident Manager can't engage a contact until the contact channel has been activated.

Public Method CreateContact(CreateContactRequest)

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.

Public Method CreateContactAsync(CreateContactRequest, CancellationToken)

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.

Public Method CreateContactChannel(CreateContactChannelRequest)

A contact channel is the method that Incident Manager uses to engage your contact.

Public Method CreateContactChannelAsync(CreateContactChannelRequest, CancellationToken)

A contact channel is the method that Incident Manager uses to engage your contact.

Public Method CreateRotation(CreateRotationRequest)

Creates a rotation in an on-call schedule.

Public Method CreateRotationAsync(CreateRotationRequest, CancellationToken)

Creates a rotation in an on-call schedule.

Public Method CreateRotationOverride(CreateRotationOverrideRequest)

Creates an override for a rotation in an on-call schedule.

Public Method CreateRotationOverrideAsync(CreateRotationOverrideRequest, CancellationToken)

Creates an override for a rotation in an on-call schedule.

Public Method DeactivateContactChannel(DeactivateContactChannelRequest)

To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.

Public Method DeactivateContactChannelAsync(DeactivateContactChannelRequest, CancellationToken)

To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.

Public Method DeleteContact(DeleteContactRequest)

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.

Public Method DeleteContactAsync(DeleteContactRequest, CancellationToken)

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.

Public Method DeleteContactChannel(DeleteContactChannelRequest)

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.

Public Method DeleteContactChannelAsync(DeleteContactChannelRequest, CancellationToken)

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.

Public Method DeleteRotation(DeleteRotationRequest)

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.

Public Method DeleteRotationAsync(DeleteRotationRequest, CancellationToken)

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.

Public Method DeleteRotationOverride(DeleteRotationOverrideRequest)

Deletes an existing override for an on-call rotation.

Public Method DeleteRotationOverrideAsync(DeleteRotationOverrideRequest, CancellationToken)

Deletes an existing override for an on-call rotation.

Public Method DescribeEngagement(DescribeEngagementRequest)

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.

Public Method DescribeEngagementAsync(DescribeEngagementRequest, CancellationToken)

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.

Public Method DescribePage(DescribePageRequest)

Lists details of the engagement to a contact channel.

Public Method DescribePageAsync(DescribePageRequest, CancellationToken)

Lists details of the engagement to a contact channel.

Public Method DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method GetContact(GetContactRequest)

Retrieves information about the specified contact or escalation plan.

Public Method GetContactAsync(GetContactRequest, CancellationToken)

Retrieves information about the specified contact or escalation plan.

Public Method GetContactChannel(GetContactChannelRequest)

List details about a specific contact channel.

Public Method GetContactChannelAsync(GetContactChannelRequest, CancellationToken)

List details about a specific contact channel.

Public Method GetContactPolicy(GetContactPolicyRequest)

Retrieves the resource policies attached to the specified contact or escalation plan.

Public Method GetContactPolicyAsync(GetContactPolicyRequest, CancellationToken)

Retrieves the resource policies attached to the specified contact or escalation plan.

Public Method GetRotation(GetRotationRequest)

Retrieves information about an on-call rotation.

Public Method GetRotationAsync(GetRotationRequest, CancellationToken)

Retrieves information about an on-call rotation.

Public Method GetRotationOverride(GetRotationOverrideRequest)

Retrieves information about an override to an on-call rotation.

Public Method GetRotationOverrideAsync(GetRotationOverrideRequest, CancellationToken)

Retrieves information about an override to an on-call rotation.

Public Method ListContactChannels(ListContactChannelsRequest)

Lists all contact channels for the specified contact.

Public Method ListContactChannelsAsync(ListContactChannelsRequest, CancellationToken)

Lists all contact channels for the specified contact.

Public Method ListContacts(ListContactsRequest)

Lists all contacts and escalation plans in Incident Manager.

Public Method ListContactsAsync(ListContactsRequest, CancellationToken)

Lists all contacts and escalation plans in Incident Manager.

Public Method ListEngagements(ListEngagementsRequest)

Lists all engagements that have happened in an incident.

Public Method ListEngagementsAsync(ListEngagementsRequest, CancellationToken)

Lists all engagements that have happened in an incident.

Public Method ListPageReceipts(ListPageReceiptsRequest)

Lists all of the engagements to contact channels that have been acknowledged.

Public Method ListPageReceiptsAsync(ListPageReceiptsRequest, CancellationToken)

Lists all of the engagements to contact channels that have been acknowledged.

Public Method ListPageResolutions(ListPageResolutionsRequest)

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.

Public Method ListPageResolutionsAsync(ListPageResolutionsRequest, CancellationToken)

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.

Public Method ListPagesByContact(ListPagesByContactRequest)

Lists the engagements to a contact's contact channels.

Public Method ListPagesByContactAsync(ListPagesByContactRequest, CancellationToken)

Lists the engagements to a contact's contact channels.

Public Method ListPagesByEngagement(ListPagesByEngagementRequest)

Lists the engagements to contact channels that occurred by engaging a contact.

Public Method ListPagesByEngagementAsync(ListPagesByEngagementRequest, CancellationToken)

Lists the engagements to contact channels that occurred by engaging a contact.

Public Method ListPreviewRotationShifts(ListPreviewRotationShiftsRequest)

Returns a list of shifts based on rotation configuration parameters.

The Incident Manager primarily uses this operation to populate the Preview calendar. It is not typically run by end users.

Public Method ListPreviewRotationShiftsAsync(ListPreviewRotationShiftsRequest, CancellationToken)

Returns a list of shifts based on rotation configuration parameters.

The Incident Manager primarily uses this operation to populate the Preview calendar. It is not typically run by end users.

Public Method ListRotationOverrides(ListRotationOverridesRequest)

Retrieves a list of overrides currently specified for an on-call rotation.

Public Method ListRotationOverridesAsync(ListRotationOverridesRequest, CancellationToken)

Retrieves a list of overrides currently specified for an on-call rotation.

Public Method ListRotations(ListRotationsRequest)

Retrieves a list of on-call rotations.

Public Method ListRotationsAsync(ListRotationsRequest, CancellationToken)

Retrieves a list of on-call rotations.

Public Method ListRotationShifts(ListRotationShiftsRequest)

Returns a list of shifts generated by an existing rotation in the system.

Public Method ListRotationShiftsAsync(ListRotationShiftsRequest, CancellationToken)

Returns a list of shifts generated by an existing rotation in the system.

Public Method ListTagsForResource(ListTagsForResourceRequest)

Lists the tags of an escalation plan or contact.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

Lists the tags of an escalation plan or contact.

Public Method PutContactPolicy(PutContactPolicyRequest)

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.

Public Method PutContactPolicyAsync(PutContactPolicyRequest, CancellationToken)

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.

Public Method SendActivationCode(SendActivationCodeRequest)

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.

Public Method SendActivationCodeAsync(SendActivationCodeRequest, CancellationToken)

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.

Public Method StartEngagement(StartEngagementRequest)

Starts an engagement to a contact or escalation plan. The engagement engages each contact specified in the incident.

Public Method StartEngagementAsync(StartEngagementRequest, CancellationToken)

Starts an engagement to a contact or escalation plan. The engagement engages each contact specified in the incident.

Public Method StopEngagement(StopEngagementRequest)

Stops an engagement before it finishes the final stage of the escalation plan or engagement plan. Further contacts aren't engaged.

Public Method StopEngagementAsync(StopEngagementRequest, CancellationToken)

Stops an engagement before it finishes the final stage of the escalation plan or engagement plan. Further contacts aren't engaged.

Public Method TagResource(TagResourceRequest)

Tags a contact or escalation plan. You can tag only contacts and escalation plans in the first region of your replication set.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

Tags a contact or escalation plan. You can tag only contacts and escalation plans in the first region of your replication set.

Public Method UntagResource(UntagResourceRequest)

Removes tags from the specified resource.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Removes tags from the specified resource.

Public Method UpdateContact(UpdateContactRequest)

Updates the contact or escalation plan specified.

Public Method UpdateContactAsync(UpdateContactRequest, CancellationToken)

Updates the contact or escalation plan specified.

Public Method UpdateContactChannel(UpdateContactChannelRequest)

Updates a contact's contact channel.

Public Method UpdateContactChannelAsync(UpdateContactChannelRequest, CancellationToken)

Updates a contact's contact channel.

Public Method UpdateRotation(UpdateRotationRequest)

Updates the information specified for an on-call rotation.

Public Method UpdateRotationAsync(UpdateRotationRequest, CancellationToken)

Updates the information specified for an on-call rotation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5