GSP
Quick Navigator
Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::SSMContacts(3) User Contributed Perl Documentation Paws::SSMContacts(3)

Paws::SSMContacts - Perl Interface to AWS AWS Systems Manager Incident Manager Contacts

  use Paws;
  my $obj = Paws->service('SSMContacts');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03>

[ContactChannelId => Str]
[Note => Str]

Each argument is described in detail in: Paws::SSMContacts::AcceptPage

Returns: a Paws::SSMContacts::AcceptPageResult instance

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

Each argument is described in detail in: Paws::SSMContacts::ActivateContactChannel

Returns: a Paws::SSMContacts::ActivateContactChannelResult instance

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

[DisplayName => Str]
[IdempotencyToken => Str]
[Tags => ArrayRef[Paws::SSMContacts::Tag]]

Each argument is described in detail in: Paws::SSMContacts::CreateContact

Returns: a Paws::SSMContacts::CreateContactResult instance

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.

[DeferActivation => Bool]
[IdempotencyToken => Str]

Each argument is described in detail in: Paws::SSMContacts::CreateContactChannel

Returns: a Paws::SSMContacts::CreateContactChannelResult instance

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

Each argument is described in detail in: Paws::SSMContacts::DeactivateContactChannel

Returns: a Paws::SSMContacts::DeactivateContactChannelResult instance

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

Each argument is described in detail in: Paws::SSMContacts::DeleteContact

Returns: a Paws::SSMContacts::DeleteContactResult instance

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.

Each argument is described in detail in: Paws::SSMContacts::DeleteContactChannel

Returns: a Paws::SSMContacts::DeleteContactChannelResult instance

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.

Each argument is described in detail in: Paws::SSMContacts::DescribeEngagement

Returns: a Paws::SSMContacts::DescribeEngagementResult instance

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.

Each argument is described in detail in: Paws::SSMContacts::DescribePage

Returns: a Paws::SSMContacts::DescribePageResult instance

Lists details of the engagement to a contact channel.

Each argument is described in detail in: Paws::SSMContacts::GetContact

Returns: a Paws::SSMContacts::GetContactResult instance

Retrieves information about the specified contact or escalation plan.

Each argument is described in detail in: Paws::SSMContacts::GetContactChannel

Returns: a Paws::SSMContacts::GetContactChannelResult instance

List details about a specific contact channel.

Each argument is described in detail in: Paws::SSMContacts::GetContactPolicy

Returns: a Paws::SSMContacts::GetContactPolicyResult instance

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

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSMContacts::ListContactChannels

Returns: a Paws::SSMContacts::ListContactChannelsResult instance

Lists all contact channels for the specified contact.

[AliasPrefix => Str]
[MaxResults => Int]
[NextToken => Str]
[Type => Str]

Each argument is described in detail in: Paws::SSMContacts::ListContacts

Returns: a Paws::SSMContacts::ListContactsResult instance

Lists all contacts and escalation plans in Incident Manager.

[IncidentId => Str]
[MaxResults => Int]
[NextToken => Str]
[TimeRangeValue => Paws::SSMContacts::TimeRange]

Each argument is described in detail in: Paws::SSMContacts::ListEngagements

Returns: a Paws::SSMContacts::ListEngagementsResult instance

Lists all engagements that have happened in an incident.

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSMContacts::ListPageReceipts

Returns: a Paws::SSMContacts::ListPageReceiptsResult instance

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

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSMContacts::ListPagesByContact

Returns: a Paws::SSMContacts::ListPagesByContactResult instance

Lists the engagements to a contact's contact channels.

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSMContacts::ListPagesByEngagement

Returns: a Paws::SSMContacts::ListPagesByEngagementResult instance

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

Each argument is described in detail in: Paws::SSMContacts::ListTagsForResource

Returns: a Paws::SSMContacts::ListTagsForResourceResult instance

Lists the tags of an escalation plan or contact.

Each argument is described in detail in: Paws::SSMContacts::PutContactPolicy

Returns: a Paws::SSMContacts::PutContactPolicyResult instance

Adds a resource to the specified contact or escalation plan.

Each argument is described in detail in: Paws::SSMContacts::SendActivationCode

Returns: a Paws::SSMContacts::SendActivationCodeResult instance

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" action. Incident Manager can't engage a contact channel until it has been activated.

[IdempotencyToken => Str]
[IncidentId => Str]
[PublicContent => Str]
[PublicSubject => Str]

Each argument is described in detail in: Paws::SSMContacts::StartEngagement

Returns: a Paws::SSMContacts::StartEngagementResult instance

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

[Reason => Str]

Each argument is described in detail in: Paws::SSMContacts::StopEngagement

Returns: a Paws::SSMContacts::StopEngagementResult instance

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

Each argument is described in detail in: Paws::SSMContacts::TagResource

Returns: a Paws::SSMContacts::TagResourceResult instance

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

Each argument is described in detail in: Paws::SSMContacts::UntagResource

Returns: a Paws::SSMContacts::UntagResourceResult instance

Removes tags from the specified resource.

[DisplayName => Str]
[Plan => Paws::SSMContacts::Plan]

Each argument is described in detail in: Paws::SSMContacts::UpdateContact

Returns: a Paws::SSMContacts::UpdateContactResult instance

Updates the contact or escalation plan specified.

[DeliveryAddress => Paws::SSMContacts::ContactChannelAddress]
[Name => Str]

Each argument is described in detail in: Paws::SSMContacts::UpdateContactChannel

Returns: a Paws::SSMContacts::UpdateContactChannelResult instance

Updates a contact's contact channel.

Paginator methods are helpers that repetively call methods that return partial results

If passed a sub as first parameter, it will call the sub for each element found in :

 - ContactChannels, passing the object as the first parameter, and the string 'ContactChannels' as the second parameter

If not, it will return a a Paws::SSMContacts::ListContactChannelsResult instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - Contacts, passing the object as the first parameter, and the string 'Contacts' as the second parameter

If not, it will return a a Paws::SSMContacts::ListContactsResult instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - Engagements, passing the object as the first parameter, and the string 'Engagements' as the second parameter

If not, it will return a a Paws::SSMContacts::ListEngagementsResult instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - Receipts, passing the object as the first parameter, and the string 'Receipts' as the second parameter

If not, it will return a a Paws::SSMContacts::ListPageReceiptsResult instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - Pages, passing the object as the first parameter, and the string 'Pages' as the second parameter

If not, it will return a a Paws::SSMContacts::ListPagesByContactResult instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - Pages, passing the object as the first parameter, and the string 'Pages' as the second parameter

If not, it will return a a Paws::SSMContacts::ListPagesByEngagementResult instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

This service class forms part of Paws

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>

2022-06-01 perl v5.40.2
Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.