| 1 | package Paws::SSMContacts; | ||
| 2 | use Moose; | ||
| 3 | sub service { 'ssm-contacts' } | ||
| 4 | sub signing_name { 'ssm-contacts' } | ||
| 5 | sub version { '2021-05-03' } | ||
| 6 | sub target_prefix { 'SSMContacts' } | ||
| 7 | sub json_version { "1.1" } | ||
| 8 | has max_attempts => (is => 'ro', isa => 'Int', default => 5); | ||
| 9 | has retry => (is => 'ro', isa => 'HashRef', default => sub { | ||
| 10 | { base => 'rand', type => 'exponential', growth_factor => 2 } | ||
| 11 | }); | ||
| 12 | has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [ | ||
| 13 | ] }); | ||
| 14 | |||
| 15 | with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::JsonCaller'; | ||
| 16 | |||
| 17 | |||
| 18 | sub AcceptPage { | ||
| 19 | my $self = shift; | ||
| 20 | my $call_object = $self->new_with_coercions('Paws::SSMContacts::AcceptPage', @_); | ||
| 21 | return $self->caller->do_call($self, $call_object); | ||
| 22 | } | ||
| 23 | sub ActivateContactChannel { | ||
| 24 | my $self = shift; | ||
| 25 | my $call_object = $self->new_with_coercions('Paws::SSMContacts::ActivateContactChannel', @_); | ||
| 26 | return $self->caller->do_call($self, $call_object); | ||
| 27 | } | ||
| 28 | sub CreateContact { | ||
| 29 | my $self = shift; | ||
| 30 | my $call_object = $self->new_with_coercions('Paws::SSMContacts::CreateContact', @_); | ||
| 31 | return $self->caller->do_call($self, $call_object); | ||
| 32 | } | ||
| 33 | sub CreateContactChannel { | ||
| 34 | my $self = shift; | ||
| 35 | my $call_object = $self->new_with_coercions('Paws::SSMContacts::CreateContactChannel', @_); | ||
| 36 | return $self->caller->do_call($self, $call_object); | ||
| 37 | } | ||
| 38 | sub DeactivateContactChannel { | ||
| 39 | my $self = shift; | ||
| 40 | my $call_object = $self->new_with_coercions('Paws::SSMContacts::DeactivateContactChannel', @_); | ||
| 41 | return $self->caller->do_call($self, $call_object); | ||
| 42 | } | ||
| 43 | sub DeleteContact { | ||
| 44 | my $self = shift; | ||
| 45 | my $call_object = $self->new_with_coercions('Paws::SSMContacts::DeleteContact', @_); | ||
| 46 | return $self->caller->do_call($self, $call_object); | ||
| 47 | } | ||
| 48 | sub DeleteContactChannel { | ||
| 49 | my $self = shift; | ||
| 50 | my $call_object = $self->new_with_coercions('Paws::SSMContacts::DeleteContactChannel', @_); | ||
| 51 | return $self->caller->do_call($self, $call_object); | ||
| 52 | } | ||
| 53 | sub DescribeEngagement { | ||
| 54 | my $self = shift; | ||
| 55 | my $call_object = $self->new_with_coercions('Paws::SSMContacts::DescribeEngagement', @_); | ||
| 56 | return $self->caller->do_call($self, $call_object); | ||
| 57 | } | ||
| 58 | sub DescribePage { | ||
| 59 | my $self = shift; | ||
| 60 | my $call_object = $self->new_with_coercions('Paws::SSMContacts::DescribePage', @_); | ||
| 61 | return $self->caller->do_call($self, $call_object); | ||
| 62 | } | ||
| 63 | sub GetContact { | ||
| 64 | my $self = shift; | ||
| 65 | my $call_object = $self->new_with_coercions('Paws::SSMContacts::GetContact', @_); | ||
| 66 | return $self->caller->do_call($self, $call_object); | ||
| 67 | } | ||
| 68 | sub GetContactChannel { | ||
| 69 | my $self = shift; | ||
| 70 | my $call_object = $self->new_with_coercions('Paws::SSMContacts::GetContactChannel', @_); | ||
| 71 | return $self->caller->do_call($self, $call_object); | ||
| 72 | } | ||
| 73 | sub GetContactPolicy { | ||
| 74 | my $self = shift; | ||
| 75 | my $call_object = $self->new_with_coercions('Paws::SSMContacts::GetContactPolicy', @_); | ||
| 76 | return $self->caller->do_call($self, $call_object); | ||
| 77 | } | ||
| 78 | sub ListContactChannels { | ||
| 79 | my $self = shift; | ||
| 80 | my $call_object = $self->new_with_coercions('Paws::SSMContacts::ListContactChannels', @_); | ||
| 81 | return $self->caller->do_call($self, $call_object); | ||
| 82 | } | ||
| 83 | sub ListContacts { | ||
| 84 | my $self = shift; | ||
| 85 | my $call_object = $self->new_with_coercions('Paws::SSMContacts::ListContacts', @_); | ||
| 86 | return $self->caller->do_call($self, $call_object); | ||
| 87 | } | ||
| 88 | sub ListEngagements { | ||
| 89 | my $self = shift; | ||
| 90 | my $call_object = $self->new_with_coercions('Paws::SSMContacts::ListEngagements', @_); | ||
| 91 | return $self->caller->do_call($self, $call_object); | ||
| 92 | } | ||
| 93 | sub ListPageReceipts { | ||
| 94 | my $self = shift; | ||
| 95 | my $call_object = $self->new_with_coercions('Paws::SSMContacts::ListPageReceipts', @_); | ||
| 96 | return $self->caller->do_call($self, $call_object); | ||
| 97 | } | ||
| 98 | sub ListPagesByContact { | ||
| 99 | my $self = shift; | ||
| 100 | my $call_object = $self->new_with_coercions('Paws::SSMContacts::ListPagesByContact', @_); | ||
| 101 | return $self->caller->do_call($self, $call_object); | ||
| 102 | } | ||
| 103 | sub ListPagesByEngagement { | ||
| 104 | my $self = shift; | ||
| 105 | my $call_object = $self->new_with_coercions('Paws::SSMContacts::ListPagesByEngagement', @_); | ||
| 106 | return $self->caller->do_call($self, $call_object); | ||
| 107 | } | ||
| 108 | sub ListTagsForResource { | ||
| 109 | my $self = shift; | ||
| 110 | my $call_object = $self->new_with_coercions('Paws::SSMContacts::ListTagsForResource', @_); | ||
| 111 | return $self->caller->do_call($self, $call_object); | ||
| 112 | } | ||
| 113 | sub PutContactPolicy { | ||
| 114 | my $self = shift; | ||
| 115 | my $call_object = $self->new_with_coercions('Paws::SSMContacts::PutContactPolicy', @_); | ||
| 116 | return $self->caller->do_call($self, $call_object); | ||
| 117 | } | ||
| 118 | sub SendActivationCode { | ||
| 119 | my $self = shift; | ||
| 120 | my $call_object = $self->new_with_coercions('Paws::SSMContacts::SendActivationCode', @_); | ||
| 121 | return $self->caller->do_call($self, $call_object); | ||
| 122 | } | ||
| 123 | sub StartEngagement { | ||
| 124 | my $self = shift; | ||
| 125 | my $call_object = $self->new_with_coercions('Paws::SSMContacts::StartEngagement', @_); | ||
| 126 | return $self->caller->do_call($self, $call_object); | ||
| 127 | } | ||
| 128 | sub StopEngagement { | ||
| 129 | my $self = shift; | ||
| 130 | my $call_object = $self->new_with_coercions('Paws::SSMContacts::StopEngagement', @_); | ||
| 131 | return $self->caller->do_call($self, $call_object); | ||
| 132 | } | ||
| 133 | sub TagResource { | ||
| 134 | my $self = shift; | ||
| 135 | my $call_object = $self->new_with_coercions('Paws::SSMContacts::TagResource', @_); | ||
| 136 | return $self->caller->do_call($self, $call_object); | ||
| 137 | } | ||
| 138 | sub UntagResource { | ||
| 139 | my $self = shift; | ||
| 140 | my $call_object = $self->new_with_coercions('Paws::SSMContacts::UntagResource', @_); | ||
| 141 | return $self->caller->do_call($self, $call_object); | ||
| 142 | } | ||
| 143 | sub UpdateContact { | ||
| 144 | my $self = shift; | ||
| 145 | my $call_object = $self->new_with_coercions('Paws::SSMContacts::UpdateContact', @_); | ||
| 146 | return $self->caller->do_call($self, $call_object); | ||
| 147 | } | ||
| 148 | sub UpdateContactChannel { | ||
| 149 | my $self = shift; | ||
| 150 | my $call_object = $self->new_with_coercions('Paws::SSMContacts::UpdateContactChannel', @_); | ||
| 151 | return $self->caller->do_call($self, $call_object); | ||
| 152 | } | ||
| 153 | |||
| 154 | sub ListAllContactChannels { | ||
| 155 | my $self = shift; | ||
| 156 | |||
| 157 | my $callback = shift @_ if (ref($_[0]) eq 'CODE'); | ||
| 158 | my $result = $self->ListContactChannels(@_); | ||
| 159 | my $next_result = $result; | ||
| 160 | |||
| 161 | if (not defined $callback) { | ||
| 162 | while ($next_result->NextToken) { | ||
| 163 | $next_result = $self->ListContactChannels(@_, NextToken => $next_result->NextToken); | ||
| 164 | push @{ $result->ContactChannels }, @{ $next_result->ContactChannels }; | ||
| 165 | } | ||
| 166 | return $result; | ||
| 167 | } else { | ||
| 168 | while ($result->NextToken) { | ||
| 169 | $callback->($_ => 'ContactChannels') foreach (@{ $result->ContactChannels }); | ||
| 170 | $result = $self->ListContactChannels(@_, NextToken => $result->NextToken); | ||
| 171 | } | ||
| 172 | $callback->($_ => 'ContactChannels') foreach (@{ $result->ContactChannels }); | ||
| 173 | } | ||
| 174 | |||
| 175 | return undef | ||
| 176 | } | ||
| 177 | sub ListAllContacts { | ||
| 178 | my $self = shift; | ||
| 179 | |||
| 180 | my $callback = shift @_ if (ref($_[0]) eq 'CODE'); | ||
| 181 | my $result = $self->ListContacts(@_); | ||
| 182 | my $next_result = $result; | ||
| 183 | |||
| 184 | if (not defined $callback) { | ||
| 185 | while ($next_result->NextToken) { | ||
| 186 | $next_result = $self->ListContacts(@_, NextToken => $next_result->NextToken); | ||
| 187 | push @{ $result->Contacts }, @{ $next_result->Contacts }; | ||
| 188 | } | ||
| 189 | return $result; | ||
| 190 | } else { | ||
| 191 | while ($result->NextToken) { | ||
| 192 | $callback->($_ => 'Contacts') foreach (@{ $result->Contacts }); | ||
| 193 | $result = $self->ListContacts(@_, NextToken => $result->NextToken); | ||
| 194 | } | ||
| 195 | $callback->($_ => 'Contacts') foreach (@{ $result->Contacts }); | ||
| 196 | } | ||
| 197 | |||
| 198 | return undef | ||
| 199 | } | ||
| 200 | sub ListAllEngagements { | ||
| 201 | my $self = shift; | ||
| 202 | |||
| 203 | my $callback = shift @_ if (ref($_[0]) eq 'CODE'); | ||
| 204 | my $result = $self->ListEngagements(@_); | ||
| 205 | my $next_result = $result; | ||
| 206 | |||
| 207 | if (not defined $callback) { | ||
| 208 | while ($next_result->NextToken) { | ||
| 209 | $next_result = $self->ListEngagements(@_, NextToken => $next_result->NextToken); | ||
| 210 | push @{ $result->Engagements }, @{ $next_result->Engagements }; | ||
| 211 | } | ||
| 212 | return $result; | ||
| 213 | } else { | ||
| 214 | while ($result->NextToken) { | ||
| 215 | $callback->($_ => 'Engagements') foreach (@{ $result->Engagements }); | ||
| 216 | $result = $self->ListEngagements(@_, NextToken => $result->NextToken); | ||
| 217 | } | ||
| 218 | $callback->($_ => 'Engagements') foreach (@{ $result->Engagements }); | ||
| 219 | } | ||
| 220 | |||
| 221 | return undef | ||
| 222 | } | ||
| 223 | sub ListAllPageReceipts { | ||
| 224 | my $self = shift; | ||
| 225 | |||
| 226 | my $callback = shift @_ if (ref($_[0]) eq 'CODE'); | ||
| 227 | my $result = $self->ListPageReceipts(@_); | ||
| 228 | my $next_result = $result; | ||
| 229 | |||
| 230 | if (not defined $callback) { | ||
| 231 | while ($next_result->NextToken) { | ||
| 232 | $next_result = $self->ListPageReceipts(@_, NextToken => $next_result->NextToken); | ||
| 233 | push @{ $result->Receipts }, @{ $next_result->Receipts }; | ||
| 234 | } | ||
| 235 | return $result; | ||
| 236 | } else { | ||
| 237 | while ($result->NextToken) { | ||
| 238 | $callback->($_ => 'Receipts') foreach (@{ $result->Receipts }); | ||
| 239 | $result = $self->ListPageReceipts(@_, NextToken => $result->NextToken); | ||
| 240 | } | ||
| 241 | $callback->($_ => 'Receipts') foreach (@{ $result->Receipts }); | ||
| 242 | } | ||
| 243 | |||
| 244 | return undef | ||
| 245 | } | ||
| 246 | sub ListAllPagesByContact { | ||
| 247 | my $self = shift; | ||
| 248 | |||
| 249 | my $callback = shift @_ if (ref($_[0]) eq 'CODE'); | ||
| 250 | my $result = $self->ListPagesByContact(@_); | ||
| 251 | my $next_result = $result; | ||
| 252 | |||
| 253 | if (not defined $callback) { | ||
| 254 | while ($next_result->NextToken) { | ||
| 255 | $next_result = $self->ListPagesByContact(@_, NextToken => $next_result->NextToken); | ||
| 256 | push @{ $result->Pages }, @{ $next_result->Pages }; | ||
| 257 | } | ||
| 258 | return $result; | ||
| 259 | } else { | ||
| 260 | while ($result->NextToken) { | ||
| 261 | $callback->($_ => 'Pages') foreach (@{ $result->Pages }); | ||
| 262 | $result = $self->ListPagesByContact(@_, NextToken => $result->NextToken); | ||
| 263 | } | ||
| 264 | $callback->($_ => 'Pages') foreach (@{ $result->Pages }); | ||
| 265 | } | ||
| 266 | |||
| 267 | return undef | ||
| 268 | } | ||
| 269 | sub ListAllPagesByEngagement { | ||
| 270 | my $self = shift; | ||
| 271 | |||
| 272 | my $callback = shift @_ if (ref($_[0]) eq 'CODE'); | ||
| 273 | my $result = $self->ListPagesByEngagement(@_); | ||
| 274 | my $next_result = $result; | ||
| 275 | |||
| 276 | if (not defined $callback) { | ||
| 277 | while ($next_result->NextToken) { | ||
| 278 | $next_result = $self->ListPagesByEngagement(@_, NextToken => $next_result->NextToken); | ||
| 279 | push @{ $result->Pages }, @{ $next_result->Pages }; | ||
| 280 | } | ||
| 281 | return $result; | ||
| 282 | } else { | ||
| 283 | while ($result->NextToken) { | ||
| 284 | $callback->($_ => 'Pages') foreach (@{ $result->Pages }); | ||
| 285 | $result = $self->ListPagesByEngagement(@_, NextToken => $result->NextToken); | ||
| 286 | } | ||
| 287 | $callback->($_ => 'Pages') foreach (@{ $result->Pages }); | ||
| 288 | } | ||
| 289 | |||
| 290 | return undef | ||
| 291 | } | ||
| 292 | |||
| 293 | |||
| 294 | sub operations { qw/AcceptPage ActivateContactChannel CreateContact CreateContactChannel DeactivateContactChannel DeleteContact DeleteContactChannel DescribeEngagement DescribePage GetContact GetContactChannel GetContactPolicy ListContactChannels ListContacts ListEngagements ListPageReceipts ListPagesByContact ListPagesByEngagement ListTagsForResource PutContactPolicy SendActivationCode StartEngagement StopEngagement TagResource UntagResource UpdateContact UpdateContactChannel / } | ||
| 295 | |||
| 296 | 1; | ||
| 297 | |||
| 298 | ### main pod documentation begin ### | ||
| 299 | |||
| 300 | =head1 NAME | ||
| 301 | |||
| 302 | Paws::SSMContacts - Perl Interface to AWS AWS Systems Manager Incident Manager Contacts | ||
| 303 | |||
| 304 | =head1 SYNOPSIS | ||
| 305 | |||
| 306 | use Paws; | ||
| 307 | |||
| 308 | my $obj = Paws->service('SSMContacts'); | ||
| 309 | my $res = $obj->Method( | ||
| 310 | Arg1 => $val1, | ||
| 311 | Arg2 => [ 'V1', 'V2' ], | ||
| 312 | # if Arg3 is an object, the HashRef will be used as arguments to the constructor | ||
| 313 | # of the arguments type | ||
| 314 | Arg3 => { Att1 => 'Val1' }, | ||
| 315 | # if Arg4 is an array of objects, the HashRefs will be passed as arguments to | ||
| 316 | # the constructor of the arguments type | ||
| 317 | Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ], | ||
| 318 | ); | ||
| 319 | |||
| 320 | =head1 DESCRIPTION | ||
| 321 | |||
| 322 | |||
| 323 | |||
| 324 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03> | ||
| 325 | |||
| 326 | |||
| 327 | =head1 METHODS | ||
| 328 | |||
| 329 | =head2 AcceptPage | ||
| 330 | |||
| 331 | =over | ||
| 332 | |||
| 333 | =item AcceptCode => Str | ||
| 334 | |||
| 335 | =item AcceptType => Str | ||
| 336 | |||
| 337 | =item PageId => Str | ||
| 338 | |||
| 339 | =item [ContactChannelId => Str] | ||
| 340 | |||
| 341 | =item [Note => Str] | ||
| 342 | |||
| 343 | |||
| 344 | =back | ||
| 345 | |||
| 346 | Each argument is described in detail in: L<Paws::SSMContacts::AcceptPage> | ||
| 347 | |||
| 348 | Returns: a L<Paws::SSMContacts::AcceptPageResult> instance | ||
| 349 | |||
| 350 | Used to acknowledge an engagement to a contact channel during an | ||
| 351 | incident. | ||
| 352 | |||
| 353 | |||
| 354 | =head2 ActivateContactChannel | ||
| 355 | |||
| 356 | =over | ||
| 357 | |||
| 358 | =item ActivationCode => Str | ||
| 359 | |||
| 360 | =item ContactChannelId => Str | ||
| 361 | |||
| 362 | |||
| 363 | =back | ||
| 364 | |||
| 365 | Each argument is described in detail in: L<Paws::SSMContacts::ActivateContactChannel> | ||
| 366 | |||
| 367 | Returns: a L<Paws::SSMContacts::ActivateContactChannelResult> instance | ||
| 368 | |||
| 369 | Activates a contact's contact channel. Incident Manager can't engage a | ||
| 370 | contact until the contact channel has been activated. | ||
| 371 | |||
| 372 | |||
| 373 | =head2 CreateContact | ||
| 374 | |||
| 375 | =over | ||
| 376 | |||
| 377 | =item Alias => Str | ||
| 378 | |||
| 379 | =item Plan => L<Paws::SSMContacts::Plan> | ||
| 380 | |||
| 381 | =item Type => Str | ||
| 382 | |||
| 383 | =item [DisplayName => Str] | ||
| 384 | |||
| 385 | =item [IdempotencyToken => Str] | ||
| 386 | |||
| 387 | =item [Tags => ArrayRef[L<Paws::SSMContacts::Tag>]] | ||
| 388 | |||
| 389 | |||
| 390 | =back | ||
| 391 | |||
| 392 | Each argument is described in detail in: L<Paws::SSMContacts::CreateContact> | ||
| 393 | |||
| 394 | Returns: a L<Paws::SSMContacts::CreateContactResult> instance | ||
| 395 | |||
| 396 | Contacts are either the contacts that Incident Manager engages during | ||
| 397 | an incident or the escalation plans that Incident Manager uses to | ||
| 398 | engage contacts in phases during an incident. | ||
| 399 | |||
| 400 | |||
| 401 | =head2 CreateContactChannel | ||
| 402 | |||
| 403 | =over | ||
| 404 | |||
| 405 | =item ContactId => Str | ||
| 406 | |||
| 407 | =item DeliveryAddress => L<Paws::SSMContacts::ContactChannelAddress> | ||
| 408 | |||
| 409 | =item Name => Str | ||
| 410 | |||
| 411 | =item Type => Str | ||
| 412 | |||
| 413 | =item [DeferActivation => Bool] | ||
| 414 | |||
| 415 | =item [IdempotencyToken => Str] | ||
| 416 | |||
| 417 | |||
| 418 | =back | ||
| 419 | |||
| 420 | Each argument is described in detail in: L<Paws::SSMContacts::CreateContactChannel> | ||
| 421 | |||
| 422 | Returns: a L<Paws::SSMContacts::CreateContactChannelResult> instance | ||
| 423 | |||
| 424 | A contact channel is the method that Incident Manager uses to engage | ||
| 425 | your contact. | ||
| 426 | |||
| 427 | |||
| 428 | =head2 DeactivateContactChannel | ||
| 429 | |||
| 430 | =over | ||
| 431 | |||
| 432 | =item ContactChannelId => Str | ||
| 433 | |||
| 434 | |||
| 435 | =back | ||
| 436 | |||
| 437 | Each argument is described in detail in: L<Paws::SSMContacts::DeactivateContactChannel> | ||
| 438 | |||
| 439 | Returns: a L<Paws::SSMContacts::DeactivateContactChannelResult> instance | ||
| 440 | |||
| 441 | To no longer receive Incident Manager engagements to a contact channel, | ||
| 442 | you can deactivate the channel. | ||
| 443 | |||
| 444 | |||
| 445 | =head2 DeleteContact | ||
| 446 | |||
| 447 | =over | ||
| 448 | |||
| 449 | =item ContactId => Str | ||
| 450 | |||
| 451 | |||
| 452 | =back | ||
| 453 | |||
| 454 | Each argument is described in detail in: L<Paws::SSMContacts::DeleteContact> | ||
| 455 | |||
| 456 | Returns: a L<Paws::SSMContacts::DeleteContactResult> instance | ||
| 457 | |||
| 458 | To remove a contact from Incident Manager, you can delete the contact. | ||
| 459 | Deleting a contact removes them from all escalation plans and related | ||
| 460 | response plans. Deleting an escalation plan removes it from all related | ||
| 461 | response plans. You will have to recreate the contact and its contact | ||
| 462 | channels before you can use it again. | ||
| 463 | |||
| 464 | |||
| 465 | =head2 DeleteContactChannel | ||
| 466 | |||
| 467 | =over | ||
| 468 | |||
| 469 | =item ContactChannelId => Str | ||
| 470 | |||
| 471 | |||
| 472 | =back | ||
| 473 | |||
| 474 | Each argument is described in detail in: L<Paws::SSMContacts::DeleteContactChannel> | ||
| 475 | |||
| 476 | Returns: a L<Paws::SSMContacts::DeleteContactChannelResult> instance | ||
| 477 | |||
| 478 | To no longer receive engagements on a contact channel, you can delete | ||
| 479 | the channel from a contact. Deleting the contact channel removes it | ||
| 480 | from the contact's engagement plan. If you delete the only contact | ||
| 481 | channel for a contact, you won't be able to engage that contact during | ||
| 482 | an incident. | ||
| 483 | |||
| 484 | |||
| 485 | =head2 DescribeEngagement | ||
| 486 | |||
| 487 | =over | ||
| 488 | |||
| 489 | =item EngagementId => Str | ||
| 490 | |||
| 491 | |||
| 492 | =back | ||
| 493 | |||
| 494 | Each argument is described in detail in: L<Paws::SSMContacts::DescribeEngagement> | ||
| 495 | |||
| 496 | Returns: a L<Paws::SSMContacts::DescribeEngagementResult> instance | ||
| 497 | |||
| 498 | Incident Manager uses engagements to engage contacts and escalation | ||
| 499 | plans during an incident. Use this command to describe the engagement | ||
| 500 | that occurred during an incident. | ||
| 501 | |||
| 502 | |||
| 503 | =head2 DescribePage | ||
| 504 | |||
| 505 | =over | ||
| 506 | |||
| 507 | =item PageId => Str | ||
| 508 | |||
| 509 | |||
| 510 | =back | ||
| 511 | |||
| 512 | Each argument is described in detail in: L<Paws::SSMContacts::DescribePage> | ||
| 513 | |||
| 514 | Returns: a L<Paws::SSMContacts::DescribePageResult> instance | ||
| 515 | |||
| 516 | Lists details of the engagement to a contact channel. | ||
| 517 | |||
| 518 | |||
| 519 | =head2 GetContact | ||
| 520 | |||
| 521 | =over | ||
| 522 | |||
| 523 | =item ContactId => Str | ||
| 524 | |||
| 525 | |||
| 526 | =back | ||
| 527 | |||
| 528 | Each argument is described in detail in: L<Paws::SSMContacts::GetContact> | ||
| 529 | |||
| 530 | Returns: a L<Paws::SSMContacts::GetContactResult> instance | ||
| 531 | |||
| 532 | Retrieves information about the specified contact or escalation plan. | ||
| 533 | |||
| 534 | |||
| 535 | =head2 GetContactChannel | ||
| 536 | |||
| 537 | =over | ||
| 538 | |||
| 539 | =item ContactChannelId => Str | ||
| 540 | |||
| 541 | |||
| 542 | =back | ||
| 543 | |||
| 544 | Each argument is described in detail in: L<Paws::SSMContacts::GetContactChannel> | ||
| 545 | |||
| 546 | Returns: a L<Paws::SSMContacts::GetContactChannelResult> instance | ||
| 547 | |||
| 548 | List details about a specific contact channel. | ||
| 549 | |||
| 550 | |||
| 551 | =head2 GetContactPolicy | ||
| 552 | |||
| 553 | =over | ||
| 554 | |||
| 555 | =item ContactArn => Str | ||
| 556 | |||
| 557 | |||
| 558 | =back | ||
| 559 | |||
| 560 | Each argument is described in detail in: L<Paws::SSMContacts::GetContactPolicy> | ||
| 561 | |||
| 562 | Returns: a L<Paws::SSMContacts::GetContactPolicyResult> instance | ||
| 563 | |||
| 564 | Retrieves the resource policies attached to the specified contact or | ||
| 565 | escalation plan. | ||
| 566 | |||
| 567 | |||
| 568 | =head2 ListContactChannels | ||
| 569 | |||
| 570 | =over | ||
| 571 | |||
| 572 | =item ContactId => Str | ||
| 573 | |||
| 574 | =item [MaxResults => Int] | ||
| 575 | |||
| 576 | =item [NextToken => Str] | ||
| 577 | |||
| 578 | |||
| 579 | =back | ||
| 580 | |||
| 581 | Each argument is described in detail in: L<Paws::SSMContacts::ListContactChannels> | ||
| 582 | |||
| 583 | Returns: a L<Paws::SSMContacts::ListContactChannelsResult> instance | ||
| 584 | |||
| 585 | Lists all contact channels for the specified contact. | ||
| 586 | |||
| 587 | |||
| 588 | =head2 ListContacts | ||
| 589 | |||
| 590 | =over | ||
| 591 | |||
| 592 | =item [AliasPrefix => Str] | ||
| 593 | |||
| 594 | =item [MaxResults => Int] | ||
| 595 | |||
| 596 | =item [NextToken => Str] | ||
| 597 | |||
| 598 | =item [Type => Str] | ||
| 599 | |||
| 600 | |||
| 601 | =back | ||
| 602 | |||
| 603 | Each argument is described in detail in: L<Paws::SSMContacts::ListContacts> | ||
| 604 | |||
| 605 | Returns: a L<Paws::SSMContacts::ListContactsResult> instance | ||
| 606 | |||
| 607 | Lists all contacts and escalation plans in Incident Manager. | ||
| 608 | |||
| 609 | |||
| 610 | =head2 ListEngagements | ||
| 611 | |||
| 612 | =over | ||
| 613 | |||
| 614 | =item [IncidentId => Str] | ||
| 615 | |||
| 616 | =item [MaxResults => Int] | ||
| 617 | |||
| 618 | =item [NextToken => Str] | ||
| 619 | |||
| 620 | =item [TimeRangeValue => L<Paws::SSMContacts::TimeRange>] | ||
| 621 | |||
| 622 | |||
| 623 | =back | ||
| 624 | |||
| 625 | Each argument is described in detail in: L<Paws::SSMContacts::ListEngagements> | ||
| 626 | |||
| 627 | Returns: a L<Paws::SSMContacts::ListEngagementsResult> instance | ||
| 628 | |||
| 629 | Lists all engagements that have happened in an incident. | ||
| 630 | |||
| 631 | |||
| 632 | =head2 ListPageReceipts | ||
| 633 | |||
| 634 | =over | ||
| 635 | |||
| 636 | =item PageId => Str | ||
| 637 | |||
| 638 | =item [MaxResults => Int] | ||
| 639 | |||
| 640 | =item [NextToken => Str] | ||
| 641 | |||
| 642 | |||
| 643 | =back | ||
| 644 | |||
| 645 | Each argument is described in detail in: L<Paws::SSMContacts::ListPageReceipts> | ||
| 646 | |||
| 647 | Returns: a L<Paws::SSMContacts::ListPageReceiptsResult> instance | ||
| 648 | |||
| 649 | Lists all of the engagements to contact channels that have been | ||
| 650 | acknowledged. | ||
| 651 | |||
| 652 | |||
| 653 | =head2 ListPagesByContact | ||
| 654 | |||
| 655 | =over | ||
| 656 | |||
| 657 | =item ContactId => Str | ||
| 658 | |||
| 659 | =item [MaxResults => Int] | ||
| 660 | |||
| 661 | =item [NextToken => Str] | ||
| 662 | |||
| 663 | |||
| 664 | =back | ||
| 665 | |||
| 666 | Each argument is described in detail in: L<Paws::SSMContacts::ListPagesByContact> | ||
| 667 | |||
| 668 | Returns: a L<Paws::SSMContacts::ListPagesByContactResult> instance | ||
| 669 | |||
| 670 | Lists the engagements to a contact's contact channels. | ||
| 671 | |||
| 672 | |||
| 673 | =head2 ListPagesByEngagement | ||
| 674 | |||
| 675 | =over | ||
| 676 | |||
| 677 | =item EngagementId => Str | ||
| 678 | |||
| 679 | =item [MaxResults => Int] | ||
| 680 | |||
| 681 | =item [NextToken => Str] | ||
| 682 | |||
| 683 | |||
| 684 | =back | ||
| 685 | |||
| 686 | Each argument is described in detail in: L<Paws::SSMContacts::ListPagesByEngagement> | ||
| 687 | |||
| 688 | Returns: a L<Paws::SSMContacts::ListPagesByEngagementResult> instance | ||
| 689 | |||
| 690 | Lists the engagements to contact channels that occurred by engaging a | ||
| 691 | contact. | ||
| 692 | |||
| 693 | |||
| 694 | =head2 ListTagsForResource | ||
| 695 | |||
| 696 | =over | ||
| 697 | |||
| 698 | =item ResourceARN => Str | ||
| 699 | |||
| 700 | |||
| 701 | =back | ||
| 702 | |||
| 703 | Each argument is described in detail in: L<Paws::SSMContacts::ListTagsForResource> | ||
| 704 | |||
| 705 | Returns: a L<Paws::SSMContacts::ListTagsForResourceResult> instance | ||
| 706 | |||
| 707 | Lists the tags of an escalation plan or contact. | ||
| 708 | |||
| 709 | |||
| 710 | =head2 PutContactPolicy | ||
| 711 | |||
| 712 | =over | ||
| 713 | |||
| 714 | =item ContactArn => Str | ||
| 715 | |||
| 716 | =item Policy => Str | ||
| 717 | |||
| 718 | |||
| 719 | =back | ||
| 720 | |||
| 721 | Each argument is described in detail in: L<Paws::SSMContacts::PutContactPolicy> | ||
| 722 | |||
| 723 | Returns: a L<Paws::SSMContacts::PutContactPolicyResult> instance | ||
| 724 | |||
| 725 | Adds a resource to the specified contact or escalation plan. | ||
| 726 | |||
| 727 | |||
| 728 | =head2 SendActivationCode | ||
| 729 | |||
| 730 | =over | ||
| 731 | |||
| 732 | =item ContactChannelId => Str | ||
| 733 | |||
| 734 | |||
| 735 | =back | ||
| 736 | |||
| 737 | Each argument is described in detail in: L<Paws::SSMContacts::SendActivationCode> | ||
| 738 | |||
| 739 | Returns: a L<Paws::SSMContacts::SendActivationCodeResult> instance | ||
| 740 | |||
| 741 | Sends an activation code to a contact channel. The contact can use this | ||
| 742 | code to activate the contact channel in the console or with the | ||
| 743 | C<ActivateChannel> action. Incident Manager can't engage a contact | ||
| 744 | channel until it has been activated. | ||
| 745 | |||
| 746 | |||
| 747 | =head2 StartEngagement | ||
| 748 | |||
| 749 | =over | ||
| 750 | |||
| 751 | =item ContactId => Str | ||
| 752 | |||
| 753 | =item Content => Str | ||
| 754 | |||
| 755 | =item Sender => Str | ||
| 756 | |||
| 757 | =item Subject => Str | ||
| 758 | |||
| 759 | =item [IdempotencyToken => Str] | ||
| 760 | |||
| 761 | =item [IncidentId => Str] | ||
| 762 | |||
| 763 | =item [PublicContent => Str] | ||
| 764 | |||
| 765 | =item [PublicSubject => Str] | ||
| 766 | |||
| 767 | |||
| 768 | =back | ||
| 769 | |||
| 770 | Each argument is described in detail in: L<Paws::SSMContacts::StartEngagement> | ||
| 771 | |||
| 772 | Returns: a L<Paws::SSMContacts::StartEngagementResult> instance | ||
| 773 | |||
| 774 | Starts an engagement to a contact or escalation plan. The engagement | ||
| 775 | engages each contact specified in the incident. | ||
| 776 | |||
| 777 | |||
| 778 | =head2 StopEngagement | ||
| 779 | |||
| 780 | =over | ||
| 781 | |||
| 782 | =item EngagementId => Str | ||
| 783 | |||
| 784 | =item [Reason => Str] | ||
| 785 | |||
| 786 | |||
| 787 | =back | ||
| 788 | |||
| 789 | Each argument is described in detail in: L<Paws::SSMContacts::StopEngagement> | ||
| 790 | |||
| 791 | Returns: a L<Paws::SSMContacts::StopEngagementResult> instance | ||
| 792 | |||
| 793 | Stops an engagement before it finishes the final stage of the | ||
| 794 | escalation plan or engagement plan. Further contacts aren't engaged. | ||
| 795 | |||
| 796 | |||
| 797 | =head2 TagResource | ||
| 798 | |||
| 799 | =over | ||
| 800 | |||
| 801 | =item ResourceARN => Str | ||
| 802 | |||
| 803 | =item Tags => ArrayRef[L<Paws::SSMContacts::Tag>] | ||
| 804 | |||
| 805 | |||
| 806 | =back | ||
| 807 | |||
| 808 | Each argument is described in detail in: L<Paws::SSMContacts::TagResource> | ||
| 809 | |||
| 810 | Returns: a L<Paws::SSMContacts::TagResourceResult> instance | ||
| 811 | |||
| 812 | Tags a contact or escalation plan. You can tag only contacts and | ||
| 813 | escalation plans in the first region of your replication set. | ||
| 814 | |||
| 815 | |||
| 816 | =head2 UntagResource | ||
| 817 | |||
| 818 | =over | ||
| 819 | |||
| 820 | =item ResourceARN => Str | ||
| 821 | |||
| 822 | =item TagKeys => ArrayRef[Str|Undef] | ||
| 823 | |||
| 824 | |||
| 825 | =back | ||
| 826 | |||
| 827 | Each argument is described in detail in: L<Paws::SSMContacts::UntagResource> | ||
| 828 | |||
| 829 | Returns: a L<Paws::SSMContacts::UntagResourceResult> instance | ||
| 830 | |||
| 831 | Removes tags from the specified resource. | ||
| 832 | |||
| 833 | |||
| 834 | =head2 UpdateContact | ||
| 835 | |||
| 836 | =over | ||
| 837 | |||
| 838 | =item ContactId => Str | ||
| 839 | |||
| 840 | =item [DisplayName => Str] | ||
| 841 | |||
| 842 | =item [Plan => L<Paws::SSMContacts::Plan>] | ||
| 843 | |||
| 844 | |||
| 845 | =back | ||
| 846 | |||
| 847 | Each argument is described in detail in: L<Paws::SSMContacts::UpdateContact> | ||
| 848 | |||
| 849 | Returns: a L<Paws::SSMContacts::UpdateContactResult> instance | ||
| 850 | |||
| 851 | Updates the contact or escalation plan specified. | ||
| 852 | |||
| 853 | |||
| 854 | =head2 UpdateContactChannel | ||
| 855 | |||
| 856 | =over | ||
| 857 | |||
| 858 | =item ContactChannelId => Str | ||
| 859 | |||
| 860 | =item [DeliveryAddress => L<Paws::SSMContacts::ContactChannelAddress>] | ||
| 861 | |||
| 862 | =item [Name => Str] | ||
| 863 | |||
| 864 | |||
| 865 | =back | ||
| 866 | |||
| 867 | Each argument is described in detail in: L<Paws::SSMContacts::UpdateContactChannel> | ||
| 868 | |||
| 869 | Returns: a L<Paws::SSMContacts::UpdateContactChannelResult> instance | ||
| 870 | |||
| 871 | Updates a contact's contact channel. | ||
| 872 | |||
| 873 | |||
| 874 | |||
| 875 | |||
| 876 | =head1 PAGINATORS | ||
| 877 | |||
| 878 | Paginator methods are helpers that repetively call methods that return partial results | ||
| 879 | |||
| 880 | =head2 ListAllContactChannels(sub { },ContactId => Str, [MaxResults => Int, NextToken => Str]) | ||
| 881 | |||
| 882 | =head2 ListAllContactChannels(ContactId => Str, [MaxResults => Int, NextToken => Str]) | ||
| 883 | |||
| 884 | |||
| 885 | If passed a sub as first parameter, it will call the sub for each element found in : | ||
| 886 | |||
| 887 | - ContactChannels, passing the object as the first parameter, and the string 'ContactChannels' as the second parameter | ||
| 888 | |||
| 889 | If not, it will return a a L<Paws::SSMContacts::ListContactChannelsResult> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory. | ||
| 890 | |||
| 891 | |||
| 892 | =head2 ListAllContacts(sub { },[AliasPrefix => Str, MaxResults => Int, NextToken => Str, Type => Str]) | ||
| 893 | |||
| 894 | =head2 ListAllContacts([AliasPrefix => Str, MaxResults => Int, NextToken => Str, Type => Str]) | ||
| 895 | |||
| 896 | |||
| 897 | If passed a sub as first parameter, it will call the sub for each element found in : | ||
| 898 | |||
| 899 | - Contacts, passing the object as the first parameter, and the string 'Contacts' as the second parameter | ||
| 900 | |||
| 901 | If not, it will return a a L<Paws::SSMContacts::ListContactsResult> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory. | ||
| 902 | |||
| 903 | |||
| 904 | =head2 ListAllEngagements(sub { },[IncidentId => Str, MaxResults => Int, NextToken => Str, TimeRangeValue => L<Paws::SSMContacts::TimeRange>]) | ||
| 905 | |||
| 906 | =head2 ListAllEngagements([IncidentId => Str, MaxResults => Int, NextToken => Str, TimeRangeValue => L<Paws::SSMContacts::TimeRange>]) | ||
| 907 | |||
| 908 | |||
| 909 | If passed a sub as first parameter, it will call the sub for each element found in : | ||
| 910 | |||
| 911 | - Engagements, passing the object as the first parameter, and the string 'Engagements' as the second parameter | ||
| 912 | |||
| 913 | If not, it will return a a L<Paws::SSMContacts::ListEngagementsResult> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory. | ||
| 914 | |||
| 915 | |||
| 916 | =head2 ListAllPageReceipts(sub { },PageId => Str, [MaxResults => Int, NextToken => Str]) | ||
| 917 | |||
| 918 | =head2 ListAllPageReceipts(PageId => Str, [MaxResults => Int, NextToken => Str]) | ||
| 919 | |||
| 920 | |||
| 921 | If passed a sub as first parameter, it will call the sub for each element found in : | ||
| 922 | |||
| 923 | - Receipts, passing the object as the first parameter, and the string 'Receipts' as the second parameter | ||
| 924 | |||
| 925 | If not, it will return a a L<Paws::SSMContacts::ListPageReceiptsResult> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory. | ||
| 926 | |||
| 927 | |||
| 928 | =head2 ListAllPagesByContact(sub { },ContactId => Str, [MaxResults => Int, NextToken => Str]) | ||
| 929 | |||
| 930 | =head2 ListAllPagesByContact(ContactId => Str, [MaxResults => Int, NextToken => Str]) | ||
| 931 | |||
| 932 | |||
| 933 | If passed a sub as first parameter, it will call the sub for each element found in : | ||
| 934 | |||
| 935 | - Pages, passing the object as the first parameter, and the string 'Pages' as the second parameter | ||
| 936 | |||
| 937 | If not, it will return a a L<Paws::SSMContacts::ListPagesByContactResult> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory. | ||
| 938 | |||
| 939 | |||
| 940 | =head2 ListAllPagesByEngagement(sub { },EngagementId => Str, [MaxResults => Int, NextToken => Str]) | ||
| 941 | |||
| 942 | =head2 ListAllPagesByEngagement(EngagementId => Str, [MaxResults => Int, NextToken => Str]) | ||
| 943 | |||
| 944 | |||
| 945 | If passed a sub as first parameter, it will call the sub for each element found in : | ||
| 946 | |||
| 947 | - Pages, passing the object as the first parameter, and the string 'Pages' as the second parameter | ||
| 948 | |||
| 949 | If not, it will return a a L<Paws::SSMContacts::ListPagesByEngagementResult> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory. | ||
| 950 | |||
| 951 | |||
| 952 | |||
| 953 | |||
| 954 | |||
| 955 | =head1 SEE ALSO | ||
| 956 | |||
| 957 | This service class forms part of L<Paws> | ||
| 958 | |||
| 959 | =head1 BUGS and CONTRIBUTIONS | ||
| 960 | |||
| 961 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 962 | |||
| 963 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 964 | |||
| 965 | =cut | ||
| 966 |