The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::SSMIncidents

NAME

Paws::SSMIncidents - Perl Interface to AWS AWS Systems Manager Incident Manager

SYNOPSIS

  use Paws;

  my $obj = Paws->service('SSMIncidents');
  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' } ],
  );

DESCRIPTION

AWS Systems Manager Incident Manager is an incident management console designed to help users mitigate and recover from incidents affecting their AWS-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.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10

METHODS

CreateReplicationSet

Regions => Paws::SSMIncidents::RegionMapInput
[ClientToken => Str]

Each argument is described in detail in: Paws::SSMIncidents::CreateReplicationSet

Returns: a Paws::SSMIncidents::CreateReplicationSetOutput instance

A replication set replicates and encrypts your data to the provided Regions with the provided KMS key.

CreateResponsePlan

IncidentTemplate => Paws::SSMIncidents::IncidentTemplate
Name => Str
[Actions => ArrayRef[Paws::SSMIncidents::Action]]
[ChatChannel => Paws::SSMIncidents::ChatChannel]
[ClientToken => Str]
[DisplayName => Str]
[Engagements => ArrayRef[Str|Undef]]
[Tags => Paws::SSMIncidents::TagMap]

Each argument is described in detail in: Paws::SSMIncidents::CreateResponsePlan

Returns: a Paws::SSMIncidents::CreateResponsePlanOutput instance

Creates a response plan that automates the initial response to incidents. A response plan engages contacts, starts chat channel collaboration, and initiates runbooks at the beginning of an incident.

CreateTimelineEvent

ClientToken => Str
EventData => Str
EventTime => Str
EventType => Str
IncidentRecordArn => Str

Each argument is described in detail in: Paws::SSMIncidents::CreateTimelineEvent

Returns: a Paws::SSMIncidents::CreateTimelineEventOutput instance

Creates a custom timeline event on the incident details page of an incident record. Timeline events are automatically created by Incident Manager, marking key moment during an incident. You can create custom timeline events to mark important events that are automatically detected by Incident Manager.

DeleteIncidentRecord

Arn => Str

Each argument is described in detail in: Paws::SSMIncidents::DeleteIncidentRecord

Returns: a Paws::SSMIncidents::DeleteIncidentRecordOutput instance

Delete an incident record from Incident Manager.

DeleteReplicationSet

Arn => Str

Each argument is described in detail in: Paws::SSMIncidents::DeleteReplicationSet

Returns: a Paws::SSMIncidents::DeleteReplicationSetOutput instance

Deletes all Regions in your replication set. Deleting the replication set deletes all Incident Manager data.

DeleteResourcePolicy

PolicyId => Str
ResourceArn => Str

Each argument is described in detail in: Paws::SSMIncidents::DeleteResourcePolicy

Returns: a Paws::SSMIncidents::DeleteResourcePolicyOutput instance

Deletes the resource policy that AWS Resource Access Manager uses to share your Incident Manager resource.

DeleteResponsePlan

Arn => Str

Each argument is described in detail in: Paws::SSMIncidents::DeleteResponsePlan

Returns: a Paws::SSMIncidents::DeleteResponsePlanOutput instance

Deletes the specified response plan. Deleting a response plan stops all linked CloudWatch alarms and EventBridge events from creating an incident with this response plan.

DeleteTimelineEvent

EventId => Str
IncidentRecordArn => Str

Each argument is described in detail in: Paws::SSMIncidents::DeleteTimelineEvent

Returns: a Paws::SSMIncidents::DeleteTimelineEventOutput instance

Deletes a timeline event from an incident.

GetIncidentRecord

Arn => Str

Each argument is described in detail in: Paws::SSMIncidents::GetIncidentRecord

Returns: a Paws::SSMIncidents::GetIncidentRecordOutput instance

Returns the details of the specified incident record.

GetReplicationSet

Arn => Str

Each argument is described in detail in: Paws::SSMIncidents::GetReplicationSet

Returns: a Paws::SSMIncidents::GetReplicationSetOutput instance

Retrieve your Incident Manager replication set.

GetResourcePolicies

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

Each argument is described in detail in: Paws::SSMIncidents::GetResourcePolicies

Returns: a Paws::SSMIncidents::GetResourcePoliciesOutput instance

Retrieves the resource policies attached to the specified response plan.

GetResponsePlan

Arn => Str

Each argument is described in detail in: Paws::SSMIncidents::GetResponsePlan

Returns: a Paws::SSMIncidents::GetResponsePlanOutput instance

Retrieves the details of the specified response plan.

GetTimelineEvent

EventId => Str
IncidentRecordArn => Str

Each argument is described in detail in: Paws::SSMIncidents::GetTimelineEvent

Returns: a Paws::SSMIncidents::GetTimelineEventOutput instance

Retrieves a timeline event based on its ID and incident record.

ListIncidentRecords

[Filters => ArrayRef[Paws::SSMIncidents::Filter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSMIncidents::ListIncidentRecords

Returns: a Paws::SSMIncidents::ListIncidentRecordsOutput instance

Lists all incident records in your account. Use this command to retrieve the Amazon Resource Name (ARN) of the incident record you want to update.

ListRelatedItems

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

Each argument is described in detail in: Paws::SSMIncidents::ListRelatedItems

Returns: a Paws::SSMIncidents::ListRelatedItemsOutput instance

List all related items for an incident record.

ListReplicationSets

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

Each argument is described in detail in: Paws::SSMIncidents::ListReplicationSets

Returns: a Paws::SSMIncidents::ListReplicationSetsOutput instance

Lists details about the replication set configured in your account.

ListResponsePlans

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

Each argument is described in detail in: Paws::SSMIncidents::ListResponsePlans

Returns: a Paws::SSMIncidents::ListResponsePlansOutput instance

Lists all response plans in your account.

ListTagsForResource

ResourceArn => Str

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

Returns: a Paws::SSMIncidents::ListTagsForResourceResponse instance

Lists the tags that are attached to the specified response plan.

ListTimelineEvents

IncidentRecordArn => Str
[Filters => ArrayRef[Paws::SSMIncidents::Filter]]
[MaxResults => Int]
[NextToken => Str]
[SortBy => Str]
[SortOrder => Str]

Each argument is described in detail in: Paws::SSMIncidents::ListTimelineEvents

Returns: a Paws::SSMIncidents::ListTimelineEventsOutput instance

Lists timeline events of the specified incident record.

PutResourcePolicy

Policy => Str
ResourceArn => Str

Each argument is described in detail in: Paws::SSMIncidents::PutResourcePolicy

Returns: a Paws::SSMIncidents::PutResourcePolicyOutput instance

Adds a resource policy to the specified response plan.

StartIncident

ResponsePlanArn => Str
[ClientToken => Str]
[Impact => Int]
[RelatedItems => ArrayRef[Paws::SSMIncidents::RelatedItem]]
[Title => Str]
[TriggerDetails => Paws::SSMIncidents::TriggerDetails]

Each argument is described in detail in: Paws::SSMIncidents::StartIncident

Returns: a Paws::SSMIncidents::StartIncidentOutput instance

Used to start an incident from CloudWatch alarms, EventBridge events, or manually.

TagResource

ResourceArn => Str
Tags => Paws::SSMIncidents::TagMap

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

Returns: a Paws::SSMIncidents::TagResourceResponse instance

Adds a tag to a response plan.

UntagResource

ResourceArn => Str
TagKeys => ArrayRef[Str|Undef]

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

Returns: a Paws::SSMIncidents::UntagResourceResponse instance

Removes a tag from a resource.

UpdateDeletionProtection

Arn => Str
DeletionProtected => Bool
[ClientToken => Str]

Each argument is described in detail in: Paws::SSMIncidents::UpdateDeletionProtection

Returns: a Paws::SSMIncidents::UpdateDeletionProtectionOutput instance

Update deletion protection to either allow or deny deletion of the final Region in a replication set.

UpdateIncidentRecord

Arn => Str
[ChatChannel => Paws::SSMIncidents::ChatChannel]
[ClientToken => Str]
[Impact => Int]
[NotificationTargets => ArrayRef[Paws::SSMIncidents::NotificationTargetItem]]
[Status => Str]
[Summary => Str]
[Title => Str]

Each argument is described in detail in: Paws::SSMIncidents::UpdateIncidentRecord

Returns: a Paws::SSMIncidents::UpdateIncidentRecordOutput instance

Update the details of an incident record. You can use this action to update an incident record from the defined chat channel. For more information about using actions in chat channels, see Interacting through chat (https://docs.aws.amazon.com/incident-manager/latest/userguide/chat.html#chat-interact).

UpdateRelatedItems

IncidentRecordArn => Str
RelatedItemsUpdate => Paws::SSMIncidents::RelatedItemsUpdate
[ClientToken => Str]

Each argument is described in detail in: Paws::SSMIncidents::UpdateRelatedItems

Returns: a Paws::SSMIncidents::UpdateRelatedItemsOutput instance

Add or remove related items from the related items tab of an incident record.

UpdateReplicationSet

Actions => ArrayRef[Paws::SSMIncidents::UpdateReplicationSetAction]
Arn => Str
[ClientToken => Str]

Each argument is described in detail in: Paws::SSMIncidents::UpdateReplicationSet

Returns: a Paws::SSMIncidents::UpdateReplicationSetOutput instance

Add or delete Regions from your replication set.

UpdateResponsePlan

Arn => Str
[Actions => ArrayRef[Paws::SSMIncidents::Action]]
[ChatChannel => Paws::SSMIncidents::ChatChannel]
[ClientToken => Str]
[DisplayName => Str]
[Engagements => ArrayRef[Str|Undef]]
[IncidentTemplateDedupeString => Str]
[IncidentTemplateImpact => Int]
[IncidentTemplateNotificationTargets => ArrayRef[Paws::SSMIncidents::NotificationTargetItem]]
[IncidentTemplateSummary => Str]
[IncidentTemplateTitle => Str]

Each argument is described in detail in: Paws::SSMIncidents::UpdateResponsePlan

Returns: a Paws::SSMIncidents::UpdateResponsePlanOutput instance

Updates the specified response plan.

UpdateTimelineEvent

ClientToken => Str
EventId => Str
IncidentRecordArn => Str
[EventData => Str]
[EventTime => Str]
[EventType => Str]

Each argument is described in detail in: Paws::SSMIncidents::UpdateTimelineEvent

Returns: a Paws::SSMIncidents::UpdateTimelineEventOutput instance

Updates a timeline event. You can update events of type Custom Event.

PAGINATORS

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

GetAllResourcePolicies(sub { },ResourceArn => Str, [MaxResults => Int, NextToken => Str])

GetAllResourcePolicies(ResourceArn => Str, [MaxResults => Int, NextToken => Str])

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

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

If not, it will return a a Paws::SSMIncidents::GetResourcePoliciesOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllIncidentRecords(sub { },[Filters => ArrayRef[Paws::SSMIncidents::Filter], MaxResults => Int, NextToken => Str])

ListAllIncidentRecords([Filters => ArrayRef[Paws::SSMIncidents::Filter], MaxResults => Int, NextToken => Str])

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

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

If not, it will return a a Paws::SSMIncidents::ListIncidentRecordsOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllRelatedItems(sub { },IncidentRecordArn => Str, [MaxResults => Int, NextToken => Str])

ListAllRelatedItems(IncidentRecordArn => Str, [MaxResults => Int, NextToken => Str])

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

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

If not, it will return a a Paws::SSMIncidents::ListRelatedItemsOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllReplicationSets(sub { },[MaxResults => Int, NextToken => Str])

ListAllReplicationSets([MaxResults => Int, NextToken => Str])

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

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

If not, it will return a a Paws::SSMIncidents::ListReplicationSetsOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllResponsePlans(sub { },[MaxResults => Int, NextToken => Str])

ListAllResponsePlans([MaxResults => Int, NextToken => Str])

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

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

If not, it will return a a Paws::SSMIncidents::ListResponsePlansOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllTimelineEvents(sub { },IncidentRecordArn => Str, [Filters => ArrayRef[Paws::SSMIncidents::Filter], MaxResults => Int, NextToken => Str, SortBy => Str, SortOrder => Str])

ListAllTimelineEvents(IncidentRecordArn => Str, [Filters => ArrayRef[Paws::SSMIncidents::Filter], MaxResults => Int, NextToken => Str, SortBy => Str, SortOrder => Str])

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

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

If not, it will return a a Paws::SSMIncidents::ListTimelineEventsOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

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