« blib/lib/Paws/SSMIncidents/UpdateDeletionProtectionOutput.pm
↑ Summary
blib/lib/Paws/SSMIncidents/UpdateIncidentRecordOutput.pm »
| 1 | |||
| 2 | package Paws::SSMIncidents::UpdateIncidentRecord; | ||
| 3 | use Moose; | ||
| 4 | has Arn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'arn', required => 1); | ||
| 5 | has ChatChannel => (is => 'ro', isa => 'Paws::SSMIncidents::ChatChannel', traits => ['NameInRequest'], request_name => 'chatChannel'); | ||
| 6 | has ClientToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientToken'); | ||
| 7 | has Impact => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'impact'); | ||
| 8 | has NotificationTargets => (is => 'ro', isa => 'ArrayRef[Paws::SSMIncidents::NotificationTargetItem]', traits => ['NameInRequest'], request_name => 'notificationTargets'); | ||
| 9 | has Status => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'status'); | ||
| 10 | has Summary => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'summary'); | ||
| 11 | has Title => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'title'); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateIncidentRecord'); | ||
| 16 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/updateIncidentRecord'); | ||
| 17 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 18 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SSMIncidents::UpdateIncidentRecordOutput'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::SSMIncidents::UpdateIncidentRecord - Arguments for method UpdateIncidentRecord on L<Paws::SSMIncidents> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method UpdateIncidentRecord on the | ||
| 30 | L<AWS Systems Manager Incident Manager|Paws::SSMIncidents> service. Use the attributes of this class | ||
| 31 | as arguments to method UpdateIncidentRecord. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateIncidentRecord. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $ssm-incidents = Paws->service('SSMIncidents'); | ||
| 38 | my $UpdateIncidentRecordOutput = $ssm -incidents->UpdateIncidentRecord( | ||
| 39 | Arn => 'MyArn', | ||
| 40 | ChatChannel => { | ||
| 41 | ChatbotSns => [ | ||
| 42 | 'MySnsArn', ... # max: 1000 | ||
| 43 | ], # min: 1, max: 5; OPTIONAL | ||
| 44 | Empty => { | ||
| 45 | |||
| 46 | }, # OPTIONAL | ||
| 47 | }, # OPTIONAL | ||
| 48 | ClientToken => 'MyClientToken', # OPTIONAL | ||
| 49 | Impact => 1, # OPTIONAL | ||
| 50 | NotificationTargets => [ | ||
| 51 | { | ||
| 52 | SnsTopicArn => 'MyArn', # max: 1000 | ||
| 53 | }, | ||
| 54 | ... | ||
| 55 | ], # OPTIONAL | ||
| 56 | Status => 'OPEN', # OPTIONAL | ||
| 57 | Summary => 'MyIncidentSummary', # OPTIONAL | ||
| 58 | Title => 'MyIncidentTitle', # OPTIONAL | ||
| 59 | ); | ||
| 60 | |||
| 61 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 62 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ssm-incidents/UpdateIncidentRecord> | ||
| 63 | |||
| 64 | =head1 ATTRIBUTES | ||
| 65 | |||
| 66 | |||
| 67 | =head2 B<REQUIRED> Arn => Str | ||
| 68 | |||
| 69 | The Amazon Resource Name (ARN) of the incident record you are updating. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 ChatChannel => L<Paws::SSMIncidents::ChatChannel> | ||
| 74 | |||
| 75 | The AWS Chatbot chat channel for responders to collaborate in. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 ClientToken => Str | ||
| 80 | |||
| 81 | A token ensuring that the action is called only once with the specified | ||
| 82 | details. | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 Impact => Int | ||
| 87 | |||
| 88 | Defines the impact to customers and applications. Providing an impact | ||
| 89 | overwrites the impact provided by the response plan. | ||
| 90 | |||
| 91 | B<Possible impacts:> | ||
| 92 | |||
| 93 | =over | ||
| 94 | |||
| 95 | =item * | ||
| 96 | |||
| 97 | C<1> - Critical impact, this typically relates to full application | ||
| 98 | failure that impacts many to all customers. | ||
| 99 | |||
| 100 | =item * | ||
| 101 | |||
| 102 | C<2> - High impact, partial application failure with impact to many | ||
| 103 | customers. | ||
| 104 | |||
| 105 | =item * | ||
| 106 | |||
| 107 | C<3> - Medium impact, the application is providing reduced service to | ||
| 108 | customers. | ||
| 109 | |||
| 110 | =item * | ||
| 111 | |||
| 112 | C<4> - Low impact, customer might aren't impacted by the problem yet. | ||
| 113 | |||
| 114 | =item * | ||
| 115 | |||
| 116 | C<5> - No impact, customers aren't currently impacted but urgent action | ||
| 117 | is needed to avoid impact. | ||
| 118 | |||
| 119 | =back | ||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | =head2 NotificationTargets => ArrayRef[L<Paws::SSMIncidents::NotificationTargetItem>] | ||
| 125 | |||
| 126 | The SNS targets that AWS Chatbot uses to notify the chat channel of | ||
| 127 | updates to an incident. You can also make updates to the incident | ||
| 128 | through the chat channel using the SNS topics. | ||
| 129 | |||
| 130 | Using multiple SNS topics creates redundancy in the case that a Region | ||
| 131 | is down during the incident. | ||
| 132 | |||
| 133 | |||
| 134 | |||
| 135 | =head2 Status => Str | ||
| 136 | |||
| 137 | The status of the incident. An incident can be C<Open> or C<Resolved>. | ||
| 138 | |||
| 139 | Valid values are: C<"OPEN">, C<"RESOLVED"> | ||
| 140 | |||
| 141 | =head2 Summary => Str | ||
| 142 | |||
| 143 | The summary describes what has happened during the incident. | ||
| 144 | |||
| 145 | |||
| 146 | |||
| 147 | =head2 Title => Str | ||
| 148 | |||
| 149 | The title of the incident is a brief and easily recognizable. | ||
| 150 | |||
| 151 | |||
| 152 | |||
| 153 | |||
| 154 | =head1 SEE ALSO | ||
| 155 | |||
| 156 | This class forms part of L<Paws>, documenting arguments for method UpdateIncidentRecord in L<Paws::SSMIncidents> | ||
| 157 | |||
| 158 | =head1 BUGS and CONTRIBUTIONS | ||
| 159 | |||
| 160 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 161 | |||
| 162 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 163 | |||
| 164 | =cut | ||
| 165 |